-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #134 from albertomercurio/dev/documentation
Change document folder structure and make Introduction
- Loading branch information
Showing
28 changed files
with
414 additions
and
561 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Contributor Covenant Code of Conduct | ||
|
|
||
| As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities. | ||
|
|
||
| We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality. | ||
|
|
||
| Examples of unacceptable behavior by participants include: | ||
|
|
||
| * The use of sexualized language or imagery | ||
| * Personal attacks | ||
| * Trolling or insulting/derogatory comments | ||
| * Public or private harassment | ||
| * Publishing other's private information, such as physical or electronic addresses, without explicit permission | ||
| * Other unethical or unprofessional conduct | ||
|
|
||
| Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team. | ||
|
|
||
| This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. | ||
|
|
||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers. | ||
|
|
||
| This Code of Conduct is adapted from the Contributor Covenant , version 1.2.0, available at https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html | ||
|
|
||
| [homepage]: https://contributor-covenant.org | ||
| [version]: https://contributor-covenant.org/version/1/2/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,29 @@ | ||
| MIT License | ||
| BSD 3-Clause License | ||
|
|
||
| Copyright (c) 2022 Alberto Mercurio | ||
| Copyright (c) 2022 to 2024 inclusive, QuTiP developers and contributors. | ||
| All rights reserved. | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| Redistribution and use in source and binary forms, with or without modification, | ||
| are permitted provided that the following conditions are met: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| 1. Redistributions of source code must retain the above copyright notice, this | ||
| list of conditions and the following disclaimer. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| 2. Redistributions in binary form must reproduce the above copyright notice, | ||
| this list of conditions and the following disclaimer in the documentation | ||
| and/or other materials provided with the distribution. | ||
|
|
||
| 3. Neither the name of the copyright holder nor the names of its contributors | ||
| may be used to endorse or promote products derived from this software without | ||
| specific prior written permission. | ||
|
|
||
| THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
| ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
| WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
| DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR | ||
| ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
| (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
| LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | ||
| ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
| SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,126 @@ | ||
| <!-- Logo --> | ||
| <div align="center"> | ||
| <img src="./docs/src/assets/logo.png" alt="QuantumToolbox.jl logo" width="150"> | ||
| </div> | ||
|
|
||
| # QuantumToolbox.jl | ||
|
|
||
| [](https://github.com/albertomercurio/QuantumToolbox.jl/releases) | ||
| [](https://doi.org/10.5281/zenodo.11096277) | ||
| [](https://juliapkgstats.com/pkg/QuantumToolbox) | ||
| [](https://github.com/albertomercurio/QuantumToolbox.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
| <!-- Current admin team (in chronological order) --> | ||
| [A. Mercurio](https://github.com/albertomercurio), | ||
| [L. Gravina](https://github.com/lgravina1997), | ||
| and [Y.-T. Huang](https://github.com/ytdHuang). | ||
|
|
||
| <!-- Badges --> | ||
| [](https://github.com/qutip/QuantumToolbox.jl/releases) | ||
| [](https://opensource.org/licenses/BSD-3-Clause) | ||
| [](https://doi.org/10.5281/zenodo.10822816) | ||
| [](https://juliapkgstats.com/pkg/QuantumToolbox) | ||
| [](https://github.com/qutip/QuantumToolbox.jl/actions/workflows/CI.yml?query=branch%3Amain) | ||
| [](https://github.com/JuliaTesting/Aqua.jl) | ||
| [](https://codecov.io/gh/albertomercurio/QuantumToolbox.jl) | ||
| [](https://albertomercurio.github.io/QuantumToolbox.jl/stable) | ||
| [](https://albertomercurio.github.io/QuantumToolbox.jl/dev) | ||
| [](https://codecov.io/gh/qutip/QuantumToolbox.jl) | ||
| [](https://qutip.github.io/QuantumToolbox.jl/stable) | ||
| [](https://qutip.github.io/QuantumToolbox.jl/dev) | ||
|
|
||
| ## Introduction | ||
|
|
||
| [QuantumToolbox.jl](https://github.com/albertomercurio/QuantumToolbox.jl) is a cutting-edge Julia package designed for quantum physics simulations, closely emulating the popular Python [QuTiP](https://github.com/qutip/qutip) package. It uniquely combines the simplicity and power of Julia with advanced features like GPU acceleration and distributed computing, making simulation of quantum systems more accessible and efficient. | ||
| [QuantumToolbox.jl](https://github.com/qutip/QuantumToolbox.jl) is a cutting-edge Julia package designed for quantum physics simulations, closely emulating the popular Python [QuTiP](https://github.com/qutip/qutip) package. It uniquely combines the simplicity and power of Julia with advanced features like GPU acceleration and distributed computing, making simulation of quantum systems more accessible and efficient. | ||
|
|
||
| *With this package, moving from Python to Julia for quantum physics simulations has never been easier*, due to the similar syntax and functionalities. | ||
|
|
||
| ## Features | ||
|
|
||
| QuantumToolbox.jl is equipped with a robust set of features: | ||
|
|
||
| - **Quantum State and Operator Manipulation:** Easily handle quantum states and operators with a rich set of tools. | ||
| - **Dynamical Evolution:** Advanced solvers for time evolution of quantum systems. | ||
| - **Measurement and Statistics:** Comprehensive quantum measurement simulation and analysis. | ||
| - **GPU and Distributed Computing:** Leverage GPU and distributed resources for high-performance computing. | ||
| - **Quantum State and Operator Manipulation:** Easily handle quantum states and operators with a rich set of tools, with the same functionalities as QuTiP. | ||
| - **Dynamical Evolution:** Advanced solvers for time evolution of quantum systems, thanks to the powerful [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl) package. | ||
| - **GPU Computing:** Leverage GPU resources for high-performance computing. For example, you run the master equation direclty on the GPU with the same syntax as the CPU case. | ||
| - **Distributed Computing:** Distribute the computation over multiple nodes (e.g., a cluster). For example, you can run undreds of quantum trajectories in parallel on a cluster, with, again, the same syntax as the simple case. | ||
| - **Easy Extension:** Easily extend the package, taking advantage of the Julia language features, like multiple dispatch and metaprogramming. | ||
|
|
||
| ## Installation | ||
| ## Brief example | ||
|
|
||
| We now provide a brief example to demonstrate the similarity between [QuantumToolbox.jl](https://github.com/qutip/QuantumToolbox.jl) and [QuTiP](https://github.com/qutip/qutip). | ||
|
|
||
| Let's consider a quantum harmonic oscillator with a Hamiltonian given by: | ||
|
|
||
| $$ | ||
| \hat{H} = \omega \hat{a}^\dagger \hat{a} | ||
| $$ | ||
|
|
||
| where $\hat{a}$ and $\hat{a}^\dagger$ are the annihilation and creation operators, respectively. We can define the Hamiltonian as follows: | ||
|
|
||
| ```julia | ||
| using QuantumToolbox | ||
|
|
||
| N = 20 # cutoff of the Hilbert space dimension | ||
| ω = 1.0 # frequency of the harmonic oscillator | ||
|
|
||
| a = destroy(N) # annohilation operator | ||
|
|
||
| H = ω * a' * a | ||
| ``` | ||
|
|
||
| We now introduce some losses in a thermal environment, described by the Lindblad master equation: | ||
|
|
||
| $$ | ||
| \frac{d \hat{\rho}}{dt} = -i [\hat{H}, \hat{\rho}] + \gamma \mathcal{D}[\hat{a}] \hat{\rho} | ||
| $$ | ||
|
|
||
| where $\hat{\rho}$ is the density matrix, $\gamma$ is the damping rate, and $\mathcal{D}[\hat{a}]$ is the Lindblad dissipator, defined as: | ||
|
|
||
| $$ | ||
| \mathcal{D}[\hat{a}]\hat{\rho} = \hat{a}\hat{\rho}\hat{a}^\dagger - \frac{1}{2}\hat{a}^\dagger\hat{a}\hat{\rho} - \frac{1}{2}\hat{\rho}\hat{a}^\dagger\hat{a} | ||
| $$ | ||
|
|
||
| We now compute the time evolution of the system using the [`mesolve`](@ref) function, starting from the initial state $\ket{\psi (0)} = \ket{3}$: | ||
|
|
||
| ```julia | ||
| γ = 0.1 # damping rate | ||
|
|
||
| ψ0 = fock(N, 3) # initial state | ||
|
|
||
| tlist = range(0, 10, 100) # time list | ||
|
|
||
| c_ops = [sqrt(γ) * a] | ||
| e_ops = [a' * a] | ||
|
|
||
| sol = mesolve(H, ψ0, tlist, c_ops, e_ops=e_ops) | ||
| ``` | ||
|
|
||
| We can extract the expectation value of the number operator $\hat{a}^\dagger \hat{a}$ with the command `sol.expect`, and the states with the command `sol.states`. | ||
|
|
||
| ### Passing in the GPU | ||
|
|
||
| We can easily pass the computation to the GPU, by simply passing all the `Qobj`s to the GPU: | ||
|
|
||
| ```julia | ||
| using CUDA | ||
|
|
||
| a_gpu = cu(destroy(N)) # The only difference in the code is the cu() function | ||
|
|
||
| H_gpu = ω * a_gpu' * a_gpu | ||
|
|
||
| ψ0_gpu = cu(fock(N, 3)) | ||
|
|
||
| c_ops = [sqrt(γ) * a_gpu] | ||
| e_ops = [a_gpu' * a_gpu] | ||
|
|
||
| sol = mesolve(H_gpi, ψ0_gpu, tlist, c_ops, e_ops=e_ops) | ||
| ``` | ||
|
|
||
| ## Installation | ||
| `QuantumToolbox.jl` requires `Julia 1.7+`. To install it, run the following commands inside Julia's interactive session (also known as REPL): | ||
| ```julia | ||
| using Pkg | ||
| Pkg.add("QuantumToolbox") | ||
| ``` | ||
| Alternatively, this can also be done in Julia's [Pkg REPL](https://julialang.github.io/Pkg.jl/v1/getting-started/) by pressing the key `]` in the REPL to use the package mode, and then type the following command: | ||
| ```julia-REPL | ||
| (1.7) pkg> add QuantumToolbox | ||
| ``` | ||
| To load the package and check the version information, use either `versioninfo()` or `about()`, namely | ||
| ```julia | ||
| using QuantumToolbox | ||
| QuantumToolbox.versioninfo() | ||
| QuantumToolbox.about() | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.