Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 4.91 KB

Computational_Notebooks.md

File metadata and controls

36 lines (22 loc) · 4.91 KB
Raw

Policy on Computational Notebooks and the AAS Journals

Chris Lintott and August Muench, February 2024

(This policy draws heavily on Erdmann, C., Stall, S., Gentemann, C., Holdgraf, C., Fernandes, F. P. A., Gehlen, K. P., & Corvellec, M. (2021), Guidance for AGU Authors - Jupyter Notebooks, Zenodo)

Much of the community served by the AAS Journals makes use of computational notebook tools (tools that combine text, code, and richer media in a single document), such as Jupyter, to develop and share code used in research. Making these notebooks available to the reader of a paper may be extremely useful and is a significant contribution to reproducibility of the research contained within the publication. This short policy is intended to help those who wish to share their work this way, alongside the publication of a paper.

  1. In preparing notebooks for a broad audience, we first recommend the advice in Rule, A. et al. (2021), Ten Simple Rules for Writing and Sharing Computational Analyses in Jupyter Notebooks, PLOS Computational Biology). In particular, we recommend giving thought to meaningful divisions between cells to help distinguish the different steps in any analysis and encourage plenty of explanatory text to help the reader understand what is happening. More detailed advice is available elsewhere, for example in this Jupyter Notebooks and Tutorials guide written by staff at STScI.

  2. The AAS Journals, which aim to publish material that will be available for decades hence, do not presently accept submission of notebooks themselves as a part of a journal article. Notebooks should thus be uploaded to a public repository that can supply a Digital Object Identifier (DOI). One option is to create a GitHub repository that includes a suitable (open source) license and a CITATION.cff, and then using Zenodo to generate a DOI. (See GitHub's Referencing and citing content Guide). Alternative repositories that issue DOIs and have suitable archive policies may also be used; authors who are unsure should consult the AAS Data Editors ([email protected]) before submission.

Please note that it is extremely important to make clear explicitly in the notebook what dependencies are necessary for it to be used. A statement at the beginning of the notebook is often sufficient, but more advanced tools such as conda-lock to manage any dependencies may be useful.

All data files required to run the notebook should also be included in the DOI deposit.

  1. This DOI should be cited in the reference section of the paper and mentioned in the main text. An example statement might be:

The Jupyter Notebook to execute the analysis in this paper/to generate the figures in this paper is hosted at [e.g. Github] and is preserved on Zenodo at [DOI].

  1. Making the notebook accessible to users with disabilities is very important. Using an accessibility checklist such as that created by the Iota-School in the “Astronomy Notebooks for All” project may help in authoring more accessible notebooks.

  2. The first four steps describe the minimum requirements for including a Jupyter notebook in an AAS Journals paper. However, we strongly encourage authors to include a rendered (HTML, PDF, or ideally both) version of the notebook in their repository. Commands such as

jupyter nbconvert --to html --execute notebook.ipynb
jupyter nbconvert --to pdf --execute notebook.ipynb

Will usually produce useful files. A variety of hosted solutions may allow more advanced rendering, but even where these are used, simple HTML (and optionally PDF) versions should be included.

Some examples of notebooks associated with published articles include: