Skip to content
How to submit your astronomy software, cite relevant astronomy software, and upload your data reduction scripts
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE
README.md

README.md

How to submit your astronomy software and data reduction scripts

When you write an astronomy paper, you use software to carry out your data analysis. To generate the plots and figures you use a series of computer scripts that use this software and produce the graphical output as plots and figures.

If you haven't done so already, register for an ORCID Identifier. The sites mentioned below have tight integration with ORCID, so it simplifies matters. Here is my ORCID ID and page.

Procedure for software packages:

  • Learn version control using GIT and how to upload your software to github. Make sure you choose a permissive license for your software - I have used the BSD 3-clause license.
  • Register the software at Astrophysics Source Code Library. Currently, the ASCL accepts astronomy code that has appeared in a peer review research, submitted for peer review, or is an accepted astronomy thesis. (Q: does this happen automatically or should you be active in it?)
  • Optionally upload it to Zenodo (Q: why Zenodo over any other storage place?)
  • If the package is not described in its own paper, consider submitted it to Journal of Open Source Software

Procedure for plots and figure scripts:

Citing astronomy software

  • Astropy from Acknowledging Astropy - We provide the following LaTeX/BibTeX acknowledgment if there is no specific place to cite the papers:

This research made use of Astropy,\footnote{http://www.astropy.org} a community-developed core Python package for Astronomy \citep{astropy:2013, astropy:2018}.

You can use the SciPy 2010 proceedings citation:

@InProceedings{ mckinney-proc-scipy-2010, 
  author    = { Wes McKinney }, 
  title     = { Data Structures for Statistical Computing in Python }, 
  booktitle = { Proceedings of the 9th Python in Science Conference }, 
  pages     = { 51 - 56 }, 
  year      = { 2010 }, 
  editor    = { St\'efan van der Walt and Jarrod Millman } 
} 

History of this document

v01 written by M Kenworthy based on Twitter conversations with Steve Crawford and Abigail Stevens on 2017 June 28 Putting it on github suggested by Thomas Robitaille

You can’t perform that action at this time.