Summary and Schedule
This lesson will help USGS researchers and software developers learn how to do the following:
- Create a Git Repository for tracking version controlled software
- Collaborate with others using USGS GitLab.
- Create a USGS-compliant software release package with source code, metadata, disclaimers, license, and citation
- Submit a software release package for publication
| Setup Instructions | Download files required for the lesson | |
| Duration: 00h 00m | 1. Using Markdown | How do you write a lesson using Markdown and sandpaper? |
| Duration: 00h 12m | 2. Open Source and Open Science |
What is open science? What is open source development? How are open science and open source development valuable? |
| Duration: 00h 19m | 3. Policy |
What is an official USGS software information product? When am I required to release my software as an official USGS software information product? When may I release my software as an official USGS software information product? |
| Duration: 00h 19m | 4. Creating Metadata for a Software Release |
What is a code.json file? How do you create a code.json file? What are the required fields in the code.json file for a USGS Software Release? |
| Duration: 00h 19m | Finish |
The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.
FIXME: Setup instructions live in this document. Please specify the tools and the data sets the Learner needs to have installed.
Data Sets
Download the data zip file and unzip it to your Desktop
Software Setup
Details
Setup for different systems can be presented in dropdown menus via a
spoiler tag. They will join to this discussion block, so
you can give a general overview of the software used in this lesson here
and fill out the individual operating systems (and potentially add more,
e.g. online setup) in the solutions blocks.
Use Git BASH. Reach out to your IT to download Git.
Use Terminal.app
Also reach out to your local IT to download Git.
Use Terminal