Contribute

Publish your calibration

Add new .ice files or partial tables via pull request. Include the manifest, checksums, and citations.

Fork the repo Add your files Open a PR

Workflow

Three steps to contribute

Follow this process to add your calibration files, partial tables, or build scripts to the library.

1

Fork and add assets

Place .ice files or .csv/metadata.yaml in library/. Add build scripts to scripts/.

2

Update library data

Edit assets/app.js to add an entry with title, type, description, citation, and links to artifacts.

3

Open a pull request

Document provenance, licenses, and checksums. A maintainer will validate and publish.

Guidelines

What to include

Make your contribution easy to review and integrate.

For .ice files

  • Complete metadata.yaml with version, sources, license, and contact.
  • All CSV tables with consistent key columns and a single value column.
  • SHA-256 checksum for the packaged archive.
  • Paper citation if the calibration supports a published work.

For build scripts

  • Clear README with dependencies and execution instructions.
  • Input data sources documented and linked.
  • Output format matching the .ice specification.
  • Concordance tables included if sector mapping is involved.

Entry format

Registry data structure

Add your entry to assets/app.js following this format.

{
  title: "Your calibration name",
  type: "full",  // full | table
  status: "In review",
  modelDescription: "Brief description of the calibration.",
  paperCitation: "Author (Year). Title. Journal.",
  iceCitation: "icefil.es Registry. Your .ice file, v1.0.",
  tags: ["Tag1", "Tag2"],
  links: [
    { label: ".ice artifact", url: "https://..." },
    { label: "Build script", url: "https://..." }
  ]
}