Use DocumenterCitations for adding references

Author: lkdvos

docs/Project.toml

@@ -1,5 +1,6 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 KrylovKit = "0b1a1467-8014-51b9-945f-bf0ae24f4b77"
 MPSKit = "bb1c41ca-d63c-52ed-829e-0820dda26502"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"

docs/make.jl

@@ -9,7 +9,9 @@ end
 
 using MPSKit
 using Documenter
+using DocumenterCitations
 
+# examples
 example_dir = joinpath(@__DIR__, "src", "examples")
 classic_pages = map(readdir(joinpath(example_dir, "classic2d"))) do dir
     return joinpath("examples", "classic2d", dir, "index.md")
@@ -18,6 +20,10 @@ quantum_pages = map(readdir(joinpath(example_dir, "quantum1d"))) do dir
     return joinpath("examples", "quantum1d", dir, "index.md")
 end
 
+# bibliography
+bibpath = joinpath(@__DIR__, "src", "assets", "mpskit.bib")
+bib = CitationBibliography(bibpath; style=:authoryear)
+
 # include MPSKit in all doctests
 DocMeta.setdocmeta!(MPSKit, :DocTestSetup, :(using MPSKit, TensorKit); recursive=true)
 
@@ -41,7 +47,9 @@ makedocs(;
                              "man/parallelism.md",
                              "man/lattices.md"],
                 "Examples" => "examples/index.md",
-                "Library" => "lib/lib.md"],
-         warnonly=true)
+                "Library" => "lib/lib.md",
+                "References" => "references.md"],
+         warnonly=true,
+         plugins=[bib])
 
 deploydocs(; repo="github.com/QuantumKitHub/MPSKit.jl.git")

docs/src/assets/mpskit.bib

@@ -201,23 +201,3 @@ not be fully documented yet. If you encounter any issues or have questions, plea
 library's [issue tracker](https://github.com/QuantumKitHub/MPSKit.jl/issues) on the GitHub
 repository and open a new issue.
 
-## Publications using MPSKit
-
-Below you can find a list of publications that have made use of MPSKit. If you have used
-this package and wish to have your publication added to this list, please open a pull
-request or an issue on the [GitHub repository](https://github.com/QuantumKitHub/MPSKit.jl/).
-
-- R. Belyansky et al., *“High-Energy Collision of Quarks and Hadrons in the Schwinger Model: From Tensor Networks to Circuit QED,”* 2023, doi: 10.48550/ARXIV.2307.02522.
-- L. Devos, L. Vanderstraeten, and F. Verstraete, *“Haldane gap in the SU(3) [3 0 0] Heisenberg chain,”* Phys. Rev. B, vol. 106, no. 15, p. 155103, Oct. 2022, doi: 10.1103/PhysRevB.106.155103.
-- J. C. Halimeh, M. V. Damme, T. V. Zache, D. Banerjee, and P. Hauke, *“Achieving the quantum field theory limit in far-from-equilibrium quantum link models,”* Quantum, vol. 6, p. 878, Dec. 2022, doi: 10.22331/q-2022-12-19-878.
-- J. C. Halimeh, D. Trapin, M. Van Damme, and M. Heyl, *“Local measures of dynamical quantum phase transitions,”* Phys. Rev. B, vol. 104, no. 7, p. 075130, Aug. 2021, doi: 10.1103/PhysRevB.104.075130.
-- M. Hauru, M. Van Damme, and J. Haegeman, *“Riemannian optimization of isometric tensor networks,”* SciPost Physics, vol. 10, no. 2, p. 040, Feb. 2021, doi: 10.21468/SciPostPhys.10.2.040.
-- M. Van Damme, R. Vanhove, J. Haegeman, F. Verstraete, and L. Vanderstraeten, *“Efficient matrix product state methods for extracting spectral information on rings and cylinders,”* Phys. Rev. B, vol. 104, no. 11, p. 115142, Sep. 2021, doi: 10.1103/PhysRevB.104.115142.
-- M. Van Damme, T. V. Zache, D. Banerjee, P. Hauke, and J. C. Halimeh, *“Dynamical quantum phase transitions in spin-$S$ $\text{U}(1)$ quantum link models,”* Phys. Rev. B, vol. 106, no. 24, p. 245110, Dec. 2022, doi: 10.1103/PhysRevB.106.245110.
-- E. L. Weerda and M. Rizzi, *“Fractional quantum Hall states with variational Projected Entangled-Pair States: a study of the bosonic Harper-Hofstadter model,”* 2023, doi: 10.48550/ARXIV.2309.12811.
-- C. Yu and J.-W. Lee, *“Closing of the Haldane gap in a spin-1 XXZ chain,”* J. Korean Phys. Soc., vol. 79, no. 9, pp. 841–845, Nov. 2021, doi: 10.1007/s40042-021-00283-z.
-- Y. Zhang, A. Hulsch, H.-C. Zhang, W. Tang, L. Wang, and H.-H. Tu, *“Universal Scaling of Klein Bottle Entropy near Conformal Critical Points,”* Phys. Rev. Lett., vol. 130, no. 15, p. 151602, Apr. 2023, doi: 10.1103/PhysRevLett.130.151602.
-- Gertian Roose, Laurens Vanderstraeten, Jutho Haegeman, and Nick Bultinck. Anomalous domain wall condensation in a modified ising chain. Phys. Rev. B, 99: 195132, May 2019. 10.1103/​PhysRevB.99.195132.
-https:/​/​doi.org/​10.1103/​PhysRevB.99.195132
-- Roose, G., Bultinck, N., Vanderstraeten, L. et al. Lattice regularisation and entanglement structure of the Gross-Neveu model. J. High Energ. Phys. 2021, 207 (2021). https://doi.org/10.1007/JHEP07(2021)207
-- Roose, G., Haegeman, J., Van Acoleyen, K. et al. The chiral Gross-Neveu model on the lattice via a Landau-forbidden phase transition. J. High Energ. Phys. 2022, 19 (2022). https://doi.org/10.1007/JHEP06(2022)019

docs/src/index.md

@@ -0,0 +1,61 @@
+# References
+
+## Publications using MPSKit
+
+Below you can find a list of publications that have made use of MPSKit. If you have used
+this package and wish to have your publication added to this list, please open a pull
+request or an issue on the [GitHub repository](https://github.com/QuantumKitHub/MPSKit.jl/).
+
+### 2025
+
+```@bibliography
+Pages = []
+```
+### 2024
+
+```@bibliography
+Pages = []
+belyansky2024
+weerda2024
+```
+
+### 2023
+
+```@bibliography
+Pages = []
+zhang2023
+```
+
+### 2022
+
+```@bibliography
+Pages = []
+devos2022
+halimeh2022
+roose2022
+vandamme2022
+```
+
+### 2021
+
+```@bibliography
+Pages = []
+halimeh2021
+hauru2021
+roose2021
+vandamme2021
+yu2021
+```
+
+### 2019
+
+```@bibliography
+Pages = []
+roose2019
+```
+
+## Full list of references
+
+```@bibliography
+```
+

docs/src/references.md

@@ -51,7 +51,7 @@ println("F = $F\tS = $S\tξ = $ξ")
 md"""
 ## The scaling hypothesis
 
-The dominant eigenvector is of course only an approximation. The finite bond dimension enforces a finite correlation length, which effectively introduces a length scale in the system. This can be exploited to formulate a [scaling hypothesis](https://arxiv.org/pdf/0812.2903.pdf), which in turn allows to extract the central charge.
+The dominant eigenvector is of course only an approximation. The finite bond dimension enforces a finite correlation length, which effectively introduces a length scale in the system. This can be exploited to formulate a [pollmann2009](@cite), which in turn allows to extract the central charge.
 
 First we need to know the entropy and correlation length at a bunch of different bond dimensions. Our approach will be to re-use the previous approximated dominant eigenvector, and then expanding its bond dimension and re-running VUMPS.
 According to the scaling hypothesis we should have ``S \propto \frac{c}{6} log(ξ)``. Therefore we should find ``c`` using

examples/classic2d/1.hard-hexagon/main.jl

@@ -1,8 +1,7 @@
 """
 $(TYPEDEF)
 
-Optimization algorithm for excitations on top of MPS groundstates, as
-introduced in this [paper](https://doi.org/10.1103/PhysRevB.96.054425).
+Single-site optimization algorithm for excitations on top of MPS groundstates.
 
 ## Fields
 
@@ -17,6 +16,10 @@ $(TYPEDFIELDS)
 
 Create a `ChepigaAnsatz` algorithm with the given eigensolver, or by passing the
 keyword arguments to `Arnoldi`.
+
+## References
+
+- [Chepiga et al. Phys. Rev. B 96 (2017)](@cite chepiga2017) 
 """
 struct ChepigaAnsatz{A} <: Algorithm
     "algorithm used for the eigenvalue solvers"
@@ -62,8 +65,7 @@ end
 """
     ChepigaAnsatz2 <: Algorithm
 
-Optimization algorithm for excitations on top of MPS groundstates, as
-introduced in this [paper](https://doi.org/10.1103/PhysRevB.96.054425).
+Two-site optimization algorithm for excitations on top of MPS groundstates.
 
 ## Fields
 - `alg::A = Defaults.eigsolver`: algorithm to use for the eigenvalue problem.
@@ -77,6 +79,10 @@ introduced in this [paper](https://doi.org/10.1103/PhysRevB.96.054425).
 
 Create a `ChepigaAnsatz2` algorithm with the given eigensolver and truncation, or by passing the
 keyword arguments to `Arnoldi`.
+
+## References
+
+- [Chepiga et al. Phys. Rev. B 96 (2017)](@cite chepiga2017) 
 """
 struct ChepigaAnsatz2{A} <: Algorithm
     alg::A

src/algorithms/excitation/chepigaansatz.jl

@@ -5,8 +5,7 @@
 """
 $(TYPEDEF)
 
-Optimization algorithm for quasiparticle excitations on top of MPS groundstates, as
-introduced in this [paper](https://journals.aps.org/prl/abstract/10.1103/PhysRevLett.111.080401).
+Optimization algorithm for quasi-particle excitations on top of MPS groundstates.
 
 ## Fields
 
@@ -20,6 +19,10 @@ $(TYPEDFIELDS)
 
 Create a `QuasiparticleAnsatz` algorithm with the given algorithm, or by passing the 
 keyword arguments to `Arnoldi`.
+
+## References
+
+- [Haegeman et al. Phys. Rev. Let. 111 (2013)](@cite haegeman2013)
 """
 struct QuasiparticleAnsatz{A} <: Algorithm
     "algorithm used for the eigenvalue solvers"

src/algorithms/excitation/quasiparticleexcitation.jl

@@ -4,12 +4,15 @@ $(TYPEDEF)
 Variational gradient-based optimization algorithm that keeps the MPS in left-canonical form,
 as points on a Grassmann manifold. The optimization is then a Riemannian gradient descent 
 with a preconditioner to induce the metric from the Hilbert space inner product.
-https://arxiv.org/abs/2007.03638
 
 ## Fields
 
 $(TYPEDFIELDS)
 
+## References
+
+* [Hauru et al. SciPost Phys. 10 (2021)](@cite hauru2021)
+
 ---
 
 ## Constructors

src/algorithms/groundstate/gradient_grassmann.jl

@@ -1,12 +1,16 @@
 """
 $(TYPEDEF)
 
-Variational optimization algorithm for uniform matrix product states, as introduced in
-https://arxiv.org/abs/1701.07035.
+Variational optimization algorithm for uniform matrix product states, based on the combination of DMRG with matrix product state tangent space concepts.
 
 ## Fields
 
 $(TYPEDFIELDS)
+
+## References
+
+* [Zauner-Stauber et al. Phys. Rev. B 97 (2018)](@cite zauner-stauber2018)
+* [Vanderstraeten et al. SciPost Phys. Lect. Notes 7 (2019)](@cite vanderstraeten2019)
 """
 @kwdef struct VUMPS{F} <: Algorithm
     "tolerance for convergence criterium"