Skip to content

About

Conversion of QUDT ontology to LinkML

Topics

Resources

Stars

9 stars

Watchers

0 watching

Forks

Repository files navigation

QUDT LinkML Model

Documentation Open in Codespaces

A LinkML model for the QUDT (Quantities, Units, Dimensions and Types) ontology.

⚠️ Early Stage Project: This is a first draft attempt at converting the QUDT ontology to LinkML. It likely contains issues and limitations. Please report problems via GitHub Issues!

Quick Links

What This Provides

  • QUDT main ontology class hierarchy in LinkML format
  • Generated artifacts in multiple formats:
    • Python dataclasses and Pydantic models
    • JSON Schema, TypeScript, SQL DDL
    • OWL/RDF, SHACL, ShEx (OWL is regenerated from LinkML)
    • Protocol Buffers, Prefix maps
  • Documentation
  • Validation tools and examples (TODO)

See the project/ directory for all generated artifacts.

Development

Prerequisites

  • Python 3.12+
  • uv

Installation

# Install dependencies
uv sync --group dev

Regenerate Artifacts

# Regenerate all project artifacts
just gen-project

Documentation Website

This project includes a static documentation website built with MkDocs:

# Serve documentation locally (auto-updates on file changes)
just serve-docs

# Build static site to site/ directory
just build-docs

# Deploy to GitHub Pages
just deploy-docs

Visit the live site at: https://vladistan.github.io/linkml-qudt

Contributing

We welcome contributions! This is an early draft and there's much room for improvement. Areas where help is particularly appreciated:

  • Improving the schema structure and class hierarchies
  • Adding better documentation and examples
  • Identifying and fixing conversion issues
  • Adding validation rules and constraints
  • Creating example data and use cases
  • Improving alignment with QUDT semantics
  • Testing and validation

Please open an issue or pull request if you have suggestions or improvements!

Resources

  • LinkML - Modeling language framework
  • QUDT - Quantities, Units, Dimensions and Types ontology
  • Documentation Site - Full project documentation

License

The QUDT ontology is licensed under Creative Commons Attribution 4.0 International License. Please refer to the QUDT license page for details.

This LinkML model derivative is provided as-is for community use and improvement.

Questions?

About

Conversion of QUDT ontology to LinkML

Topics

Resources

Stars

9 stars

Watchers

0 watching

Forks

Contributors

Languages