open-MaStR

Download and process German energy data from BNetzA database Marktstammdatenregister.
https://github.com/openenergyplatform/open-mastr

Category: Energy Systems
Sub Category: Energy Data Accessibility and Integration

Keywords

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

Keywords from Contributors

energy-system ontology oemof sql-alchemy-bindings renewable-energy grid climate-change modelling-framework renewables energy-system-model

Last synced: about 12 hours ago
JSON representation

Repository metadata

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 (over 6 years ago)
• Default Branch: develop
• Last Pushed: 2026-03-26T14:54:55.000Z (18 days ago)
• Last Synced: 2026-03-26T22:04:00.503Z (18 days 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.7 MB
• Stars: 131
• Watchers: 8
• Forks: 30
• Open Issues: 48
• Releases: 21
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Citation: CITATION.cff

README.rst

          
.. 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 python package ``open-mastr`` provides an interface for accessing the `Marktstammdatenregister (MaStR) `_ data. The 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. It is a daily growing dataset with millions of data points covering electricity and gas production units, electricity and gas consumers, storages, grids, and energy market participants.

Generally, and besides the offerings of ``open-mastr``, the MaStR data can be accessed via three main options:

#. browse, filter and download `in the browser `_
#. download `daily provided dumps `_
#. access via the `web service `_

These access options, however, are not exactly frictionless. ``open-mastr`` thus provides an interface for and improved developer experience of accessing the data. This project is intended for individuals who wish to "just work" with the MaStR data and who do not want to deal with the idiosyncrasies of the three access options above.

In particular, ``open-mastr`` facilitates access to the daily provided MaStR dumps with download methods (bulk) and by parsing the XML files to a relational database. Furthermore, the software provides a Python wrapper to access the MaStR SOAP web service (API).


**Does open-mastr edit or change the MaStR data?**
No. ``open-mastr`` is a wrapper around the MaStR data and does not edit or change the data. It is intended to be used as a tool for working with the MaStR data.

Benefits provided by ``open-mastr``
===================================

.. list-table::
   :widths: 30, 70
   :header-rows: 1

   * - Benefit
     - Description
   * - Data download and parsing
     - Download, decode, and write data to a local database
   * - Translation to English
     - Translate table names and columns from German to English as well as an English documentation page of the dataset
   * - Data processing
     - Merge relevant information about different technologies to single csv files

**Just here for the data?**
We regularly run the whole download and cleansing pipeline and upload the dataset as csv files at `zenodo `_!


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

- 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 original dataset is licensed under the **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.md
    :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



        

Citation (CITATION.cff)

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"
    affiliation: "Reiner Lemoine Institut"
    orcid: "https://orcid.org/0000-0003-4655-2321"
  - family-names: "Pleßmann"
    given-names: "Guido"
    alias: "@gplssm"
    affiliation: "Reiner Lemoine Institut"
  - family-names: "Muschner"
    given-names: "Christoph"
    alias: "@chrwm"
    affiliation: "Reiner Lemoine Institut"
    orcid: " https://orcid.org/0000-0001-8144-5260"
  - family-names: "Kotthoff"
    given-names: "Florian"
    alias: "@FlorianK13"
    affiliation: "fortiss"
    orcid: " https://orcid.org/0000-0003-3666-6122"
  - family-names: "Tepe"
    given-names: "Deniz"
    alias: "@deniztepe"
    affiliation: "fortiss"
    orcid: " https://orcid.org/0000-0002-7605-0173"
  - family-names: "Amme"
    given-names: "Jonathan"
    alias: "@nesnoj"
    affiliation: "Reiner Lemoine Institut"
    orcid: " https://orcid.org/0000-0002-8563-5261"
  - family-names: "Imbrisca"
    given-names: "Alexandra-Andreea"
    alias: "@AlexandraImbrisca"
    affiliation: "Technical University of Munich"
  - family-names: 'Krämer'
    given-names: "Kevin"
    alias: "pt-kkraemer"
    affiliation: "ProjectTogether gGmbH"  
title: "open-MaStR"
type: software
license: AGPL-3.0
version: 0.15.0
doi: 
date-released: 2025-04-19
url: "https://github.com/OpenEnergyPlatform/open-MaStR/"

---

Owner metadata

• Name: Open Energy Family
• Login: OpenEnergyPlatform
• Email:
• Kind: organization
• Description: The Open Energy Family and Open Energy Platform
• Website: https://github.com/OpenEnergyPlatform/organisation/blob/master/README.md
• Location: Magdeburg, Germany
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/37101913?v=4
• Repositories: 25
• Last ynced at: 2024-04-16T23:20:58.483Z
• Profile URL: https://github.com/OpenEnergyPlatform

---

GitHub Events

Total

• Create event: 22
• Release event: 1
• Issues event: 63
• Watch event: 21
• Delete event: 16
• Issue comment event: 180
• Push event: 74
• Pull request review comment event: 17
• Pull request event: 35
• Pull request review event: 51
• Fork event: 6

Last Year

• Create event: 21
• Release event: 1
• Issues event: 60
• Watch event: 20
• Delete event: 16
• Issue comment event: 166
• Push event: 71
• Pull request review comment event: 17
• Pull request event: 35
• Pull request review event: 49
• Fork event: 5

---

Committers metadata

Last synced: 6 months ago

Name	Email	Commits
Florian Kotthoff	f****f@p****e	583
Guido Pleßmann	g****n@r****e	417
Ludee	L****k@r****e	327
chrwm	c****r@r****e	242
Deniz Tepe	d****2@g****m	135
nesnoj	j****e@r****e	81
Bachibouzouk	p****c@r****e	67
solar-c		49
AlexandraImbrisca	a****6@g****m	45
Kevin Krämer	k****r@p****g	18
solar-c	s****c	16
jadeaffenjaeger	e****r@r****e	14
Bachibouzouk	p****c@r****e	12
Benjamin W. Portner	b****r@b****t	10
Jonas Hoersch	j****s@c****t	7
Grazvy	k****s@f****g	7
Grazvy	7****y	6
oakca	o****a@g****m	5
Christian Hofmann	c****n@r****e	3
Johann150	j****e@p****m	3
Oskar.Oetken	o****n@r****e	3
wok77	9****7	2
Guido Pleßmann	R****n@p****l	2
solar-c		2
stap-m	3****m	2
izzet kilicarslan	i****n@r****e	2
Florian Maurer	m****r@f****e	2
Guido Pleßmann	R****n@s****l	1
Leonhard Markert	c****o	1
steull	s****u@g****m	1

Committer domains:

• rl-institut.de: 9
• fh-aachen.de: 1
• fortiss.org: 1
• chaoflow.net: 1
• bauhaus-luftfahrt.net: 1
• projecttogether.org: 1
• rl-institute.de: 1
• posteo.de: 1

---

Issue and Pull Request metadata

Last synced: 6 months ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/openenergyplatform/open-mastr

---

---

---

Package metadata

• Total packages: 3
• Total downloads:
  • pypi: 8,352 last-month
• Total dependent packages: 0 (may contain duplicates)
• Total dependent repositories: 0 (may contain duplicates)
• Total versions: 61
• Total maintainers: 1

---

Dependencies

Score: 17.618959222258816