Skip to content

Commit

Permalink
Update landing page comments, features and comparable software
Browse files Browse the repository at this point in the history
For features that are unlikely to be developed in PyPSA directly, we
have linked to comparable software with this functionality.

Scare warning about heavy development has been removed.
  • Loading branch information
nworbmot committed Dec 3, 2018
1 parent 6cb091a commit 867c69e
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 73 deletions.
38 changes: 14 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,6 @@ 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.

As of 2018 PyPSA is under heavy development and therefore it is
recommended to use caution when using it in a production environment.
Some APIs may change - the changes in each PyPSA version are listed in
the `doc/release_notes.rst <doc/release_notes.rst>`_.




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
Expand Down Expand Up @@ -93,31 +85,29 @@ It has models for:
* 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), etc.; each of these is demonstrated in the `examples
(BEVs), Fischer-Tropsch, direct air capture (DAC), etc.; each of
these is demonstrated in the `examples
<https://www.pypsa.org/examples/>`_


Functionality that will definitely be added soon:
Functionality that may be added in the future:

* Multi-year investment optimisation
* Simple RMS simulations with the swing equation
* Distributed active power slack
* Non-linear power flow solution using `analytic continuation
<https://en.wikipedia.org/wiki/Holomorphic_embedding_load_flow_method>`_
in the complex plane following `GridCal
<https://github.com/SanPen/GridCal>`_

Functionality that may be added in the future:

* Short-circuit current calculations
* Dynamic RMS simulations
* Small signal stability analysis
* Interactive web-based GUI with SVG
* OPF with the full non-linear network equations
* Dynamic EMT simulations
* Unbalanced load flow
* Port to `Julia <https://julialang.org/>`_

Other complementary libraries:

* `pandapower <https://github.com/e2nIEE/pandapower>`_ 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
====================================
Expand Down Expand Up @@ -165,7 +155,7 @@ What PyPSA uses under the hood
===============================

PyPSA is written and tested to be compatible with both Python 2.7 and
Python 3.5.
Python 3.6.

It leans heavily on the following Python packages:

Expand Down
37 changes: 14 additions & 23 deletions doc/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ 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.


As of 2018 PyPSA is under heavy development and therefore it is
recommended to use caution when using it in a production
environment. Some APIs may change - the changes in each PyPSA version
are listed in the :doc:`release_notes`.

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
Expand Down Expand Up @@ -62,31 +56,28 @@ It has models for:
* 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), etc.; each of these is demonstrated in the `examples
(BEVs), Fischer-Tropsch, direct air capture (DAC), etc.; each of
these is demonstrated in the `examples
<https://www.pypsa.org/examples/>`_


Functionality that will definitely be added soon:
Functionality that may be added in the future:

* Multi-year investment optimisation
* Simple RMS simulations with the swing equation
* Distributed active power slack
* Non-linear power flow solution using `analytic continuation
<https://en.wikipedia.org/wiki/Holomorphic_embedding_load_flow_method>`_
in the complex plane following `GridCal
<https://github.com/SanPen/GridCal>`_

Functionality that may be added in the future:

* Short-circuit current calculations
* Dynamic RMS simulations
* Small signal stability analysis
* Interactive web-based GUI with SVG
* OPF with the full non-linear network equations
* Dynamic EMT simulations
* Unbalanced load flow
* Port to `Julia <https://julialang.org/>`_

Other complementary libraries:

* `pandapower <https://github.com/e2nIEE/pandapower>`_ 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
Expand Down Expand Up @@ -171,8 +162,8 @@ and DC. PyPSA uses some of the sparse-matrix constructs from PYPOWER.
What PyPSA uses under the hood
===============================

PyPSA is written and tested to be compatible with Python 2.7 and
Python 3.5.
PyPSA is written and tested to be compatible with both Python 2.7 and
Python 3.6.

It leans heavily on the following Python packages:

Expand Down
42 changes: 16 additions & 26 deletions website/index.org
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ units, coupling to other energy sectors, and mixed alternating and direct curren
networks. PyPSA is designed to scale well with large networks and long
time series.

As of 2018 PyPSA is under heavy development and therefore it is
recommended to use caution when using it in a production environment.
Some APIs may change - the changes in each PyPSA version are listed in
the [[./doc/release_notes.html][release notes]].



This project is maintained by the [[https://www.iai.kit.edu/english/2338.php][Energy System Modelling group]] at the
[[https://www.iai.kit.edu/english/index.php][Institute for Automation and Applied Informatics]] at the [[https://www.kit.edu/english/index.php][Karlsruhe
Expand Down Expand Up @@ -76,29 +70,25 @@ It has models for:
- 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), etc.; each of these is demonstrated in the
[[./examples/index.html][examples]]

Functionality that will definitely be added soon:
(BEVs), Fischer-Tropsch, direct air capture (DAC), etc.; each of
these is demonstrated in the [[./examples/index.html][examples]]

- Multi-year investment optimisation
- Simple RMS simulations with the swing equation
- Distributed active power slack
- Non-linear power flow solution using
[[https://en.wikipedia.org/wiki/Holomorphic_embedding_load_flow_method][analytic
continuation]] in the complex plane following
[[https://github.com/SanPen/GridCal][GridCal]]

Functionality that may be added in the future:

- Short-circuit current calculations
- Dynamic RMS simulations
- Small signal stability analysis
- Interactive web-based GUI with SVG
- OPF with the full non-linear network equations
- Dynamic EMT simulations
- Unbalanced load flow
- Port to [[https://julialang.org/][Julia]]
- Multi-year investment optimisation
- Distributed active power slack
- Interactive web-based GUI with SVG
- OPF with the full non-linear network equations
- Port to [[https://julialang.org/][Julia]]

Other complementary libraries:

- [[https://github.com/e2nIEE/pandapower][pandapower]] for more detailed modelling of distribution grids,
short-circuit calculations, unbalanced load flow and more
- [[https://github.com/JuliaEnergy/PowerDynamics.jl][PowerDynamics.jl]] for dynamic modelling of power grids at time scales
where differential equations are relevant



* Example scripts as Jupyter notebooks
Expand Down Expand Up @@ -153,7 +143,7 @@ interactive plots generated with the [[https://plot.ly/python/][plotly]] library
* What PyPSA uses under the hood

PyPSA is written and tested to be compatible with both Python 2.7 and
Python 3.5.
Python 3.6.

It leans heavily on the following Python packages:

Expand Down

0 comments on commit 867c69e

Please sign in to comment.