..
SPDX-FileCopyrightText: 2024 Ludwig Hülk <@Ludee> © Reiner Lemoine Institut
SPDX-License-Identifier: CC0-1.0
.. 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|
* - Publication
- |badge_pypi| |badge_python| |badge_pypi_downloads|
* - Development
- |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
* - Community
- |badge_contributing| |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 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 <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json>`_ contains an empty metadata string
- `example.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json>`_ contains a basic metadata example
- `metadata_key_description.md <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md>`_ contains a description of each metadata key
Documentation
=============
| The documentation is created with Markdown using `MkDocs <https://www.mkdocs.org/>`_.
| 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/ <https://openenergyplatform.github.io/oemetadata/>`_
Collaboration
=============
| Everyone is invited to develop this repository with good intentions.
| Please follow the workflow described in the `CONTRIBUTING.md <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 <.metadata/latest/build_source/>`_
License and Citation
====================
| The code of this repository is licensed under the **MIT License** (MIT).
| See `LICENSE.txt <LICENSE.txt>`_ for rights and obligations.
| See the *Cite this repository* function or `CITATION.cff <CITATION.cff>`_ for citation of this repository.
| Copyright: `OEMetadata <https://github.com/OpenEnergyPlatform/oemetadata/>`_ © `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ | `MIT <LICENSE.txt>`_
| The OEMetadata schema is licensed under `Creative Commons Zero v1.0 Universal <https://creativecommons.org/publicdomain/zero/1.0/>`_.
| The OEMetadata examples and templates are licensed under `Creative Commons Zero v1.0 Universal <https://creativecommons.org/publicdomain/zero/1.0/>`_.
.. |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
:target: https://openenergyplatform.github.io/oemetadata/
:alt: Documentation
.. |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://pypi.org/project/oemetadata/
:alt: PyPI Python Version
.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/oemetadata
:target: https://openenergyplatform.github.io/oemetadata/
:alt: PyPI Downloads
.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
:target: https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md
:alt: Contributions
.. |badge_repo_counts| image:: https://img.shields.io/endpoint?url=https%3A%2F%2Fhits.dwyl.com%2FOpenEnergyPlatform%2Foemetadata.svg&color=green
:alt: Counter
.. |badge_contributors| image:: https://img.shields.io/github/contributors/OpenEnergyPlatform/oemetadata
:target: https://github.com/OpenEnergyPlatform/oemetadata/graphs/contributors
:alt: Contributors
.. |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
Raw data
{
"_id": null,
"home_page": "https://github.com/OpenEnergyPlatform/oemetadata",
"name": "oemetadata",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "OEFamily OEP JSON metadata schema open energy",
"author": "Ludwig H\u00fclk",
"author_email": "ludwig.huelk@rl-institut.de",
"download_url": "https://files.pythonhosted.org/packages/5c/c5/91766f8b10ca6e6bea07f160402e93762bcd792730b0ca713b54b0dc4a89/oemetadata-2.0.2.tar.gz",
"platform": null,
"description": "..\n SPDX-FileCopyrightText: 2024 Ludwig H\u00fclk <@Ludee> \u00a9 Reiner Lemoine Institut\n\n SPDX-License-Identifier: CC0-1.0\n\n.. figure:: https://user-images.githubusercontent.com/14353512/245271998-794e9d73-e728-4993-9ecf-4d0d08d96827.png\n :align: left\n :target: https://github.com/OpenEnergyPlatform/oemetadata\n :alt: Repo logo\n\n=================================\nOpen Energy Metadata (OEMetadata)\n=================================\n\n**The energy metadata standard including a metadata schema, templates, and examples.**\n\n.. list-table::\n :widths: auto\n\n * - License\n - |badge_license| |badge_reuse|\n * - Documentation\n - |badge_documentation|\n * - Publication\n - |badge_pypi| |badge_python| |badge_pypi_downloads|\n * - Development\n - |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|\n * - Community\n - |badge_contributing| |badge_contributors| |badge_repo_counts|\n\n.. contents::\n :depth: 2\n :local:\n :backlinks: top\n\nIntroduction\n============\n| Open Energy Metadata (OEMetadata) is a metadata standard for the energy domain.\n| It is an extensive set of metadata based on the tabular data package specifications and the FAIR principles.\n| The metadata contains multiple fields (keys) in a nested JSON structure.\n\nYou can find the latest version right here:\n\n- `template.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/template.json>`_ contains an empty metadata string\n- `example.json <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/example.json>`_ contains a basic metadata example\n- `metadata_key_description.md <https://github.com/OpenEnergyPlatform/oemetadata/blob/production/metadata/latest/metadata_key_description.md>`_ contains a description of each metadata key\n\nDocumentation\n=============\n| The documentation is created with Markdown using `MkDocs <https://www.mkdocs.org/>`_.\n| All files are stored in the ``docs`` folder of the repository.\n| A **GitHub Actions** deploys the ``production`` branch on a **GitHub Page**.\n| The documentation page is `openenergyplatform.github.io/oemetadata/ <https://openenergyplatform.github.io/oemetadata/>`_\n\nCollaboration\n=============\n| Everyone is invited to develop this repository with good intentions.\n| Please follow the workflow described in the `CONTRIBUTING.md <CONTRIBUTING.md>`_.\n| Development work that aims to extend the oemetadata specification is added to the build_source/schemas/ directory for each release.\n| To generate the schema, template & example JSON files see your script based `tooling <.metadata/latest/build_source/>`_ \n\nLicense and Citation\n====================\n| The code of this repository is licensed under the **MIT License** (MIT).\n| See `LICENSE.txt <LICENSE.txt>`_ for rights and obligations.\n| See the *Cite this repository* function or `CITATION.cff <CITATION.cff>`_ for citation of this repository.\n| Copyright: `OEMetadata <https://github.com/OpenEnergyPlatform/oemetadata/>`_ \u00a9 `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ | `MIT <LICENSE.txt>`_\n| The OEMetadata schema is licensed under `Creative Commons Zero v1.0 Universal <https://creativecommons.org/publicdomain/zero/1.0/>`_.\n| The OEMetadata examples and templates are licensed under `Creative Commons Zero v1.0 Universal <https://creativecommons.org/publicdomain/zero/1.0/>`_.\n\n\n.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/oemetadata\n :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/production/LICENSE.txt\n :alt: License\n\n.. |badge_reuse| image:: https://api.reuse.software/badge/github.com/OpenEnergyPlatform/oemetadata\n :target: https://api.reuse.software/info/github.com/OpenEnergyPlatform/oemetadata\n :alt: REUSE\n\n.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oemetadata/documentation.yml\n :target: https://openenergyplatform.github.io/oemetadata/\n :alt: Documentation\n\n.. |badge_pypi| image:: https://img.shields.io/pypi/v/oemetadata\n :target: https://pypi.org/project/oemetadata/\n :alt: PyPI Version\n\n.. |badge_python| image:: https://img.shields.io/pypi/pyversions/oemetadata\n :target: https://pypi.org/project/oemetadata/\n :alt: PyPI Python Version\n\n.. |badge_pypi_downloads| image:: https://img.shields.io/pypi/dm/oemetadata\n :target: https://openenergyplatform.github.io/oemetadata/\n :alt: PyPI Downloads\n\n.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat\n :target: https://github.com/OpenEnergyPlatform/oemetadata/blob/develop/CONTRIBUTING.md\n :alt: Contributions\n\n.. |badge_repo_counts| image:: https://img.shields.io/endpoint?url=https%3A%2F%2Fhits.dwyl.com%2FOpenEnergyPlatform%2Foemetadata.svg&color=green\n :alt: Counter\n\n.. |badge_contributors| image:: https://img.shields.io/github/contributors/OpenEnergyPlatform/oemetadata\n :target: https://github.com/OpenEnergyPlatform/oemetadata/graphs/contributors\n :alt: Contributors\n\n.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/oemetadata\n :target: https://github.com/OpenEnergyPlatform/oemetadata/issues\n :alt: Open issues\n\n.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/oemetadata\n :target: https://github.com/OpenEnergyPlatform/oemetadata/issues?q=is%3Aissue+is%3Aclosed\n :alt: Closed issues\n\n.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/oemetadata\n :target: https://github.com/OpenEnergyPlatform/oemetadata/pulls\n :alt: Open PR\n\n.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/oemetadata\n :target: https://github.com/OpenEnergyPlatform/oemetadata/pulls?q=is%3Apr+is%3Aclosed\n :alt: Closed PR\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Open Energy Metadata (OEMetadata) - The energy metadata standard",
"version": "2.0.2",
"project_urls": {
"Homepage": "https://github.com/OpenEnergyPlatform/oemetadata"
},
"split_keywords": [
"oefamily",
"oep",
"json",
"metadata",
"schema",
"open",
"energy"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f09ac7f8c6cc48f4448ea3a842ee4449b8f1a55bfdeeeecfeba68d80e4b6b01f",
"md5": "30ed29fb687bf2d2b082198f955ef8b5",
"sha256": "11137bd55f461aa70586c5fe88ce603d364ccba8b68db6cbdab02727dbdf4cff"
},
"downloads": -1,
"filename": "oemetadata-2.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "30ed29fb687bf2d2b082198f955ef8b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 26906,
"upload_time": "2025-01-24T10:43:51",
"upload_time_iso_8601": "2025-01-24T10:43:51.519876Z",
"url": "https://files.pythonhosted.org/packages/f0/9a/c7f8c6cc48f4448ea3a842ee4449b8f1a55bfdeeeecfeba68d80e4b6b01f/oemetadata-2.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5cc591766f8b10ca6e6bea07f160402e93762bcd792730b0ca713b54b0dc4a89",
"md5": "8f50e7db946c9f32a568ef9486f239f6",
"sha256": "f7a1cb55f5bb0857640eb0a7095c89f14c14d5a632df7a57be81d89decb79cb3"
},
"downloads": -1,
"filename": "oemetadata-2.0.2.tar.gz",
"has_sig": false,
"md5_digest": "8f50e7db946c9f32a568ef9486f239f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 21233,
"upload_time": "2025-01-24T10:43:53",
"upload_time_iso_8601": "2025-01-24T10:43:53.215987Z",
"url": "https://files.pythonhosted.org/packages/5c/c5/91766f8b10ca6e6bea07f160402e93762bcd792730b0ca713b54b0dc4a89/oemetadata-2.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 10:43:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenEnergyPlatform",
"github_project": "oemetadata",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "argparse",
"specs": []
},
{
"name": "black",
"specs": []
},
{
"name": "build",
"specs": []
},
{
"name": "isort",
"specs": []
},
{
"name": "jsonschema",
"specs": []
},
{
"name": "mike",
"specs": []
},
{
"name": "mkdocs",
"specs": []
},
{
"name": "mkdocs-material",
"specs": []
},
{
"name": "mkdocstrings",
"specs": []
},
{
"name": "pytest",
"specs": []
},
{
"name": "referencing",
"specs": []
},
{
"name": "tox",
"specs": []
},
{
"name": "twine",
"specs": []
},
{
"name": "wheel",
"specs": []
},
{
"name": "pyld",
"specs": []
}
],
"tox": true,
"lcname": "oemetadata"
}
JSON
