REMARK Guidelines

A REMARK refers to an open git repository that is indexed in this repository with appropriate metadata.

Submitting a REMARK¶

To index the repository as a REMARK, please file a pull request in this repository.

The PR should add a link to the repository to the Catalog (currently, in the README).

.
|-- reproduce.sh
|-- CITATION.cff
`-- binder
    `-- environment.yml

The REMARK’s repository must:

Have a tagged release, the last commit before including it as a REMARK should be tagged with a 1.0 release.
In that repository at that release, there must be:

There must be a binder/ directory containing an environment.yml:
- an environment.yml file with pinned dependencies
A reproduce.sh script that
- Installs the requirements
- Runs and reproduces all the results

Include a valid CITATION.cff document with bibliographic metadata for the repository.
Subset of results that you are claiming to be reproducible.
- This could be specified as a directory?

It is strongly recommended to include:

If reproduce.sh takes longer than a few minutes, a reproduce_min.sh that generates some interesting subset of results within a few minutes
A Jupyter notebook that exposits the material being reproduced.

A maximalist REMARK (the extra stuff is completely optional) includes: