oemetadata 2.0.4

Open Energy Metadata (OEMetadata) - The energy metadata standard

Open Energy Metadata (OEMetadata)

The energy metadata standard including a metadata schema, templates, and examples.

License
Documentation
Tests
Publication
Development
Community

• Introduction

• Documentation

• Collaboration

• License and Citation

Introduction

Open Energy Metadata (OEMetadata) is a metadata standard for the energy domain.

It is an extensive set of metadata based on the tabular data package specifications and the FAIR principles.

The metadata contains multiple fields (keys) in a nested JSON structure.

You can find the latest version right here:

• template.json contains an empty metadata string

• example.json contains a basic metadata example

• metadata_key_description.md contains a description of each metadata key

Documentation

The documentation is created with Markdown using MkDocs.

All files are stored in the docs folder of the repository.

A GitHub Actions deploys the production branch on a GitHub Page.

The documentation page is openenergyplatform.github.io/oemetadata/

Collaboration

Everyone is invited to develop this repository with good intentions.

Please follow the workflow described in the CONTRIBUTING.md.

Development work that aims to extend the oemetadata specification is added to the build_source/schemas/ directory for each release.

To generate the schema, template & example JSON files see your script based tooling

Contributors:

License and Citation

The code of this repository is licensed under the MIT License (MIT).

See LICENSE.txt for rights and obligations.

See the Cite this repository function or CITATION.cff for citation of this repository.

Copyright: OEMetadata © Reiner Lemoine Institut | MIT

The OEMetadata schema is licensed under Creative Commons Zero v1.0 Universal.

The OEMetadata examples and templates are licensed under Creative Commons Zero v1.0 Universal.