tkphd / pfhub-schema

Phase-field simulation and benchmark schema in LinkML

PFHub Schema

Phase-field simulation and benchmark schema in LinkML.

Website

pages.nist.gov/pfhub-schema

Repository Structure

• examples/ - example data
• project/ - project files (do not edit these)
• src/ - source files (edit these)
  • pfhub_schema
    • schema -- LinkML schema (edit this)
    • datamodel -- generated Python datamodel
• tests/ - Python tests

Developer Documentation

Use the make command to generate project artefacts:

• make all to make everything
• make deploy to deploy the website

Examples of Use

Some examples of LinkML in use are available from their documentation.

Linter

You can check that the pfhub_schema.yaml conforms to the LinkML specification using the linkml-lint tool:

linkml-lint src/pfhub_schema/schema/pfhub_schema.yaml

which is what happens when you

make lint

Validator

You can check that the example BenchmarkResult-001.yaml conforms to the PFHub schema using the linkml-validate tool:

linkml-validate -s src/pfhub_schema/schema/pfhub_schema.yaml examples/BenchmarkResult-001.yaml

Credits

This project was made with the LinkML cookiecutter. It is maintained by

• Trevor Keller (@tkphd), NIST