Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/1917 improved imports #2512

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ body:
Please follow [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) on how to
provide a minimal, copy-pastable example.
placeholder: >
import pandapower as pp
from pandapower.create import create_empty_network

net = pp.create_empty_network()
net = create_empty_network()

...
render: python
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@ Making sure you don't break anything

If you make changes to pandapower that you plan to submit, first make sure that all tests are still passing. You can do this locally with: ::

import pandapower.test
pandapower.test.run_all_tests()
from pandapower.test import run_all_tests
run_all_tests()

When you submit a pull request, github actions will run the same tests with actual, by pandapower supported Python versions. In most cases, if tests pass for you locally, they will also pass on github actions. But it can also happen that the tests pass for you locally, but still fail on github actions, because the new code is not compatible with all Python versions.
In this case you will have to update your pull request until the tests pass in all Python versions. Pull requests that lead to failing tests will not be accepted.
Expand Down
8 changes: 4 additions & 4 deletions doc/about/update20.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ it will be for the convert_format function to apply all necessary changes. There
With pandapower 2.0, we also advice to save networks in the .json format. It is much more robust to updates of libraries (for example, a .p file created with pandas < 0.20 can
not be loaded with pandas 0.20 due to a change in the internal data structures. This is not an issue when saving the networks as .json files). So resave your pickle files as .json files such as ::

import pandapower as pp
net = pp.from_pickle("C:\\my_file.p")
pp.runpp(net)
pp.to_json(net, "C:\\my_file_2.0.json")
from pandapower import from_pickle, runpp, to_json
net = from_pickle("C:\\my_file.p")
runpp(net)
to_json(net, "C:\\my_file_2.0.json")


Transformer parameter naming
Expand Down
8 changes: 4 additions & 4 deletions doc/control/run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Then, run a power flow with the run_control option set to true:

.. code::

import pandapower as pp
pp.runpp(net, run_control=True)
from pandapower import runpp
runpp(net, run_control=True)

The runpp function will now run multiple power flow calculations until all registered controllers are converged.

Expand All @@ -22,8 +22,8 @@ Instead of calling runpp it is also possible to call run_control from the contro

.. code::

import pandapower.control as control
control.run_control(net)
from pandapower.control import run_control
run_control(net)


By default, this will do the same as runpp with run_control=True. Calling the run_control function however gives you more flexibility to configurate
Expand Down
7 changes: 4 additions & 3 deletions doc/gridequivalent/gridequivalent_example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ First, we create an example network.

.. code:: python

import pandapower as pp
from pandapower import runpp
from pandapower.networks import case9

net = pp.case9()
net = case9()

# getting power flow results
pp.runpp(net)
runpp(net)


Define Grid Areas
Expand Down
20 changes: 10 additions & 10 deletions doc/networks/cigre.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ High voltage transmission network

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_cigre_network_hv

# You may specify a length for the connection line between buses 6a and 6b
net = pn.create_cigre_network_hv(length_km_6a_6b=0.1)
net = create_cigre_network_hv(length_km_6a_6b=0.1)

'''
This pandapower network includes the following parameter tables:
Expand Down Expand Up @@ -53,9 +53,9 @@ Medium voltage distribution network

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_cigre_network_mv

net = pn.create_cigre_network_mv(with_der=False)
net = create_cigre_network_mv(with_der=False)

'''
This pandapower network includes the following parameter tables:
Expand Down Expand Up @@ -94,9 +94,9 @@ Although the case study mentions the High Voltage as 220 kV, we assume 110 kV ag

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_cigre_network_mv

net = pn.create_cigre_network_mv(with_der="pv_wind")
net = create_cigre_network_mv(with_der="pv_wind")

'''
This pandapower network includes the following parameter tables:
Expand Down Expand Up @@ -138,9 +138,9 @@ considered. Although the case study mentions the High Voltage as 220 kV, we assu

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_cigre_network_mv

net = pn.create_cigre_network_mv(with_der="all")
net = create_cigre_network_mv(with_der="all")

'''
This pandapower network includes the following parameter tables:
Expand Down Expand Up @@ -170,9 +170,9 @@ Low voltage distribution network

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_cigre_network_lv

net = pn.create_cigre_network_lv()
net = create_cigre_network_lv()

'''
This pandapower network includes the following parameter tables:
Expand Down
64 changes: 32 additions & 32 deletions doc/networks/kerber.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,9 @@ You can include the kerber networks by simply using:

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_kerber_net

net1 = pn.create_kerber_net()
net1 = create_kerber_net()



Expand All @@ -81,9 +81,9 @@ Kerber Landnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_kerber_landnetz_freileitung_1, create_kerber_landnetz_freileitung_2

net1 = pn.create_kerber_landnetz_freileitung_1()
net1 = create_kerber_landnetz_freileitung_1()

'''
This pandapower network includes the following parameter tables:
Expand All @@ -94,7 +94,7 @@ Kerber Landnetze
- ext_grid (1 elements)
'''

net2 = pn.create_kerber_landnetz_freileitung_2()
net2 = create_kerber_landnetz_freileitung_2()

'''
This pandapower network includes the following parameter tables:
Expand All @@ -121,9 +121,9 @@ Kerber Landnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_kerber_landnetz_kabel_1, create_kerber_landnetz_kabel_2

net1 = pn.create_kerber_landnetz_kabel_1()
net1 = create_kerber_landnetz_kabel_1()

'''
This pandapower network includes the following parameter tables:
Expand All @@ -134,7 +134,7 @@ Kerber Landnetze
- ext_grid (1 elements)
'''

net2 = pn.create_kerber_landnetz_kabel_2()
net2 = create_kerber_landnetz_kabel_2()

'''
This pandapower network includes the following parameter tables:
Expand All @@ -161,9 +161,9 @@ Kerber Dorfnetz

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_kerber_dorfnetz

net = pn.create_kerber_dorfnetz()
net = create_kerber_dorfnetz()

'''
This pandapower network includes the following parameter tables:
Expand Down Expand Up @@ -192,9 +192,9 @@ Kerber Vorstadtnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_kerber_vorstadtnetz_kabel_1

net1 = pn.create_kerber_vorstadtnetz_kabel_1()
net1 = create_kerber_vorstadtnetz_kabel_1()

'''
This pandapower network includes the following parameter tables:
Expand All @@ -220,9 +220,9 @@ Kerber Vorstadtnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import create_kerber_vorstadtnetz_kabel_2

net2 = pn.create_kerber_vorstadtnetz_kabel_2()
net2 = create_kerber_vorstadtnetz_kabel_2()

'''
This pandapower network includes the following parameter tables:
Expand Down Expand Up @@ -293,14 +293,14 @@ Extreme Kerber Landnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_landnetz_freileitung, kb_extrem_landnetz_kabel

'''Extrem Landnetz Freileitung Typ I'''
net = pn.kb_extrem_landnetz_freileitung()
net = kb_extrem_landnetz_freileitung()


'''Extrem Landnetz Kabel Typ I'''
net = pn.kb_extrem_landnetz_kabel()
net = kb_extrem_landnetz_kabel()



Expand All @@ -318,14 +318,14 @@ Extreme Kerber Landnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_landnetz_freileitung_trafo, kb_extrem_landnetz_kabel_trafo

'''Extrem Landnetz Freileitung Typ II'''
net = pn.kb_extrem_landnetz_freileitung_trafo()
net = kb_extrem_landnetz_freileitung_trafo()


'''Extrem Landnetz Kabel Typ II'''
net = pn.kb_extrem_landnetz_kabel_trafo()
net = kb_extrem_landnetz_kabel_trafo()



Expand All @@ -344,10 +344,10 @@ Extreme Kerber Dorfnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_dorfnetz

'''Extrem Dorfnetz Kabel Typ I'''
net = pn.kb_extrem_dorfnetz()
net = kb_extrem_dorfnetz()



Expand All @@ -364,10 +364,10 @@ Extreme Kerber Dorfnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_dorfnetz_trafo

'''Extrem Dorfnetz Kabel Typ II'''
net = pn.kb_extrem_dorfnetz_trafo()
net = kb_extrem_dorfnetz_trafo()



Expand All @@ -383,10 +383,10 @@ Extreme Kerber Vorstadtnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_vorstadtnetz_1

'''Extrem Vorstadtnetz Kabel_a Typ I'''
net = pn.kb_extrem_vorstadtnetz_1()
net = kb_extrem_vorstadtnetz_1()


.. image:: /pics/networks/kerber//kerber_extrem_vorstadt_a_typ_1.png
Expand All @@ -401,10 +401,10 @@ Extreme Kerber Vorstadtnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_vorstadtnetz_2

'''Extrem Vorstadtnetz Kabel_b Typ I'''
net = pn.kb_extrem_vorstadtnetz_2()
net = kb_extrem_vorstadtnetz_2()


.. image:: /pics/networks/kerber//kerber_extrem_vorstadt_b_typ_1.png
Expand All @@ -419,10 +419,10 @@ Extreme Kerber Vorstadtnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_vorstadtnetz_trafo_1

'''Extrem Vorstadtnetz Kabel_c Typ II'''
net = pn.kb_extrem_vorstadtnetz_trafo_1()
net = kb_extrem_vorstadtnetz_trafo_1()


.. image:: /pics/networks/kerber//kerber_extrem_vorstadt_c_typ_2.png
Expand All @@ -437,10 +437,10 @@ Extreme Kerber Vorstadtnetze

.. code:: python

import pandapower.networks as pn
from pandapower.networks import kb_extrem_vorstadtnetz_trafo_2

'''Extrem Vorstadtnetz Kabel_d Typ II'''
net = pn.kb_extrem_vorstadtnetz_trafo_2()
net = kb_extrem_vorstadtnetz_trafo_2()


.. image:: /pics/networks/kerber//kerber_extrem_vorstadt_d_typ_2.png
Expand Down
8 changes: 4 additions & 4 deletions doc/shortcircuit/run.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ The short circuit calculation is carried out with the calc_sc function:

.. code:: python

import pandapower.shortcircuit as sc
import pandapower.networks as nw
from pandapower.shortcircuit import calc_sc
from pandapower.networks import mv_oberrhein

net = nw.mv_oberrhein()
net = mv_oberrhein()
net.ext_grid["s_sc_min_mva"] = 100
net.ext_grid["rx_min"] = 0.1

net.line["endtemp_degree"] = 20
sc.calc_sc(net, case="min")
calc_sc(net, case="min")
print(net.res_bus_sc)
13 changes: 7 additions & 6 deletions doc/std_types/save_pp_std_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@

@author: thurner
"""
import pandapower as pp
from pandapower.std_types import available_std_types
from pandapower.create import create_empty_network

net = pp.create_empty_network()
net = create_empty_network()

linetypes = pp.available_std_types(net, "line")
linetypes = available_std_types(net, "line")
columns = [c for c in net.line.columns if c in linetypes.columns] + ["q_mm2", "alpha"]
linetypes = linetypes.reindex(columns, axis=1)
linetypes.to_csv("linetypes.csv", sep=";")

trafotypes = pp.available_std_types(net, "trafo")
trafotypes = available_std_types(net, "trafo")
trafotypes = trafotypes.reindex([c for c in net.trafo.columns if c in trafotypes.columns], axis=1)
trafotypes.to_csv("trafotypes.csv", sep=";")

trafo3wtypes = pp.available_std_types(net, "trafo3w")
trafo3wtypes = available_std_types(net, "trafo3w")
trafo3wtypes = trafo3wtypes.reindex([c for c in net.trafo3w.columns if c in trafo3wtypes.columns], axis=1)
trafo3wtypes.to_csv("trafo3wtypes.csv", sep=";")
trafo3wtypes.to_csv("trafo3wtypes.csv", sep=";")
Loading
Loading