Merge pull request #1093 from dirac-institute/making-a-sorcha-cite-in…

…-the-CLI Sorcha cite command line function
dirac-institute · Jan 14, 2025 · 380af93 · 380af93
2 parents 38e7956 + b9b33ec
commit 380af93
Show file tree

Hide file tree

Showing 5 changed files with 689 additions and 592 deletions.
diff --git a/docs/cite.rst b/docs/cite.rst
@@ -21,7 +21,14 @@ Citing the Software
 
 Built-In Citation Function
 ----------------------------
-If you use ``Sorcha`` in your research, please do include a citation in your published papers for ``Sorcha`` and the software packages and resources that ``Sorcha'' is based on. The simplest way to find this information is to use our built-in citation function. In an interactive Python session or a Jupyter notebook::
+
+If you use ``Sorcha`` in your research, please do include a citation in your published papers for ``Sorcha`` and the software packages and resources that ``Sorcha`` is based on. There are two ways to find this information: 
+
+The first is to create a text file of the citation by running the following command on the command line:: 
+
+   sorcha cite
+
+The second is to use our built-in citation function. In an interactive Python session or a Jupyter notebook::
 
    import sorcha
    sorcha.cite()

diff --git a/pyproject.toml b/pyproject.toml
@@ -45,6 +45,7 @@ sorcha-init = "sorcha_cmdline.init:main"
 sorcha-demo = "sorcha_cmdline.demo:main"
 sorcha-outputs = "sorcha_cmdline.outputs:main"
 sorcha-bootstrap = "sorcha_cmdline.bootstrap:main"
+sorcha-cite = "sorcha_cmdline.cite:main"
 
 [project.urls]
 "Documentation" = "https://sorcha.readthedocs.io/en/latest/"