# Copyright (c) 2023, RTE (http://www.rte-france.com)
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
# SPDX-License-Identifier: MPL-2.0
#
import io
import warnings
from os import PathLike
from typing import Union, Dict, List
import pypowsybl._pypowsybl as _pp
from pypowsybl.report import ReportNode
from pypowsybl.utils import path_to_str
from .network import Network
deprecated_reporter_warning = "Use of deprecated attribute reporter. Use report_node instead."
def _create_network(name: str, network_id: str = '') -> Network:
return Network(_pp.create_network(name, network_id))
[docs]def create_empty(network_id: str = "Default") -> Network:
"""
Create an empty network.
Args:
network_id: id of the network, defaults to 'Default'
Returns:
a new empty network
"""
return _create_network('empty', network_id=network_id)
[docs]def create_ieee9() -> Network:
"""
Create an instance of IEEE 9 bus network
Returns:
a new instance of IEEE 9 bus network
"""
return _create_network('ieee9')
[docs]def create_ieee14() -> Network:
"""
Create an instance of IEEE 14 bus network
Returns:
a new instance of IEEE 14 bus network
"""
return _create_network('ieee14')
[docs]def create_ieee30() -> Network:
"""
Create an instance of IEEE 30 bus network
Returns:
a new instance of IEEE 30 bus network
"""
return _create_network('ieee30')
[docs]def create_ieee57() -> Network:
"""
Create an instance of IEEE 57 bus network
Returns:
a new instance of IEEE 57 bus network
"""
return _create_network('ieee57')
[docs]def create_ieee118() -> Network:
"""
Create an instance of IEEE 118 bus network
Returns:
a new instance of IEEE 118 bus network
"""
return _create_network('ieee118')
[docs]def create_ieee300() -> Network:
"""
Create an instance of IEEE 300 bus network
Returns:
a new instance of IEEE 300 bus network
"""
return _create_network('ieee300')
[docs]def create_eurostag_tutorial_example1_network() -> Network:
"""
Create an instance of example 1 network of Eurostag tutorial
Returns:
a new instance of example 1 network of Eurostag tutorial
"""
return _create_network('eurostag_tutorial_example1')
[docs]def create_eurostag_tutorial_example1_with_power_limits_network() -> Network:
"""
Create an instance of example 1 network of Eurostag tutorial with Power limits
Returns:
a new instance of example 1 network of Eurostag tutorial with Power limits
"""
return _create_network('eurostag_tutorial_example1_with_power_limits')
[docs]def create_four_substations_node_breaker_network() -> Network:
"""
Create an instance of powsybl "4 substations" test case.
It is meant to contain most network element types that can be
represented in powsybl networks.
The topology is in node-breaker representation.
Returns:
a new instance of powsybl "4 substations" test case
"""
return _create_network('four_substations_node_breaker')
[docs]def create_four_substations_node_breaker_network_with_extensions() -> Network:
"""
Create an instance of powsybl "4 substations" test case with ConnectablePosition and BusbarSectionPosition extensions.
The topology is in node-breaker representation.
"""
return _create_network('four_substations_node_breaker_with_extensions')
[docs]def create_micro_grid_be_network() -> Network:
"""
Create an instance of micro grid BE CGMES test case
Returns:
a new instance of micro grid BE CGMES test case
"""
return _create_network('micro_grid_be')
[docs]def create_micro_grid_nl_network() -> Network:
"""
Create an instance of micro grid NL CGMES test case
Returns:
a new instance of micro grid NL CGMES test case
"""
return _create_network('micro_grid_nl')
def create_metrix_tutorial_six_buses_network() -> Network:
"""
Create an instance of metrix tutorial six buses test case
Returns:
a new instance of metrix tutorial six buses test case
"""
return _create_network('metrix_tutorial_six_buses')
[docs]def load(file: Union[str, PathLike], parameters: Dict[str, str] = None, reporter: ReportNode = None,
report_node: ReportNode = None) -> Network:
"""
Load a network from a file. File should be in a supported format.
Basic compression formats are also supported (gzip, bzip2).
Args:
file: path to the network file
parameters: a dictionary of import parameters
reporter: deprecated, use report_node instead
report_node: the reporter to be used to create an execution report, default is None (no report)
Returns:
The loaded network
Examples:
Some examples of file loading, including relative or absolute paths, and compressed files:
.. code-block:: python
network = pp.network.load('network.xiidm')
network = pp.network.load('/path/to/network.xiidm')
network = pp.network.load('network.xiidm.gz')
network = pp.network.load('network.uct')
...
"""
if reporter is not None:
warnings.warn(deprecated_reporter_warning, DeprecationWarning)
report_node = reporter
file = path_to_str(file)
if parameters is None:
parameters = {}
return Network(_pp.load_network(file, parameters,
None if report_node is None else report_node._report_node)) # pylint: disable=protected-access
[docs]def load_from_binary_buffer(buffer: io.BytesIO, parameters: Dict[str, str] = None,
reporter: ReportNode = None, report_node: ReportNode = None) -> Network:
"""
Load a network from a binary buffer.
Args:
buffer: The BytesIO data buffer
parameters: A dictionary of import parameters
reporter: deprecated, use report_node instead
report_node: the reporter to be used to create an execution report, default is None (no report)
Returns:
The loaded network
"""
if reporter is not None:
warnings.warn(deprecated_reporter_warning, DeprecationWarning)
report_node = reporter
return load_from_binary_buffers([buffer], parameters, report_node)
[docs]def load_from_binary_buffers(buffers: List[io.BytesIO], parameters: Dict[str, str] = None,
reporter: ReportNode = None, report_node: ReportNode = None) -> Network:
"""
Load a network from a list of binary buffers. Only zipped CGMES are supported for several zipped source load.
Args:
buffers: The list of BytesIO data buffer
parameters: A dictionary of import parameters
reporter: deprecated, use report_node instead
report_node: the reporter to be used to create an execution report, default is None (no report)
Returns:
The loaded network
"""
if reporter is not None:
warnings.warn(deprecated_reporter_warning, DeprecationWarning)
report_node = reporter
if parameters is None:
parameters = {}
buffer_list = []
for b in buffers:
buffer_list.append(b.getbuffer())
return Network(_pp.load_network_from_binary_buffers(buffer_list, parameters,
None if report_node is None else report_node._report_node)) # pylint: disable=protected-access
[docs]def load_from_string(file_name: str, file_content: str, parameters: Dict[str, str] = None,
reporter: ReportNode = None, report_node: ReportNode = None) -> Network:
"""
Load a network from a string. File content should be in a supported format.
Args:
file_name: file name
file_content: file content
parameters: a dictionary of import parameters
reporter: deprecated, use report_node instead
report_node: the reporter to be used to create an execution report, default is None (no report)
Returns:
The loaded network
"""
if reporter is not None:
warnings.warn(deprecated_reporter_warning, DeprecationWarning)
report_node = reporter
if parameters is None:
parameters = {}
return Network(_pp.load_network_from_string(file_name, file_content, parameters,
None if report_node is None else report_node._report_node)) # pylint: disable=protected-access