Skip to content

Commit dd7813c

Browse files
authored
Name change (#7)
* Change OSQAT to HOQST in README * Modify some comments in HOSQATTutorials.jl * Update the closed-system introduction * Rebuild introduction-02 * Clean up folders
1 parent ad5f0f9 commit dd7813c

29 files changed

+411
-768
lines changed

Project.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
name = "OSQATTutorials"
1+
name = "HOQSTTutorials"
22
uuid = "355a68e2-8a29-4473-87d2-0bdae3433bdb"
33
authors = ["Huo Chen <[email protected]>"]
4-
version = "0.1.0"
4+
version = "0.2.0"
55

66
[deps]
77
Arpack = "7d9fca2a-8960-54d3-9f78-7d1dccf2cb97"

README.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
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.
33

44
## Table of Contents
55

66
- 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)
1212
- 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)
1414
- 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)
1818

1919
## Contributing
2020

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
2222
of the files are generated from the Weave.jl files in the `tutorials` folder.
2323
To run the generation process, do for example:
2424

2525
```julia
26-
using Pkg, OSQATTutorials
27-
cd(joinpath(dirname(pathof(OSQATTutorials)), ".."))
26+
using Pkg, HOQSTTutorials
27+
cd(joinpath(dirname(pathof(HOQSTTutorials)), ".."))
2828
Pkg.pkg"activate ."
2929
Pkg.pkg"instantiate"
30-
OSQATTutorials.weave_file("introduction","01-closed_system.jmd")
30+
HOQSTTutorials.weave_file("introduction","01-closed_system.jmd")
3131
```
3232

3333
To generate all of the notebooks, do:
3434

3535
```julia
36-
OSQATTutorials.weave_all()
36+
HOQSTTutorials.weave_all()
3737
```
3838

3939
If you add new tutorials which require new packages, simply updating your local

html/introduction/01-closed_system.html

+62-189
Large diffs are not rendered by default.

html/introduction/02-single_qubit_ame.html

+46-100
Large diffs are not rendered by default.

html/redfield/02-polaron-transformed-redfield.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@ <h5>Huo Chen</h5>
663663
</div>
664664

665665
<h2>Correlation function in polaron frame</h2>
666-
<p>This is an tutorial for using polaron transformed Redfield equation &#40;PTRE&#41; in OSQAT. For more details on PTRE, <a href="https://link.springer.com/article/10.1007&#37;2Fs11467-016-0540-2">Xu and Cao</a> is a good reference.</p>
666+
<p>This is an tutorial for using polaron transformed Redfield equation &#40;PTRE&#41; in HOQST. For more details on PTRE, <a href="https://link.springer.com/article/10.1007&#37;2Fs11467-016-0540-2">Xu and Cao</a> is a good reference.</p>
667667
<p>In this example, we solve both Redfield equation and PTRE for a single qubit model with system Hamiltonian</p>
668668
<p class="math">\[
669669
H_\mathrm{S}=\epsilon \sigma_z + \Delta \sigma_x

0 commit comments

Comments
 (0)