|
1 |
| -# OSQATTutorials.jl |
2 |
| -Tutorials for open system quantum annealing toolbox(OSQAT). This repo is inspired by [SciMLTutorials](https://github.com/SciML/SciMLTutorials.jl) so the workflow is the same. Because currently `OSQAT` and `OSQATTutorials.jl` are not officially registered, you need manually install these packages. |
| 1 | +# HOQSTTutorials.jl |
| 2 | +Tutorials for Hamiltonian Open Quantum System Toolkit(HOQST). This repo is inspired by [SciMLTutorials](https://github.com/SciML/SciMLTutorials.jl) so the workflow is the same. Because currently `HOQST` and `HOQSTTutorials.jl` are not officially registered, you need to manually install these packages. |
3 | 3 |
|
4 | 4 | ## Table of Contents
|
5 | 5 |
|
6 | 6 | - Introduction
|
7 |
| - - [Introduction to OSQAT through closed-system simulation](https://uscqserver.github.io/OSQATTutorials.jl/html/introduction/01-closed_system.html) |
8 |
| - - [Introduction to OSQAT through adiabatic master equation](https://uscqserver.github.io/OSQATTutorials.jl/html/introduction/02-single_qubit_ame.html) |
9 |
| - - [Redfield equation with multi-axis noise](https://uscqserver.github.io/OSQATTutorials.jl/html/introduction/03-redfield_multi_axis_noise.html) |
10 |
| - - [Spin-fluctuator model](https://uscqserver.github.io/OSQATTutorials.jl/html/introduction/04-spin_fluctuators.html) |
11 |
| - - [AME Spin-fluctuator model](https://uscqserver.github.io/OSQATTutorials.jl/html/introduction/05-ame_spin_fluctuators.html) |
| 7 | + - [Introduction to HOQST through closed-system simulation](https://uscqserver.github.io/HOQSTTutorials.jl/html/introduction/01-closed_system.html) |
| 8 | + - [Introduction to HOQST through adiabatic master equation](https://uscqserver.github.io/HOQSTTutorials.jl/html/introduction/02-single_qubit_ame.html) |
| 9 | + - [Redfield equation with multi-axis noise](https://uscqserver.github.io/HOQSTTutorials.jl/html/introduction/03-redfield_multi_axis_noise.html) |
| 10 | + - [Spin-fluctuator model](https://uscqserver.github.io/HOQSTTutorials.jl/html/introduction/04-spin_fluctuators.html) |
| 11 | + - [AME Spin-fluctuator model](https://uscqserver.github.io/HOQSTTutorials.jl/html/introduction/05-ame_spin_fluctuators.html) |
12 | 12 | - Hamiltonian
|
13 |
| - - [Custom eigendecomposition function](https://uscqserver.github.io/OSQATTutorials.jl/html/hamiltonian/01-custom-eigen.html) |
| 13 | + - [Custom eigendecomposition function](https://uscqserver.github.io/HOQSTTutorials.jl/html/hamiltonian/01-custom-eigen.html) |
14 | 14 | - Redfield
|
15 |
| - - [Non-positivity in Redfield equation](https://uscqserver.github.io/OSQATTutorials.jl/html/redfield/01-non_positivity_redfield.html) |
16 |
| - - [Introduction to polaron transformed Redfield equation](https://uscqserver.github.io/OSQATTutorials.jl/html/redfield/02-polaron-transformed-redfield.html) |
17 |
| - - [Introduction to CGME and ULE](https://uscqserver.github.io/OSQATTutorials.jl/html/redfield/03-CGME_ULE.html) |
| 15 | + - [Non-positivity in Redfield equation](https://uscqserver.github.io/HOQSTTutorials.jl/html/redfield/01-non_positivity_redfield.html) |
| 16 | + - [Introduction to polaron transformed Redfield equation](https://uscqserver.github.io/HOQSTTutorials.jl/html/redfield/02-polaron-transformed-redfield.html) |
| 17 | + - [Introduction to CGME and ULE](https://uscqserver.github.io/HOQSTTutorials.jl/html/redfield/03-CGME_ULE.html) |
18 | 18 |
|
19 | 19 | ## Contributing
|
20 | 20 |
|
21 |
| -First of all, make sure that your current directory is `OSQATTutorials`. All |
| 21 | +First of all, make sure that your current directory is `HOQSTTutorials`. All |
22 | 22 | of the files are generated from the Weave.jl files in the `tutorials` folder.
|
23 | 23 | To run the generation process, do for example:
|
24 | 24 |
|
25 | 25 | ```julia
|
26 |
| -using Pkg, OSQATTutorials |
27 |
| -cd(joinpath(dirname(pathof(OSQATTutorials)), "..")) |
| 26 | +using Pkg, HOQSTTutorials |
| 27 | +cd(joinpath(dirname(pathof(HOQSTTutorials)), "..")) |
28 | 28 | Pkg.pkg"activate ."
|
29 | 29 | Pkg.pkg"instantiate"
|
30 |
| -OSQATTutorials.weave_file("introduction","01-closed_system.jmd") |
| 30 | +HOQSTTutorials.weave_file("introduction","01-closed_system.jmd") |
31 | 31 | ```
|
32 | 32 |
|
33 | 33 | To generate all of the notebooks, do:
|
34 | 34 |
|
35 | 35 | ```julia
|
36 |
| -OSQATTutorials.weave_all() |
| 36 | +HOQSTTutorials.weave_all() |
37 | 37 | ```
|
38 | 38 |
|
39 | 39 | If you add new tutorials which require new packages, simply updating your local
|
|
0 commit comments