Getting Started

The intention of open-MaStR is to provide tools for receiving a complete as possible and accurate as possible list of power plant units based on the public registry Marktstammdatenregister (short: MaStR).

Installation

To install open-mastr, run

pip install open-mastr

To get the latest bug fixes in your local version of open-mastr, run

pip install open-mastr --upgrade

Downloading the MaStR data

The MaStR dataset is updated on a daily basis. To download todays MaStR and save it in a sqlite database, you will use the Mastr class and its download method. The download method offers two different ways to get the data by changing the method parameter (if not specified, method defaults to "bulk"):

method = "bulk": Get data via the bulk download from MaStR/Datendownload. Use this if you want to download the whole dataset (few Gigabite) or if you want to download all units of a given technology (e.g. all wind turbines in Germany).
method = "API": Get data via the MaStR SOAP-API. Use this if you want specific information about single units and if you have registerd to get an API token.

Bulk download

The following code block shows the basic download commands:

from open_mastr import Mastr

db = Mastr()
db.download()

When a Mastr object is initialized, a sqlite database is created in $HOME/.open-MaStR/data/sqlite. With the function Mastr.download(), the whole MaStR is downloaded in the zipped xml file format. It is then read into the sqlite database and simple data cleansing functions are started.

If you are interested in a specific part of the dataset, you can specify this by using the data parameter:

from open_mastr import Mastr

db = Mastr()
db.download(data=["wind","hydro"])

More detailed information can be found in the section bulk download.

API download

API download has been removed

In versions > v0.16.0 the download(method="API") cannot be used anymore. The default behaviour changes method="API" to method="bulk". You can still use the basic SOAP API functionalities from the MaStRAPI class.

Accessing the database

For accessing and working with the MaStR database after you have downloaded it, you can use sqlite browsers such as DB Browser for SQLite or any python module which can process sqlite data. Pandas, for example, comes with the function read_sql.

pandasDB Browser for sqlite

import pandas as pd

# generate a list of all tables
df = pd.read_sql_query("SELECT name FROM sqlite_master WHERE type='table';", con=db.engine)

# read the data of one table
table="wind_extended"
df = pd.read_sql(sql=table, con=db.engine)

Image caption

Exporting data

The tables in the database can be exported as csv files. While technology-related data is joined for each unit, additional tables are mirrored from database to csv as they are. To export the data you can use to method to_csv.

    tables=["wind", "grids"]
    db.to_csv(tables)