2020-05-29 07:50:55 +00:00
|
|
|
# Copyright 2019-2020 Fabian Hofmann (FIAS)
|
|
|
|
# SPDX-FileCopyrightText: : 2017-2020 The PyPSA-Eur Authors
|
|
|
|
#
|
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
|
2019-11-06 13:50:59 +00:00
|
|
|
"""
|
|
|
|
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517935.svg
|
|
|
|
:target: https://doi.org/10.5281/zenodo.3517935
|
|
|
|
|
|
|
|
The data bundle (1.4 GB) contains common GIS datasets like NUTS3 shapes, EEZ shapes, CORINE Landcover, Natura 2000 and also electricity specific summary statistics like historic per country yearly totals of hydro generation, GDP and POP on NUTS3 levels and per-country load time-series.
|
|
|
|
|
|
|
|
This rule downloads the data bundle from `zenodo <https://doi.org/10.5281/zenodo.3517935>`_ and extracts it in the ``data`` sub-directory, such that all files of the bundle are stored in the ``data/bundle`` subdirectory.
|
|
|
|
|
|
|
|
The :ref:`tutorial` uses a smaller `data bundle <https://zenodo.org/record/3517921/files/pypsa-eur-tutorial-data-bundle.tar.xz>`_ than required for the full model (19 MB)
|
|
|
|
|
|
|
|
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517921.svg
|
|
|
|
:target: https://doi.org/10.5281/zenodo.3517921
|
|
|
|
|
|
|
|
**Relevant Settings**
|
|
|
|
|
|
|
|
.. code:: yaml
|
|
|
|
|
|
|
|
tutorial:
|
|
|
|
|
|
|
|
.. seealso::
|
|
|
|
Documentation of the configuration file ``config.yaml`` at
|
|
|
|
:ref:`toplevel_cf`
|
|
|
|
|
|
|
|
**Outputs**
|
|
|
|
|
|
|
|
- ``cutouts/bundle``: input data collected from various sources
|
|
|
|
|
|
|
|
"""
|
2019-11-05 11:53:21 +00:00
|
|
|
|
2019-11-28 07:22:52 +00:00
|
|
|
import logging
|
2019-11-05 11:53:21 +00:00
|
|
|
logger = logging.getLogger(__name__)
|
2019-11-28 07:22:52 +00:00
|
|
|
from _helpers import progress_retrieve, configure_logging
|
|
|
|
|
|
|
|
from pathlib import Path
|
|
|
|
import tarfile
|
2019-11-05 11:53:21 +00:00
|
|
|
|
2019-11-06 13:50:59 +00:00
|
|
|
if __name__ == "__main__":
|
2019-12-09 20:29:15 +00:00
|
|
|
# Detect running outside of snakemake and mock snakemake for testing
|
|
|
|
if 'snakemake' not in globals():
|
|
|
|
from _helpers import mock_snakemake
|
|
|
|
snakemake = mock_snakemake('retrieve_databundle')
|
|
|
|
rootpath = '..'
|
|
|
|
else:
|
|
|
|
rootpath = '.'
|
2019-11-28 07:22:52 +00:00
|
|
|
configure_logging(snakemake) # TODO Make logging compatible with progressbar (see PR #102)
|
|
|
|
|
2019-11-06 13:50:59 +00:00
|
|
|
if snakemake.config['tutorial']:
|
|
|
|
url = "https://zenodo.org/record/3517921/files/pypsa-eur-tutorial-data-bundle.tar.xz"
|
|
|
|
else:
|
|
|
|
url = "https://zenodo.org/record/3517935/files/pypsa-eur-data-bundle.tar.xz"
|
2019-11-05 11:53:21 +00:00
|
|
|
|
2019-11-28 07:22:52 +00:00
|
|
|
# Save locations
|
2019-12-09 20:29:15 +00:00
|
|
|
tarball_fn = Path(f"{rootpath}/bundle.tar.xz")
|
|
|
|
to_fn = Path(f"{rootpath}/data")
|
2019-11-05 11:53:21 +00:00
|
|
|
|
2019-11-28 07:22:52 +00:00
|
|
|
logger.info(f"Downloading databundle from '{url}'.")
|
2019-11-06 13:50:59 +00:00
|
|
|
progress_retrieve(url, tarball_fn)
|
2019-11-05 11:53:21 +00:00
|
|
|
|
2019-11-28 07:22:52 +00:00
|
|
|
logger.info(f"Extracting databundle.")
|
|
|
|
tarfile.open(tarball_fn).extractall(to_fn)
|
2019-12-09 20:29:15 +00:00
|
|
|
|
2019-11-28 07:22:52 +00:00
|
|
|
tarball_fn.unlink()
|
2019-12-09 20:29:15 +00:00
|
|
|
|
|
|
|
logger.info(f"Databundle available in '{to_fn}'.")
|