Data

Tools

Indexes

Applications

Experiments

Open Source Science

HierarchicalEOM

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

https://github.com/qutip/hierarchicaleom.jl

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 10 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary

Keywords

chemical-physics heom hierarchical-equations-of-motion hierarchy-equations-of-motion julia lindblad many-body-physics open-quantum-systems physics quantum quantum-dynamics quantum-mechanincs quantum-optics
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 44
  • Watchers: 6
  • Forks: 10
  • Open Issues: 2
  • Releases: 51
Topics
chemical-physics heom hierarchical-equations-of-motion hierarchy-equations-of-motion julia lindblad many-body-physics open-quantum-systems physics quantum quantum-dynamics quantum-mechanincs quantum-optics
Created over 3 years ago · Last pushed 6 months ago
Metadata Files
Readme License Code of conduct Citation

README.md

Fancy logo Fancy logo

HierarchicalEOM.jl

| Release | Release License Cite | |:-----------------:|:-------------| | Runtests | Runtests Coverage | | Code Quality | Code Quality 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 built upon QuantumToolbox.jl.

Installation

[!NOTE] HierarchicalEOM.jl requires Julia 1.10+.

To install HierarchicalEOM.jl, run the following commands inside Julia's interactive session (also known as REPL): julia 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: julia-REPL (1.10) pkg> add HierarchicalEOM More information about Julia's package manager can be found at Pkg.jl.

To load the package and check the version information, use either HierarchicalEOM.versioninfo() or HierarchicalEOM.about(), namely julia using HierarchicalEOM HierarchicalEOM.versioninfo() HierarchicalEOM.about()

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 [ Communications Physics 6, 313 (2023) ] using the following bibtex entry:

bib @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} }

Since this package is built on top of QuantumToolbox.jl, we would appreciate it if you could also cite the arXiv preprint [ arXiv:2504.21440 (2025) ] using the following bibtex entry:

bib @article{QuantumToolbox-jl2025, title={{QuantumToolbox.jl}: An efficient {Julia} framework for simulating open quantum systems}, author={Mercurio, Alberto and Huang, Yi-Te and Cai, Li-Xun and Chen, Yueh-Nan and Savona, Vincenzo and Nori, Franco}, journal={arXiv preprint arXiv:2504.21440}, year={2025}, publisher = {arXiv}, eprint={2504.21440}, archivePrefix={arXiv}, primaryClass={quant-ph}, doi = {10.48550/arXiv.2504.21440} }

License

HierarchicalEOM.jl is released under the BSD 3-Clause License.

Contributing to HierarchicalEOM.jl

You are most welcome to contribute to HierarchicalEOM.jl development by forking this repository and sending pull requests (PRs), or filing bug reports at the issues page. You can also help out with users' questions, or discuss proposed changes in the QuTiP discussion group.

For more information about contribution, including technical advice, please see the Contributing to Quantum Toolbox in Julia.

Owner

  • Name: QuTiP
  • Login: qutip
  • Kind: organization

Quantum Toolbox in Python

Citation (CITATION.bib) 

@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}
}

GitHub Events

Total
  • Create event: 59
  • Commit comment event: 21
  • Issues event: 4
  • Release event: 19
  • Watch event: 9
  • Delete event: 30
  • Issue comment event: 85
  • Push event: 174
  • Pull request review event: 24
  • Pull request event: 119
  • Fork event: 2
Last Year
  • Create event: 59
  • Commit comment event: 21
  • Issues event: 4
  • Release event: 19
  • Watch event: 9
  • Delete event: 30
  • Issue comment event: 85
  • Push event: 174
  • Pull request review event: 24
  • Pull request event: 119
  • Fork event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 192
  • Average time to close issues: about 8 hours
  • Average time to close pull requests: 1 day
  • Total issue authors: 4
  • Total pull request authors: 5
  • Average comments per issue: 12.0
  • Average comments per pull request: 0.72
  • Merged pull requests: 117
  • Bot issues: 0
  • Bot pull requests: 90
Past Year
  • Issues: 3
  • Pull requests: 184
  • Average time to close issues: about 12 hours
  • Average time to close pull requests: 1 day
  • Issue authors: 3
  • Pull request authors: 5
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.71
  • Merged pull requests: 114
  • Bot issues: 0
  • Bot pull requests: 90
View more stats
Top Authors
Issue Authors
  • KristofferC (1)
  • cerisola (1)
  • ytdHuang (1)
  • JuliaTagBot (1)
Pull Request Authors
  • ytdHuang (91)
  • github-actions[bot] (56)
  • dependabot[bot] (34)
  • TendonFFF (7)
  • cerisola (4)
Top Labels
Issue Labels
Pull Request Labels
dependencies (34) github_actions (15)

Packages

  • Total packages: 1
  • Total downloads:
    • julia 6 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 51
juliahub.com: HierarchicalEOM

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

  • Versions: 51
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 6 Total
Rankings
Dependent repos count: 9.8%
Average: 30.7%
Forks count: 33.6%
Dependent packages count: 38.3%
Stargazers count: 40.9%
Last synced: 6 months ago