VeraGridEngine.Simulations.NodalCapacity package

Submodules

VeraGridEngine.Simulations.NodalCapacity.nodal_capacity_options module

class VeraGridEngine.Simulations.NodalCapacity.nodal_capacity_options.NodalCapacityOptions(opf_options: None | ~VeraGridEngine.Simulations.OPF.opf_options.OptimalPowerFlowOptions = None, capacity_nodes_idx: None | ~numpy.ndarray[tuple[~typing.Any, ...], ~numpy.dtype[~numpy.int64]] = None, nodal_capacity_sign: float = 1.0, method: ~VeraGridEngine.enumerations.NodalCapacityMethod = Linear Optimization)

Bases: OptionsTemplate

Nodal Capacity Options

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:opf_options, prop:capacity_nodes_idx, prop:method, prop:nodal_capacity_sign)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:opf_options, prop:capacity_nodes_idx, prop:method, prop:nodal_capacity_sign)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'action': prop:action, 'capacity_nodes_idx': prop:capacity_nodes_idx, 'code': prop:code, 'comment': prop:comment, 'diff_changes': prop:diff_changes, 'idtag': prop:idtag, 'method': prop:method, 'name': prop:name, 'nodal_capacity_sign': prop:nodal_capacity_sign, 'opf_options': prop:opf_options, 'rdfid': prop:rdfid}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:opf_options, prop:capacity_nodes_idx, prop:method, prop:nodal_capacity_sign)

action: ActionType

comment: str

device_type: DeviceType

diff_changes

selected_to_merge

VeraGridEngine.Simulations.NodalCapacity.nodal_capacity_ts_driver module

class VeraGridEngine.Simulations.NodalCapacity.nodal_capacity_ts_driver.NodalCapacityTimeSeriesDriver(grid: MultiCircuit, options: NodalCapacityOptions | None = None, time_indices: ndarray[tuple[Any, ...], dtype[int64]] | None = None, clustering_results: ClusteringResults | None = None, engine: EngineType = VeraGrid)

Bases: TimeSeriesDriverTemplate

add_report(eps: float = 1e-06) → None

Add a report of the results (in-place)

all_solved

cpf(remote=False, batteries_energy_0=None)

Run a power flow for every circuit :param remote: is this function being called from the time series? :param batteries_energy_0: initial state of the batteries, if None the default values are taken :return: OptimalPowerFlowResults object

get_steps()

Get time steps list of strings

get_time_indices()

linear_opf(remote=False, batteries_energy_0=None)

Run a power flow for every circuit :param remote: is this function being called from the time series? :param batteries_energy_0: initial state of the batteries, if None the default values are taken :return: OptimalPowerFlowResults object

name = 'Nodal capacity time series'

non_linear_opf(remote=False, batteries_energy_0=None)

Run a power flow for every circuit :param remote: is this function being called from the time series? :param batteries_energy_0: initial state of the batteries, if None the default values are taken :return: OptimalPowerFlowResults object

property opf_options: OptimalPowerFlowOptions

Get the OptimalPowerFlowOptions options provides with the OpfOptions :return: PowerFlowOptions

options

property pf_options: PowerFlowOptions

Get the PowerFlow options provides with the OpfOptions :return: PowerFlowOptions

run()

Returns:

tpe = 'Nodal capacity time series'

VeraGridEngine.Simulations.NodalCapacity.nodal_capacity_ts_results module

class VeraGridEngine.Simulations.NodalCapacity.nodal_capacity_ts_results.NodalCapacityTimeSeriesResults(bus_names: StrVec, branch_names: StrVec, load_names: StrVec, generator_names: StrVec, battery_names: StrVec, shunt_like_names: StrVec, hvdc_names: StrVec, vsc_names: StrVec, fuel_names: StrVec, emission_names: StrVec, technology_names: StrVec, fluid_node_names: StrVec, fluid_path_names: StrVec, fluid_injection_names: StrVec, nt: int, time_array=None, bus_types=(), clustering_results: None | ClusteringResults = None, capacity_nodes_idx: None | IntVec = None)

Bases: OptimalPowerFlowTimeSeriesResults

Optimal power flow time series results

CLASS_DATA_VARIABLES = {'Sbus': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'Sf': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'St': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'battery_energy': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'battery_invested': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'battery_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'battery_power': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'branch_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'bus_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'bus_shadow_prices': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'bus_types': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'capacity_nodes_idx': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'contingency_flows_list': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'contingency_flows_slacks_list': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'contingency_indices_list': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'contingency_rates': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'converged': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'emission_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_injection_flow': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_injection_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_node_current_level': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_node_flow_in': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_node_flow_out': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_node_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_node_p2x_flow': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_node_spillage': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_path_flow': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fluid_path_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'fuel_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_cost': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_invested': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_power': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_producing': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_reactive_power': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_shedding': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_shutting_down': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'generator_starting_up': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'hvdc_Pf': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'hvdc_loading': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'hvdc_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'load_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'load_power': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'load_shedding': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'load_shedding_cost': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'loading': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'losses': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'nodal_capacity': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'overloads': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'overloads_cost': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'power_by_technology': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'rates': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'shunt_like_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'shunt_like_reactive_power': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'system_emissions': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'system_energy_cost': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'system_fuel': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'system_total_energy_cost': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'tap_angle': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'tap_module': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'technology_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'voltage': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'vsc_Pf': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'vsc_loading': <VeraGridEngine.Simulations.results_template.ResultsProperty object>, 'vsc_names': <VeraGridEngine.Simulations.results_template.ResultsProperty object>}

CLASS_RESULTS_DECLARATIONS = (<VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>)

LOCAL_RESULTS_DECLARATIONS = (<VeraGridEngine.Simulations.results_template.ResultsProperty object>, <VeraGridEngine.Simulations.results_template.ResultsProperty object>)

capacity_nodes_idx

mdl(result_type) → ResultsTable

Plot the results :param result_type: :return:

nodal_capacity

Module contents