American Astronomical Society

← Back to Policies

Policy Statement on Software

1 January 2016

AAS Journals have adopted a policy that reflects the importance of software to the astronomical community, and the need for clear communication about such software which ensures that credit is appropriately given to its authors. The policy provides clear guidelines for citing software in all papers, and supports the publication of descriptive papers about software relevant to research in astronomy and astrophysics.

Guidelines for software papers

AAS Journals welcome papers which describe the design and function of software of relevance to research in astronomy and astrophysics. Such papers should contain a description of the software, its novel features and its intended use. Such papers need not include research results produced using the software, although including examples of applications can be helpful. There is no minimum length requirement for software papers.

If a piece of novel software is important to published research then it is likely appropriate to describe it in such a paper.

We highly recommend that authors release code described in a paper under an appropriate open source license (see http://opensource.org/faq#osd or http://choosealicense.com/) and archive the published version of their code using a service such as Zenodo (https://zenodo.org/) or FigShare (http://figshare.com/) which will provide a unique digital object identifier (DOI) and ensure that the code is accessible in the long term. However, any papers which provide a clear statement on how to access the code - for example, by contacting the author - are acceptable.

Guidelines for citation of software

Software can be cited in two ways:

Ideally, both forms of citation should be included. The former extends credit to the authors for their publication and tells the reader where to learn about the software. The latter gives the reader access to the exact version of the software used in the project. These forms of citation are intended to allow authors to properly reference their use of software; alongside these formal references, they may also want to include links to appropriate code repositories, such as GitHub, or indices, such as the Astrophysics Source Code Library.

Authors may also include a section below the acknowledgments listing scientific software packages used as part of the work presented in the manuscript. This should be done via the new \software AASTeX 6 macro. The content of the command should take the form of a list of software name and citation in parentheses, for example:

                \software{Astropy \citep{http://dx.doi.org/10.1051/0004-6361/201322068},
                          Matplotlib \citep{http://dx.doi.org/10.1109/MCSE.2007.55}}
                

This is analogous to acknowledging a major facility or instrument and is done for the same reason, to give credit to a project which is generally useful for the community.