osc-em / OSCEM_Schemas

BSD 3-Clause "New" or "Revised" License
1 stars 1 forks source link

OSCEM schemas

Schema for the Open Standards Community for Electron Microscopy (OSC-EM): Defining the electron microscopy-related fields required by the OSCEM standard.

Overview

The OSCEM schemas are designed to standardize metadata for electron microscopy, structured modularly to accommodate various methods and use cases. Each module can represent different aspects of an experiment, such as "sample", "instrument", and "author." These modules are combined into a comprehensive schema that defines the required metadata for a specific method. This standard ensures consistency in data collection, facilitates data validation, and enhances comparability between datasets.

To increase compatibility with different formats, we utilize LinkML, which allows us to export the schema to widely used formats.

Currently implemented methods

Life sciences:

Usage

All schemas are available in YAML format under the directory src/oscemschemas/schema. Files prefixed with oscem refer to collections of subschemas, such as those for single particle analysis. Schemas with more specific names, like "instrument," represent individual subschemas that can be modularly incorporated into oscem_ schemas. By using LinkML generator functions, these schemas can be exported to various formats such as JSON Schema, JSON-LD, OWL, CSV and RDF. For metadata validation, we recommend using the JSON Schema versions.

Note

Current versions are a work in progress, details might change.

Website

Here you can browse all our keywords for single particle analysis with descriptions: https://osc-em.github.io/OSCEM_Schemas/

Repository Structure

Developer Documentation

Use the `make` command to generate project artifacts: * `make setup`: one-time setup * `make all`: make everything * `make deploy`: deploys site * `make lint`: check syntax * `make test`: run tests * `make serve`: run docs locally on http://127.0.0.1:8000/oscem-schemas/ * `make clean` : remove generated files

Credits

This project was made with linkml-project-cookiecutter.