SPB Git

Repository Public MIT

collections.md 3.2 KB 71 lines markdown

1---2title: Collections and research toolkits3description: What collections are, how they are curated, and how to publish a reproducible toolkit as a bundle.4order: 235section: Publish6---78# Collections and research toolkits910Two different things help people find sets of artifacts that belong together.1112| | Collection | Bundle |13|---|---|---|14| What | An editorial list on the website | A published artifact of type `bundle` |15| Who makes it | Registry curators | Any publisher |16| Versions | None; it changes over time | Versioned and immutable, with exact pins |17| Use it for | Discovery | Reproducibility |1819## Collections2021A collection is a titled, described list of public artifacts, optionally with a curator's note per item. The registry starts with these topics:2223Academic Research, Financial Econometrics, Scientific Writing, macOS Automation, Local LLMs, Data Engineering, Developer Productivity, Evaluation.2425A collection may be empty. The registry does not fill collections with placeholder entries; a collection shows what has actually been published and selected.2627- Browse: [/collections](/collections)28- API: `GET /api/v1/collections`, `GET /api/v1/collections/{slug}`2930Only public artifacts appear. If an artifact is taken down, made private or archived, it disappears from the collection automatically.3132### Suggesting an addition3334Curation is done by the registry's administrators in this version. Email contact@spboucher.ai with the artifact name, the collection, and one sentence on why it belongs. Inclusion is an editorial choice, not an endorsement of safety or quality, and is never paid.3536## Reproducible research toolkits3738When you want someone else to get exactly the set of tools behind a paper or a project, publish a bundle.39401. Publish each component as its own artifact.412. Create a bundle whose dependencies pin exact versions:4243```json44{45  "schemaVersion": "1.0",46  "name": "@yourns/paper-2026-toolkit",47  "version": "1.0.0",48  "type": "bundle",49  "description": "Skills and evaluation kit used for the 2026 working paper on intraday volatility.",50  "license": "CC-BY-4.0",51  "repository": "https://example.org/you/paper-2026",52  "dependencies": [53    { "name": "@yourns/garch-estimation", "version": "2.1.0" },54    { "name": "@yourns/table-builder", "version": "1.4.2" },55    { "name": "@yourns/replication-kit", "version": "1.0.0" }56  ]57}58```59603. In the bundle's `README.md`, state the environment (clients and versions used), the order of use, the data that is needed and where to obtain it, and the expected outputs.614. Cite the bundle by name **and version**. Because releases are immutable and each has a SHA-256, that citation identifies exact bytes.6263Good practice for a toolkit meant to be replicated:6465- Put the replication materials in an `eval-kit` artifact: test cases, fixtures, expected results, and instructions to run them.66- Do not include data you cannot redistribute. Describe how to obtain it.67- Record the commit of your source repository in `sourceCommit`.68- If a component is later revoked, publish a new bundle version; the old one keeps describing what was used at the time.6970The registry stores and displays the bundle's pins. It does not install a bundle's components automatically in this version; the bundle page lists each one with its pinned version.71
Files main
Menu

Theme