From dc144f39fbf3e3d15386bfee82159f8810aba6ba Mon Sep 17 00:00:00 2001 From: Jonas Jeckstadt Date: Thu, 10 Aug 2023 16:10:16 +0200 Subject: [PATCH] Document dataset MatrData --- src/egon/data/datasets/mastr.py | 46 ++++++++++++++++++++------------- 1 file changed, 28 insertions(+), 18 deletions(-) diff --git a/src/egon/data/datasets/mastr.py b/src/egon/data/datasets/mastr.py index 1b7b307ce..8f74b2b90 100644 --- a/src/egon/data/datasets/mastr.py +++ b/src/egon/data/datasets/mastr.py @@ -1,22 +1,6 @@ """ Download Marktstammdatenregister (MaStR) datasets unit registry. -It incorporates two different datasets: - -Dump 2021-05-03 -* Source: https://sandbox.zenodo.org/record/808086 -* Used technologies: PV plants, wind turbines, biomass, hydro plants, - combustion, nuclear, gsgk, storage -* Data is further processed in dataset - :py:class:`egon.data.datasets.power_plants.PowerPlants` - -Dump 2022-11-17 -* Source: https://sandbox.zenodo.org/record/1132839 -* Used technologies: PV plants, wind turbines, biomass, hydro plants -* Data is further processed in module - :py:mod:`egon.data.datasets.power_plants.mastr` `PowerPlants` - -Todo: Finish docstring -TBD + """ from dataclasses import dataclass @@ -32,7 +16,7 @@ def download_mastr_data(): - """Download MaStR data from Zenodo""" + """Download MaStR data from Zenodo.""" def download(dataset_name, download_dir): print(f"Downloading dataset {dataset_name} to {download_dir} ...") @@ -68,6 +52,32 @@ def download(dataset_name, download_dir): @dataclass class mastr_data_setup(Dataset): + """ + Download Marktstammdatenregister (MaStR) datasets unit registry. + + The downloaded data incorporates two different datasets: + + Dump 2021-05-03 + * Source: https://sandbox.zenodo.org/record/808086 + * Used technologies: PV plants, wind turbines, biomass, hydro plants, combustion, + nuclear, gsgk, storage + * Data is further processed in dataset :py:class:`PowerPlants + ` + + Dump 2022-11-17 + * Source: https://sandbox.zenodo.org/record/1132839 + * Used technologies: PV plants, wind turbines, biomass, hydro plants + * Data is further processed in module :py:mod:`mastr + ` and :py:class:`PowerPlants + ` + + *Dependencies* + * :py:func:`Setup ` + + *Resulting Tables* + * :py:class:`PowerPlants ` + """ + #: name: str = "MastrData" #: