fairscape_models
Pydantic models that define the canonical data shape for Fairscape RO-Crate releases. This package is the source of truth: the JSON Schemas, TypeScript types, and the EVI OWL/RDFS vocabulary published with the Fairscape profile are all generated from the classes in fairscape_models/.
What's in here
| Path | What it is |
|---|---|
fairscape_models/*.py |
Pydantic class definitions: Dataset, Software, MLModel, Computation, Annotation, Experiment, Schema, Sample, Instrument, Patient, ModelCard, AnnotatedComputation, AnnotatedEvidenceGraph, ROCrateMetadataElem, ROCrateV1_2, … |
fairscape_models/conversion/ |
Crosswalks: Datasheet-for-Datasets (LinkML), Croissant / Croissant-RAI 1.0. |
json-schemas/ |
Per-class JSON Schemas, generated by scripts/generate_json_schemas.py. |
typescript-types/ |
TypeScript .d.ts declarations, generated by scripts/generate_ts_types.py. |
js/ |
JavaScript bindings. |
profiles/evi-vocabulary.ttl |
OWL/RDFS vocabulary for the EVI namespace, generated by scripts/generate_profile.py. Contains the class hierarchy, property domains/ranges, and owl:Restriction cardinality blocks. |
profiles/profile.ttl |
W3C PROF manifest for the Fairscape profile (see below). |
tests/ |
pytest suite. Test fixtures under tests/test_rocrates/ are real conforming crates. |
Profile
This package implements the Fairscape Release RO-Crate Profile v0.1:
- Profile URI: https://w3id.org/fairscape/profile/0.1
- Specification: https://fairscape.github.io/profile/0.1/
- PROF manifest:
profiles/profile.ttl - EVI vocabulary:
profiles/evi-vocabulary.ttl
Every crate produced from the ROCrateMetadataElem model declares dct:conformsTo: https://w3id.org/fairscape/profile/0.1 on its Root Data Entity. This is the conformance signal — the Root entity's @type stays ["Dataset", "https://w3id.org/EVI#ROCrate"] and never includes "Profile". (Only the hand-authored Profile Crate published at the profile URI is Profile-typed.)
Regenerating derived artifacts
python scripts/generate_json_schemas.py
python scripts/generate_ts_types.py
python scripts/generate_profile.py profiles/evi-vocabulary.ttl
Tests
pytest
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fairscape_models-1.2.1.tar.gz.
File metadata
- Download URL: fairscape_models-1.2.1.tar.gz
- Upload date:
- Size: 164.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
932525de7731e47dbe1ea3878b8c70cd0374349465acf50f8327ab649099a053
|
|
| MD5 |
914f496cb8c20737fb75990f1b0f07ab
|
|
| BLAKE2b-256 |
a9b4cae4457a8e840ac51a38ca1b98ecc9abc1266a6884fedf2a763347a06f94
|
File details
Details for the file fairscape_models-1.2.1-py3-none-any.whl.
File metadata
- Download URL: fairscape_models-1.2.1-py3-none-any.whl
- Upload date:
- Size: 165.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c84939512df1ecf1ec1e2547932738d4b69886aa7133b64ccef4f02a209c80fd
|
|
| MD5 |
3b904ac20f492526373bcc47ab69dc8c
|
|
| BLAKE2b-256 |
f810580092cf07bf0aa2abc5aff17d70cff70e6eb6fb4a12ad645d3c56f5a760
|
