merge docs

doc/Makefile

@@ -1,10 +1,7 @@
-<<<<<<< HEAD
 # SPDX-FileCopyrightText: 2017-2023 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
 
-=======
->>>>>>> pypsa-eur-sec/master
 # Makefile for Sphinx documentation
 #
 

doc/conf.py

@@ -1,12 +1,9 @@
 # -*- coding: utf-8 -*-
-<<<<<<< HEAD
 # SPDX-FileCopyrightText: 20017-2020 The PyPSA-Eur Authors
 #
 # SPDX-License-Identifier: MIT
 
 # -*- coding: utf-8 -*-
-=======
->>>>>>> pypsa-eur-sec/master
 #
 # PyPSA documentation build configuration file, created by
 # sphinx-quickstart on Tue Jan  5 10:04:42 2016.
@@ -40,10 +37,7 @@ sys.path.insert(0, os.path.abspath("../scripts"))
 extensions = [
     #'sphinx.ext.autodoc',
     #'sphinx.ext.autosummary',
-<<<<<<< HEAD
-=======
     "sphinx.ext.autosectionlabel",
->>>>>>> pypsa-eur-sec/master
     "sphinx.ext.intersphinx",
     "sphinx.ext.todo",
     "sphinx.ext.mathjax",
@@ -73,15 +67,9 @@ source_suffix = ".rst"
 master_doc = "index"
 
 # General information about the project.
-<<<<<<< HEAD
 project = "PyPSA-Eur"
-copyright = "2017-2023 Jonas Hoersch (KIT, FIAS), Fabian Hofmann (TUB, FIAS), David Schlachtberger (FIAS), Tom Brown (TUB, KIT, FIAS); 2019-2023 Fabian Neumann (TUB, KIT)"
+copyright = "2017-2023 Tom Brown (KIT, TUB, FIAS), Jonas Hoersch (KIT, FIAS), Fabian Hofmann (TUB, FIAS), Fabian Neumann (TUB, KIT), Marta Victoria (Aarhus University), Lisa Zeyen (KIT, TUB)"
-author = "Jonas Hoersch (KIT, FIAS), Fabian Hofmann (TUB, FIAS), David Schlachtberger (FIAS), Tom Brown (TUB, KIT, FIAS), Fabian Neumann (TUB, KIT)"
+author = "Tom Brown (KIT, TUB, FIAS), Jonas Hoersch (KIT, FIAS), Fabian Hofmann (TUB, FIAS), Fabian Neumann (TUB, KIT), Marta Victoria (Aarhus University), Lisa Zeyen (KIT, TUB)"
-=======
-project = "PyPSA-Eur-Sec"
-copyright = "2019-2023 Tom Brown (KIT, TUB), Marta Victoria (Aarhus University), Lisa Zeyen (KIT, TUB), Fabian Neumann (TUB)"
-author = "2019-2023 Tom Brown (KIT, TUB), Marta Victoria (Aarhus University), Lisa Zeyen (KIT, TUB), Fabian Neumann (TUB)"
->>>>>>> pypsa-eur-sec/master
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -97,11 +85,7 @@ release = "0.7.0"
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-<<<<<<< HEAD
 language = "en"
-=======
-language = None
->>>>>>> pypsa-eur-sec/master
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -145,24 +129,15 @@ todo_include_todos = True
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-<<<<<<< HEAD
 html_theme = "sphinx_book_theme"
-=======
-html_theme = "sphinx_rtd_theme"
->>>>>>> pypsa-eur-sec/master
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-<<<<<<< HEAD
     "repository_url": "https://github.com/pypsa/pypsa-eur",
     "use_repository_button": True,
     "show_navbar_depth": 2,
-=======
-    "display_version": True,
-    "sticky_navigation": True,
->>>>>>> pypsa-eur-sec/master
 }
 
 
@@ -171,47 +146,26 @@ html_theme_options = {
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-<<<<<<< HEAD
 html_title = "PyPSA-Eur"
-=======
-# html_title = None
->>>>>>> pypsa-eur-sec/master
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-<<<<<<< HEAD
 html_logo = "img/pypsa-logo.png"
-=======
-# html_logo = None
->>>>>>> pypsa-eur-sec/master
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 # html_favicon = None
 
-<<<<<<< HEAD
 # These folders are copied to the documentation's HTML output
 # html_static_path = ["_static"]
 
 # These paths are either relative to html_static_path
 # or fully qualified paths (eg. https://...)
 # html_css_files = ["theme_overrides.css"]
-=======
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-html_context = {
-    "css_files": [
-        "_static/theme_overrides.css",  # override wide tables in RTD theme
-    ],
-}
->>>>>>> pypsa-eur-sec/master
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -274,11 +228,7 @@ html_context = {
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-<<<<<<< HEAD
 htmlhelp_basename = "PyPSAEurdoc"
-=======
-htmlhelp_basename = "PyPSAEurSecdoc"
->>>>>>> pypsa-eur-sec/master
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -297,17 +247,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-<<<<<<< HEAD
     (master_doc, "PyPSA-Eur.tex", "PyPSA-Eur Documentation", "author", "manual"),
-=======
-    (
-        master_doc,
-        "PyPSA-Eur-Sec.tex",
-        "PyPSA-Eur-Sec Documentation",
-        "author",
-        "manual",
-    ),
->>>>>>> pypsa-eur-sec/master
 ]
 
 
@@ -315,13 +255,8 @@ latex_documents = [
 rinoh_documents = [
     (
         master_doc,  # top-level file (index.rst)
-<<<<<<< HEAD
         "PyPSA-Eur",  # output (target.pdf)
         "PyPSA-Eur Documentation",  # document title
-=======
-        "PyPSA-Eur-Sec",  # output (target.pdf)
-        "PyPSA-Eur-Sec Documentation",  # document title
->>>>>>> pypsa-eur-sec/master
         "author",
     )
 ]  # document author
@@ -352,11 +287,7 @@ rinoh_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-<<<<<<< HEAD
 man_pages = [(master_doc, "pypsa-eur", "PyPSA-Eur Documentation", [author], 1)]
-=======
-man_pages = [(master_doc, "pypsa-eur-sec", "PyPSA-Eur-Sec Documentation", [author], 1)]
->>>>>>> pypsa-eur-sec/master
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -370,17 +301,10 @@ man_pages = [(master_doc, "pypsa-eur-sec", "PyPSA-Eur-Sec Documentation", [autho
 texinfo_documents = [
     (
         master_doc,
-<<<<<<< HEAD
         "PyPSA-Eur",
         "PyPSA-Eur Documentation",
         author,
         "PyPSA-Eur",
-=======
-        "PyPSA-Eur-Sec",
-        "PyPSA-Eur-Sec Documentation",
-        author,
-        "PyPSA-Eur-Sec",
->>>>>>> pypsa-eur-sec/master
         "One line description of project.",
         "Miscellaneous",
     ),

doc/index.rst

@@ -1,11 +1,10 @@
-<<<<<<< HEAD
 ..
   SPDX-FileCopyrightText: 2019-2023 The PyPSA-Eur Authors
 
   SPDX-License-Identifier: CC-BY-4.0
 
-PyPSA-Eur: An Open Optimisation Model of the European Transmission System
+PyPSA-Eur: A Sector-Coupled Open Optimisation Model of the European Energy System
-=========================================================================
+=================================================================================
 
 .. image:: https://img.shields.io/github/v/release/pypsa/pypsa-eur?include_prereleases
     :alt: GitHub release (latest by date including pre-releases)
@@ -31,65 +30,61 @@ PyPSA-Eur: An Open Optimisation Model of the European Transmission System
     :target: https://api.reuse.software/info/github.com/pypsa/pypsa-eur
     :alt: REUSE status
 
-PyPSA-Eur is an open model dataset of the European power system at the
+
+PyPSA-Eur is an open model dataset of the European energy system at the
 transmission network level that covers the full ENTSO-E area.
 
-It contains alternating current lines at and above 220 kV voltage level and all high voltage direct current lines, substations, an open database of conventional power plants, time series for electrical demand and variable renewable generator availability, and geographic potentials for the expansion of wind and solar power.
+It contains alternating current lines at and above 220 kV voltage level and all
+high voltage direct current lines, substations, an open database of conventional
+power plants, time series for electrical demand and variable renewable generator
+availability, and geographic potentials for the expansion of wind and solar
+power.
 
-The model is suitable both for operational studies and generation and transmission expansion planning studies. The continental scope and highly resolved spatial scale enables a proper description of the long-range smoothing effects for renewable power generation and their varying resource availability.
+A sector-coupled extension (previously known as PyPSA-Eur-Sec) adds demand and
+supply for the following sectors: transport, space and water heating, biomass,
+energy consumption in the agriculture, industry and industrial feedstocks,
+carbon management, carbon capture and usage/sequestration. This completes the
+energy system and includes all greenhouse gas emitters except waste management,
+agriculture, forestry and land use.
+
+The model is suitable both for operational studies and generation and
+transmission expansion planning studies. The continental scope and highly
+resolved spatial scale enables a proper description of the long-range smoothing
+effects for renewable power generation and their varying resource availability.
 
 .. image:: img/elec.png
     :width: 50%
     :align: center
 
-The restriction to freely available and open data encourages the open exchange of model data developments and eases the comparison of model results. It provides a full, automated software pipeline to assemble the load-flow-ready model from the original datasets, which enables easy replacement and improvement of the individual parts.
+The restriction to freely available and open data encourages the open exchange
+of model data developments and eases the comparison of model results. It
+provides a full, automated software pipeline to assemble the load-flow-ready
+model from the original datasets, which enables easy replacement and improvement
+of the individual parts.
 
-PyPSA-Eur is designed to be imported into the open toolbox `PyPSA <https://www.pypsa.org>`_ for which `documentation <https://pypsa.org/doc>`_ is available as well.
+PyPSA-Eur is designed to be imported into the open toolbox `PyPSA
+<https://www.pypsa.org>`_ for which `documentation <https://pypsa.org/doc>`_ is
+available as well.
 
 This project is currently maintained by the `Department of Digital
 Transformation in Energy Systems <https:/www.ensys.tu-berlin.de>`_ at the
 `Technische Universität Berlin <https://www.tu.berlin>`_. Previous versions were
-developed within the `IAI <http://www.iai.kit.edu>`_ at the `Karlsruhe Institute of
+developed within the `IAI <http://www.iai.kit.edu>`_ at the `Karlsruhe Institute
-Technology (KIT) <http://www.kit.edu/english/index.php>`_ and by the `Renewable
+of Technology (KIT) <http://www.kit.edu/english/index.php>`_ which was funded by
-Energy Group
+the `Helmholtz Association <https://www.helmholtz.de/en/>`_, and by the
-=======
+`Renewable Energy Group
-PyPSA-Eur-Sec: A Sector-Coupled Open Optimisation Model of the European Energy System
+<https://fias.uni-frankfurt.de/physics/schramm/renewable-energy-system-and-network-analysis/>`_
-=====================================================================================
+at `FIAS <https://fias.uni-frankfurt.de/>`_ to carry out simulations for the
+`CoNDyNet project <http://condynet.de/>`_, financed by the `German Federal
+Ministry for Education and Research (BMBF) <https://www.bmbf.de/en/index.html>`_
+as part of the `Stromnetze Research Initiative
+<http://forschung-stromnetze.info/projekte/grundlagen-und-konzepte-fuer-effiziente-dezentrale-stromnetze/>`_.
 
-.. image:: https://img.shields.io/github/v/release/pypsa/pypsa-eur-sec?include_prereleases
+**WARNING**: PyPSA-Eur is under active development and has several
-    :alt: GitHub release (latest by date including pre-releases)
+`limitations <https://pypsa-eur.readthedocs.io/en/latest/limitations.html>`_ which
-
-.. image:: https://readthedocs.org/projects/pypsa-eur-sec/badge/?version=latest
-    :target: https://pypsa-eur-sec.readthedocs.io/en/latest/?badge=latest
-    :alt: Documentation Status
-
-.. image:: https://img.shields.io/github/license/pypsa/pypsa-eur-sec
-    :alt: GitHub
-
-.. image:: https://img.shields.io/github/repo-size/pypsa/pypsa-eur-sec
-    :alt: GitHub repo size
-
-
-PyPSA-Eur-Sec is an open model dataset of the European energy system at the
-transmission network level that covers the full ENTSO-E area.
-
-PyPSA-Eur-Sec builds on the electricity generation and transmission
-model `PyPSA-Eur <https://github.com/PyPSA/pypsa-eur>`_ to add demand
-and supply for the following sectors: transport, space and water
-heating, biomass, energy consumption in the agriculture, industry
-and industrial feedstocks, carbon management, carbon capture and usage/sequestration.
-This completes the energy system and includes all greenhouse gas emitters except waste management, agriculture,
-forestry and land use.
-
-
-**WARNING**: PyPSA-Eur-Sec is under active development and has several
-`limitations <https://pypsa-eur-sec.readthedocs.io/en/latest/limitations.html>`_ which
 you should understand before using the model. The github repository
-`issues <https://github.com/PyPSA/pypsa-eur-sec/issues>`_ collect known
+`issues <https://github.com/PyPSA/pypsa-eur/issues>`_ collect known
 topics we are working on (please feel free to help or make suggestions).
-The `documentation <https://pypsa-eur-sec.readthedocs.io/>`_ remains somewhat
-patchy.
-We cannot support this model if you choose to use it.
 
 .. note::
     You can find showcases of the model's capabilities in the Supplementary Materials of the
@@ -105,58 +100,18 @@ them:
 
 .. image:: ../graphics/multisector_figure.png
 
-PyPSA-Eur-Sec was initially based on the model PyPSA-Eur-Sec-30 described
+The sector-coupled extension of PyPSA-Eur (previously PyPSA-Eur-Sec) was
-in the paper `Synergies of sector coupling and transmission
+initially described in the paper `Synergies of sector coupling and transmission
-reinforcement in a cost-optimised, highly renewable European energy
+reinforcement in a cost-optimised, highly renewable European energy system
-system <https://arxiv.org/abs/1801.05290>`_ (2018) but it differs by
+<https://arxiv.org/abs/1801.05290>`_ (2018) but it differs by being based on the
-being based on the higher resolution electricity transmission model
+higher resolution electricity transmission model `PyPSA-Eur
-`PyPSA-Eur <https://github.com/PyPSA/pypsa-eur>`_ rather than a
+<https://github.com/PyPSA/pypsa-eur>`_ rather than a one-node-per-country model,
-one-node-per-country model, and by including biomass, industry,
+and by including biomass, industry, industrial feedstocks, aviation, shipping,
-industrial feedstocks, aviation, shipping, better carbon management,
+better carbon management, carbon capture and usage/sequestration, and gas
-carbon capture and usage/sequestration, and gas networks.
+networks.
 
 
-PyPSA-Eur-Sec includes PyPSA-Eur as a
-`snakemake <https://snakemake.readthedocs.io/en/stable/index.html>`_
-`subworkflow <https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html#snakefiles-sub-workflows>`_. PyPSA-Eur-Sec
-uses PyPSA-Eur to build the clustered transmission model along with
-wind, solar PV and hydroelectricity potentials and time series. Then
-PyPSA-Eur-Sec adds other conventional generators, storage units and
-the additional sectors.
 
-Currently the scripts to solve and process the resulting PyPSA models
-are also included in PyPSA-Eur-Sec, although they could in future be
-better integrated with the corresponding scripts in PyPSA-Eur. A
-stumbling block to sharing solve_network.py between PyPSA-Eur and
-PyPSA-Eur-Sec is the different extra_functionality required to build
-storage and CHP constraints.
-
-
-PyPSA-Eur-Sec is designed to be imported into the open toolbox `PyPSA
-<https://www.pypsa.org>`_ for which `documentation <https://pypsa.org/doc>`_ is
-available as well.
-
-This project is currently maintained by the `Department of Digital
-Transformation in Energy Systems <https://tub-ensys.github.io>`_ at the
-`Technical University of Berlin <https://www.tu.berlin>`_. Previous versions
-were developed by the `Energy System Modelling group
-<https://www.iai.kit.edu/english/2338.php>`_ at the `Institute for Automation
-and Applied Informatics <https://www.iai.kit.edu/english/index.php>`_ at the
-`Karlsruhe Institute of Technology <http://www.kit.edu/english/index.php>`_
-which was funded by the `Helmholtz Association <https://www.helmholtz.de/en/>`_,
-and by the `Renewable Energy Group
->>>>>>> pypsa-eur-sec/master
-<https://fias.uni-frankfurt.de/physics/schramm/renewable-energy-system-and-network-analysis/>`_
-at `FIAS <https://fias.uni-frankfurt.de/>`_ to carry out simulations for the
-`CoNDyNet project <http://condynet.de/>`_, financed by the `German Federal
-Ministry for Education and Research (BMBF) <https://www.bmbf.de/en/index.html>`_
-as part of the `Stromnetze Research Initiative
-<http://forschung-stromnetze.info/projekte/grundlagen-und-konzepte-fuer-effiziente-dezentrale-stromnetze/>`_.
-
-<<<<<<< HEAD
-A version of the model that adds building heating, transport and industry sectors to the model,
-as well as gas networks, is currently being developed in the `PyPSA-Eur-Sec repository <https://github.com/pypsa/pypsa-eur-sec>`_.
-=======
 Workflow Outline
 ================
 
@@ -166,27 +121,21 @@ Workflow Outline
     The graph above was generated using
     ``snakemake --rulegraph -F | sed -n "/digraph/,/}/p" | dot -Tpng -o workflow.png``
 
->>>>>>> pypsa-eur-sec/master
 
 Documentation
 =============
 
 **Getting Started**
 
-<<<<<<< HEAD
 * :doc:`introduction`
 * :doc:`installation`
 * :doc:`tutorial`
-=======
-* :doc:`installation`
->>>>>>> pypsa-eur-sec/master
 
 .. toctree::
    :hidden:
    :maxdepth: 1
    :caption: Getting Started
 
-<<<<<<< HEAD
    introduction
    installation
    tutorial
@@ -196,25 +145,30 @@ Documentation
 * :doc:`wildcards`
 * :doc:`configuration`
 * :doc:`costs`
-=======
+
-   installation
+.. toctree::
+   :hidden:
+   :maxdepth: 1
+   :caption: Configuration
+
+   wildcards
+   configuration
+   costs
 
 **Implementation details**
 
 * :doc:`spatial_resolution`
 * :doc:`supply_demand`
 * :doc:`technology_assumptions`
->>>>>>> pypsa-eur-sec/master
 
 .. toctree::
    :hidden:
    :maxdepth: 1
-<<<<<<< HEAD
+   :caption: Implementation details
-   :caption: Configuration
 
-   wildcards
+   spatial_resolution
-   configuration
+   supply_demand
-   costs
+   technology_assumptions
 
 **Rules Overview**
 
@@ -222,46 +176,37 @@ Documentation
 * :doc:`simplification`
 * :doc:`solving`
 * :doc:`plotting`
-=======
-   :caption: Implementation details
-
-   spatial_resolution
-   supply_demand
-   technology_assumptions
-
-**Foresight options**
-
-* :doc:`overnight`
-* :doc:`myopic`
-* :doc:`perfect`
->>>>>>> pypsa-eur-sec/master
 
 .. toctree::
    :hidden:
    :maxdepth: 1
-<<<<<<< HEAD
    :caption: Rules Overview
 
    preparation
    simplification
    solving
    plotting
-=======
+
+**Foresight options**
+
+* :doc:`overnight`
+* :doc:`myopic`
+* :doc:`perfect`
+
+.. toctree::
+   :hidden:
+   :maxdepth: 1
    :caption: Foresight options
 
    overnight
    myopic
    perfect
->>>>>>> pypsa-eur-sec/master
 
 **References**
 
 * :doc:`release_notes`
 * :doc:`limitations`
-<<<<<<< HEAD
 * :doc:`contributing`
-=======
->>>>>>> pypsa-eur-sec/master
 
 .. toctree::
    :hidden:
@@ -270,9 +215,9 @@ Documentation
 
    release_notes
    limitations
-<<<<<<< HEAD
    contributing
 
+
 Warnings
 ========
 
@@ -344,14 +289,10 @@ The included ``.nc`` files are PyPSA network files which can be imported with Py
 
     filename = "elec_s_1024_ec.nc"  # example
     n = pypsa.Network(filename)
-=======
-
->>>>>>> pypsa-eur-sec/master
 
 Licence
 =======
 
-<<<<<<< HEAD
 PyPSA-Eur work is released under multiple licenses:
 
 * All original source code is licensed as free software under `MIT <LICENSES/MIT.txt>`_.
@@ -372,9 +313,3 @@ More details are included in
 * *BY: Attribute Source*
 * *NC: Non-Commercial Use Only*
 * *SA: Share Alike*
-=======
-The code in PyPSA-Eur-Sec is released as free software under the
-`MIT license <https://opensource.org/licenses/MIT>`_, see
-`LICENSE <https://github.com/PyPSA/pypsa-eur-sec/blob/master/LICENSE.txt>`_.
-However, different licenses and terms of use may apply to the various input data.
->>>>>>> pypsa-eur-sec/master

doc/installation.rst

@@ -1,11 +1,8 @@
-<<<<<<< HEAD
 ..
   SPDX-FileCopyrightText: 2019-2023 The PyPSA-Eur Authors
 
   SPDX-License-Identifier: CC-BY-4.0
 
-=======
->>>>>>> pypsa-eur-sec/master
 .. _installation:
 
 ##########################################
@@ -15,13 +12,10 @@ Installation
 The subsequently described installation steps are demonstrated as shell commands, where the path before the ``%`` sign denotes the
 directory in which the commands following the ``%`` should be entered.
 
-<<<<<<< HEAD
 Clone the Repository
 ====================
 
 First of all, clone the `PyPSA-Eur repository <https://github.com/PyPSA/pypsa-eur>`_ using the version control system ``git``.
-The path to the directory into which the ``git repository`` is cloned, must **not** have any spaces!
-If you do not have ``git`` installed, follow installation instructions `here <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_.
 
 .. code:: bash
 
@@ -42,47 +36,6 @@ For instructions for your operating system follow the ``conda`` `installation gu
 
 The python package requirements are curated in the `envs/environment.yaml <https://github.com/PyPSA/pypsa-eur/blob/master/envs/environment.yaml>`_ file.
 The environment can be installed and activated using
-=======
-Install PyPSA-Eur and its data
-==============================
-
-First install `PyPSA-Eur <https://github.com/PyPSA/pypsa-eur>`_ and all
-its dependencies. Clone the repository:
-
-
-.. code:: bash
-
-    projects % git clone https://github.com/PyPSA/pypsa-eur.git
-
-then download and unpack all the PyPSA-Eur data files by running the following snakemake rule:
-
-.. code:: bash
-
-    projects/pypsa-eur % snakemake -j 1 retrieve_databundle
-
-
-
-Clone PyPSA-Eur-Sec repository
-==============================
-
-Create a parallel directory for `PyPSA-Eur-Sec <https://github.com/PyPSA/pypsa-eur-sec>`_ with:
-
-.. code:: bash
-
-    projects % git clone https://github.com/PyPSA/pypsa-eur-sec.git
-
-Environment/package requirements
-================================
-
-
-
-The requirements are the same as `PyPSA-Eur <https://github.com/PyPSA/pypsa-eur>`_. For
-``solve_network.py`` in addition you need ``gurobipy``.  If you have
-xarray version >= 0.15.1, you will need the latest master branch of
-atlite version 0.0.2.
-
-You can create an environment using the environment.yaml file in pypsa-eur/envs:
->>>>>>> pypsa-eur-sec/master
 
 .. code:: bash
 
@@ -90,7 +43,7 @@ You can create an environment using the environment.yaml file in pypsa-eur/envs:
 
     .../pypsa-eur % conda activate pypsa-eur
 
-<<<<<<< HEAD
+
 Note that activation is local to the currently open shell!
 After opening a new terminal window, one needs to reissue the second command!
 
@@ -173,65 +126,4 @@ Before first use, create a ``config.yaml`` by copying the example.
 
 Users are advised to regularly check their own ``config.yaml`` against changes in the ``config.default.yaml``
 when pulling a new version from the remote repository.
-=======
-See details in `PyPSA-Eur Installation <https://pypsa-eur.readthedocs.io/en/latest/installation.html>`_
 
-Data requirements
-=================
-
-Small data files are included directly in the git repository, while
-larger ones are archived in a data bundle on zenodo (`10.5281/zenodo.5824485 <https://doi.org/10.5281/zenodo.5824485>`_).
-The data bundle's size is around 640 MB.
-
-To download and extract the data bundle on the command line:
-
-.. code:: bash
-
-    projects/pypsa-eur-sec/data % wget "https://zenodo.org/record/5824485/files/pypsa-eur-sec-data-bundle.tar.gz"
-    projects/pypsa-eur-sec/data % tar -xvzf pypsa-eur-sec-data-bundle.tar.gz
-
-
-The data licences and sources are given in the following table.
-
-
-.. csv-table::
-   :header-rows: 1
-   :file: data.csv
-
-
-
-Set up the default configuration
-================================
-
-First make your own copy of the ``config.yaml`` based on
- ``config.default.yaml``. For example:
-
-.. code:: bash
-
-    projects/pypsa-eur-sec % cp config.default.yaml config.yaml
-
-
-Getting started
-===============
-
-
-In ``config.yaml`` you can control the settings for the scenarios you
-want to run, such as the number of nodes, the CO2 limit, the
-installable potentials for solar and wind, which technologies are
-activated, etc.
-
-To run the full optimization with your settings:
-
-.. code:: bash
-
-    projects/pypsa-eur-sec % snakemake -j1
-
-Warning: you may need a computer cluster for this (with e.g. 10-100 GB of RAM
-and several processors).
-
-To only prepare the networks, you can run the scripts up to the point before optimization:
-
-.. code:: bash
-
-    projects/pypsa-eur-sec % snakemake -j1 prepare_sector_networks
->>>>>>> pypsa-eur-sec/master

doc/limitations.rst

@@ -1,37 +1,24 @@
-<<<<<<< HEAD
 ..
   SPDX-FileCopyrightText: 2019-2023 The PyPSA-Eur Authors
 
   SPDX-License-Identifier: CC-BY-4.0
 
-=======
->>>>>>> pypsa-eur-sec/master
 ##########################################
 Limitations
 ##########################################
 
-<<<<<<< HEAD
-
-While the benefit of an openly available, functional and partially validated
-model of the European transmission system is high, many approximations have
-=======
 While the benefit of an openly available, functional and partially validated
 model of the European energy system is high, many approximations have
->>>>>>> pypsa-eur-sec/master
 been made due to missing data.
 The limitations of the dataset are listed below,
 both as a warning to the user and as an encouragement to assist in
 improving the approximations.
 
-<<<<<<< HEAD
-- **Network topology:**
-=======
 This list of limitations is incomplete and will be added to over time.
 
-See also the `GitHub repository issues <https://github.com/PyPSA/pypsa-eur-sec/issues>`_.
+See also the `GitHub repository issues <https://github.com/PyPSA/pypsa-eur/issues>`_.
 
 - **Electricity transmission network topology:**
->>>>>>> pypsa-eur-sec/master
   The grid data is based on a map of the ENTSO-E area that is known
   to contain small distortions to improve readability. Since the exact impedances
   of the lines are unknown, approximations based on line lengths and standard
@@ -39,20 +26,11 @@ See also the `GitHub repository issues <https://github.com/PyPSA/pypsa-eur-sec/i
   particular lines. There is no openly available data on busbar configurations, switch
   locations, transformers or reactive power compensation assets.
 
-<<<<<<< HEAD
-- **Distribution networks:**
-=======
 - **Assignment of electricity demand to transmission nodes:**
->>>>>>> pypsa-eur-sec/master
   Using Voronoi cells to aggregate load and generator data to transmission
   network substations ignores the topology of the underlying distribution network,
   meaning that assets may be connected to the wrong substation.
 
-<<<<<<< HEAD
-- **Power Demand:**
-  Assumptions
-  have been made about the distribution of load in each country proportional to
-=======
 - **Incomplete information on existing assets:** Approximations have
   been made for missing data, including: existing distribution grid
   capacities and costs, existing space and water heating supply,
@@ -69,14 +47,12 @@ See also the `GitHub repository issues <https://github.com/PyPSA/pypsa-eur-sec/i
 - **Energy demand distribution within countries:**
   Assumptions
   have been made about the distribution of demand in each country proportional to
->>>>>>> pypsa-eur-sec/master
   population and GDP that may not reflect local circumstances.
   Openly available
   data on load time series may not correspond to the true vertical load and is
   not spatially disaggregated; assuming, as we have done, that the load time series
   shape is the same at each node within each country ignores local differences.
 
-<<<<<<< HEAD
 - **Currently installed renewable capacities:**
   Information on existing wind, solar and small hydro, geothermal, marine and
   biomass power plants are excluded from the dataset because of a lack of data
@@ -84,8 +60,6 @@ See also the `GitHub repository issues <https://github.com/PyPSA/pypsa-eur-sec/i
   plants in each country can be generated that are proportional to the capacity
   factor at each location.
 
-=======
->>>>>>> pypsa-eur-sec/master
 - **Hydro-electric power plants:**
   The database of hydro-electric power plants does not include plant-specific
   energy storage information, so that blanket values based on country storage
@@ -98,9 +72,6 @@ See also the `GitHub repository issues <https://github.com/PyPSA/pypsa-eur-sec/i
   Belarus, Ukraine, Turkey and Morocco have not been taken into account;
   islands which are not connected to the main European system, such as Malta,
   Crete and Cyprus, are also excluded from the model.
-<<<<<<< HEAD
-=======
 
 - **Demand sufficiency:** Further measures of demand reduction may be
   possible beyond the assumptions made here.
->>>>>>> pypsa-eur-sec/master

doc/preparation/retrieve.rst

@@ -129,3 +129,19 @@ None.
 **Outputs**
 
 - ``data/shipdensity_global.zip``
+
+
+Rule ``retrieve_sector_databundle``
+-----------------------------------
+
+
+Small data files are included directly in the git repository, while
+larger ones are archived in a data bundle on zenodo (`10.5281/zenodo.5824485 <https://doi.org/10.5281/zenodo.5824485>`_).
+The data bundle's size is around 640 MB.
+
+The data licences and sources are given in the following table.
+
+
+.. csv-table::
+   :header-rows: 1
+   :file: data.csv

doc/release_notes.rst

@@ -1,21 +1,24 @@
-<<<<<<< HEAD
 ..
   SPDX-FileCopyrightText: 2019-2023 The PyPSA-Eur Authors
 
   SPDX-License-Identifier: CC-BY-4.0
 
-=======
->>>>>>> pypsa-eur-sec/master
 ##########################################
 Release Notes
 ##########################################
 
-<<<<<<< HEAD
 Upcoming Release
 ================
 
 * new features
 
+Future release
+==============
+
+.. note::
+  This unreleased version currently may require the master branches of PyPSA, PyPSA-Eur, and the technology-data repository.
+
+* new feature
 
 PyPSA-Eur 0.7.0 (16th February 2023)
 ====================================
@@ -605,18 +608,13 @@ This is the first release of PyPSA-Eur, a model of the European power system at
 * Logfiles for all rules of the ``snakemake`` workflow are now written in the folder ``log/`` [`#102 <https://github.com/PyPSA/pypsa-eur/pull/102>`_].
 
 * The new function ``_helpers.mock_snakemake`` creates a ``snakemake`` object which mimics the actual ``snakemake`` object produced by workflow by parsing the ``Snakefile`` and setting all paths for inputs, outputs, and logs. This allows running all scripts within a (I)python terminal (or just by calling ``python <script-name>``) and thereby facilitates developing and debugging scripts significantly [`#107 <https://github.com/PyPSA/pypsa-eur/pull/107>`_].
-=======
-Future release
-==============
 
-.. note::
-  This unreleased version currently may require the master branches of PyPSA, PyPSA-Eur, and the technology-data repository.
-
-* new feature
 
+PyPSA-Eur-Sec Releases
+======================
 
 PyPSA-Eur-Sec 0.7.0 (16th February 2023)
-========================================
+----------------------------------------
 
 This release includes many new features. Highlights include new gas
 infrastructure data with retrofitting options for hydrogen transport, improved
@@ -827,7 +825,7 @@ Many thanks to all who contributed to this release!
 
 
 PyPSA-Eur-Sec 0.6.0 (4 October 2021)
-====================================
+------------------------------------
 
 This release includes
 improvements regarding the basic chemical production,
@@ -1013,7 +1011,7 @@ Many thanks to all who contributed to this release!
 
 
 PyPSA-Eur-Sec 0.5.0 (21st May 2021)
-===================================
+-----------------------------------
 
 This release includes improvements to the cost database for building retrofits, carbon budget management and wildcard settings, as well as an important bugfix for the emissions from land transport.
 
@@ -1034,7 +1032,7 @@ New features and bugfixes:
 Thanks to Lisa Zeyen (KIT) for the retrofitting improvements and Marta Victoria (Aarhus University) for the carbon budget and wildcard management.
 
 PyPSA-Eur-Sec 0.4.0 (11th December 2020)
-=========================================
+----------------------------------------
 
 This release includes a more accurate nodal disaggregation of industry demand within each country, fixes to CHP and CCS representations, as well as changes to some configuration settings.
 
@@ -1056,7 +1054,7 @@ Many thanks to Fraunhofer ISI for opening the hotmaps database and to Lisa Zeyen
 
 
 PyPSA-Eur-Sec 0.3.0 (27th September 2020)
-=========================================
+-----------------------------------------
 
 This releases focuses on improvements to industry demand and the generation of intermediate files for demand for basic materials. There are still inconsistencies with CCS and waste management that need to be improved.
 
@@ -1079,7 +1077,7 @@ New features:
 
 
 PyPSA-Eur-Sec 0.2.0 (21st August 2020)
-======================================
+--------------------------------------
 
 This release introduces pathway optimization over many years (e.g. 2020, 2030, 2040, 2050) with myopic foresight, as well as outsourcing the technology assumptions to the `technology-data <https://github.com/PyPSA/technology-data>`_ repository.
 
@@ -1103,7 +1101,7 @@ Many thanks to Marta Victoria for implementing the myopic foresight, and Marta V
 
 
 PyPSA-Eur-Sec 0.1.0 (8th July 2020)
-===================================
+-----------------------------------
 
 This is the first proper release of PyPSA-Eur-Sec, a model of the European energy system at the transmission network level that covers the full ENTSO-E area.
 
@@ -1141,7 +1139,7 @@ the additional sectors.
 
 
 PyPSA-Eur-Sec 0.0.2 (4th September 2020)
-========================================
+----------------------------------------
 
 This version, also called PyPSA-Eur-Sec-30-Path, built on
 PyPSA-Eur-Sec 0.0.1 (also called PyPSA-Eur-Sec-30) to include myopic
@@ -1157,7 +1155,7 @@ on Zenodo <https://zenodo.org/record/4014807>`_.
 
 
 PyPSA-Eur-Sec 0.0.1 (12th January 2018)
-========================================
+---------------------------------------
 
 This is the first published version of PyPSA-Eur-Sec, also called
 PyPSA-Eur-Sec-30. It was first used in the research paper `Synergies of
@@ -1171,12 +1169,9 @@ transport.
 It is `archived on Zenodo <https://zenodo.org/record/1146666>`_.
 
 
->>>>>>> pypsa-eur-sec/master
-
 Release Process
 ===============
 
-<<<<<<< HEAD
 * Checkout a new release branch ``git checkout -b release-v0.x.x``.
 
 * Finalise release notes at ``doc/release_notes.rst``.
@@ -1187,29 +1182,19 @@ Release Process
 
 * Update version number in ``doc/conf.py``, ``CITATION.cff`` and ``*config.*.yaml``.
 
+* Make a ``git commit``.
+
 * Open, review and merge pull request for branch ``release-v0.x.x``.
   Make sure to close issues and PRs or the release milestone with it (e.g. closes #X).
 
 * Tag a release on Github via ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message.
 
-* Upload code to `zenodo code repository <https://doi.org/10.5281/zenodo.3520874>`_ with `MIT license <https://opensource.org/licenses/MIT>`_.
+* Make a `GitHub release <https://github.com/PyPSA/pypsa-eur-sec/releases>`_, which automatically triggers archiving to the `zenodo code repository <https://doi.org/10.5281/zenodo.3520874>`_ with `MIT license <https://opensource.org/licenses/MIT>`_.
 
 * Create pre-built networks for ``config.default.yaml`` by running ``snakemake -call extra_components_all_networks``.
 
 * Upload pre-built networks to `zenodo data repository <https://doi.org/10.5281/zenodo.3601881>`_ with `CC BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`_ license.
 
-* Send announcement on the `PyPSA and PyPSA-Eur mailing list <https://groups.google.com/forum/#!forum/pypsa>`_.
-=======
-* Finalise release notes at ``doc/release_notes.rst``.
-
-* Update version number in ``doc/conf.py`` and ``*config.*.yaml``.
-
-* Make a ``git commit``.
-
-* Tag a release by running ``git tag v0.x.x``, ``git push``, ``git push --tags``. Include release notes in the tag message.
-
-* Make a `GitHub release <https://github.com/PyPSA/pypsa-eur-sec/releases>`_, which automatically triggers archiving by `zenodo <https://doi.org/10.5281/zenodo.3938042>`_.
-
 * Send announcement on the `PyPSA mailing list <https://groups.google.com/forum/#!forum/pypsa>`_.
 
 To make a new release of the data bundle, make an archive of the files in ``data`` which are not already included in the git repository:
@@ -1217,4 +1202,3 @@ To make a new release of the data bundle, make an archive of the files in ``data
 .. code:: bash
 
     data % tar pczf pypsa-eur-sec-data-bundle.tar.gz eea/UNFCCC_v23.csv switzerland-sfoe biomass eurostat-energy_balances-* jrc-idees-2015 emobility WindWaveWEC_GLTB.xlsx myb1-2017-nitro.xls Industrial_Database.csv retro/tabula-calculator-calcsetbuilding.csv nuts/NUTS_RG_10M_2013_4326_LEVL_2.geojson h2_salt_caverns_GWh_per_sqkm.geojson
->>>>>>> pypsa-eur-sec/master