https://github.com/PyPSA/PyPSA
Tip revision: cd7bcab757a4b3257e5c3a60aa618668cb679663 authored by Fabian Neumann on 18 February 2024, 11:18:00 UTC
Merge pull request #837 from PyPSA/prepare-release-v0.27
Merge pull request #837 from PyPSA/prepare-release-v0.27
Tip revision: cd7bcab
index.rst
.. PyPSA documentation master file, created by
sphinx-quickstart on Tue Jan 5 10:04:42 2016.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
PyPSA: Python for Power System Analysis
=======================================
.. image:: https://img.shields.io/pypi/v/pypsa.svg
:target: https://pypi.python.org/pypi/pypsa
:alt: PyPI version
.. image:: https://img.shields.io/conda/vn/conda-forge/pypsa.svg
:target: https://anaconda.org/conda-forge/pypsa
:alt: Conda version
.. image:: https://github.com/pypsa/pypsa/actions/workflows/CI.yml/badge.svg
:target: https://github.com/pypsa/pypsa/actions/workflows/circumstances.yml
.. image:: https://github.com/pypsa/pypsa/actions/workflows/CI-micromamba.yml/badge.svg
:target: https://github.com/pypsa/pypsa/actions/workflows/CI-micromamba.yml
.. image:: https://codecov.io/gh/PyPSA/PyPSA/branch/master/graph/badge.svg?token=kCpwJiV6Jr
:target: https://codecov.io/gh/PyPSA/PyPSA
.. image:: https://readthedocs.org/projects/pypsa/badge/?version=latest
:target: https://pypsa.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/pypi/l/pypsa.svg
:target: License
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.3946412.svg
:target: https://doi.org/10.5281/zenodo.3946412
.. 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
.. image:: https://results.pre-commit.ci/badge/github/PyPSA/PyPSA/master.svg
:target: https://results.pre-commit.ci/latest/github/PyPSA/PyPSA/master
:alt: pre-commit.ci status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code style: black
.. image:: https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg
:target: code_of_conduct.md
:alt: Contributor Covenant 2.1
.. image:: https://img.shields.io/stackexchange/stackoverflow/t/pypsa
:target: https://stackoverflow.com/questions/tagged/pypsa
:alt: Stackoverflow
PyPSA stands for "Python for Power System Analysis". It is pronounced "pipes-ah".
PyPSA is an open source toolbox for
simulating and optimising modern power and energy systems that include features
such as conventional generators and links with unit commitment, variable wind
and solar generation, storage units, coupling to other energy sectors,
and mixed alternating and direct current networks. PyPSA is graph-based and designed
to scale well with large networks and long time series.
This project is 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 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>`_ funded by the
`Helmholtz Association <https://www.helmholtz.de/en/>`_, and 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
=============
**Getting Started**
* :doc:`introduction`
* :doc:`installation`
* :doc:`quick_start`
.. toctree::
:hidden:
:maxdepth: 1
:caption: Getting Started
introduction
installation
quick_start
**Examples**
* :doc:`examples-basic`
* :doc:`examples-lopf`
* :doc:`examples-sector_coupling`
* :doc:`examples-models`
* :doc:`examples-other`
.. toctree::
:hidden:
:maxdepth: 2
:caption: Examples
examples-basic
examples-lopf
examples-sector_coupling
examples-models
examples-other
**User Guide**
* :doc:`design`
* :doc:`components`
* :doc:`import_export`
* :doc:`power_flow`
* :doc:`optimal_power_flow`
* :doc:`contingency_analysis`
* :doc:`plotting`
.. toctree::
:hidden:
:maxdepth: 2
:caption: User Guide
design
components
import_export
power_flow
optimal_power_flow
contingency_analysis
plotting
**Help & References**
* :doc:`release_notes`
* :doc:`api_reference`
* :doc:`troubleshooting`
* :doc:`comparable_software`
* :doc:`contributing`
* :doc:`support`
* :doc:`citing`
* :doc:`unit_testing`
* :doc:`mailing_list`
* :doc:`users`
* :doc:`developers`
.. toctree::
:hidden:
:maxdepth: 1
:caption: Help & References
release_notes
api_reference
troubleshooting
comparable_software
contributing
support
citing
unit_testing
mailing_list
users
developers