docs: update CITATION.cff and related docs

CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 title: pyg4ometry
-doi: UPDATEME
-date-released: 2000-01-01
+doi: 10.5281/zenodo.10449301
+date-released: 2024-01-01
 url: https://github.com/github-linguist/linguist
 message: "If you use this software, please cite it as below."
 authors:

README.md

@@ -12,6 +12,7 @@ Carlo (Geant4 and Fluka) geometries.
 ![GitHub issues](https://img.shields.io/github/issues/g4edge/pyg4ometry?logo=github)
 ![GitHub pull requests](https://img.shields.io/github/issues-pr/g4edge/pyg4ometry?logo=github)
 ![License](https://img.shields.io/github/license/g4edge/pyg4ometry)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10449301.svg)](https://doi.org/10.5281/zenodo.10449301)
 [![Read the Docs](https://img.shields.io/readthedocs/pyg4ometry?logo=readthedocs)](https://pyg4ometry.readthedocs.io)
 
 ## Installing from PyPI
@@ -20,7 +21,7 @@ Carlo (Geant4 and Fluka) geometries.
 > pip install pyg4ometry
 ```
 
-> **Note**
+> [!NOTE]
 > Most dependencies are available from pip but you will need to install OpenCASCADE
 > cgal, mpfr, gmp, ROOT. Find [here](https://github.com/g4edge/pyg4ometry/tree/main/.github/bin)
 > installers for Ubuntu and MacOS.
@@ -33,7 +34,7 @@ Carlo (Geant4 and Fluka) geometries.
 > pip install . # add --editable for a version which you can edit
 ```
 
-> **Note**
+> [!NOTE]
 > If you update your Git clone and the pybind11 C++ has changes you will need
 > to reinstall and thus trigger a rebuild.
 

docs/source/citation.rst

@@ -2,37 +2,33 @@
 Referencing & Citation
 ======================
 
-Any publications including simulations made using pyg4ometry **must** cite:
+.. important::
 
-  S.D. Walker, A. Abramov, L.J. Nevay, W. Shields, S.T. Boogert,
-  pyg4ometry: A Python library for the creation of Monte Carlo radiation transport physical geometries,
-  Computer Physics Communications **272** 108228 (2022).
-  DOI: `<https://doi.org/10.1016/j.cpc.2021.108228>`_ (pre-print: `<https://arxiv.org/abs/2010.01109>`_)
+   Citation information can be obtained on GitHub by pointing your browser to
+   `github.com/g4edge/pyg4ometry <https://github.com/g4edge/pyg4ometry>`_ and
+   selecting "Cite this repository" in the sidebar on the right. pyg4ometry
+   uses a `CITATION.cff
+   <https://github.com/g4edge/pyg4ometry/blob/main/CITATION.cff>`_ file.
 
-The bibtex citation from `<https://inspirehep.net/literature/1821231>`_:
+Citations allow the authors to demonstrably show the code usage and therefore to
+continue to support the development and maintenance of pyg4ometry.
 
-.. code-block:: bibtex
+Any publications including simulations made using pyg4ometry **must** cite:
 
-   @article{Boogert:2020cmn,
-       author = "Boogert, Stewart and Abramov, Andrey and Nevay, Laurence and Shields, William and Walker, Stuart",
-       title = "{Pyg4ometry: A Python library for the creation of Monte Carlo radiation transport physical geometries}",
-       eprint = "2010.01109",
-       archivePrefix = "arXiv",
-       primaryClass = "physics.comp-ph",
-       doi = "10.1016/j.cpc.2021.108228",
-       journal = "Comput. Phys. Commun.",
-       volume = "272",
-       pages = "108228",
-       year = "2022"
-   }
+  S.D. Walker, A. Abramov, L.J. Nevay, W. Shields, S.T. Boogert,
+  *"pyg4ometry: A Python library for the creation of Monte Carlo radiation transport physical geometries"*,
+  Computer Physics Communications **272** 108228 (2022).
+  DOI: `10.1016/j.cpc.2021.108228 <https://doi.org/10.1016/j.cpc.2021.108228>`_
 
-Citations allow the authors to demonstrably show the code usage and therefore to
-continue to support the development and maintenance of pyg4ometry.
+Additionally, we automatically generate a DOI for each pyg4ometry code release
+through Zenodo at `this page
+<https://zenodo.org/doi/10.5281/zenodo.10449301>`_, if you wish to cite a
+specific pyg4ometry version.
 
 Other publications on pyg4ometry:
 
-* `Pyg4ometry : A Tool To Create Geometries For Geant4, Bdsim, G4Beamline and
-  Fluka For Particle Loss and Energy Deposit Studies, IPAC2019, Melbourne,
-  Australia, 2019 <https://doi.org/10.18429/JACoW-IPAC2019-WEPTS054>`_
-  (Google scholar `cites
-  <https://scholar.google.com/scholar?cites=7483314837088930734&as_sdt=2005&sciodt=0,5&hl=en>`_)
+* S.T. Boogert, A. Abramov, J. Albrecht, G. D’Alessandro, L.J. Nevay, W. Shields, S.D. Walker,
+  *Pyg4ometry : A Tool To Create Geometries For Geant4, Bdsim, G4Beamline and
+  Fluka For Particle Loss and Energy Deposit Studies*, IPAC2019, Melbourne,
+  Australia, 2019. DOI: `10.18429/JACoW-IPAC2019-WEPTS054
+  <https://doi.org/10.18429/JACoW-IPAC2019-WEPTS054>`_

src/pyg4ometry/cli.py

@@ -78,24 +78,7 @@ def _parseStrPythonAsDict(strPython):
 
 
 def _printCitation():
-    s = "S.D. Walker, A. Abramov, L.J. Nevay, W. Shields, S.T. Boogert,\n"
-    s += "pyg4ometry: A Python library for the creation of Monte Carlo radiation\n"
-    s += "transport physical geometries, Computer Physics Communications **272** 108228 (2022)."
-    print(s)
-    print("Bibtex entry:")
-    s = "@article{Boogert:2020cmn,\n"
-    s += '    author = "Boogert, Stewart and Abramov, Andrey and Nevay, Laurence and Shields, William and Walker, Stuart",\n'
-    s += '    title = "{Pyg4ometry: A Python library for the creation of Monte Carlo radiation transport physical geometries}",\n'
-    s += '    eprint = "2010.01109",\n'
-    s += '    archivePrefix = "arXiv",\n'
-    s += '    primaryClass = "physics.comp-ph",\n'
-    s += '    doi = "10.1016/j.cpc.2021.108228",\n'
-    s += '    journal = "Comput. Phys. Commun.",\n'
-    s += '    volume = "272",\n'
-    s += '    pages = "108228",\n'
-    s += '    year = "2022"\n'
-    s += "}"
-    print(s)
+    print("https://zenodo.org/doi/10.5281/zenodo.10449301")
 
 
 def cli(