Criteria

This list of criteria are to be checked in order to ensure that the project is open and reproducible.

The workflow

• The scientific context is clearly explained in the README.md
• The project objectives are clearly explained in the README.md
• Instructions on how to proceed are detailed in the README.md
• There is a license associated with this project
• Every notebook has an objective section
• Every notebook has a conclusion section
• Every notebook is organized in logical processing steps, with an explicit narrative structure, with each cells having a clear purpose, and including comments/intermediate conclusions between cells

The data

• There is a description of the input data
• There are instructions on how to retrieve the input data (doi or URL, additional scripts can be provided)

The code

• The code is documented: each function has a doc string that describes the input and output arguments and what the function does, and each Jupyter cell has a short comment that describes the purpose of the cell (doc strings, headers)
• The computing environment associated with the code is described (ex: env.yml file or list of libraries and their versions)
• The code has an open-source license (such as BSD-3-Clause or GPLv3)
• The strategy of short term and long term conservation of the code is explained
• Long-term conserved code is public and stored properly (example: Zenodo or Software heritage)