diff --git a/README.md b/README.md index c6b75e22..391ae934 100644 --- a/README.md +++ b/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 diff --git a/doc/conf.py b/doc/conf.py index 12c2aaca..9eda248a 100644 --- a/doc/conf.py +++ b/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', diff --git a/doc/contributing.rst b/doc/contributing.rst index 7f30dea0..d11b37cd 100644 --- a/doc/contributing.rst +++ b/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 `_. -* 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 `_. +* If you are wondering where we would greatly appreciate your efforts, check out the ``help wanted`` tag in the `issues list `_ in your code. +* We encourage you to use the `PEP 8 coding style `_. 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. diff --git a/doc/costs.rst b/doc/costs.rst index e65ddf27..767268b5 100644 --- a/doc/costs.rst +++ b/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 `_ 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 `_ +- `Gurobi `_ - `CPLEX `_ and any other solver that works with the underlying modelling framework `Pyomo `_. diff --git a/doc/introduction.rst b/doc/introduction.rst index d28e6ee7..c6debbd4 100644 --- a/doc/introduction.rst +++ b/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 ========= diff --git a/doc/tutorial.rst b/doc/tutorial.rst index 4e03ec42..26a2cf85 100644 --- a/doc/tutorial.rst +++ b/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 `_. diff --git a/environment.docs.yaml b/environment.docs.yaml index 19c3d224..afefac9d 100755 --- a/environment.docs.yaml +++ b/environment.docs.yaml @@ -50,3 +50,5 @@ dependencies: - cdsapi - sphinx - sphinx_rtd_theme + - sphinxcontrib-youtube + - sphinxcontrib-slide