.. SPDX-FileCopyrightText: oeplatform https://github.com/OpenEnergyPlatform/oeplatform SPDX-License-Identifier: CC0-1.0

.. figure:: https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/docs/img/banner_oefamily_oep.png :align: left :target: https://github.com/OpenEnergyPlatform/oeplatform/ :alt: OEP Logo

========================== Open Energy Platform (OEP)

The Open Energy Platform (OEP) is research data infrastructure for the energy, climate and mobility domain.

.. list-table:: :widths: auto

• • License
  • |badge_license| |badge_reuse|
• • Documentation
  • |badge_documentation| |badge_mkdocs| |DeepWiki|
• • Tests
  • |badge_tox| |badge_precommit|
• • Publication
• • 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

| The Open Energy Family promotes quality, transparency, and reproducibility in energy system research through a collection of tools. | The primary module, the Open Energy Platform (OEP), offers a web interface for accessing various tools and the community database.

Documentation

| The documentation is created with Markdown using MkDocs <https://www.mkdocs.org/>_ and mike <https://github.com/jimporter/mike>. | All files are stored in the docs folder of the repository. | A GitHub Actions deploys the develop branch on a GitHub Page. | The documentation page is: openenergyplatform.github.io/oeplatform/ <https://openenergyplatform.github.io/oeplatform/>

Collaboration

| Everyone is invited to develop this repository with good intentions. | Please follow the workflow described in the CONTRIBUTING.md <https://github.com/OpenEnergyPlatform/oeplatform/blob/master/CONTRIBUTING.md>_.

Contributors:

.. figure:: https://contrib.rocks/image?repo=OpenEnergyPlatform/oeplatform :align: left :target: https://github.com/OpenEnergyPlatform/oeplatform/graphs/contributors :alt: contrib.rocks

License and Citation

| The code of this repository is licensed under the GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later). | Authorship and license for each file are documented using REUSE <https://api.reuse.software/info/github.com/OpenEnergyPlatform/oeplatform>_ specification. | See LICENSE.txt <https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/LICENSE.txt>_ for rights and obligations. | See the Cite this repository function or CITATION.cff <https://github.com/OpenEnergyPlatform/oeplatform/blob/master/CITATION.cff>_ for citation of this repository. | Copyright: oeplatform <https://github.com/OpenEnergyPlatform/oeplatform/>_ © OEP-Developers | AGPL-3.0-or-later <LICENSE.txt>_

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

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

.. |badge_documentation| image:: https://img.shields.io/github/actions/workflow/status/OpenEnergyPlatform/oeplatform/deploy-docs.yaml?branch=develop&label=documentation :target: https://openenergyplatform.github.io/oeplatform/ :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/oeplatform/automated-testing.yaml?label=tox :target: https://github.com/OpenEnergyPlatform/oeplatform/actions/workflows/automated-testing.yaml :alt: Tox Tests

.. |badge_precommit| image:: https://results.pre-commit.ci/badge/github/OpenEnergyPlatform/oeplatform/develop.svg :target: https://results.pre-commit.ci/latest/github/OpenEnergyPlatform/oeplatform/develop :alt: pre-commit.ci status

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

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

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

.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/oeplatform :target: https://github.com/OpenEnergyPlatform/oeplatform/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/oeplatform/blob/master/CONTRIBUTING.md :alt: Contributions

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

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

.. |DeepWiki| image:: https://deepwiki.com/badge.svg :target: https://deepwiki.com/OpenEnergyPlatform/oeplatform :alt: Devin DeepWiki