From 9aaa26cbbe43e2b508f4eae757309da6f066f1f8 Mon Sep 17 00:00:00 2001 From: Fabian Neumann Date: Thu, 24 Oct 2019 15:54:12 +0200 Subject: [PATCH] add zenodo files (closes #60) --- doc/configtables/licenses.csv | 14 ++++++++++++++ doc/index.rst | 13 +++++++++++-- doc/installation.rst | 32 +++++++++++++++++++++++--------- doc/tutorial.rst | 12 ++++++++++-- 4 files changed, 58 insertions(+), 13 deletions(-) create mode 100644 doc/configtables/licenses.csv diff --git a/doc/configtables/licenses.csv b/doc/configtables/licenses.csv new file mode 100644 index 00000000..3e25f5df --- /dev/null +++ b/doc/configtables/licenses.csv @@ -0,0 +1,14 @@ +"Files","BY","NC","SA","Mark Changes",Detail +"corine/*","x",,,"x",https://land.copernicus.eu/pan-european/corine-land-cover/clc-2012?tab=metadata +"eez/*","x","x","x",,http://www.marineregions.org/disclaimer.php +"natura/*","x",,,,https://www.eea.europa.eu/data-and-maps/data/natura-10#tab-metadata +"naturalearth/*",,,,,http://www.naturalearthdata.com/about/terms-of-use/ +"NUTS_2013 _60M_SH/*","x","x",,"x",https://ec.europa.eu/eurostat/web/gisco/geodata/reference-data/administrative-units-statistical-units +"cantons.csv","x",,"x",,https://en.wikipedia.org/wiki/Data_codes_for_Switzerland +"EIA_hydro_generation _2000_2014.csv","x",,,,https://www.eia.gov/about/copyrights_reuse.php +"GEBCO_2014_2D.nc","x",,,,https://www.gebco.net/data_and_products/gridded_bathymetry_data/documents/gebco_2014_historic.pdf +"hydro_capacities.csv","x",,,, +"je-e-21.03.02.xls","x","x",,,https://www.bfs.admin.ch/bfs/en/home/fso/swiss-federal-statistical-office/terms-of-use.html +"nama_10r_3 gdp.tsv.gz","x",,,"x",https://ec.europa.eu/eurostat/about/policies/copyright +"nama_10r_3 popgdp.tsv.gz","x",,,"x",https://ec.europa.eu/eurostat/about/policies/copyright +"time_series_60min _singleindex_filtered.csv","x",,,,https://data.open-power-system-data.org/time_series/2019-06-05/README.md diff --git a/doc/index.rst b/doc/index.rst index 1e124ef0..bc036220 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -135,8 +135,6 @@ Please use the following BibTeX: :: } -.. todo:: Add versions to zenodo - If you want to cite a specific PyPSA-Eur version, each release of PyPSA-Eur is stored on Zenodo with a release-specific DOI. This can be found linked from the overall PyPSA-Eur Zenodo DOI: @@ -150,3 +148,14 @@ Licence The code in PyPSA-Eur is released as free software under the `GPLv3 `_, see `LICENSE `_. +However, different licenses and terms of use apply to the various input data, which are summarised below. +More details are included in +`the description of the data bundles on zenodo `_. + +.. csv-table:: + :header-rows: 1 + :file: configtables/licenses.csv + +* *BY: Attribute Source* +* *NC: Non-Commercial Use Only* +* *SA: Share Alike* \ No newline at end of file diff --git a/doc/installation.rst b/doc/installation.rst index b66ab895..33dde1d4 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -60,32 +60,46 @@ extracting them manually in the locations outlined below. The :ref:`tutorial` uses smaller data bundles than required for the full model. To start with the tutorial, substitute with the links below using the following alternatives: - - - **Data Bundle:** ``https://vfs.fias.science/d/0a0ca1e2fb/files/?dl=1&p=/pypsa-eur-data-bundle.tar.xz`` (197 MB) - - **Cutouts:** ``https://vfs.fias.science/d/0a0ca1e2fb/files/?p=/pypsa-eur-cutouts.tar.xz`` (19 MB) -1. **Data Bundle:** `pypsa-eur-data-bundle.tar.xz `_ (1.3 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. It should be extracted in the ``data`` sub-directory, such that all files of the bundle are stored in the ``data/bundle`` subdirectory) + .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517921.svg + :target: https://doi.org/10.5281/zenodo.3517921 + + .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3518020.svg + :target: https://doi.org/10.5281/zenodo.3518020 + + - **Data Bundle:** ``https://zenodo.org/record/3517921/files/pypsa-eur-tutorial-data-bundle.tar.xz`` (197 MB) + - **Cutouts:** ``https://zenodo.org/record/3518020/files/pypsa-eur-tutorial-cutouts.tar.xz`` (19 MB) + +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517935.svg + :target: https://doi.org/10.5281/zenodo.3517935 + +1. **Data Bundle:** `pypsa-eur-data-bundle.tar.xz `_ (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. It should be extracted in the ``data`` sub-directory, such that all files of the bundle are stored in the ``data/bundle`` subdirectory) .. code:: bash - .../pypsa-eur/data % curl -OL "https://vfs.fias.science/d/0a0ca1e2fb/files/?dl=1&p=/pypsa-eur-data-bundle.tar.xz" + .../pypsa-eur/data % curl -OL "https://zenodo.org/record/3517935/files/pypsa-eur-data-bundle.tar.xz" .../pypsa-eur/data % tar xJf pypsa-eur-data-bundle.tar.xz +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517949.svg + :target: https://doi.org/10.5281/zenodo.3517949 -2. **Cutouts:** `pypsa-eur-cutouts.tar.xz `_ (3.9 GB) are spatiotemporal subsets of the European weather data from the `ECMWF ERA5 `_ reanalysis dataset and the `CMSAF SARAH-2 `_ solar surface radiation dataset for the year 2013. They have been prepared by and are for use with the `atlite `_ tool. You can either generate them yourself using the ``build_cutouts`` rule or extract them directly into the ``pypsa-eur`` directory. To download cutouts yourself you need to `set up the CDS API `_. For more details read the `atlite documentation `_. For beginners, extracting the bundle is recommended: +2. **Cutouts:** `pypsa-eur-cutouts.tar.xz `_ (3.9 GB) are spatiotemporal subsets of the European weather data from the `ECMWF ERA5 `_ reanalysis dataset and the `CMSAF SARAH-2 `_ solar surface radiation dataset for the year 2013. They have been prepared by and are for use with the `atlite `_ tool. You can either generate them yourself using the ``build_cutouts`` rule or extract them directly into the ``pypsa-eur`` directory. To download cutouts yourself you need to `set up the CDS API `_. For more details read the `atlite documentation `_. For beginners, extracting the bundle is recommended: .. code:: bash - .../pypsa-eur % curl -OL "https://vfs.fias.science/d/0a0ca1e2fb/files/?dl=1&p=/pypsa-eur-cutouts.tar.xz" + .../pypsa-eur % curl -OL "https://zenodo.org/record/3517949/files/pypsa-eur-cutouts.tar.xz" .../pypsa-eur % tar xJf pypsa-eur-cutouts.tar.xz -3. **Natura:** Optionally, you can download a rasterized version of the NATURA dataset `natura.tiff `_ and put it into the ``resources`` sub-directory. If you don't, it will be generated automatically, which is a time-consuming process. +.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3518215.svg + :target: https://doi.org/10.5281/zenodo.3518215 + +3. **Natura:** Optionally, you can download a rasterized version of the NATURA dataset `natura.tiff `_ and put it into the ``resources`` sub-directory. If you don't, it will be generated automatically, which is a time-consuming process. .. code:: bash - .../pypsa-eur % curl -L "https://vfs.fias.science/d/0a0ca1e2fb/files/?p=/natura.tiff&dl=1" -o "resources/natura.tiff" + .../pypsa-eur % curl -L "https://zenodo.org/record/3518215/files/natura.tiff" -o "resources/natura.tiff" 4. **Remove Archives:** Optionally, if you want to save disk space, you can delete ``data/pypsa-eur-data-bundle.tar.xz`` and ``pypsa-eur-cutouts.tar.xz`` once extracting the bundles is complete. E.g. diff --git a/doc/tutorial.rst b/doc/tutorial.rst index a2e00f0e..cd5cf67c 100644 --- a/doc/tutorial.rst +++ b/doc/tutorial.rst @@ -19,9 +19,17 @@ The tutorial will cover examples on how to If not yet completed, follow the :ref:`installation` steps but substitute the links for the **data bundle** and the **cutouts** with the following lightweight alternatives: + + .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3517921.svg + :target: https://doi.org/10.5281/zenodo.3517921 + + .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3518020.svg + :target: https://doi.org/10.5281/zenodo.3518020 - - **Data Bundle:** ``https://vfs.fias.science/d/0a0ca1e2fb/files/?dl=1&p=/pypsa-eur-data-bundle.tar.xz`` (197 MB) - - **Cutouts:** ``https://vfs.fias.science/d/0a0ca1e2fb/files/?p=/pypsa-eur-cutouts.tar.xz`` (19 MB) + - **Data Bundle:** ``https://zenodo.org/record/3517921/files/pypsa-eur-tutorial-data-bundle.tar.xz`` (197 MB) + + + - **Cutouts:** ``https://zenodo.org/record/3518020/files/pypsa-eur-tutorial-cutouts.tar.xz`` (19 MB) The configuration of the tutorial is included in the ``config.tutorial.yaml``. To run the tutorial, use this as your configuration file ``config.yaml``.