Update citations for new paper (#117)

* Initialise citation CFF * Switch to bib file * Update bibtex referencei n README * Update citations on docs index page * Update changelog * Add missing curly braces
desy-ml · Jan 16, 2024 · bdb336d · bdb336d
1 parent 2549df9
commit bdb336d
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -25,6 +25,7 @@
 - Add pull request template (see #97) (@jank324)
 - Add _Acknowledgements_ section to README (see #103) (@jank324)
 - `benchmark` directory was moved to `desy-ml/cheetah-demos` repository (see #108) (@jank324)
+- Update citations to new arXiv preprint (see #117) (@jank324)
 
 ## [v0.6.1](https://github.com/desy-ml/cheetah/releases/tag/v0.6.1) (2023-09-17)
 

diff --git a/CITATION.bib b/CITATION.bib
@@ -0,0 +1,14 @@
+@misc{kaiser2024cheetah,
+  title         = {Cheetah: Bridging the Gap Between Machine Learning and Particle Accelerator Physics with High-Speed, Differentiable Simulations},
+  author        = {Kaiser, Jan and Xu, Chenran and Eichler, Annika and {Santamaria Garcia}, Andrea},
+  year          = {2024},
+  eprint        = {2401.05815},
+  archiveprefix = {arXiv},
+  primaryclass  = {physics.acc-ph}
+}
+@inproceedings{stein2022accelerating,
+  title     = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},
+  author    = {Stein, Oliver and Kaiser, Jan and Eichler, Annika},
+  year      = {2022},
+  booktitle = {Proceedings of the 13th International Particle Accelerator Conference}
+}
diff --git a/README.md b/README.md
@@ -85,15 +85,22 @@ where the optional keyword argument `beam` is the incoming beam represented by t
 
 ## Cite Cheetah
 
-To cite Cheetah in publications:
+If you use Cheetah, please cite the following two papers:
 
 ```bibtex
+@misc{kaiser2024cheetah,
+  title         = {Cheetah: Bridging the Gap Between Machine Learning and Particle Accelerator Physics with High-Speed, Differentiable Simulations},
+  author        = {Kaiser, Jan and Xu, Chenran and Eichler, Annika and {Santamaria Garcia}, Andrea},
+  year          = {2024},
+  eprint        = {2401.05815},
+  archiveprefix = {arXiv},
+  primaryclass  = {physics.acc-ph}
+}
 @inproceedings{stein2022accelerating,
-    title        = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},
-    author       = {Stein, Oliver and Kaiser, Jan and Eichler, Annika},
-    year         = 2022,
-    booktitle    = {Proceedings of the 13th International Particle Accelerator Conference},
-    url          = {https://github.com/desy-ml/cheetah}
+  title     = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},
+  author    = {Stein, Oliver and Kaiser, Jan and Eichler, Annika},
+  year      = {2022},
+  booktitle = {Proceedings of the 13th International Particle Accelerator Conference}
 }
 ```
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -61,18 +61,23 @@ For more advanced usage, please refer to the in-depth documentation.
 Cite Cheetah
 ------------
 
-To cite Cheetah in publications:
+If you use Cheetah, please cite the following two papers:
 
 .. code-block:: bibtex
 
+    @misc{kaiser2024cheetah,
+      title         = {Cheetah: Bridging the Gap Between Machine Learning and Particle Accelerator Physics with High-Speed, Differentiable Simulations},
+      author        = {Kaiser, Jan and Xu, Chenran and Eichler, Annika and {Santamaria Garcia}, Andrea},
+      year          = {2024},
+      eprint        = {2401.05815},
+      archiveprefix = {arXiv},
+      primaryclass  = {physics.acc-ph}
+    }
     @inproceedings{stein2022accelerating,
-        author = {Stein, Oliver and
-                Kaiser, Jan and
-                Eichler, Annika},
-        title = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},
-        booktitle = {Proceedings of the 13th International Particle Accelerator Conference},
-        year = {2022},
-        url = {https://github.com/desy-ml/cheetah},
+      title     = {Accelerating Linear Beam Dynamics Simulations for Machine Learning Applications},
+      author    = {Stein, Oliver and Kaiser, Jan and Eichler, Annika},
+      year      = {2022},
+      booktitle = {Proceedings of the 13th International Particle Accelerator Conference}
     }
 
 For Developers