Code & software availability (lite) — v1.0.0
Released: 2026-02-02 · Hash: sha256:1f9d1592a0052f2713e0f87bf6fc1d7299ed66709cae3ec86bc3e819b5a2953d
Repository & release
| Criterion | Text |
|---|---|
| must CODE-01 | Provide a public repository URL and a versioned release (tag) corresponding to the artifact used in the work. |
| must CODE-02 | Include a README describing purpose, scope, prerequisites, inputs/outputs, and a minimal 'how to run' workflow. |
| must CODE-03 | State the code license and any notable third‑party dependency/license constraints. |
Citation metadata
| Criterion | Text |
|---|---|
| must CODE-10 | Provide software citation metadata (e.g., CITATION.cff) including authors, title, version, and persistent identifier (if available). |
| should CODE-11 | Provide a recommended citation in the manuscript and repository that includes version and PID/URL, aligning with software citation principles. |
Reproducible execution
| Criterion | Text |
|---|---|
| must CODE-20 | Pin dependencies and the execution environment (e.g., lockfile, conda env, Docker image) with explicit versions. |
| must CODE-21 | Provide a reproducible run command/workflow (scripts/Makefile/Snakemake) and a configuration template for paths/parameters. |
| should CODE-22 | Document sources of randomness/nondeterminism and how they are controlled (seeds, deterministic flags, hardware notes). |
Quality & documentation
| Criterion | Text |
|---|---|
| should CODE-30 | Provide minimal tests (smoke tests) and instructions to run them; include expected outputs or verification checks. |
| may CODE-31 | Provide basic input validation and clear error messages for common failures (missing files, bad config, dependency issues). |
| may CODE-32 | Provide module/API documentation (docstrings or docs site) sufficient for reuse and review. |
Archival & persistence
| Criterion | Text |
|---|---|
| should CODE-40 | Archive a release in a long-term repository (e.g., Zenodo) and provide a DOI that resolves to the exact version. |
| should CODE-41 | Ensure the archived artifact matches the repository release (tag/version), and provide an asset list or checksum manifest where feasible. |
| may CODE-50 | State maintenance status and support channels (issue tracker/contact), including how citation or deprecation will be handled. |