Skip to content

Commit 3cb064f

Browse files
committed
Add references
1 parent 6c7eec0 commit 3cb064f

File tree

7 files changed

+408
-3
lines changed

7 files changed

+408
-3
lines changed

docs/make.jl

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ using QuantumControl.Functionals
88
using QuantumControl.Generators
99
using Pkg
1010
using Documenter
11+
using QuantumCitations
1112

1213
DocMeta.setdocmeta!(QuantumControl, :DocTestSetup, :(using QuantumControl); recursive=true)
1314

@@ -21,13 +22,16 @@ println("Starting makedocs")
2122

2223
include("generate_api.jl")
2324

24-
makedocs(;
25+
bib = CitationBibliography(joinpath(@__DIR__, "src", "refs.bib"); style=:numeric)
26+
27+
makedocs(
28+
bib;
2529
authors=AUTHORS,
2630
sitename="QuantumControl.jl",
2731
format=Documenter.HTML(;
2832
prettyurls=true,
2933
canonical="https://juliaquantumcontrol.github.io/QuantumControl.jl",
30-
assets=["assets/custom.css"],
34+
assets=["assets/custom.css", "assets/citations.css"],
3135
footer="[$NAME.jl]($GITHUB) v$VERSION docs powered by [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)."
3236
),
3337
pages=[
@@ -47,6 +51,7 @@ makedocs(;
4751
],
4852
"Index" => "api/quantum_control_index.md",
4953
],
54+
"References" => "references.md",
5055
]
5156
)
5257

docs/src/assets/citations.css

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
.citation dl {
2+
display: grid;
3+
grid-template-columns: max-content auto; }
4+
.citation dt {
5+
grid-column-start: 1; }
6+
.citation dd {
7+
grid-column-start: 2;
8+
margin-bottom: 0.75em; }
9+
.citation ul {
10+
padding: 0 0 2.25em 0;
11+
margin: 0;
12+
list-style: none;}
13+
.citation ul li {
14+
text-indent: -2.25em;
15+
margin: 0.33em 0.5em 0.5em 2.25em;}
16+
.citation ol li {
17+
padding-left:0.75em;}

docs/src/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Markdown.parse("$github_badge $version_badge")
1515

1616
[QuantumControl.jl](https://github.com/JuliaQuantumControl/QuantumControl.jl) is a [Julia framework for quantum dynamics and control](https://github.com/JuliaQuantumControl).
1717

18-
[Quantum optimal control](https://link.springer.com/article/10.1140%2Fepjd%2Fe2015-60464-1) attempts to steer a quantum system in some desired way by finding optimal control parameters or control fields inside the system Hamiltonian or Liouvillian. Typical control tasks are the preparation of a specific quantum state or the realization of a logical gate in a quantum computer (["pulse level control"](https://arxiv.org/abs/2004.06755)). Thus, quantum control theory is a critical part of realizing quantum technologies at the lowest level. Numerical methods of *open-loop* quantum control (methods that do not involve measurement feedback from a physical quantum device) such as [Krotov's method](https://github.com/JuliaQuantumControl/Krotov.jl) and [GRAPE](https://github.com/JuliaQuantumControl/GRAPE.jl) address the control problem by [simulating the dynamics of the system](https://github.com/JuliaQuantumControl/QuantumPropagators.jl) and then iteratively improving the value of a functional that encodes the desired outcome.
18+
Quantum optimal control [BrumerShapiro2003](@cite)[BrifNJP2010](@cite)[Shapiro2012](@cite)[KochJPCM2016](@cite)[SolaAAMOP2018](@cite)[MorzhinRMS2019](@cite)[Wilhelm2003.10132](@cite)[KochEPJQT2022](@cite) attempts to steer a quantum system in some desired way by finding optimal control parameters or control fields inside the system Hamiltonian or Liouvillian. Typical control tasks are the preparation of a specific quantum state or the realization of a logical gate in a quantum computer (["pulse level control"](https://arxiv.org/abs/2004.06755)). Thus, quantum control theory is a critical part of realizing quantum technologies at the lowest level. Numerical methods of *open-loop* quantum control (methods that do not involve measurement feedback from a physical quantum device) such as [Krotov's method](https://github.com/JuliaQuantumControl/Krotov.jl) [Krotov1996](@cite)[SomloiCP1993](@cite)[BartanaJCP1997](@cite)[PalaoPRA2003](@cite)[ReichJCP2012](@cite)[GoerzSPP2019](@cite) and [GRAPE](https://github.com/JuliaQuantumControl/GRAPE.jl) [KhanejaJMR2005](@cite)[FouquieresJMR2011](@cite) address the control problem by [simulating the dynamics of the system](https://github.com/JuliaQuantumControl/QuantumPropagators.jl) and then iteratively improving the value of a functional that encodes the desired outcome.
1919

2020
The `QuantumControl.jl` package collects the [packages](https://github.com/JuliaQuantumControl#packages) in the [JuliaQuantumControl](https://github.com/JuliaQuantumControl) organization and provides a single coherent [API](@ref QuantumControlAPI) for solving the quantum control problem.
2121

docs/src/references.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# References
2+
3+
```@bibliography
4+
```

0 commit comments

Comments
 (0)