Last Updated December 19, 2017
This describes the process to publish, or release, software to the public and includes links to supporting information. In some cases the software may accompany a reviewed paper/OFR or other kind of reviewed publication, and/or produce a data product also needing a release process. The following focuses on the software portion. Current expectations are that papers, software, and data sets are distinct information products, and thus each has its own entry in IPDS.
The motivation behind this process is to meet the USGS software release policy (which will hopefully be itself released by end of fiscal year 2016). The general goal is to ensure all USGS information products, of which software is an example, meet the USGS Fundamental Science Practices and result in reviewed, high quality products.
Please note the process is a work in progress and feedback is encouraged.
● Common Git Commands
● Diagram of suggested Git workflow (e.g. so you can work on your own branch and not impact others as you implement new features)
● How to set up SSH keys for Git (you can also just authenticate every time, but this is more convenient for repetitive access)
● Updated policy in progress, will post as soon as it is released
● An example iPython notebook demonstrating testing and validation for scientific review, thanks to Josh Rigler
● An example routing sheet , thanks to Josh Rigler
Template Routing sheet for software release: