Template repository for a single point of access meta-repository to reproduce an experiment
NOTE: Delete this instructional section after creating your template!
A meta-repository allows us to create a single point of access for someone to find all of the components that were used to create a published work for the purpose of reproducibility. This repository should contain references to all minted data and software as well as house any ancillary code used to transform the source data, create figures for your publication, conduct the experiment, and / or execute the contributing software.
Simply click
Use this template
on the main repository page (shows up to the left ofClone or download
) and fill in yourRepository name
, theDescription
, select whether you want the repository to bePublic
orPrivate
, and leaveInclude all branches
unchecked.The following naming conventions should be used when naming your repository:
- Single author:
lastname_year_journal
- Multi author:
lastname-etal_year_journal
- Multiple publications in the same journal:
lastname-etal_year-letter_journal
(e.g.,human-etal_2020-b_nature
)A general
.gitignore
for use with Python development is included. However, you may wish to customize this to the needs of your project.
- Don't bog down your repository with a bunch of raw data. Instead archive and mint a DOI for your data and provide the reference in this repository with instructions for use.
- Create complete and tested documentation for how to use what is in this repository to reproduce your experiment.
It is important to version and release your meta-repository as well due to changes that may occur during the publication review process. If you do not know how to conduct a release on GitHub when linked with Zenodo, please contact chris.vernon@pnnl.gov to get set up. The first line of this file is a space holder for your Zenodo DOI badge.
One sentence describing your research
Your abstract here.
References for each minted software release for all code involved. If you have modified a codebase that is outside of a formal release, and the modifications are not planned on being merged back into a version, fork the parent repository and add a .<shortname>
to the version number of the parent and conduct your own name. For example, v1.2.5.hydro
.
Human, I.M. (2020, January 1). human/myrepo: v1.2.5.hydro (Version v1.2.5.hydro). Zenodo. https://doi.org/some-doi-number
Update your journal reference here after acceptance.
Reference for each minted data source for your input data.
Human, I.M. (2020). My dataset name [Data set]. DataHub. https://doi.org/some-doi-number
Reference for each minted data source for your output data.
Model | Version | Repository Link | DOI |
---|---|---|---|
<model 1> | |||
<model 2> |
Fill in detailed info here or link to other documentation that is a thorough walkthrough of how to use what is in this repository to reproduce your experiment.