Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/USCqserver/OpenQuantumTools.jl
Julia toolkit for open quantum system simulation.
https://github.com/USCqserver/OpenQuantumTools.jl
quantum-computing
Last synced: 14 days ago
JSON representation
Julia toolkit for open quantum system simulation.
- Host: GitHub
- URL: https://github.com/USCqserver/OpenQuantumTools.jl
- Owner: USCqserver
- License: mit
- Created: 2018-12-02T07:38:55.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-11-16T07:27:44.000Z (12 months ago)
- Last Synced: 2024-10-15T23:05:40.953Z (28 days ago)
- Topics: quantum-computing
- Language: Julia
- Homepage: https://uscqserver.github.io/OpenQuantumTools.jl/stable/
- Size: 2.94 MB
- Stars: 72
- Watchers: 7
- Forks: 12
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenQuantumTools.jl
[](https://uscqserver.github.io/OpenQuantumTools.jl/stable/)
[](https://uscqserver.github.io/OpenQuantumTools.jl/dev/)
[](https://codecov.io/gh/USCqserver/OpenQuantumTools.jl)
The official name of this package is "Hamiltonian Open Quantum System Toolkit" (HOQST). To conform with the Julia package name [guidelines](https://julialang.github.io/Pkg.jl/v1/creating-packages/) the code name of the package is `OpenQuantumTools`. It is a Julia toolkit for simulating the open quantum system dynamics. The package is still under development, but the current functionality and APIs are stable. Future releases before v1.0 will focus on adding more features instead of introducing breaking changes. Detailed documentation can be found [here](https://uscqserver.github.io/OpenQuantumTools.jl/dev/). Any pull requests are welcome.
## Installation
To install, run the following commands inside the Julia REPL:
```julia
using Pkg
Pkg.add("OpenQuantumTools")
```
Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/):
```julia-REPL
(@v1.7) pkg> add OpenQuantumTools
```
`OpenQuantumTools` requires Julia 1.4 or higher. Installing it on an older version of Julia will result in an unsatisfiable requirements error.
## Useful Packages
It is recommended to install the following external packages:
### [Plots.jl](https://github.com/JuliaPlots/Plots.jl)
Plots is a visualization interface and toolset for Julia. `OpenQuantumTools.jl` provides several plotting functionality by recipes to `Plots.jl`.
### [DifferentialEquations.jl](http://docs.juliadiffeq.org/latest/)
Even though `OpenQuantumTools.jl` can function without `DifferentialEquations.jl`, it needs to be loaded in order for the master equation solvers to work properly. For [low dependency usage](http://docs.juliadiffeq.org/stable/features/low_dep.html#Low-Dependency-Usage-1), replacing `DifferentialEquations` by [OrdinaryDiffEq.jl](https://github.com/JuliaDiffEq/OrdinaryDiffEq.jl) will also work.
## Tutorials
Tutorials and examples can be found in [HOQSTTutorials.jl](https://github.com/USCqserver/HOQSTTutorials.jl).
## Developers
`HOQST` has a component package [OpenQuantumBase.jl](https://github.com/USCqserver/OpenQuantumBase.jl). It holds the common types and utility functions in order to reduce the size of dependencies.
## Citing
The corresponding paper for `OpenQuantumTools` is
[Chen, H., Lidar, D.A. Hamiltonian open quantum system toolkit. Commun Phys 5, 112 (2022)](https://doi.org/10.1038/s42005-022-00887-2)
This software is developed as part of academic research. If you use `OpenQuantumTools` as part of your research, teaching, or other activities, we would be grateful if you could cite our work.
## Acknowledgment
The authors thank Grace Chen for the HOQST logo design. The authors also thank Ka-Wa Yip for providing his data and MATLAB program on 1/f noise simulation for cross-checking. You can find them in this [repo](https://github.com/USCqserver/1fnoise).