/HierarchicalEOM.jl

An efficient Julia framwork for Hierarchical Equations of Motion (HEOM) in open quantum systems

Primary LanguageJuliaOtherNOASSERTION

Fancy logo Fancy logo

HierarchicalEOM.jl

Release Release License arXiv
Runtests Runtests Coverage Aqua QA JET
Documentation Doc-Stable Doc-Dev

HierarchicalEOM.jl is a numerical framework written in Julia. It provides a user-friendly and efficient tool based on hierarchical equations of motion (HEOM) approach to simulate complex open quantum systems, including non-Markovian effects due to non-perturbative interaction with one (or multiple) environment(s). It is inspired by the Quantum Toolbox in Python (QuTiP).

Installation

To install HierarchicalEOM.jl, run the following commands inside Julia's interactive session (also known as REPL):

using Pkg
Pkg.add("HierarchicalEOM")

Alternatively, this can also be done in Julia's Pkg REPL by pressing the key ] in the REPL to use the package mode, and then type the following command:

(1.9) pkg> add HierarchicalEOM

More information about Julia's package manager can be found at Pkg.jl.
HierarchicalEOM.jl now requires Julia 1.9 or higher. Installing it on an older version of Julia will result in many errors.

To load the package and check the version information, use the command:

julia> using HierarchicalEOM
julia> HierarchicalEOM.versioninfo()

Documentation

The documentation can be found in :

  • STABLE : most recently tagged version.
  • DEVELOP : in-development version.

Cite HierarchicalEOM.jl

If you like HierarchicalEOM.jl, we would appreciate it if you starred the repository in order to help us increase its visibility. Furthermore, if you find the framework useful in your research, we would be grateful if you could cite our publication [ Commun. Phys. 6, 313 (2023) ] using the following bibtex entry:

@article{HierarchicalEOM-jl2023,
  doi = {10.1038/s42005-023-01427-2},
  url = {https://doi.org/10.1038/s42005-023-01427-2},
  year = {2023},
  month = {Oct},
  publisher = {Nature Portfolio},
  volume = {6},
  number = {1},
  pages = {313},
  author = {Huang, Yi-Te and Kuo, Po-Chen and Lambert, Neill and Cirio, Mauro and Cross, Simon and Yang, Shen-Liang and Nori, Franco and Chen, Yueh-Nan},
  title = {An efficient {J}ulia framework for hierarchical equations of motion in open quantum systems},
  journal = {Communications Physics}
}

License

HierarchicalEOM.jl is released under the Apache 2 license.