Skip to content

Commit

Permalink
fix docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
heckstrahler committed Oct 26, 2023
1 parent 9520690 commit 6b32b2d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions pandapower/converter/cim/cim2pp/from_cim.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,23 +95,23 @@ def from_cim(file_list: List[str] = None, encoding: str = 'utf-8', convert_line_
"""
Convert a CIM net to a pandapower net from XML files.
Additional parameters for kwargs:
create_measurements (str): Set this parameter to 'SV' to create measurements for the pandapower net from the SV
- create_measurements (str): Set this parameter to 'SV' to create measurements for the pandapower net from the SV
profile. Set it to 'Analog' to create measurements from Analogs. If the parameter is not set or is set to None, no
measurements will be created.
update_assets_from_sv (bool): Set this parameter to True to update the assets (sgens, loads, wards, ...) with values
from the SV profile. Default: False.
use_GL_or_DL_profile (str): Choose the profile to use for converting coordinates. Set it to 'GL' to use the GL
- update_assets_from_sv (bool): Set this parameter to True to update the assets (sgens, loads, wards, ...) with
values from the SV profile. Default: False.
- use_GL_or_DL_profile (str): Choose the profile to use for converting coordinates. Set it to 'GL' to use the GL
profile (Usually lat and long coordinates). Set it to 'DL' to use the DL profile (Usually x, y coordinates for
displaying control room schema). Set it to 'both' to let the converter choose the profile. The converter will
choose the GL profile first if available, otherwise the DL profile. Optional, default: both.
diagram_name (str): The name from the Diagram from the diagram layout profile for the geo coordinates. Default: The
first diagram sorted ascending by name. Set the parameter to "all" to use available diagrams for creating the
- diagram_name (str): The name from the Diagram from the diagram layout profile for the geo coordinates. Default:
The first diagram sorted ascending by name. Set the parameter to "all" to use available diagrams for creating the
coordinates.
create_tap_controller (bool): If True, create pandapower controllers for transformer tap changers. If False, skip
- create_tap_controller (bool): If True, create pandapower controllers for transformer tap changers. If False, skip
creating them. Default: True
sn_mva (float): Set the sn_mva from the pandapower net to a specific value. This value is not given in CGMES.
- sn_mva (float): Set the sn_mva from the pandapower net to a specific value. This value is not given in CGMES.
Default: None (pandapower default will be chosen)
create_res_table (bool): Option to opt out of the internal powerflow. Useful when the powerflow is guaranteed to
- create_res_table (bool): Option to opt out of the internal powerflow. Useful when the powerflow is guaranteed to
fail because of broken input data. If the parameter is not set powerflow is run to create result tables.
:param file_list: The path to the CGMES files as a list.
Expand Down

0 comments on commit 6b32b2d

Please sign in to comment.