The TRACE (TRAnsparency CErtified) specification defines how Transparent Research Objects (TROs) are declared, signed, and packaged for distribution. It is the primary documentation home for the TRACE project, funded by the National Science Foundation (OAC-2209628, OAC-2209629, OAC-2209630).
The documents in this repository are assembled into a Jupyter Book and published at https://transparency-certified.github.io/trace-specification/. For further details on how TRACE documentation is built and deployed across repositories, see Documentation Infrastructure.
| Document | Description |
|---|---|
| TROV Vocabulary Reference | Terms defined by the TROV vocabulary |
| TRO Declaration Format | Structure and field reference for TRO declarations |
| TRO Packages | How TROs are packaged, signed, and distributed |
| TRO Declaration Design | Why TRO declarations use JSON-LD |
| TROV Extension Guide | How to include institution-specific metadata |
| TROV Versioning and Roadmap | Version policy, namespace scheme, and roadmap |
trace-specification/
├── _config.yml Jupyter Book configuration
├── _toc.yml Jupyter Book table of contents and navigation
├── _static/
│ └── custom.css Custom styles for the published site
├── docs/ Specification and documentation source files
├── build/
│ ├── run_docker.sh Runs Jupyter Book build in Docker
│ └── config.sh Build configuration
├── .github/workflows/
│ └── deploy.yml builds and deploys to GitHub Pages
├── references.bib BibTeX references
├── requirements.txt Python dependencies for Jupyter Book
├── Makefile Jupyter Book build targets
└── test.sh Build script for local testing
| Repository | Description |
|---|---|
| trov | TROV ontology files (Turtle, JSON-LD, SHACL) |
| trace-vocabularies | Vocabulary hub with w3id.org redirects and Widoco builds |
| transparency-certified.github.io | Project website |
Using the Docker-based build (same image as CI):
./build/run_docker.sh test.shOr with jupyter-book installed locally:
./test.shSee .github/workflows/deploy.yml for the full build process.