miaard

Minimum Information about any Radiocarbon Determination

Documentation Website

https://MIxS-MInAS.github.io/miaard

Repository Structure

• docs/ - mkdocs-managed documentation
  • elements/ - generated schema documentation
• examples/ - Examples of using the schema
• project/ - project files (these files are auto-generated, do not edit)
• src/ - source files (edit these)
  • c14
    • schema/ -- LinkML schema (edit this)
    • datamodel/ -- generated Python datamodel
• tests/ - Python tests
  • data/ - Example data

User Information

To validate the schema you will need LinkML installed.

As an example, you can see the contents of examples/example-1.csv of an example of a radiocarbon determination collection that can be validated against the schema.

lab_id,conventional_age
MAMS 81038,4468

To validate, you then run the following command:

linkml-validate --schema src/c14/schema/c14.yaml --target-class RadiocarbonDate examples/example-1.csv

Developer Tools

Set up

After cloning the repository, you will need uv, just and pre-commit to run the developer commands.

To install with pipx:

pipx install uv
pipx install just
pipx install pre-commit

Running Commands

There are several pre-defined command-recipes available. They are written for the command runner just. To list all pre-defined commands, run just or just --list.

A typical workflow is:

## Testing
just test
just lint
just testdoc

## Pushing
just site
pre-commit run -a

Credits

This project uses the template linkml-project-copier published as doi:10.5281/zenodo.15163584.