Skip to content

Commit 6eb9761

Browse files
gefuxgefux
authored
Update Documentation (#135)
* Update Authors and References * Fix documentation * Remove unecessary copyright statements
1 parent 7a49701 commit 6eb9761

File tree

110 files changed

+3484
-1372
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+3484
-1372
lines changed

‎.github/workflows/python-package-tests.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: tests
22

3-
on: [push, workflow_dispatch]
3+
on: [push, pull_request, workflow_dispatch]
44

55
jobs:
66
tests:

‎.readthedocs.yaml‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,35 @@
1-
# File: .readthedocs.yaml
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
23

4+
# Required
35
version: 2
46

7+
# Set the OS, Python version and other tools you might need
8+
build:
9+
os: ubuntu-22.04
10+
tools:
11+
python: "3.10"
12+
# You can also specify other tool versions:
13+
# nodejs: "20"
14+
# rust: "1.70"
15+
# golang: "1.20"
16+
17+
# Build documentation in the "docs/" directory with Sphinx
518
sphinx:
619
configuration: docs/conf.py
20+
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21+
# builder: "dirhtml"
22+
# Fail on all warnings to avoid broken references
23+
# fail_on_warning: true
24+
25+
# Optionally build your docs in additional formats such as PDF and ePub
26+
# formats:
27+
# - pdf
28+
# - epub
729

30+
# Optional but recommended, declare the Python requirements required
31+
# to build your documentation
32+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
833
python:
9-
version: 3.10
1034
install:
11-
- requirements: requirements_ci.txt
35+
- requirements: docs/requirements.txt

‎AUTHORS.md‎

Lines changed: 24 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,34 @@
11
Authors & Acknowledgements
22
==========================
33

4-
Lead developer since 2020 (start of the project): [Gerald E. Fux](https://github.com/gefux)
4+
- Lead developer since 2020: [**Gerald E. Fux**](https://github.com/gefux) (<[email protected]>)
5+
- Co-lead developer since 2022: [**Piper Fowler-Wright**](https://github.com/piperfw) (<[email protected]>)
56

67
Major code contributions
78
------------------------
89

10+
**Version 0.5.0**
11+
- [Aidan Strathearn](https://github.com/aidanstrathearn): Gibbs state TEMPO [Chiu2022].
12+
- [Eoin P. Butler](https://github.com/ebutler414), [Eoin O'Neill](https://github.com/eoin-dp-oneill), and [Paul R. Eastham](https://github.com/paulreastham): Process tensor gradients and optimization [Fux2021, Butler2024]
13+
- [Ewen D.C. Lawrence](https://github.com/ewenlawrence) and [Peter Kirton](https://github.com/peterkirton/): Degeneracy trick in TEMPO and PT-TEMPO.
14+
- [Roosmarijn de Wit](https://github.com/rmadw): Multi-time system correlations.
15+
- [Piper Fowler-Wright](https://github.com/piperfw): TEMPO parameter tutorial and automatic estimation.
16+
917
**Version 0.4.0**
10-
- [Joel Beckles](https://github.com/JoelANB) and [Piper Fowler-Wright](https://github.com/piperfw): Extension of mean-field evolution to multiple types of system
18+
- [Joel Beckles](https://github.com/JoelANB) and [Piper Fowler-Wright](https://github.com/piperfw): Extension of mean-field evolution to multiple types of system.
1119

1220
**Version 0.3.0**
13-
- [Piper Fowler-Wright](https://github.com/piperfw): Open quantum systems with mean-field evolution [FowlerWright2022]
21+
- [Piper Fowler-Wright](https://github.com/piperfw): Open quantum systems with mean-field evolution [FowlerWright2022].
1422

1523
**Version 0.2.0**
16-
- [Gerald E. Fux](https://github.com/gefux): Chains of open quantum systems [Fux2022].
17-
- Dainius Kilda: Precursor code for chains of open quantum systems [Fux2022].
18-
- [Dominic Gribben](https://github.com/djgribben): Bath dynamics extension [Gribben2021].
19-
- [Dominic Gribben](https://github.com/djgribben): Multiple environments extension [Gribben2022].
24+
- [Gerald E. Fux](https://github.com/gefux): Chains of open quantum systems [Fux2023].
25+
- Dainius Kilda: Precursor code for chains of open quantum systems [Fux2023].
26+
- [Dominic Gribben](https://github.com/djgribben): Bath dynamics extension [Gribben2022b].
27+
- [Dominic Gribben](https://github.com/djgribben): Multiple environments extension [Gribben2022a].
2028

2129
**Version 0.1.2 (TimeEvolvingMPO)**
2230
- [Gerald E. Fux](https://github.com/gefux): Improved memory cut-off [Strathearn2017].
2331

24-
**Version 0.1.1 (TimeEvolvingMPO)**
25-
- No major code contributions in this version.
26-
2732
**Version 0.1.0 (TimeEvolvingMPO)**
2833
- [Gerald E. Fux](https://github.com/gefux): Implement process tensor TEMPO (API and backend) [Fux2021].
2934
- [Gerald E. Fux](https://github.com/gefux): Implement core TEMPO functionality (API and backend) [Strathearn2018].
@@ -33,24 +38,12 @@ Major code contributions
3338
Acknowledgements
3439
----------------
3540

36-
**Members of the TEMPO collaboration:**
37-
- Kristín Arnardóttir (*University of St Andrews*) <[email protected]>
38-
- [Piper Fowler-Wright](https://github.com/piperfw) (*University of St Andrews*) <[email protected]>
39-
- [Gerald E. Fux](https://github.com/gefux) (*University of St Andrews*) <[email protected]>
40-
- [Erik Gauger](https://github.com/erikgauger) (*Heriot-Watt University*) <[email protected]>
41-
- [Dominic Gribben](https://github.com/djgribben) (*University of St Andrews*)
42-
- Jonathan Keeling (*University of St Andrews*) <[email protected]>
43-
- Dainius Kilda (*Max Planck Institute of Quantum Optics*)
44-
- [Peter Kirton](https://github.com/peterkirton) (*University of Strathclyde*) <[email protected]>
45-
- [Thibaut Lacroix](https://github.com/tfmlaX) (*University of St Andrews*) <[email protected]>
46-
- Brendon W. Lovett (*University of St Andrews*) <[email protected]>
47-
48-
**Project administrators:**
49-
- [Gerald E. Fux](https://github.com/gefux) (<[email protected]>)
50-
- Jonathan Keeling (<[email protected]>)
51-
- Brendon W. Lovett (<[email protected]>)
52-
53-
54-
**Project maintainers:**
55-
- [Piper Fowler-Wright](https://github.com/piperfw) (<[email protected]>)
56-
- [Gerald E. Fux](https://github.com/gefux) (<[email protected]>)
41+
**Scientific advisors:**
42+
- Jonathan Keeling (*University of St Andrews*)
43+
- Brendon W. Lovett (*University of St Andrews*)
44+
45+
**Other Collaborators:**
46+
- Kristín Arnardóttir (*University of Southern Denmark*)
47+
- [Erik Gauger](https://github.com/erikgauger) (*Heriot-Watt University*)
48+
- [Thibaut Lacroix](https://github.com/tfmlaX) (*University of St Andrews*)
49+

‎BIBLIOGRAPHY.md‎

Lines changed: 72 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,55 @@ Bibliography
33

44
The code in this project is based on ideas from the following publications:
55

6-
- **[Strathearn2017]** Strathearn et al., *Efficient real-time path integrals for non-Markovian spin-boson models*. [New J. Phys. 19(9), p.093009](http://dx.doi.org/10.1088/1367-2630/aa8744) (2017).
6+
- **[Strathearn2017]** Strathearn et al., *Efficient real-time path integrals for non-Markovian spin-boson models*. [New J. Phys. 19(9), p.093009](https://doi.org/10.1088/1367-2630/aa8744) (2017).
77
- **[Strathearn2018]** Strathearn et al., *Efficient non-Markovian quantum dynamics using time-evolving matrix product operators*, [Nat. Commun. 9, 3322](https://doi.org/10.1038/s41467-018-05617-3)
88
(2018).
9-
- **[Pollock2018]** Pollock et al., *Non-Markovian quantum processes: Complete framework and efficient characterization*, [Phys. Rev. A 97, 012127](http://dx.doi.org/10.1103/PhysRevA.97.012127) (2018).
10-
- **[Jorgensen2019]** Jørgensen and Pollock, *Exploiting the causal tensor network structure of quantum processes to efficiently simulate non-Markovian path integrals*, [Phys. Rev. Lett. 123, 240602](http://dx.doi.org/10.1103/PhysRevLett.123.240602) (2019).
11-
- **[Strathearn2019]** Strathearn, *Modelling Non-Markovian Quantum Systems Using Tensor Networks*, [Springer Theses](http://link.springer.com/10.1007/978-3-030-54975-6) (2020).
12-
- **[Fux2020]** Fux et al., *Efficient exploration of Hamiltonian parameter space for optimal control of non-Markovian open quantum systems*, [Phys. Rev. Lett. 126, 200401](https://link.aps.org/doi/10.1103/PhysRevLett.126.200401) (2021).
13-
- **[Gribben2021]** Gribben et al., *Using the Environment to Understand non-Markovian Open Quantum Systems*, [arXiv:20106.0412](http://arxiv.org/abs/2106.04212) (2021).
14-
- **[Gribben2022]** Gribben et al., *Exact dynamics of non-additive environments in non-Markovian open quantum systems*, [PRX Quantum 3, 10321](https://link.aps.org/doi/10.1103/PRXQuantum.3.010321) (2021).
9+
- **[Pollock2018]** Pollock et al., *Non-Markovian quantum processes: Complete framework and efficient characterization*, [Phys. Rev. A 97, 012127](https://doi.org/10.1103/PhysRevA.97.012127) (2018).
10+
- **[Jorgensen2019]** Jørgensen and Pollock, *Exploiting the causal tensor network structure of quantum processes to efficiently simulate non-Markovian path integrals*, [Phys. Rev. Lett. 123, 240602](https://doi.org/10.1103/PhysRevLett.123.240602) (2019).
11+
- **[Strathearn2019]** Strathearn, *Modelling Non-Markovian Quantum Systems Using Tensor Networks*, [Springer Theses](https://doi.org/10.1007/978-3-030-54975-6) (2020).
12+
- **[Fux2021]** Fux et al., *Efficient exploration of Hamiltonian parameter space for optimal control of non-Markovian open quantum systems*, [Phys. Rev. Lett. 126, 200401](https://doi.org/10.1103/PhysRevLett.126.200401) (2021).
13+
- **[Gribben2022a]** Gribben et al., *Exact dynamics of non-additive environments in non-Markovian open quantum systems*, [PRX Quantum 3, 10321](https://doi.org/10.1103/PRXQuantum.3.010321) (2022).
14+
- **[Gribben2022b]** Gribben et al., *Using the Environment to Understand non-Markovian Open Quantum Systems*, [Quantum, 6, 847](https://doi.org/10.22331/q-2022-10-25-847) (2022).
15+
- **[Chiu2022]** Chiu et al., *Numerical evaluation and robustness of the quantum mean-force Gibbs state*, [Phys. Rev. A 106, 012204](https://doi.org/10.1103/PhysRevA.106.012204}) (2022).
1516
- **[FowlerWright2022]** Fowler-Wright et al., *Efficient Many-Body Non-Markovian Dynamics of Organic Polaritons*, [Phys. Rev. Lett. 129, 173001](https://doi.org/10.1103/PhysRevLett.129.173001) (2022).
16-
- **[Fux2022]** Fux et al., *Thermalization of a spin chain strongly coupled to its environment*, [arXiv:2201.05529](http://arxiv.org/abs/2201.05529) (2022).
17+
- **[Fux2023]** Fux et al., *Tensor network simulation of chains of non-Markovian open quantum systems*, [Phys. Rev. Research 5, 033078 ](https://doi.org/10.1103/PhysRevResearch.5.033078}) (2023).
18+
- **[Butler2024]** Butler et al., *Optimizing Performance of Quantum Operations with Non-Markovian Decoherence: The Tortoise or the Hare?*, [Phys. Rev. Lett. 132, 060401 ](https://doi.org/10.1103/PhysRevLett.132.060401}) (2024).
1719

1820

1921
BibTeX:
2022
-------
2123

22-
2324
```
25+
@article{Butler2024,
26+
title = {Optimizing Performance of Quantum Operations with Non-Markovian Decoherence: The Tortoise or the Hare?},
27+
author = {Butler, Eoin P. and Fux, Gerald E. and Ortega-Taberner, Carlos and Lovett, Brendon W. and Keeling, Jonathan and Eastham, Paul R.},
28+
journal = {Phys. Rev. Lett.},
29+
volume = {132},
30+
issue = {6},
31+
pages = {060401},
32+
numpages = {7},
33+
year = {2024},
34+
month = {Feb},
35+
publisher = {American Physical Society},
36+
doi = {10.1103/PhysRevLett.132.060401},
37+
url = {https://doi.org/10.1103/PhysRevLett.132.060401}
38+
}
39+
40+
@article{Chiu2022,
41+
title = {Numerical evaluation and robustness of the quantum mean-force Gibbs state},
42+
author = {Chiu, Yiu-Fung and Strathearn, Aidan and Keeling, Jonathan},
43+
journal = {Phys. Rev. A},
44+
volume = {106},
45+
issue = {1},
46+
pages = {012204},
47+
numpages = {8},
48+
year = {2022},
49+
month = {Jul},
50+
publisher = {American Physical Society},
51+
doi = {10.1103/PhysRevA.106.012204},
52+
url = {https://doi.org/10.1103/PhysRevA.106.012204}
53+
}
54+
2455
@article{FowlerWright2022,
2556
title = {Efficient Many-Body Non-Markovian Dynamics of Organic Polaritons},
2657
author = {Fowler-Wright, Piper and Lovett, Brendon W. and Keeling, Jonathan},
@@ -48,30 +79,25 @@ BibTeX:
4879
month = {May},
4980
publisher = {American Physical Society},
5081
doi = {10.1103/PhysRevLett.126.200401},
51-
url = {https://link.aps.org/doi/10.1103/PhysRevLett.126.200401}
82+
url = {https://doi.org/10.1103/PhysRevLett.126.200401}
5283
}
5384
54-
@article{Fux2022,
55-
title = {{Thermalization of a spin chain strongly coupled to its environment}},
85+
@article{Fux2023,
86+
title = {Tensor network simulation of chains of non-Markovian open quantum systems},
5687
author = {Fux, Gerald E. and Kilda, Dainius and Lovett, Brendon W. and Keeling, Jonathan},
57-
archivePrefix = {arXiv},
58-
arxivId = {2201.05529},
59-
eprint = {2201.05529},
60-
url = {http://arxiv.org/abs/2201.05529},
61-
year = {2022}
62-
}
63-
64-
@article{Gribben2021,
65-
title = {{Using the Environment to Understand non-Markovian Open Quantum Systems}},
66-
author = {Gribben, Dominic and Strathearn, Aidan and Fux, Gerald E. and Kirton, Peter and Lovett, Brendon W.},
67-
archivePrefix = {arXiv},
68-
arxivId = {2106.04212},
69-
eprint = {2106.04212},
70-
url = {http://arxiv.org/abs/2106.04212},
71-
year = {2021}
88+
journal = {Phys. Rev. Res.},
89+
volume = {5},
90+
issue = {3},
91+
pages = {033078},
92+
numpages = {14},
93+
year = {2023},
94+
month = {Aug},
95+
publisher = {American Physical Society},
96+
doi = {10.1103/PhysRevResearch.5.033078},
97+
url = {https://doi.org/10.1103/PhysRevResearch.5.033078}
7298
}
7399
74-
@article{Gribben2022,
100+
@article{Gribben2022a,
75101
title = {Exact Dynamics of Nonadditive Environments in Non-Markovian Open Quantum Systems},
76102
author = {Gribben, Dominic and Rouse, Dominic M. and Iles-Smith, Jake and Strathearn, Aidan and Maguire, Henry and Kirton, Peter and Nazir, Ahsan and Gauger, Erik M. and Lovett, Brendon W.},
77103
journal = {PRX Quantum},
@@ -83,7 +109,21 @@ BibTeX:
83109
month = {Feb},
84110
publisher = {American Physical Society},
85111
doi = {10.1103/PRXQuantum.3.010321},
86-
url = {https://link.aps.org/doi/10.1103/PRXQuantum.3.010321}
112+
url = {https://doi.org/10.1103/PRXQuantum.3.010321}
113+
}
114+
115+
@article{Gribben2022b,
116+
doi = {10.22331/q-2022-10-25-847},
117+
url = {https://doi.org/10.22331/q-2022-10-25-847},
118+
title = {Using the {E}nvironment to {U}nderstand non-{M}arkovian {O}pen {Q}uantum {S}ystems},
119+
author = {Gribben, Dominic and Strathearn, Aidan and Fux, Gerald E. and Kirton, Peter and Lovett, Brendon W.},
120+
journal = {{Quantum}},
121+
issn = {2521-327X},
122+
publisher = {{Verein zur F{\"{o}}rderung des Open Access Publizierens in den Quantenwissenschaften}},
123+
volume = {6},
124+
pages = {847},
125+
month = oct,
126+
year = {2022}
87127
}
88128
89129
@article{Jorgensen2019,
@@ -99,7 +139,7 @@ BibTeX:
99139
month = {Dec},
100140
publisher = {American Physical Society},
101141
doi = {10.1103/PhysRevLett.123.240602},
102-
url = {https://link.aps.org/doi/10.1103/PhysRevLett.123.240602}
142+
url = {https://doi.org/10.1103/PhysRevLett.123.240602}
103143
}
104144
105145
@misc{OQuPy,
@@ -123,9 +163,7 @@ BibTeX:
123163
pages = {012127},
124164
title = {{Non-Markovian quantum processes: Complete framework and
125165
efficient characterization}},
126-
url = {https://link.aps.org/doi/10.1103/PhysRevA.97.012127
127-
http://arxiv.org/abs/1512.00589
128-
http://dx.doi.org/10.1103/PhysRevA.97.012127},
166+
url = {https://doi.org/10.1103/PhysRevA.97.012127},
129167
volume = {97},
130168
year = {2018}
131169
}
@@ -169,7 +207,7 @@ BibTeX:
169207
publisher = {Springer International Publishing},
170208
series = {Springer Theses},
171209
title = {{Modelling Non-Markovian Quantum Systems Using Tensor Networks}},
172-
url = {http://link.springer.com/10.1007/978-3-030-54975-6},
210+
url = {https://doi.org/10.1007/978-3-030-54975-6},
173211
year = {2020}
174212
}
175213

‎HOW_TO_CITE.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,21 @@ How to Cite this Project
55
Citing the Code
66
---------------
77

8-
- **[OQuPy]** The TEMPO collaboration, *OQuPy: A Python 3 package to efficiently compute non-Markovianopen quantum systems*, [GitHub](https://doi.org/10.5281/zenodo.4428316) (2020).
8+
- **[OQuPy]** The TEMPO collaboration, *OQuPy: A Python 3 package to efficiently compute non-Markovian open quantum systems*, [GitHub](https://doi.org/10.5281/zenodo.4428316) (2020).
99

1010

1111
Please consider citing
1212
----------------------
1313

1414
- TEMPO algorithm: **[Strathearn2018]**, **[Strathearn2019]**
15-
- Process tensor approach: **[Pollock2018]**, **[Jorgensen2019]**, **[Fux2021]**
16-
- Bath dynamics: **[Gribben2021]**
17-
- Multiple environments: **[Gribben2022]**
18-
- Chains (PT-TEBD): **[Fux2022]**
15+
- Process tensor approach: **[Pollock2018]**, **[Jorgensen2019]**
16+
- Optimization: **[Fux2021]**, **[Bulter2024]**
17+
- Multiple environments: **[Gribben2022a]**
18+
- Bath dynamics: **[Gribben2022b]**
19+
- Chains (PT-TEBD): **[Fux2023]**
1920
- Mean-Field TEMPO: **[FowlerWright2022]**
21+
- Gibbs TEMPO: **[Chiu2022]**
22+
2023

2124
BibTeX
2225
------

0 commit comments

Comments
 (0)