doc: link tutorial videos, slides and snakemake badge [skip travis]

README.md

@@ -5,6 +5,7 @@
 ![Size](https://img.shields.io/github/repo-size/pypsa/pypsa-eur)
 [![Zenodo](https://zenodo.org/badge/DOI/10.5281/zenodo.3520875.svg)](https://doi.org/10.5281/zenodo.3520875)
 [![Gitter](https://badges.gitter.im/PyPSA/community.svg)](https://gitter.im/PyPSA/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Snakemake](https://img.shields.io/badge/snakemake-≥5.0.0-brightgreen.svg?style=flat)](https://snakemake.readthedocs.io)
 
 # PyPSA-Eur: An Open Optimisation Model of the European Transmission System
 

doc/conf.py

@@ -37,6 +37,8 @@ extensions = [
     'sphinx.ext.mathjax',
     'sphinx.ext.napoleon',
     'sphinx.ext.graphviz',
+    'sphinxcontrib.youtube',
+    'sphinxcontrib.slide',
     #'sphinx.ext.pngmath',
     #'sphinxcontrib.tikz',
     #'rinoh.frontend.sphinx',

doc/contributing.rst

@@ -6,11 +6,12 @@ We happily welcome anyone interested in contributing to this project,
 be it with new ideas, suggestions, by filing bug reports or contributing code
 to our `GitHub repository <https://github.com/PyPSA/PyPSA-Eur>`_.
 
-* If you already have some code changes, you can submit them directly as a pull request.
+* If you already have some code changes, you can submit them directly as a `pull request <https://github.com/PyPSA/pypsa-eur/pulls>`_.
+* If you are wondering where we would greatly appreciate your efforts, check out the ``help wanted`` tag in the `issues list <https://github.com/PyPSA/pypsa-eur/issues`_ and initiate a discussion there..
 * If you start working on a feature in the code, let us know by opening an issue or a draft pull request.
   This helps all of us to keep an overview on what is being done and helps to avoid a situation where we
   are doing the same work twice in parallel.
-* We encourage you to use the `PEP 8 coding style <https://www.python.org/dev/peps/pep-0008/>`_ in your code.
+* We encourage you to use the `PEP 8 coding style <https://www.python.org/dev/peps/pep-0008/>`_.
 
 For all code contributions we follow the four eyes principle (two person principle), i.e. all suggested code
 including our own are reviewed by a second person before they are incoporated into our repository.

doc/costs.rst

@@ -25,6 +25,9 @@ with a discount rate of :math:`r` over the economic lifetime :math:`n` using the
 
 Based on the parameters above the ``marginal_cost`` and ``capital_cost`` of the system components are calculated.
 
+.. note::
+
+    Another great resource for `cost assumptions <https://ens.dk/en/our-services/projections-and-models/technology-data`_ is the cost database from the Danish Energy Agency.
 
 Modifying Cost Assumptions
 ==========================

doc/index.rst

@@ -24,6 +24,10 @@ PyPSA-Eur: An Open Optimisation Model of the European Transmission System
     :target: https://gitter.im/PyPSA/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
     :alt: Chat on Gitter
 
+.. image:: https://img.shields.io/badge/snakemake-≥5.0.0-brightgreen.svg?style=flat
+    :target: https://snakemake.readthedocs.io
+    :alt: Snakemake
+
 PyPSA-Eur is an open model dataset of the European power system at the
 transmission network level that covers the full ENTSO-E area.
 

doc/installation.rst

@@ -45,6 +45,20 @@ The environment can be installed and activated using
     Note that activation is local to the currently open shell!
     After opening a new terminal window, one needs to reissue the second command!
 
+.. note::
+    If you have troubles with a slow ``conda`` installation, we recommend to install
+    `mamba <https://github.com/QuantStack/mamba>`_ as a fast drop-in replacement via
+
+    .. code:: bash
+        
+        conda install -c conda-forge mamba
+
+    and then install the environment with
+
+    .. coda:: bash
+
+        mamba env create -f environment.yaml
+
 Install a Solver
 ================
 
@@ -57,7 +71,7 @@ PyPSA is known to work with the free software
 
 and the non-free, commercial software (for which free academic licenses are available)
 
-- `Gurobi <https://www.gurobi.com/documentation/8.1/remoteservices/installation.html>`_
+- `Gurobi <https://www.gurobi.com/documentation/quickstart.html>`_
 - `CPLEX <https://www.ibm.com/products/ilog-cplex-optimization-studio>`_
 
 and any other solver that works with the underlying modelling framework `Pyomo <http://www.pyomo.org/>`_.

doc/introduction.rst

@@ -4,6 +4,10 @@
  Introduction
 ##########################################
 
+.. youtube:: ty47YU1_eeQ
+
+.. slide:: https://docs.google.com/presentation/d/e/2PACX-1vQGQZD7KIVdocRZzRVu8Uk-JC_ltEow5zjtIarhyws46IMJpaqGuux695yincmJA_i5bVEibEs7z2eo/pub?start=false&loop=true&delayms=3000
+
 Workflow
 =========
 

doc/tutorial.rst

@@ -4,6 +4,8 @@
 Tutorial
 #####################
 
+.. youtube:: mAwhQnNRIvs
+
 Before getting started with **PyPSA-Eur** it makes sense to be familiar
 with its general modelling framework `PyPSA <https://pypsa.readthedocs.io>`_.
 

environment.docs.yaml

@@ -50,3 +50,5 @@ dependencies:
     - cdsapi
     - sphinx
     - sphinx_rtd_theme
+    - sphinxcontrib-youtube
+    - sphinxcontrib-slide