Fairscape RO-Crate Profile

This repository is the canonical home of the Fairscape Release RO-Crate Profile — the structural and semantic constraints that an RO-Crate must satisfy to be considered a Fairscape release.

The rendered specification lives at https://fairscape.github.io/profile/.

What's a Fairscape Release Crate?

A Fairscape Release Crate is an RO-Crate 1.2 packaging a versioned, AI-ready research dataset together with provenance, schema, and machine-learning-readiness metadata. The profile constrains and extends:

• RO-Crate 1.2 — base packaging and metadata layout
• EVI Ontology — Dataset, Software, MLModel, Computation, Annotation, Experiment, …
• PROV-O — prov:used, prov:wasGeneratedBy, prov:wasAttributedTo
• Schema.org — Person, Organization, Dataset, author, license, …
• Croissant / Croissant-RAI 1.0 — ML crosswalk emitted alongside each release

Published versions

Version	Profile URI	Specification	Status
0.1	https://w3id.org/fairscape/profile/0.1	v0.1 spec	Superseded by 0.2
0.2	https://w3id.org/fairscape/profile/0.2	v0.2 spec	Current (adds SHACL shapes)

Profile URIs are immutable. Future revisions will be published under a new URI (e.g. …/0.2, …/1.0); a crate's dct:conformsTo value pins the exact revision it was authored against.

How conformance is signaled

A Fairscape release crate declares conformance by setting dct:conformsTo on its Root Data Entity:

{
  "@id": "ark:99999/my-release",
  "@type": ["Dataset", "https://w3id.org/EVI#ROCrate"],
  "conformsTo": { "@id": "https://w3id.org/fairscape/profile/0.2" }
}

Conformance is checkable with fairscape_models: ROCrateV1_2.model_validate does the Pydantic structural check. From v0.2 the profile also ships SHACL shapes (profile/0.2/fairscape-shapes.ttl), which fairscape_models.validation.shacl.validate_shacl runs (pip install 'fairscape-models[shacl]'). They add graph rules such as "generatedBy must point at a Computation/Experiment".

Profile artifacts

Each version lives under profile/<version>/. The contents follow the W3C Profiles Vocabulary (PROF) resource roles:

Artifact	Path	PROF role	Format
Profile Crate manifest	profile/0.1/ro-crate-metadata.json	—	JSON-LD
W3C PROF manifest	profile/0.1/profile.ttl	—	Turtle
EVI ontology (classes/properties)	profile/0.1/evi-vocabulary.ttl	role:vocabulary	Turtle
Per-class JSON Schemas	profile/0.1/schemas/	role:schema	JSON Schema
Canonical conforming crate	profile/0.1/examples/release/	role:example	JSON-LD
SHACL shapes (v0.2+)	profile/0.2/fairscape-shapes.ttl	role:validation	Turtle
Validator	fairscape_models.validation.shacl	role:validation	Python

Each artifact resolves at https://fairscape.github.io/profile/0.1/<artifact> — the same path declared inside profile.ttl and the Profile Crate manifest.

Repository layout

profile/                  # the canonical profile artifacts (source of truth)
  0.1/
    ro-crate-metadata.json
    profile.ttl
    evi-vocabulary.ttl
    schemas/
    examples/release/
  0.2/                    # adds fairscape-shapes.ttl (SHACL)
scripts/render_shapes.py  # regenerates site/.../<version>/validation.md from the shapes
site/                     # Astro + Starlight source for the rendered spec site
README.md                 # you are here

The site/ folder is the documentation generator — see site/README.md if you're working on the rendered spec, otherwise ignore it.

Versioning policy

• Backwards-incompatible changes (relaxing or tightening any MUST) → MAJOR bump, new URI.
• Additive changes (new MAY properties, new supporting files) → MINOR bump, new URI.
• The profile URI is the version pin. Never mutate a published version in place.

Related Fairscape projects

To build a conforming crate and a human-readable datasheet, start at https://fairscape.github.io/ (Quick start).

• fairscape_conversion — builds release crates from metadata you already have (datasheets, data packages, workflow runs)
• fairscape_models — Pydantic models (authoritative source for required/optional fields) and the SHACL validator
• fairscape_artifacts — HTML datasheet, evidence graph and previews from a finished crate
• AIreadiness-grader — AI-readiness scoring
• fairscape_publish — publishes crates
• fairscape_server — API server
• fairscape_web_client — web UI

License

Profile content is licensed under CC BY 4.0.