https://github.com/OpenEnergyPlatform/open-MaStR

A Python Package to Download and Process the German Power Plant and Energy System Registry Marktstammdatenregister (MaStR)
https://github.com/OpenEnergyPlatform/open-MaStR

dataset datasets energy energy-data marktstammdatenregister oep open-energy-family python solar

Last synced: about 1 year ago
JSON representation

A Python Package to Download and Process the German Power Plant and Energy System Registry Marktstammdatenregister (MaStR)

Host: GitHub
URL: https://github.com/OpenEnergyPlatform/open-MaStR
Owner: OpenEnergyPlatform
License: agpl-3.0
Created: 2019-08-21T14:11:11.000Z (almost 7 years ago)
Default Branch: develop
Last Pushed: 2025-04-29T08:26:33.000Z (about 1 year ago)
Last Synced: 2025-04-29T08:32:02.997Z (about 1 year ago)
Topics: dataset, datasets, energy, energy-data, marktstammdatenregister, oep, open-energy-family, python, solar
Language: Python
Homepage: https://open-mastr.readthedocs.io/en/latest/
Size: 31.5 MB
Stars: 100
Watchers: 7
Forks: 23
Open Issues: 31
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Citation: CITATION.cff

Awesome Lists containing this project

open-sustainable-technology - open-MaStR - Download and process German energy data from BNetzA database Marktstammdatenregister. (Energy Systems / Energy Data Accessibility and Integration)

README

          
.. image:: https://raw.githubusercontent.com/OpenEnergyPlatform/open-MaStR/refs/heads/production/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| |PyPI download month| |Total PyPI downloads|

   

.. contents::

    :depth: 2

    :local:

    :backlinks: top

Introduction

============

The `Marktstammdatenregister (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 `_

#. taken from `daily provided dumps `_

#. be accessed via the `web service `_

| 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 `_ markdown format in the ``doc`` sub-folder of the repository.

| Find the `documentation `_ hosted on ReadTheDocs.

| The original API documentation can be found on the `Webhilfe des Marktstammdatenregisters `_.

Installation

============

| It is recommended to use a virtual python environment, for example `conda `_ or `virtualenv `_.

| 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

==================

These projects already use open-mastr:

- `PV- und Windflächenrechner `_

- `Wasserstoffatlas `_

- `EE-Status App `_

- `Digiplan Anhalt `_

- `Data Quality Assessment of the MaStR `_

- `EmPowerPlan `_

- `Goal100 Monitor `_

If you want to see your project in this list, write an  

`Issue `_ or add

changes in a `Pull Request `_.

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

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

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 `_ for rights and obligations.

| See the *Cite this repository* function or `CITATION.cff `_ for citation of this repository.

| Copyright: `open-MaStR `_ © `Reiner Lemoine Institut `_ © `fortiss `_ © `OFFIS `_  | `AGPL-3.0-or-later `_

Data

----

| The data has the license **Datenlizenz Deutschland – Namensnennung – Version 2.0** (DL-DE-BY-2.0)

| Copyright: `Marktstammdatenregister `_ - © Bundesnetzagentur für Elektrizität, Gas, Telekommunikation, Post und Eisenbahnen | `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/actions/workflows/ci-production.yml/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

    

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

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/OpenEnergyPlatform/open-MaStR

Awesome Lists containing this project

README