Welcome to metadata-schema’s documentation!

The metadata-schema repository provides standardized metadata schemas for the echemdb project. Schemas are defined in LinkML and used to validate and describe electrochemical data packages.

The mdstools Python package provides tools for working with these schemas:

• Flatten nested YAML metadata into tabular (Excel/CSV) format

• Enrich flattened metadata with descriptions and examples from the schemas

• Validate metadata against the schemas

• Convert between YAML, Excel, and CSV formats

JSON Schemas (v0.5.1)

The following JSON Schema files can be used to validate metadata in any language or tool that supports JSON Schema:

Schema	Download
Autotag	autotag.json
Minimum echemdb	minimum_echemdb.json
Source Data	source_data.json
SVG Digitizer	svgdigitizer.json
echemdb Package	echemdb_package.json
SVG Digitizer Package	svgdigitizer_package.json

Getting started

See the installation guide for setup instructions.

Contents

• Installation
  • Using pixi (recommended)
  • Using pip
• Usage
  • Command-line interface
  • Python API
• Schema Reference
  • Available schemas
  • Schema generation
  • Validation
  • Schema details
• Example Files
  • Object schemas
  • File schemas
• API Reference
  • Metadata
  • Schema Enricher
  • Validator
  • Converters
  • CLI Entrypoint