ncku-qfort/hierarchicaleom.jl

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

HierarchicalEOM.jl

Release
Runtests
Documentation

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.

hierarchicaleom.jl's Issues

Add some benchmark of the solvers in the documentation

We should add some benchmark of the solvers in the documentation

add new solver of LinearSolve.jl to benchmark

• Krylov BICGSTAB KrylovJL_BICGSTAB()
• MKL direct factorizations MKLLUFactorization() : This doesn't work on sparse matrix, use MKLPardiso instead.

Calculating general power spectrum

$$\pi S(\omega)=\textrm{Re} \left\{ \int_0^\infty dt \langle P(t) Q(0)\rangle^* e^{i\omega t}\right\}$$

Where currently (HierarchicalEOM v1.0.0), $P$ must be $Q^\dagger$.

Rename spectrum as PowerSpectrum (PS).

Also, split the calculation of "density of states (DOS)" out of spectrum and make it become an independent function : DensityOfStates

TODO list:

• code for PS e0ef57f
• code for DOS e0ef57f
• docstring for spectrum() e0ef57f, e36db80
• runtests for PS e0ef57f
• runtests for DOS e0ef57f
• update Spectrum in document 93bc513

TagBot trigger issue

This issue is used to trigger TagBot; feel free to unsubscribe.

If you haven't already, you should update your TagBot.yml to include issue comment triggers.
Please see this post on Discourse for instructions and more details.

If you'd like for me to do this for you, comment TagBot fix on this issue.
I'll open a PR within a few hours, please be patient!

support system-bosonic-bath interaction under rotating wave approximation

TODO list:

• codes for generating corresponding M_Boson (2a9a88d)
• corresponding two-time correlation functionC(t) (555370e)
• corresponding runtests (2a9a88d , 6647fa8)
• add new functions to libraryAPI in docs (522c441)
• add corresponding introduction to docs (522c441)

LinearSolve UMFPack solver default settings for SteadyState

The default settings of the UMFPack solver for the function SteadyState should be
UMFPACKFactorization(; reuse_symbolic=false)

Add some examples in the documentation

We should add some more simple examples in the documentation

Update description to be compatible with the paper

Including the function docstrings and documentation