.. image:: docs/images/README_HeaderThreePartners.svg
:align: left
:target: https://github.com/OpenEnergyPlatform/open-MaStR
:alt: MaStR logo
==========
open-mastr
==========
**A package that provides an interface for downloading and processing the Marktstammdatenregister (MaStR)**
.. list-table::
:widths: 10, 50
* - License
- |badge_license|
* - Documentation
- |badge_rtd|
* - Tests
- |badge_ci|
* - Publication
- |badge_pypi| |badge_joss|
* - Data Publication
- |badge_zenodo|
* - Development
- |badge_issue_open| |badge_issue_closes| |badge_pr_open| |badge_pr_closes|
* - Community
- |badge_contributing| |badge_contributors| |badge_repo_counts| |PyPI download month| |Total PyPI downloads|
.. contents::
:depth: 2
:local:
:backlinks: top
Introduction
============
The `Marktstammdatenregister (MaStR) <https://www.marktstammdatenregister.de/MaStR>`_ is a German register
provided by the German Federal Network Agency (Bundesnetzagentur / BNetza) that keeps track of all power and gas units located in Germany.
The MaStR data can be
#. browsed and filtered `online <https://www.marktstammdatenregister.de/MaStR>`_
#. taken from `daily provided dumps <https://www.marktstammdatenregister.de/MaStR/Datendownload>`_
#. be accessed via the `web service <https://www.marktstammdatenregister.de/MaStRHilfe/subpages/webdienst.html>`_
| The python package ``open-mastr`` provides an interface for accessing the data.
| It contains methods to download and parse the xml files (bulk) and the SOAP web service (API).
| In this repository we are developing methods to analyze, validate and enrich the data.
| We want to collect and compile post processing scripts to improve data quality.
Documentation
=============
| The documentation is in `Material for Mkdocs <https://squidfunk.github.io/mkdocs-material/>`_ markdown format in the ``doc`` sub-folder of the repository.
| Find the `documentation <https://open-mastr.readthedocs.io/en/latest/>`_ hosted on ReadTheDocs.
| The original API documentation can be found on the `Webhilfe des Marktstammdatenregisters <https://www.marktstammdatenregister.de/MaStRHilfe/subpages/webdienst.html>`_.
Installation
============
| It is recommended to use a virtual python environment, for example `conda <https://docs.conda.io/en/latest/miniconda.html>`_ or `virtualenv <https://virtualenv.pypa.io/en/latest/installation.html>`_.
| The package is intended to be used with ``Python >=3.8``.
PyPI
----
Install the current release of ``open-mastr`` with ``pip``:
.. code-block:: python
pip install open-mastr
GitHub
------
For development, clone this repository manually.
.. code-block:: python
git clone git@github.com:OpenEnergyPlatform/open-MaStR.git
cd open-MaStR
Setup the conda environment with
.. code-block:: python
conda env create -f environment.yml
Install the package with
.. code-block:: python
pip install "open_mastr[dev]"
Examples of Usage
==================
If you want to see your project in this list, write an
`Issue <https://github.com/OpenEnergyPlatform/open-MaStR/issues>`_ or add
changes in a `Pull Request <https://github.com/OpenEnergyPlatform/open-MaStR/pulls>`_.
- `PV- und Windflächenrechner <https://www.agora-energiewende.de/service/pv-und-windflaechenrechner/>`_
- `Wasserstoffatlas <https://wasserstoffatlas.de/>`_
- `EE-Status App <https://ee-status.de/>`_
- `Digiplan Anhalt <https://digiplan.rl-institut.de/>`_
- `Data Quality Assessment of the MaStR <https://marktstammdaten.kotthoff.dev/>`_
External Resources
===================
Besides open-mastr, some other resources exist that ease the process of working with the Marktstammdatenregister:
- If you are interested in browsing the MaStR online, check out the github organisation `Marktstammdatenregister.dev <https://github.com/marktstammdatenregister-dev>`_.
- The `bundesAPI/Marktstammdaten-API <https://github.com/bundesAPI/marktstammdaten-api>`_ is another implementation to access data via an official API.
Collaboration
=============
| Everyone is invited to develop this repository with good intentions.
| Please follow the workflow described in the `CONTRIBUTING.md <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/CONTRIBUTING.md>`_.
License and Citation
====================
Software
--------
| This repository is licensed under the **GNU Affero General Public License v3.0 or later** (AGPL-3.0-or-later).
| See `LICENSE.md <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/LICENSE.md>`_ for rights and obligations.
| See the *Cite this repository* function or `CITATION.cff <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/CITATION.cff>`_ for citation of this repository.
| Copyright: `open-MaStR <https://github.com/OpenEnergyPlatform/open-MaStR/>`_ © `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ © `fortiss <https://www.fortiss.org/>`_ © `OFFIS <https://www.offis.de/>`_ | `AGPL-3.0-or-later <https://www.gnu.org/licenses/agpl-3.0.txt>`_
Data
----
| The data has the license **Datenlizenz Deutschland – Namensnennung – Version 2.0** (DL-DE-BY-2.0)
| Copyright: `Marktstammdatenregister <https://www.marktstammdatenregister.de/MaStR>`_ - © Bundesnetzagentur für Elektrizität, Gas, Telekommunikation, Post und Eisenbahnen | `DL-DE-BY-2.0 <https://www.govdata.de/dl-de/by-2-0>`_
.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/open-MaStR
:target: LICENSE.txt
:alt: License
.. |badge_rtd| image:: https://readthedocs.org/projects/open-mastr/badge/?style=flat
:target: https://open-mastr.readthedocs.io/en/latest/
:alt: Read the Docs
.. |badge_ci| image:: https://github.com/OpenEnergyPlatform/open-MaStR/workflows/CI/badge.svg
:target: https://github.com/OpenEnergyPlatform/open-MaStR/actions?query=workflow%3ACI
:alt: GitHub Actions
.. |badge_pypi| image:: https://img.shields.io/pypi/v/open-mastr.svg
:target: https://pypi.org/project/open-mastr/
:alt: PyPI
.. |badge_zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6807426.svg
:target: https://doi.org/10.5281/zenodo.6807425
:alt: zenodo
.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/open-MaStR
:alt: open issues
.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/open-MaStR
:alt: closes issues
.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/open-MaStR
:alt: closes issues
.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/open-MaStR
:alt: closes issues
.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat
:alt: contributions
.. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square
:alt: contributors
.. |badge_repo_counts| image:: https://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg
:alt: counter
.. |PyPI download month| image:: https://img.shields.io/pypi/dm/open-mastr?label=PyPi%20Downloads
:target: https://pypistats.org/packages/open-mastr
.. |Total PyPI downloads| image:: https://static.pepy.tech/badge/open-mastr
:target: https://pepy.tech/project/open-mastr
.. |badge_joss| image:: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e/status.svg
:target: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e
Raw data
{
"_id": null,
"home_page": null,
"name": "open-mastr",
"maintainer": "Florian Kotthoff, Christoph Muschner",
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": "Jonathan Amme <jonathan.amme@rl-institut.de>, Ludwig H\u00fclk <datenzentrum@rl-institut.de>",
"keywords": "Markstammdatenregister, Energy, Dataset, Solar, Wind, Energy-data, OEP, OpenEnergyFamily",
"author": "H\u00fclk Ludwig, Ple\u00dfmann Guido, Muschner Christoph, Kotthoff Florian, Tepe Deniz, Amme Jonathan, Open Energy Family",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/6d/8b/af613f18d80c9e7336720bfaea5f2539953c525f8c93ee00ee7f41afba40/open_mastr-0.14.5.tar.gz",
"platform": null,
"description": "\n.. image:: docs/images/README_HeaderThreePartners.svg\n :align: left\n :target: https://github.com/OpenEnergyPlatform/open-MaStR\n :alt: MaStR logo\n\n==========\nopen-mastr\n==========\n\n**A package that provides an interface for downloading and processing the Marktstammdatenregister (MaStR)**\n\n.. list-table::\n :widths: 10, 50\n\n * - License\n - |badge_license|\n * - Documentation\n - |badge_rtd|\n * - Tests\n - |badge_ci|\n * - Publication\n - |badge_pypi| |badge_joss|\n * - Data Publication\n - |badge_zenodo|\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| |PyPI download month| |Total PyPI downloads|\n \n\n.. contents::\n :depth: 2\n :local:\n :backlinks: top\n\nIntroduction\n============\n\nThe `Marktstammdatenregister (MaStR) <https://www.marktstammdatenregister.de/MaStR>`_ is a German register \nprovided by the German Federal Network Agency (Bundesnetzagentur / BNetza) that keeps track of all power and gas units located in Germany.\n\nThe MaStR data can be\n \n#. browsed and filtered `online <https://www.marktstammdatenregister.de/MaStR>`_\n#. taken from `daily provided dumps <https://www.marktstammdatenregister.de/MaStR/Datendownload>`_\n#. be accessed via the `web service <https://www.marktstammdatenregister.de/MaStRHilfe/subpages/webdienst.html>`_\n\n| The python package ``open-mastr`` provides an interface for accessing the data. \n| It contains methods to download and parse the xml files (bulk) and the SOAP web service (API).\n| In this repository we are developing methods to analyze, validate and enrich the data.\n| We want to collect and compile post processing scripts to improve data quality.\n\n\nDocumentation\n=============\n\n| The documentation is in `Material for Mkdocs <https://squidfunk.github.io/mkdocs-material/>`_ markdown format in the ``doc`` sub-folder of the repository.\n| Find the `documentation <https://open-mastr.readthedocs.io/en/latest/>`_ hosted on ReadTheDocs.\n\n| The original API documentation can be found on the `Webhilfe des Marktstammdatenregisters <https://www.marktstammdatenregister.de/MaStRHilfe/subpages/webdienst.html>`_.\n\n\nInstallation\n============\n\n| It is recommended to use a virtual python environment, for example `conda <https://docs.conda.io/en/latest/miniconda.html>`_ or `virtualenv <https://virtualenv.pypa.io/en/latest/installation.html>`_.\n| The package is intended to be used with ``Python >=3.8``.\n\n\nPyPI\n----\n\nInstall the current release of ``open-mastr`` with ``pip``:\n\n.. code-block:: python\n\n pip install open-mastr\n\nGitHub\n------\n\nFor development, clone this repository manually.\n\n.. code-block:: python\n\n git clone git@github.com:OpenEnergyPlatform/open-MaStR.git\n cd open-MaStR\n\nSetup the conda environment with\n\n.. code-block:: python\n\n conda env create -f environment.yml\n\nInstall the package with\n\n.. code-block:: python\n\n pip install \"open_mastr[dev]\"\n\n\nExamples of Usage\n==================\nIf you want to see your project in this list, write an \n`Issue <https://github.com/OpenEnergyPlatform/open-MaStR/issues>`_ or add\nchanges in a `Pull Request <https://github.com/OpenEnergyPlatform/open-MaStR/pulls>`_.\n\n- `PV- und Windfl\u00e4chenrechner <https://www.agora-energiewende.de/service/pv-und-windflaechenrechner/>`_\n- `Wasserstoffatlas <https://wasserstoffatlas.de/>`_\n- `EE-Status App <https://ee-status.de/>`_\n- `Digiplan Anhalt <https://digiplan.rl-institut.de/>`_\n- `Data Quality Assessment of the MaStR <https://marktstammdaten.kotthoff.dev/>`_\n\nExternal Resources\n===================\nBesides open-mastr, some other resources exist that ease the process of working with the Marktstammdatenregister:\n- If you are interested in browsing the MaStR online, check out the github organisation `Marktstammdatenregister.dev <https://github.com/marktstammdatenregister-dev>`_.\n- The `bundesAPI/Marktstammdaten-API <https://github.com/bundesAPI/marktstammdaten-api>`_ is another implementation to access data via an official API.\n\nCollaboration\n=============\n| Everyone is invited to develop this repository with good intentions.\n| Please follow the workflow described in the `CONTRIBUTING.md <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/CONTRIBUTING.md>`_.\n\n\nLicense and Citation\n====================\n\nSoftware\n--------\n\n| This repository is licensed under the **GNU Affero General Public License v3.0 or later** (AGPL-3.0-or-later).\n| See `LICENSE.md <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/LICENSE.md>`_ for rights and obligations.\n| See the *Cite this repository* function or `CITATION.cff <https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/CITATION.cff>`_ for citation of this repository.\n| Copyright: `open-MaStR <https://github.com/OpenEnergyPlatform/open-MaStR/>`_ \u00a9 `Reiner Lemoine Institut <https://reiner-lemoine-institut.de/>`_ \u00a9 `fortiss <https://www.fortiss.org/>`_ \u00a9 `OFFIS <https://www.offis.de/>`_ | `AGPL-3.0-or-later <https://www.gnu.org/licenses/agpl-3.0.txt>`_\n\nData\n----\n| The data has the license **Datenlizenz Deutschland \u2013 Namensnennung \u2013 Version 2.0** (DL-DE-BY-2.0)\n| Copyright: `Marktstammdatenregister <https://www.marktstammdatenregister.de/MaStR>`_ - \u00a9 Bundesnetzagentur f\u00fcr Elektrizit\u00e4t, Gas, Telekommunikation, Post und Eisenbahnen | `DL-DE-BY-2.0 <https://www.govdata.de/dl-de/by-2-0>`_\n\n\n.. |badge_license| image:: https://img.shields.io/github/license/OpenEnergyPlatform/open-MaStR\n :target: LICENSE.txt\n :alt: License\n\n.. |badge_rtd| image:: https://readthedocs.org/projects/open-mastr/badge/?style=flat\n :target: https://open-mastr.readthedocs.io/en/latest/\n :alt: Read the Docs\n\n.. |badge_ci| image:: https://github.com/OpenEnergyPlatform/open-MaStR/workflows/CI/badge.svg\n :target: https://github.com/OpenEnergyPlatform/open-MaStR/actions?query=workflow%3ACI\n :alt: GitHub Actions\n\n.. |badge_pypi| image:: https://img.shields.io/pypi/v/open-mastr.svg\n :target: https://pypi.org/project/open-mastr/\n :alt: PyPI\n\n.. |badge_zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.6807426.svg\n :target: https://doi.org/10.5281/zenodo.6807425\n :alt: zenodo\n\n.. |badge_issue_open| image:: https://img.shields.io/github/issues-raw/OpenEnergyPlatform/open-MaStR\n :alt: open issues\n\n.. |badge_issue_closes| image:: https://img.shields.io/github/issues-closed-raw/OpenEnergyPlatform/open-MaStR\n :alt: closes issues\n\n.. |badge_pr_open| image:: https://img.shields.io/github/issues-pr-raw/OpenEnergyPlatform/open-MaStR\n :alt: closes issues\n\n.. |badge_pr_closes| image:: https://img.shields.io/github/issues-pr-closed-raw/OpenEnergyPlatform/open-MaStR\n :alt: closes issues\n\n.. |badge_contributing| image:: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat\n :alt: contributions\n\n.. |badge_contributors| image:: https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square\n :alt: contributors\n\n.. |badge_repo_counts| image:: https://hits.dwyl.com/OpenEnergyPlatform/open-MaStR.svg\n :alt: counter\n \n.. |PyPI download month| image:: https://img.shields.io/pypi/dm/open-mastr?label=PyPi%20Downloads\n :target: https://pypistats.org/packages/open-mastr\n\n.. |Total PyPI downloads| image:: https://static.pepy.tech/badge/open-mastr\n :target: https://pepy.tech/project/open-mastr\n\n.. |badge_joss| image:: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e/status.svg\n :target: https://joss.theoj.org/papers/dc0d33e7dc74f7233e15a7b6fe0c7a3e\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "A package that provides an interface for downloading and processing the data of the Marktstammdatenregister (MaStR)",
"version": "0.14.5",
"project_urls": {
"Bug Tracker": "https://github.com/OpenEnergyPlatform/open-MaStR/issues",
"Changelog": "https://github.com/OpenEnergyPlatform/open-MaStR/blob/production/CHANGELOG.md",
"Documentation": "https://open-mastr.readthedocs.io/",
"Homepage": "https://github.com/OpenEnergyPlatform/open-MaStR",
"Repository": "https://github.com/OpenEnergyPlatform/open-MaStR"
},
"split_keywords": [
"markstammdatenregister",
" energy",
" dataset",
" solar",
" wind",
" energy-data",
" oep",
" openenergyfamily"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a139cdc5cc5b4870d462f5319f2fc696b7b4f589f7a38f8ceb75d8d3d09ae9c",
"md5": "eabb8bf750fc9bb1c1590c134054c708",
"sha256": "9384bce18091569bde05beafa3f5e657800b2b50f6986c755b355a7fbd15d869"
},
"downloads": -1,
"filename": "open_mastr-0.14.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eabb8bf750fc9bb1c1590c134054c708",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 164575,
"upload_time": "2024-10-11T12:23:07",
"upload_time_iso_8601": "2024-10-11T12:23:07.657430Z",
"url": "https://files.pythonhosted.org/packages/4a/13/9cdc5cc5b4870d462f5319f2fc696b7b4f589f7a38f8ceb75d8d3d09ae9c/open_mastr-0.14.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d8baf613f18d80c9e7336720bfaea5f2539953c525f8c93ee00ee7f41afba40",
"md5": "26e7e21482dbcd984cd21f6576370eca",
"sha256": "e00d40e85b4f58f44c65525229d5a0fdf1ac71e19fb7e94efeeaff2cf047dbc4"
},
"downloads": -1,
"filename": "open_mastr-0.14.5.tar.gz",
"has_sig": false,
"md5_digest": "26e7e21482dbcd984cd21f6576370eca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 8920948,
"upload_time": "2024-10-11T12:23:09",
"upload_time_iso_8601": "2024-10-11T12:23:09.746692Z",
"url": "https://files.pythonhosted.org/packages/6d/8b/af613f18d80c9e7336720bfaea5f2539953c525f8c93ee00ee7f41afba40/open_mastr-0.14.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-11 12:23:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OpenEnergyPlatform",
"github_project": "open-MaStR",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "open-mastr"
}
JSON
