You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Fabian b44171c591 plot.py ignore empty geometries if geometry=True 2 days ago
doc index.rst: add chat on gitter (skip travis) 1 week ago
examples Update plots in examples and introduction [skip travis] 1 month ago
pypsa plot.py ignore empty geometries if geometry=True 2 days ago
test test: handle missing Python 2 support for pandapower 1 month ago
website PyPSA Version 0.13.2 7 months ago
.gitignore website: Add website files 2 years ago
.readthedocs.yml conda readthedocs environment 1 month ago
.travis.yml .travis: Make travis respect PYTHON_VERSION 2 months ago
LICENSE.txt Include full GPL v3 licence 2 years ago
MANIFEST.in Prepare for travis-ci 1 year ago
Makefile Prepare for travis-ci 1 year ago
README.rst README: add gitter community chat (skip travis) 1 week ago
environment.yaml setup.py: Update dependencies and rename requirements.yml files 2 months ago
environment_dev.yaml .travis: Make travis respect PYTHON_VERSION 2 months ago
environment_docs.yml build conda environment pypsa from directory + minor corrections [skip travis] 1 month ago
setup.cfg Include a more friendly package format with setup.py etc. 3 years ago
setup.py setup: Move cartopy to extras_require (fixes #78) 6 days ago

README.rst

|badge_pypi| |badge_conda| |badge_travis| |badge_docs| |badge_license| |link-latest-doi| |gitter|

-----

################################
Python for Power System Analysis
################################

.. contents::

.. section-numbering::


About
=====

PyPSA stands for "Python for Power System Analysis". It is pronounced "pipes-ah".

PyPSA is a `free software
<http://www.gnu.org/philosophy/free-sw.en.html>`_ toolbox for
simulating and optimising modern power systems that include features
such as conventional generators with unit commitment, variable wind
and solar generation, storage units, coupling to other energy sectors,
and mixed alternating and direct current networks. PyPSA is designed
to scale well with large networks and long time series.

This project is maintained 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>`_. The group is funded by the
`Helmholtz Association <https://www.helmholtz.de/en/>`_ until 2024.
Previous versions were developed by the `Renewable Energy Group
<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/>`_.


Documentation
=============

`Documentation as a website <http://www.pypsa.org/doc/index.html>`_

`Quick start <http://www.pypsa.org/doc/quick_start.html>`_

`Examples <http://www.pypsa.org/examples/>`_

Documentation is in `sphinx
<http://www.sphinx-doc.org/en/stable/>`_ reStructuredText format in
the ``doc`` sub-folder of the repository.


What PyPSA does and does not do (yet)
=======================================

PyPSA can calculate:

* static power flow (using both the full non-linear network equations and
the linearised network equations)
* linear optimal power flow (least-cost optimisation of power plant
and storage dispatch within network constraints, using the linear
network equations, over several snapshots)
* security-constrained linear optimal power flow
* total electricity/energy system least-cost investment optimisation
(using linear network equations, over several snapshots
simultaneously for optimisation of generation and storage dispatch
and investment in the capacities of generation, storage,
transmission and other infrastructure)

It has models for:

* meshed multiply-connected AC and DC networks, with controllable
converters between AC and DC networks
* standard types for lines and transformers following the implementation in `pandapower <https://www.pandapower.org/>`_
* conventional dispatchable generators with unit commitment
* generators with time-varying power availability, such as
wind and solar generators
* storage units with efficiency losses
* simple hydroelectricity with inflow and spillage
* coupling with other energy carriers
* basic components out of which more complicated assets can be built,
such as Combined Heat and Power (CHP) units, heat pumps, resistive
Power-to-Heat (P2H), Power-to-Gas (P2G), battery electric vehicles
(BEVs), Fischer-Tropsch, direct air capture (DAC), etc.; each of
these is demonstrated in the `examples
<http://www.pypsa.org/examples/>`_


Functionality that may be added in the future:

* Multi-year investment optimisation
* Distributed active power slack
* Interactive web-based GUI with SVG
* OPF with the full non-linear network equations
* Port to `Julia <http://julialang.org/>`_

Other complementary libraries:

* `pandapower <https://www.pandapower.org/>`_ for more
detailed modelling of distribution grids, short-circuit
calculations, unbalanced load flow and more
* `PowerDynamics.jl
<https://github.com/JuliaEnergy/PowerDynamics.jl>`_ for dynamic
modelling of power grids at time scales where differential equations are relevant



Example scripts as Jupyter notebooks
====================================

There are `extensive examples <http://www.pypsa.org/examples/>`_
available as `Jupyter notebooks <https://jupyter.org/>`_. They are
also described in the `doc/examples.rst <doc/examples.rst>`_ and are
available as Python scripts in `examples/ <examples/>`_.

Screenshots
===========


* `PyPSA-Eur <https://github.com/PyPSA/pypsa-eur>`_ optimising capacities of generation, storage and transmission lines (9% line volume expansion allowed) for a 95% reduction in CO2 emissions in Europe compared to 1990 levels

.. image:: doc/img/elec_s_256_lv1.09_Co2L-3H.png
:align: center
:width: 700px


* `SciGRID model <https://power.scigrid.de/>`_ simulating the German power system for 2015. Interactive plots also be generated with the `plotly <https://plot.ly/python/>`_ library, as shown in this `Notebook <https://pypsa.org/examples/scigrid-lopf-then-pf-plotly.html>`_

.. image:: doc/img/stacked-gen_and_storage-scigrid.png
:align: center

.. image:: doc/img/lmp_and_line-loading.png
:align: right


.. image:: doc/img/reactive-power.png
:align: center
:width: 600px


* Small meshed AC-DC toy model

.. image:: doc/img/ac_dc_meshed.png
:align: center
:width: 400px

All results from a PyPSA simulation can be converted into an interactive
online animation using `PyPSA-animation
<https://github.com/PyPSA/PyPSA-animation>`_, for an example see the `PyPSA-Eur-30
example <https://www.pypsa.org/animations/pypsa-eur-30/>`_.



What PyPSA uses under the hood
===============================

PyPSA is written and tested to be compatible with Python 2.7, 3.6 and 3.7.

It leans heavily on the following Python packages:

* `pandas <http://pandas.pydata.org/>`_ for storing data about components and time series
* `numpy <http://www.numpy.org/>`_ and `scipy <http://scipy.org/>`_ for calculations, such as
linear algebra and sparse matrix calculations
* `pyomo <http://www.pyomo.org/>`_ for preparing optimisation problems (currently only linear)
* `plotly <https://plot.ly/python/>`_ for interactive plotting
* `matplotlib <https://matplotlib.org/>`_ for static plotting
* `cartopy <https://scitools.org.uk/cartopy>`_ for plotting the baselayer map
* `networkx <https://networkx.github.io/>`_ for some network calculations
* `py.test <http://pytest.org/>`_ for unit testing
* `logging <https://docs.python.org/3/library/logging.html>`_ for managing messages


The optimisation uses pyomo so that it is independent of the preferred
solver. You can use e.g. one of the free solvers `GLPK <https://www.gnu.org/software/glpk/>`_
and `CLP/CBC <https://github.com/coin-or/Cbc/>`_ or the commercial
solver `Gurobi <http://www.gurobi.com/>`_
for which free academic licenses are available.

The time-expensive calculations, such as solving sparse linear
equations, are carried out using the `scipy.sparse <https://docs.scipy.org/doc/scipy/reference/sparse.html>`_ libraries.



Mailing list
============

PyPSA has a Google Group `forum / mailing list
<https://groups.google.com/group/pypsa>`_.

Anyone can join and anyone can read the posts; only members of the
group can post to the list.

The intention is to have a place where announcements of new releases
can be made and questions can be asked.

To discuss issues and suggest/contribute features
for future development we prefer ticketing through the `PyPSA Github Issues page
<https://github.com/PyPSA/PyPSA/issues>`_.


Citing PyPSA
============



If you use PyPSA for your research, we would appreciate it if you
would cite the following paper:

* T. Brown, J. Hörsch, D. Schlachtberger, `PyPSA: Python for Power
System Analysis <https://arxiv.org/abs/1707.09913>`_, 2018,
`Journal of Open Research Software
<https://openresearchsoftware.metajnl.com/>`_, 6(1),
`arXiv:1707.09913 <https://arxiv.org/abs/1707.09913>`_,
`DOI:10.5334/jors.188 <https://doi.org/10.5334/jors.188>`_


Please use the following BibTeX: ::

@article{PyPSA,
author = {T. Brown and J. H\"orsch and D. Schlachtberger},
title = {{PyPSA: Python for Power System Analysis}},
journal = {Journal of Open Research Software},
volume = {6},
issue = {1},
number = {4},
year = {2018},
eprint = {1707.09913},
url = {https://doi.org/10.5334/jors.188},
doi = {10.5334/jors.188}
}


If you want to cite a specific PyPSA version, each release of PyPSA is
stored on `Zenodo <https://zenodo.org/>`_ with a release-specific DOI.
This can be found linked from the overall PyPSA Zenodo DOI:

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.786605.svg
:target: https://doi.org/10.5281/zenodo.786605


Licence
=======

Copyright 2015-2019 Tom Brown (KIT, FIAS), Jonas Hörsch (KIT, FIAS),
David Schlachtberger (FIAS)

This program is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either `version 3 of the
License <LICENSE.txt>`_, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
`GNU General Public License <LICENSE.txt>`_ for more details.

.. |link-latest-doi| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.786605.svg
.. _link-latest-doi: https://doi.org/10.5281/zenodo.786605

.. |badge_pypi| image:: https://img.shields.io/pypi/v/pypsa.svg
:target: https://pypi.python.org/pypi/pypsa
:alt: PyPI version

.. |badge_license| image:: https://img.shields.io/pypi/l/pypsa.svg
:target: License

.. |badge_travis| image:: https://img.shields.io/travis/PyPSA/PyPSA/master.svg
:target: https://travis-ci.org/PyPSA/PyPSA
:alt: Build status on Linux

.. |badge_docs| image:: https://readthedocs.org/projects/pypsa/badge/?version=latest
:target: https://pypsa.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. |badge_conda| image:: https://img.shields.io/conda/vn/conda-forge/pypsa.svg
:target: https://anaconda.org/conda-forge/pypsa
:alt: Conda version

.. |gitter| image:: https://badges.gitter.im/PyPSA/community.svg
:target: https://gitter.im/PyPSA/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge
:alt: Chat on Gitter