metrology-atlas¶
The engine that turns this dataset's YAML files into the atlas JSON and this site.
| Repository | github.com/metrology-atlas/metrology-atlas |
| Branch | main |
| Visibility | public |
| Licence | MIT |
| Language | Python 3.11+ (pyyaml); the site is built with Zensical |
What it is¶
Nothing in the engine is specific to VitalDB. A dataset is a folder of YAML files, one per item, which the engine checks (types, references, figures, code paths, forbidden patterns such as record identifiers), compiles to one JSON file, and writes as this site, including the planner and the accuracy chart.
Install¶
python -m metrology_atlas check datasets/vitaldb
python -m metrology_atlas json datasets/vitaldb --out build/vitaldb.metrology.json
python -m metrology_atlas site datasets/vitaldb --out build/vitaldb # then: zensical build, in that folder
What is in it¶
model.py |
The schema: every kind of item and its fields. |
load.py |
Loads and checks a dataset folder, and derives the relations stated on the other side. |
code.py |
Code references and their links into repositories. |
site.py |
Writes the site, one page per item. |
planner.py |
The synchronisation planner. |
chart.py |
The accuracy-against-resolution chart. |