Review for Publication

This milestone serves as documentation and checklist for the review of the repository. The description of the repository can be found at the wiki ADD LINK HERE. Performing the review

For the performance of the review, the checklist below should serve as guideline for main points to address. If issues should be addressed by the authors or clarified, please create an issue and allocate it to the milestone.

For short discussions and coordination only between the reviewers, use the chat channel https://chat.km3net.de/group/osc_reviews . Checklist

• Public repository in KM3NeT Gitlab, or other Github/Gitlab instances
• The relevant WG has reviewed the repository and agreed on the publication of its content

Structure and documentation

• Includes README
  • Includes execution in README
  • Structure of the repository is documented
• An open license is assigned according to KM3NeT recommendations
• A citation file is included
• An obvious folders structure is used like /src, /data
• Code comments are used

Execution

• Uses python packaging if applicable
• Avoids manual execution of code
• Uses notebooks with extensive description where possible
• Provides environment installation like conda
• and/or provides a container environment
• Analysis can be run in an independent environment “from scratch”

Data

• References and does not duplicate data where available (for open data)
• Provides dummy data where no “real” data is available
• Uses standard data formats where available
• Provides relevant metadata with data (at minimum description in README)

For publication

• Consistency between public plots / journal publication and repository content is ensured
• Gets a DOI assigned to the repository
• Publishes in a public repository (e.g. Zenodo)
• Add reference to paper