We will be adjusting the guidance on this page in accordance with the NISO Reproducibility Badging and Definitions Guidelines currently in draft status.
In order to be awarded an Open Code badge, all source code should be made publicly available in a searchable, open access, trusted digital repository. A DOI, permanent URL or other permanent digital resource locator for accessing the model code must be provided that links to the specific version of the code used in the the publication. Narrative documentation and detailed software metadata should also accompany the source code and enable others to fully understand and/or replicate the source code. Metadata should clearly indicate all software, system, and data dependencies needed to compile and/or execute the source code with versions included.
As a concrete example, model source code made available on an author’s personal website, GitHub repository, or via email request does not meet the criteria for an Open Code badge whereas model source code published in the CoMSES Net Computational Model Library that has also passed the CoMSES Net peer review process does. For a comprehensive list of repositories where model source code can be archived to meet Open Code criteria please visit our trusted digital repositories page.
Journals participating in the Open Code program award Open Code badges to selected publications based on information provided by the authors and reviewers during the submission and review process. Online versions of publications should link the Open Code badge to a permanent digital resource locator that resolves to a landing page for the archived source code. If you have questions on the use of the Open Code badge, please contact us.
These badges are derived from the “Badges to Acknowledge Open Practices” project from the Open Science Framework (see also https://cos.io/our-services/open-science-badges/) and are similarly licensed via the CC-By Attribution 4.0.
Examples of how to use the badge to link to a model are present on computational model releases that have been peer reviewed. For example, see https://www.comses.net/codebases/2222/releases/1.1.0/#open-code-badge in the
Cite this Model box. The general format is something like this:
<a href='https://doi.org/10.25937/krp4-g724'> <img height='88' src='https://www.comses.net/static/images/icons/open-code-badge.png'> </a>
If you have any comments, feedback, or suggestions on how to improve our usage of the open code badge, please let us know.