Skip to main content

Reproduction-document publisher: turn a deposited nirs4all .n4a into a methods + bibliography report and a live in-browser pipeline replay.

Project description

nirs4all-papers

nirs4all-papers

Public archive for deposited nirs4all papers and reproducible public code bundles.

This repository is for material that can be public and permanent:

  • accepted/deposited paper PDFs;
  • reproducibility kits;
  • public data references and download scripts;
  • frozen code used for a paper result;
  • WASM/static builds linked from nirs4all.org;
  • DOI, tag, release, and provenance metadata.

Drafts, reviewer-private material, journal scouting, private datasets, and in-progress manuscripts belong in the private nirs4all-drafts repository.

Lifecycle

  1. Work happens privately in nirs4all-drafts and experimentally in nirs4all-lab.
  2. Once the draft and lab work are ready for public release, move only the deposited PDF and reproducible public code here.
  3. Build a stable WASM/static artifact when the paper needs an interactive public companion.
  4. Link the released paper bundle from nirs4all.org.

Layout

papers/
  README.md
templates/
  reproducibility-kit/
    README.md

Each paper should use a stable slug, for example:

papers/2026-aom-transfer/
  README.md
  paper.pdf
  CITATION.cff
  code/
  data/
  wasm/

Do not commit generated caches, private review files, unpublished drafts, or data that cannot be redistributed.

Reproduction-document publisher

n4a-papers turns a deposited .n4a bundle plus a short paper.yaml into a self-contained reproduction page — the exact pipeline, a bibliography for every method, the protocol and scores, a live in-browser replay that re-runs the pipeline, and deposit sidecars (CITATION.cff, BibTeX, RO-Crate). It builds a static site for papers.nirs4all.org.

pip install nirs4all-papers     # the publisher CLI (or: pip install -e . from a checkout)
n4a-papers build --out site     # papers/*/  →  ./site  (open site/index.html)

See docs/REPRODUCTION_PUBLISHER.md for the design and papers/README.md for the per-paper bundle layout.

License

This repository — reproducibility code and accompanying content alike — is dual-licensed open-source — CeCILL-2.1 OR AGPL-3.0-or-later — with an optional commercial license (for any commercial use, contact nirs4all-admin@cirad.fr), matching the rest of the nirs4all ecosystem. Deposited manuscripts carry their publisher's terms, and datasets / third-party assets keep their upstream terms. See LICENSING.md and LICENSES/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nirs4all_papers-0.2.0.tar.gz (76.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nirs4all_papers-0.2.0-py3-none-any.whl (76.1 kB view details)

Uploaded Python 3

File details

Details for the file nirs4all_papers-0.2.0.tar.gz.

File metadata

  • Download URL: nirs4all_papers-0.2.0.tar.gz
  • Upload date:
  • Size: 76.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nirs4all_papers-0.2.0.tar.gz
Algorithm Hash digest
SHA256 e418807b7447afb0454d2f2d51b3aac0440ee5936c91479dded138a86bfd0dad
MD5 7d51563e7b21661ade82f1425bbb3784
BLAKE2b-256 fc26828ee963e5e62e143e408ea0d29dde7f36c26f3c3f45a7d9b78d177067a3

See more details on using hashes here.

Provenance

The following attestation bundles were made for nirs4all_papers-0.2.0.tar.gz:

Publisher: publish.yml on GBeurier/nirs4all-papers

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nirs4all_papers-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: nirs4all_papers-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 76.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for nirs4all_papers-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 005411b8f8e9220cd2f00062a30199114e7feb1cd0978a5346b684f69946534e
MD5 f5b9f7f867c967adc68e6f0975978335
BLAKE2b-256 40e6a8671abf8c57f9319b7fc3a5712ca73791bb7c00139773495965704703a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for nirs4all_papers-0.2.0-py3-none-any.whl:

Publisher: publish.yml on GBeurier/nirs4all-papers

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page