Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sorcha cite command line function #1093

Merged
merged 8 commits into from
Jan 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/cite.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Expand Down
Loading
Loading