Citing the Software

Sorcha is described provided in joint Astromical Journal/JOSS software papers: Merritt et al. (in press) and Holman et al. (submitted). We also ask that you reference in your software citations and acknowledgements the other packages that Sorcha is built upon (see below).

Tip

Beyond citing the relevant papers, make sure to include details about your configuration for Sorcha (e.g. which footprint filter you're using), details about your input population (e.g. orbital, H, color, and phase curve distribution), and information about the pointing database used.

Hint

You find out what version of Sorcha you're running by typing sorcha --version on the command line.

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 user can create a text file of the citation information (or output the information to the standard output on the terminal) by running the following command on the command line:

sorcha cite

Additional Citation Details

Please also cite the software and ancillary data files that helps power Sorcha. Our citation function described above will give the full details or you can manually find the acknowledgement information for each package:

• assist https://assist.readthedocs.io/en/latest/

• astropy https://www.astropy.org/acknowledging.html

• healpy https://healpy.readthedocs.io/en/latest/

• importlib_resources https://github.com/python/importlib_resources

• matplotlib https://matplotlib.org/stable/users/project/citing.html

• Minor Planet Center https://www.minorplanetcenter.net/data

• numba https://numba.pydata.org/

• numpy https://numpy.org/citing-numpy/

• pandas https://pandas.pydata.org/about/citing.html

• pooch https://www.fatiando.org/pooch/latest/#

• pyTables https://www.pytables.org/

• rebound https://rebound.readthedocs.io/en/latest/

• sbpy https://joss.theoj.org/papers/10.21105/joss.01426

• scipy https://scipy.org/citing-scipy/

• SPICE kernels and ancillary data files https://naif.jpl.nasa.gov/naif/credit.html

• spiceypy https://spiceypy.readthedocs.io/en/main/citation.html

• tqdm https://tqdm.github.io/

Note

The same information is available from our built-on citation function.