oemetadata

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

https://github.com/openenergyplatform/oemetadata

Keywords

Keywords from Contributors

Repository

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

README.rst

..
  SPDX-FileCopyrightText: 2024 Ludwig Hülk  © Reiner Lemoine Institut
  SPDX-FileCopyrightText: oemetadata 
  SPDX-License-Identifier: MIT

.. figure:: https://user-images.githubusercontent.com/14353512/245271998-794e9d73-e728-4993-9ecf-4d0d08d96827.png
    :align: left
    :target: https://github.com/OpenEnergyPlatform/oemetadata
    :alt: Repo logo

=================================
Open Energy Metadata (OEMetadata)
=================================

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

.. list-table::
   :widths: auto

   * - License
     - |badge_license| |badge_reuse|
   * - Documentation
     - |badge_documentation| |badge_mkdocs|
   * - Tests
     - |badge_tox| |badge_codecov|
   * - Publication
     - |badge_pypi| |badge_python| |badge_pypi_downloads| |badge_zenodo|
   * - Standard Catalogs
     - |badge_fairsharing| |badge_rda|
   * - Development
     - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
   * - Community
     - |badge_contributions| |badge_contributors| |badge_repo_counts|

.. contents::
    :depth: 2
    :local:
    :backlinks: top

Introduction
============
| Open Energy Metadata (OEMetadata) is a metadata standard for the energy domain.
| It is an extensive set of metadata based on the Frictionless `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:

- `schema.json `_ contains the json schema for the metadata standard.
- `context.json `_ contains the references of metadata keys in ontology terms.
- `template.json `_ contains an empty metadata string with all fields.
- `example.json `_ contains a basic metadata example.
- `metadata_key_description.md `_ contains a detailed 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 the scripts based `tooling `_

Contributors:

.. figure:: https://contrib.rocks/image?repo=OpenEnergyPlatform/oemetadata
    :align: left
    :target: https://github.com/OpenEnergyPlatform/oemetadata/graphs/contributors
    :alt: [contrib.rocks](https://contrib.rocks)

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 `_.


.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt
    :alt: License

.. |badge_reuse| image:: https://api.reuse.software/badge/github.com/OpenEnergyPlatform/oemetadata
    :target: https://api.reuse.software/info/github.com/OpenEnergyPlatform/oemetadata
    :alt: REUSE

.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oemetadata/documentation.yml?branch=develop&label=documentation
    :target: https://openenergyplatform.github.io/oemetadata/
    :alt: Documentation

.. |badge_mkdocs| image:: https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=flat&logo=MaterialForMkDocs&logoColor=white&color=grey
    :target: https://squidfunk.github.io/mkdocs-material/
    :alt: MkDocs

.. |badge_tox| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oemetadata/tox.yml?label=tox
    :target: https://github.com/OpenEnergyPlatform/oemetadata/actions/workflows/tox.yml
    :alt: Tox Tests

.. |badge_codecov| image:: https://codecov.io/gh/OpenEnergyPlatform/oemetadata/graph/badge.svg?token=HY4TZGSG4N
    :target: https://codecov.io/gh/OpenEnergyPlatform/oemetadata
    :alt: Codecov

.. |badge_pypi| image:: https://img.shields.io/pypi/v/oemetadata
    :target: https://pypi.org/project/oemetadata/
    :alt: PyPI Version

.. |badge_python| image:: https://img.shields.io/pypi/pyversions/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/pyproject.toml
    :alt: PyPI Python Version

.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/oemetadata
    :target: https://pypi.org/project/oemetadata/
    :alt: PyPI Downloads

.. |badge_zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.15019562.svg
    :target: https://doi.org/10.5281/zenodo.15019562
    :alt: Zenodo

.. |badge_fairsharing| image:: https://img.shields.io/badge/DOI-10.25504%2FFAIRsharing.777897-blue?style=flat
    :target: https://doi.org/10.25504/FAIRsharing.777897
    :alt: FAIRsharing

.. |badge_rda| image:: https://img.shields.io/badge/RDA%20MSC-msc%3Am128-blue?style=flat
    :target: https://rdamsc.bath.ac.uk/msc/m128
    :alt: RDA MSC

.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/issues
    :alt: Open Issues

.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/issues?q=is%3Aissue+is%3Aclosed
    :alt: Closed Issues

.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/pulls
    :alt: Open PR

.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/pulls?q=is%3Apr+is%3Aclosed
    :alt: Closed PR

.. |badge_contributions| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
    :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/CONTRIBUTING.md
    :alt: Contributions

.. |badge_contributors| image:: https://img.shields.io/github/contributors/OpenEnergyPlatform/oemetadata
    :target: https://github.com/OpenEnergyPlatform/oemetadata/graphs/contributors
    :alt: Contributors

.. |badge_repo_counts| image:: https://hits.sh/github.com/OpenEnergyPlatform/oemetadata.svg
    :target: https://hits.sh/github.com/OpenEnergyPlatform/oemetadata/
    :alt: Hits

Owner

Citation (CITATION.cff)

# SPDX-FileCopyrightText: 2023 Jonas Huber <@jh-RLI> © Reiner Lemoine Institut
# SPDX-FileCopyrightText: 2023 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
# SPDX-FileCopyrightText: oemetadata <https://github.com/OpenEnergyPlatform/oemetadata/>
# SPDX-License-Identifier: CC0-1.0

cff-version: 1.2.0
message: "If you use this software, please cite it using these metadata."
authors:
  - family-names: "Hülk"
    given-names: "Ludwig"
    alias: "@Ludee"
    website: "https://github.com/Ludee"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0003-4655-2321"
  - family-names: "Huber"
    given-names: "Jonas"
    alias: "@jh-RLI"
    website: "https://github.com/jh-RLI"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0002-6234-0751"
  - family-names: "Hofmann"
    given-names: "Christian"
    alias: "@christian-rli"
    website: "https://github.com/christian-rli"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0003-4520-7008"
  - family-names: "Muschner"
    given-names: "Christoph"
    alias: "@chrwm"
    website: "https://github.com/chrwm"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0001-8144-5260"
title: "Open Energy Family - Open Energy Metadata (OEMetadata)"
type: software
license: MIT
version: 2.0.4
doi:
date-released: 2025-01-24
url: "https://github.com/OpenEnergyPlatform/oemetadata"

GitHub Events

Committers

Last synced: about 2 years ago

Issues and Pull Requests

Last synced: 6 months ago

Packages