VeraGridEngine.Devices.Injections package

Submodules

VeraGridEngine.Devices.Injections.battery module

class VeraGridEngine.Devices.Injections.battery.Battery

Bases: Generator

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'Cost': 'Cost_prof', 'Cost0': 'Cost0_prof', 'Cost2': 'Cost2_prof', 'P': 'P_prof', 'Pf': 'Pf_prof', 'Pmax': 'Pmax_prof', 'Pmin': 'Pmin_prof', 'Q': 'Q_prof', 'Qmax': 'Qmax_prof', 'Qmin': 'Qmin_prof', 'Vset': 'Vset_prof', 'active': 'active_prof', 'enabled_dispatch': 'enabled_dispatch_prof', 'must_run': 'must_run_prof', 'shift_key': 'shift_key_prof', 'srap_enabled': 'srap_enabled_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pmin, prop:Pmax, prop:Q, prop:Qmin, prop:Qmax, prop:control_mode, prop:control_bus, prop:Pf, prop:Vset, prop:k_droop, prop:dead_band, prop:Snom, prop:use_reactive_power_curve, prop:q_curve, prop:R1, prop:X1, prop:R0, prop:X0, prop:R2, prop:X2, prop:Rs, prop:Xs, prop:Xm, prop:Rr, prop:Xr, prop:Cost2, prop:Cost0, prop:startup_cost, prop:shutdown_cost, prop:min_time_up, prop:min_time_down, prop:ramp_up, prop:ramp_down, prop:enabled_dispatch, prop:must_run, prop:emissions, prop:fuels, prop:srap_enabled, prop:tpe, prop:Enom, prop:max_soc, prop:min_soc, prop:soc_0, prop:charge_efficiency, prop:discharge_efficiency, prop:discharge_per_cycle)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pmin, prop:Pmax, prop:Q, prop:Qmin, prop:Qmax, prop:control_mode, prop:control_bus, prop:Pf, prop:Vset, prop:k_droop, prop:dead_band, prop:Snom, prop:use_reactive_power_curve, prop:q_curve, prop:R1, prop:X1, prop:R0, prop:X0, prop:R2, prop:X2, prop:Rs, prop:Xs, prop:Xm, prop:Rr, prop:Xr, prop:Cost2, prop:Cost0, prop:startup_cost, prop:shutdown_cost, prop:min_time_up, prop:min_time_down, prop:ramp_up, prop:ramp_down, prop:enabled_dispatch, prop:must_run, prop:emissions, prop:fuels, prop:srap_enabled, prop:tpe, prop:Enom, prop:max_soc, prop:min_soc, prop:soc_0, prop:charge_efficiency, prop:discharge_efficiency, prop:discharge_per_cycle)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'Cost': prop:Cost, 'Cost0': prop:Cost0, 'Cost2': prop:Cost2, 'Enom': prop:Enom, 'P': prop:P, 'Pf': prop:Pf, 'Pmax': prop:Pmax, 'Pmin': prop:Pmin, 'Q': prop:Q, 'Qmax': prop:Qmax, 'Qmin': prop:Qmin, 'R0': prop:R0, 'R1': prop:R1, 'R2': prop:R2, 'Rr': prop:Rr, 'Rs': prop:Rs, 'Snom': prop:Snom, 'Vset': prop:Vset, 'X0': prop:X0, 'X1': prop:X1, 'X2': prop:X2, 'Xm': prop:Xm, 'Xr': prop:Xr, 'Xs': prop:Xs, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'charge_efficiency': prop:charge_efficiency, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'control_bus': prop:control_bus, 'control_mode': prop:control_mode, 'dead_band': prop:dead_band, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'discharge_efficiency': prop:discharge_efficiency, 'discharge_per_cycle': prop:discharge_per_cycle, 'emissions': prop:emissions, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'enabled_dispatch': prop:enabled_dispatch, 'facility': prop:facility, 'fuels': prop:fuels, 'idtag': prop:idtag, 'k_droop': prop:k_droop, 'latitude': prop:latitude, 'longitude': prop:longitude, 'max_soc': prop:max_soc, 'min_soc': prop:min_soc, 'min_time_down': prop:min_time_down, 'min_time_up': prop:min_time_up, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'must_run': prop:must_run, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'q_curve': prop:q_curve, 'ramp_down': prop:ramp_down, 'ramp_up': prop:ramp_up, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'shutdown_cost': prop:shutdown_cost, 'soc_0': prop:soc_0, 'srap_enabled': prop:srap_enabled, 'startup_cost': prop:startup_cost, 'technologies': prop:technologies, 'tpe': prop:tpe, 'use_kw': prop:use_kw, 'use_reactive_power_curve': prop:use_reactive_power_curve}

property Enom: float

Get Enom.

Returns:

float

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:Enom, prop:max_soc, prop:min_soc, prop:soc_0, prop:charge_efficiency, prop:discharge_efficiency, prop:discharge_per_cycle)

property charge_efficiency: float

Get charge_efficiency.

Returns:

float

charge_per_cycle

device_type: DeviceType

property discharge_efficiency: float

Get discharge_efficiency.

Returns:

float

property discharge_per_cycle: float

Get discharge_per_cycle.

Returns:

float

energy

property max_soc: float

Get max_soc.

Returns:

float

min_energy

property min_soc: float

Get min_soc.

Returns:

float

min_soc_charge

soc

property soc_0: float

Get soc_0.

Returns:

float

VeraGridEngine.Devices.Injections.controllable_shunt module

class VeraGridEngine.Devices.Injections.controllable_shunt.ControllableShunt(name='Controllable Shunt', idtag: None | str = None, code: str = '', number_of_steps: int = 1, step: int = 1, g_per_step: float = 0.0, b_per_step: float = 0.0, Bmin: float = -9999.0, Bmax: float = 9999.0, Gmin: float = -9999.0, Gmax: float = 9999.0, Cost: float = 1200.0, active: bool = True, G: float = 1e-20, G1: float = 1e-20, G2: float = 1e-20, G3: float = 1e-20, B: float = 1e-20, B1: float = 1e-20, B2: float = 1e-20, B3: float = 1e-20, G0: float = 1e-20, B0: float = 1e-20, vset: float = 1.0, vmin: float = 0.9, vmax: float = 1.1, mttf: float = 0.0, mttr: float = 0.0, capex: float = 0.0, opex: float = 0.0, control_bus: Bus = None, control_mode: ShuntControlMode = Continuous, build_status: BuildStatus = Commissioned)

Bases: ShuntParent

Controllable Shunt

property Bmax: float

Get Bmax.

Returns:

float

property Bmin: float

Get Bmin.

Returns:

float

CLASS_NON_EDITABLE_PROPERTIES: Tuple[str, ...] = ('idtag', 'diff_changes', 'bus', 'ysh', 'g_steps', 'b_steps', 'active_steps')

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'B': 'B_prof', 'B0': 'B0_prof', 'Ba': 'Ba_prof', 'Bb': 'Bb_prof', 'Bc': 'Bc_prof', 'Cost': 'Cost_prof', 'G': 'G_prof', 'G0': 'G0_prof', 'Ga': 'Ga_prof', 'Gb': 'Gb_prof', 'Gc': 'Gc_prof', 'Vset': 'Vset_prof', 'active': 'active_prof', 'shift_key': 'shift_key_prof', 'step': 'step_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:G, prop:G0, prop:Ga, prop:Gb, prop:Gc, prop:B, prop:B0, prop:Ba, prop:Bb, prop:Bc, prop:ysh, prop:control_mode, prop:control_bus, prop:g_steps, prop:b_steps, prop:Gmax, prop:Gmin, prop:Bmax, prop:Bmin, prop:active_steps, prop:step, prop:Vmin, prop:Vset, prop:Vmax)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:G, prop:G0, prop:Ga, prop:Gb, prop:Gc, prop:B, prop:B0, prop:Ba, prop:Bb, prop:Bc, prop:ysh, prop:control_mode, prop:control_bus, prop:g_steps, prop:b_steps, prop:Gmax, prop:Gmin, prop:Bmax, prop:Bmin, prop:active_steps, prop:step, prop:Vmin, prop:Vset, prop:Vmax)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'B': prop:B, 'B0': prop:B0, 'Ba': prop:Ba, 'Bb': prop:Bb, 'Bc': prop:Bc, 'Bmax': prop:Bmax, 'Bmin': prop:Bmin, 'Cost': prop:Cost, 'G': prop:G, 'G0': prop:G0, 'Ga': prop:Ga, 'Gb': prop:Gb, 'Gc': prop:Gc, 'Gmax': prop:Gmax, 'Gmin': prop:Gmin, 'Vmax': prop:Vmax, 'Vmin': prop:Vmin, 'Vset': prop:Vset, 'action': prop:action, 'active': prop:active, 'active_steps': prop:active_steps, 'b_steps': prop:b_steps, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'control_bus': prop:control_bus, 'control_mode': prop:control_mode, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'facility': prop:facility, 'g_steps': prop:g_steps, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'step': prop:step, 'technologies': prop:technologies, 'use_kw': prop:use_kw, 'ysh': prop:ysh}

property Gmax: float

Get Gmax.

Returns:

float

property Gmin: float

Get Gmin.

Returns:

float

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:control_mode, prop:control_bus, prop:g_steps, prop:b_steps, prop:Gmax, prop:Gmin, prop:Bmax, prop:Bmin, prop:active_steps, prop:step, prop:Vmin, prop:Vset, prop:Vmax)

property Vmax: float

Get Vmax.

Returns:

float

property Vmin: float

Get Vmin.

Returns:

float

property Vset: float

Get Vset.

Returns:

float

property Vset_prof: ProfileFloat

Cost profile :return: Profile

property active_steps

G steps :return:

b_per_step

property b_steps

B steps :return:

control_bus

control_mode: ShuntControlMode

g_per_step

property g_steps

G steps :return:

get_Vset_at(t: int | None) → float

Parameters:

t

Returns:

get_block_points()

Get B points for CGMES export. :return: :rtype:

get_cumulative_b() → ndarray[tuple[Any, ...], dtype[float64]]

Get the cumulative B values :return:

get_cumulative_g() → ndarray[tuple[Any, ...], dtype[float64]]

Get the cumulative G values :return:

get_linear_b_steps()

Returns:

get_linear_g_steps()

Returns:

get_step_at(t: int | None) → float

Parameters:

t

Returns:

set_blocks(n_list: list[int], b_list: list[float])

Initialize the steps from block data :param n_list: list of number of blocks per step :param b_list: list of unit impedance block at each step

property step

Step :return:

property step_prof: ProfileInt

Cost profile :return: Profile

VeraGridEngine.Devices.Injections.current_injection module

class VeraGridEngine.Devices.Injections.current_injection.CurrentInjection

Bases: InjectionParent

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'Cost': 'Cost_prof', 'Ii': 'Ii_prof', 'Ii1': 'Ii1_prof', 'Ii2': 'Ii2_prof', 'Ii3': 'Ii3_prof', 'Ir': 'Ir_prof', 'Ir1': 'Ir1_prof', 'Ir2': 'Ir2_prof', 'Ir3': 'Ir3_prof', 'active': 'active_prof', 'shift_key': 'shift_key_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:Ir, prop:Ir1, prop:Ir2, prop:Ir3, prop:Ii, prop:Ii1, prop:Ii2, prop:Ii3)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:Ir, prop:Ir1, prop:Ir2, prop:Ir3, prop:Ii, prop:Ii1, prop:Ii2, prop:Ii3)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'Cost': prop:Cost, 'Ii': prop:Ii, 'Ii1': prop:Ii1, 'Ii2': prop:Ii2, 'Ii3': prop:Ii3, 'Ir': prop:Ir, 'Ir1': prop:Ir1, 'Ir2': prop:Ir2, 'Ir3': prop:Ir3, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'facility': prop:facility, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'technologies': prop:technologies, 'use_kw': prop:use_kw}

property Ii: float

Get Ii.

Returns:

float

property Ii1: float

Get Ii1.

Returns:

float

property Ii1_prof: ProfileFloat

Cost profile :return: Profile

property Ii2: float

Get Ii2.

Returns:

float

property Ii2_prof: ProfileFloat

Cost profile :return: Profile

property Ii3: float

Get Ii3.

Returns:

float

property Ii3_prof: ProfileFloat

Cost profile :return: Profile

property Ii_prof: ProfileFloat

Cost profile :return: Profile

property Ir: float

Get Ir.

Returns:

float

property Ir1: float

Get Ir1.

Returns:

float

property Ir1_prof: ProfileFloat

Cost profile :return: Profile

property Ir2: float

Get Ir2.

Returns:

float

property Ir2_prof: ProfileFloat

Cost profile :return: Profile

property Ir3: float

Get Ir3.

Returns:

float

property Ir3_prof: ProfileFloat

Cost profile :return: Profile

property Ir_prof: ProfileFloat

Cost profile :return: Profile

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:Ir, prop:Ir1, prop:Ir2, prop:Ir3, prop:Ii, prop:Ii1, prop:Ii2, prop:Ii3)

get_I1_at(t: int | None) → complex

Parameters:

t

Returns:

get_I2_at(t: int | None) → complex

Parameters:

t

Returns:

get_I3_at(t: int | None) → complex

Parameters:

t

Returns:

get_I_at(t: int | None) → complex

Parameters:

t

Returns:

get_Ii1_at(t: int | None) → float

Parameters:

t

Returns:

get_Ii2_at(t: int | None) → float

Parameters:

t

Returns:

get_Ii3_at(t: int | None) → float

Parameters:

t

Returns:

get_Ii_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir1_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir2_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir3_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir_at(t: int | None) → float

Parameters:

t

Returns:

plot_profiles(time=None, show_fig=True)

Plot the time series results of this object :param time: array of time values :param show_fig: Show the figure?

VeraGridEngine.Devices.Injections.external_grid module

class VeraGridEngine.Devices.Injections.external_grid.ExternalGrid(name='External grid', idtag=None, code='', active=True, substituted_device_id: str = '', Vm=1.0, Va=0.0, P=0.0, Q=0.0, P1=0.0, P2=0.0, P3=0.0, Q1=0.0, Q2=0.0, Q3=0.0, mttf=0.0, mttr=0.0, mode: ExternalGridMode = PQ, capex=0, opex=0, build_status: BuildStatus = Commissioned)

Bases: LoadParent

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'Cost': 'Cost_prof', 'P': 'P_prof', 'Pa': 'Pa_prof', 'Pb': 'Pb_prof', 'Pc': 'Pc_prof', 'Q': 'Q_prof', 'Qa': 'Qa_prof', 'Qb': 'Qb_prof', 'Qc': 'Qc_prof', 'Va': 'Va_prof', 'Vm': 'Vm_prof', 'active': 'active_prof', 'shift_key': 'shift_key_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pa, prop:Pb, prop:Pc, prop:Q, prop:Qa, prop:Qb, prop:Qc, prop:mode, prop:substituted_device_id, prop:Vm, prop:Va)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pa, prop:Pb, prop:Pc, prop:Q, prop:Qa, prop:Qb, prop:Qc, prop:mode, prop:substituted_device_id, prop:Vm, prop:Va)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'Cost': prop:Cost, 'P': prop:P, 'Pa': prop:Pa, 'Pb': prop:Pb, 'Pc': prop:Pc, 'Q': prop:Q, 'Qa': prop:Qa, 'Qb': prop:Qb, 'Qc': prop:Qc, 'Va': prop:Va, 'Vm': prop:Vm, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'facility': prop:facility, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'mode': prop:mode, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'substituted_device_id': prop:substituted_device_id, 'technologies': prop:technologies, 'use_kw': prop:use_kw}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:mode, prop:substituted_device_id, prop:Vm, prop:Va)

property Va: float

Get Va.

Returns:

float

property Va_prof: ProfileFloat

Cost profile :return: Profile

property Vm: float

Get Vm.

Returns:

float

property Vm_prof: ProfileFloat

Cost profile :return: Profile

get_Va_at(t: int | None) → float

Parameters:

t

Returns:

get_Vm_at(t: int | None) → float

Parameters:

t

Returns:

mode: ExternalGridMode

plot_profiles(time=None, show_fig=True)

Plot the time series results of this object :param time: array of time values :param show_fig: Show the figure?

substituted_device_id: str

VeraGridEngine.Devices.Injections.generator module

class VeraGridEngine.Devices.Injections.generator.Generator(name='gen', idtag: str | None = None, code: str = '', P: float = 0.0, Q: float = 0.0, power_factor: float = 0.8, vset: float = 1.0, control_mode: GeneratorControlMode = V, k_droop=1.0, dead_band=0.0, Qmin: float = -9999, Qmax: float = 9999, Snom: float = 9999, active: bool = True, Pmin: float = 0.0, Pmax: float = 9999.0, Cost: float = 1.0, Cost2: float = 0.0, Cost0: float = 0.0, Sbase: float = 100, enabled_dispatch=True, mttf: float = 0.0, mttr: float = 0.0, q_points=None, use_reactive_power_curve=False, r1: float = 1e-20, x1: float = 1e-20, r0: float = 1e-20, x0: float = 1e-20, r2: float = 1e-20, x2: float = 1e-20, Rs: float = 1e-20, Xs: float = 1e-20, Xm: float = 1e-20, Rr: float = 1e-20, Xr: float = 1e-20, freq=60.0, capex: float = 0, opex: float = 0, srap_enabled: bool = True, build_status: BuildStatus = Commissioned, must_run: bool = False, startup_cost=0.0, shutdown_cost=0.0, min_time_up=0.0, min_time_down=0.0, ramp_up=1e+20, ramp_down=1e+20, tpe: GeneratorType = Synchronous)

Bases: InjectionParent

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'Cost': 'Cost_prof', 'Cost0': 'Cost0_prof', 'Cost2': 'Cost2_prof', 'P': 'P_prof', 'Pf': 'Pf_prof', 'Pmax': 'Pmax_prof', 'Pmin': 'Pmin_prof', 'Q': 'Q_prof', 'Qmax': 'Qmax_prof', 'Qmin': 'Qmin_prof', 'Vset': 'Vset_prof', 'active': 'active_prof', 'enabled_dispatch': 'enabled_dispatch_prof', 'must_run': 'must_run_prof', 'shift_key': 'shift_key_prof', 'srap_enabled': 'srap_enabled_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pmin, prop:Pmax, prop:Q, prop:Qmin, prop:Qmax, prop:control_mode, prop:control_bus, prop:Pf, prop:Vset, prop:k_droop, prop:dead_band, prop:Snom, prop:use_reactive_power_curve, prop:q_curve, prop:R1, prop:X1, prop:R0, prop:X0, prop:R2, prop:X2, prop:Rs, prop:Xs, prop:Xm, prop:Rr, prop:Xr, prop:Cost2, prop:Cost0, prop:startup_cost, prop:shutdown_cost, prop:min_time_up, prop:min_time_down, prop:ramp_up, prop:ramp_down, prop:enabled_dispatch, prop:must_run, prop:emissions, prop:fuels, prop:srap_enabled, prop:tpe)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pmin, prop:Pmax, prop:Q, prop:Qmin, prop:Qmax, prop:control_mode, prop:control_bus, prop:Pf, prop:Vset, prop:k_droop, prop:dead_band, prop:Snom, prop:use_reactive_power_curve, prop:q_curve, prop:R1, prop:X1, prop:R0, prop:X0, prop:R2, prop:X2, prop:Rs, prop:Xs, prop:Xm, prop:Rr, prop:Xr, prop:Cost2, prop:Cost0, prop:startup_cost, prop:shutdown_cost, prop:min_time_up, prop:min_time_down, prop:ramp_up, prop:ramp_down, prop:enabled_dispatch, prop:must_run, prop:emissions, prop:fuels, prop:srap_enabled, prop:tpe)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'Cost': prop:Cost, 'Cost0': prop:Cost0, 'Cost2': prop:Cost2, 'P': prop:P, 'Pf': prop:Pf, 'Pmax': prop:Pmax, 'Pmin': prop:Pmin, 'Q': prop:Q, 'Qmax': prop:Qmax, 'Qmin': prop:Qmin, 'R0': prop:R0, 'R1': prop:R1, 'R2': prop:R2, 'Rr': prop:Rr, 'Rs': prop:Rs, 'Snom': prop:Snom, 'Vset': prop:Vset, 'X0': prop:X0, 'X1': prop:X1, 'X2': prop:X2, 'Xm': prop:Xm, 'Xr': prop:Xr, 'Xs': prop:Xs, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'control_bus': prop:control_bus, 'control_mode': prop:control_mode, 'dead_band': prop:dead_band, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emissions': prop:emissions, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'enabled_dispatch': prop:enabled_dispatch, 'facility': prop:facility, 'fuels': prop:fuels, 'idtag': prop:idtag, 'k_droop': prop:k_droop, 'latitude': prop:latitude, 'longitude': prop:longitude, 'min_time_down': prop:min_time_down, 'min_time_up': prop:min_time_up, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'must_run': prop:must_run, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'q_curve': prop:q_curve, 'ramp_down': prop:ramp_down, 'ramp_up': prop:ramp_up, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'shutdown_cost': prop:shutdown_cost, 'srap_enabled': prop:srap_enabled, 'startup_cost': prop:startup_cost, 'technologies': prop:technologies, 'tpe': prop:tpe, 'use_kw': prop:use_kw, 'use_reactive_power_curve': prop:use_reactive_power_curve}

property Cost0: float

Get Cost0.

Returns:

float

property Cost0_prof: ProfileFloat

Cost profile :return: Profile

property Cost2: float

Get Cost2.

Returns:

float

property Cost2_prof: ProfileFloat

Cost profile :return: Profile

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:P, prop:Pmin, prop:Pmax, prop:Q, prop:Qmin, prop:Qmax, prop:control_mode, prop:control_bus, prop:Pf, prop:Vset, prop:k_droop, prop:dead_band, prop:Snom, prop:use_reactive_power_curve, prop:q_curve, prop:R1, prop:X1, prop:R0, prop:X0, prop:R2, prop:X2, prop:Rs, prop:Xs, prop:Xm, prop:Rr, prop:Xr, prop:Cost2, prop:Cost0, prop:startup_cost, prop:shutdown_cost, prop:min_time_up, prop:min_time_down, prop:ramp_up, prop:ramp_down, prop:enabled_dispatch, prop:must_run, prop:emissions, prop:fuels, prop:srap_enabled, prop:tpe)

property P: float

Get the active power value :return: float

property P_prof: ProfileFloat

Cost profile :return: Profile

property Pf: float

Get Pf.

Returns:

float

property Pf_prof: ProfileFloat

Cost profile :return: Profile

property Pmax: float

Get Pmax.

Returns:

float

property Pmax_prof: ProfileFloat

Pmax profile :return: Profile

property Pmin: float

Get Pmin.

Returns:

float

property Pmin_prof: ProfileFloat

Pmin profile :return: Profile

property Q: float

Get the active power value :return: float

property Q_prof: ProfileFloat

Q profile :return: Profile

property Qmax

Return the reactive power upper limit :return: value

property Qmax_prof: ProfileFloat

Qmax profile :return: Profile

property Qmin

Return the reactive power lower limit :return: value

property Qmin_prof: ProfileFloat

Qmin profile :return: Profile

property R0: float

Get R0.

Returns:

float

property R1: float

Get R1.

Returns:

float

property R2: float

Get R2.

Returns:

float

property Rr: float

Get Rr.

Returns:

float

property Rs: float

Get Rs.

Returns:

float

Sbase

property Snom

Return the reactive power lower limit :return: value

property Vset: float

Get Vset.

Returns:

float

property Vset_prof: ProfileFloat

Cost profile :return: Profile

property X0: float

Get X0.

Returns:

float

property X1: float

Get X1.

Returns:

float

property X2: float

Get X2.

Returns:

float

property Xm: float

Get Xm.

Returns:

float

property Xr: float

Get Xr.

Returns:

float

property Xs: float

Get Xs.

Returns:

float

control_bus: Bus | None

control_cn

property control_mode: GeneratorControlMode

Get control_mode. :return:

custom_q_points

property dead_band: float

Get dead_band.

Returns:

float

emissions: Associations

property emissions_list: List[EmissionGas]

get the EmissionGas list :return: EmissionGas list

property enabled_dispatch: bool

Get enabled_dispatch.

Returns:

bool

property enabled_dispatch_prof: ProfileBool

Cost profile :return: Profile

fix_inconsistencies(logger: Logger, min_vset=0.98, max_vset=1.02)

Correct the voltage set points :param logger: logger to store the events :param min_vset: minimum voltage set point (p.u.) :param max_vset: maximum voltage set point (p.u.) :return: True if any correction happened

freq

fuels: Associations

property fuels_list: List[Fuel]

get the Fuel list :return: Fuel

get_Cost0_at(t: int | None) → float

Parameters:

t

Returns:

get_Cost2_at(t: int | None) → float

Parameters:

t

Returns:

get_P_at(t: int | None) → float

Parameters:

t

Returns:

get_Pf_at(t: int | None) → float

Parameters:

t

Returns:

get_Pmax_at(t: int | None) → float

Parameters:

t

Returns:

get_Pmin_at(t: int | None) → float

Parameters:

t

Returns:

get_Q_at(t: int | None) → float

Parameters:

t

Returns:

get_Qmax_at(t: int | None) → float

Parameters:

t

Returns:

get_Qmin_at(t: int | None) → float

Parameters:

t

Returns:

get_S_with_sign() → complex

Returns:

get_Sprof_with_sign() → ndarray[tuple[Any, ...], dtype[complex128]]

Returns:

get_Vset_at(t: int | None) → float

Parameters:

t

Returns:

get_enabled_dispatch_at(t: int | None) → float

Parameters:

t

Returns:

get_first_emission() → EmissionGas | None

Get the first emissions available :return: Technology

get_first_fuel() → Fuel | None

Get the first fuels available :return: Technology

get_must_run_at(t: int | None) → float

Parameters:

t

Returns:

get_srap_enabled_at(t: int | None) → float

Parameters:

t

Returns:

property is_controlled: bool

Get is_controlled.

Returns:

bool

property k_droop: float

Get k_droop.

Returns:

float

property min_time_down: float

Get MinTimeDown.

Returns:

float

property min_time_up: float

Get MinTimeUp.

Returns:

float

property must_run: bool

Get must_run.

Returns:

bool

property must_run_prof: ProfileBool

Cost profile :return: Profile

plot_profiles(time=None, show_fig=True)

Plot the time series results of this object :param time: array of time values :param show_fig: Show the figure?

q_curve

qmax_set

qmin_set

property ramp_down: float

Get RampDown.

Returns:

float

property ramp_up: float

Get RampUp.

Returns:

float

property shutdown_cost: float

Get ShutdownCost.

Returns:

float

property srap_enabled: bool

Get srap_enabled.

Returns:

bool

property srap_enabled_prof: ProfileBool

Control bus profile :return: Profile

property startup_cost: float

Get StartupCost.

Returns:

float

tpe: GeneratorType

property use_reactive_power_curve: bool

Get use_reactive_power_curve.

Returns:

bool

VeraGridEngine.Devices.Injections.generator.compute_pf(p: float, q: float) → float

Compute the power factor from p and q :param p: Active power :param q: Reactive power :return: Power factor

VeraGridEngine.Devices.Injections.generator.compute_q(p: float, pf: float) → float

Compute the reactive power from p and the power factor :param p: Active power :param pf: power factor :return: Reactive power

VeraGridEngine.Devices.Injections.generator_q_curve module

class VeraGridEngine.Devices.Injections.generator_q_curve.GeneratorQCurve

Bases: object

copy() → GeneratorQCurve

get_Pmax()

get_Pmin()

get_Qmax()

get_Qmin()

get_Snom()

get_data()

Get the data :return:

get_data_by_type()

Get the data points P, Qmin, Qmax :return: P, Qmin, Qmax

get_q_limits(p: float) → Tuple[float, float]

Get the reactive power limits :param p: active power value (or array) :return: Qmin (float), Qmax (float)

get_qmax(p: float) → float

Get Qmax :param p: active power value in MW :return: Qmax in MVAr

get_qmin(p: float) → float

Get Qmin :param p: active power value in MW :return: Qmin in MVAr

make_default_q_curve(Snom: float, Qmin: float, Qmax: float, n: int = 3)

Compute the theoretical generator capability curve :param Snom: Nominal power :param Qmin: Minimum reactive power :param Qmax: Maximum reactive power :param n: number of points, at least 3

parse(data: List[Tuple[float, float, float]])

Parse Json data :param data: List of lists with (latitude, longitude, altitude)

plot(ax: axis)

Parameters:

ax

Returns:

set(data: ndarray)

Parse Json data :param data: List of [(P1, Qmin1, Qmax1), (P2, Qmin2, Qmax2), …]

str() → str

Get string representation of the curve :return: json string of list of lists: “[[P1, Qmin1, Qmax1], [P2, Qmin2, Qmax2], …]”

to_list() → list

Get list of points :return:

VeraGridEngine.Devices.Injections.load module

class VeraGridEngine.Devices.Injections.load.Load

Bases: LoadParent

property B: float

Get B.

Returns:

float

property B1: float

Get B1.

Returns:

float

property B1_prof: ProfileFloat

Cost profile :return: Profile

property B2: float

Get B2.

Returns:

float

property B2_prof: ProfileFloat

Cost profile :return: Profile

property B3: float

Get B3.

Returns:

float

property B3_prof: ProfileFloat

Cost profile :return: Profile

property B_prof: ProfileFloat

Cost profile :return: Profile

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'B': 'B_prof', 'B1': 'B1_prof', 'B2': 'B2_prof', 'B3': 'B3_prof', 'Cost': 'Cost_prof', 'G': 'G_prof', 'G1': 'G1_prof', 'G2': 'G2_prof', 'G3': 'G3_prof', 'Ii': 'Ii_prof', 'Ii1': 'Ii1_prof', 'Ii2': 'Ii2_prof', 'Ii3': 'Ii3_prof', 'Ir': 'Ir_prof', 'Ir1': 'Ir1_prof', 'Ir2': 'Ir2_prof', 'Ir3': 'Ir3_prof', 'P': 'P_prof', 'Pa': 'Pa_prof', 'Pb': 'Pb_prof', 'Pc': 'Pc_prof', 'Q': 'Q_prof', 'Qa': 'Qa_prof', 'Qb': 'Qb_prof', 'Qc': 'Qc_prof', 'active': 'active_prof', 'n_customers': 'n_customers_prof', 'shift_key': 'shift_key_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pa, prop:Pb, prop:Pc, prop:Q, prop:Qa, prop:Qb, prop:Qc, prop:Ir, prop:Ir1, prop:Ir2, prop:Ir3, prop:Ii, prop:Ii1, prop:Ii2, prop:Ii3, prop:G, prop:G1, prop:G2, prop:G3, prop:B, prop:B1, prop:B2, prop:B3, prop:n_customers, prop:contract_power)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pa, prop:Pb, prop:Pc, prop:Q, prop:Qa, prop:Qb, prop:Qc, prop:Ir, prop:Ir1, prop:Ir2, prop:Ir3, prop:Ii, prop:Ii1, prop:Ii2, prop:Ii3, prop:G, prop:G1, prop:G2, prop:G3, prop:B, prop:B1, prop:B2, prop:B3, prop:n_customers, prop:contract_power)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'B': prop:B, 'B1': prop:B1, 'B2': prop:B2, 'B3': prop:B3, 'Cost': prop:Cost, 'G': prop:G, 'G1': prop:G1, 'G2': prop:G2, 'G3': prop:G3, 'Ii': prop:Ii, 'Ii1': prop:Ii1, 'Ii2': prop:Ii2, 'Ii3': prop:Ii3, 'Ir': prop:Ir, 'Ir1': prop:Ir1, 'Ir2': prop:Ir2, 'Ir3': prop:Ir3, 'P': prop:P, 'Pa': prop:Pa, 'Pb': prop:Pb, 'Pc': prop:Pc, 'Q': prop:Q, 'Qa': prop:Qa, 'Qb': prop:Qb, 'Qc': prop:Qc, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'contract_power': prop:contract_power, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'facility': prop:facility, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'n_customers': prop:n_customers, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'technologies': prop:technologies, 'use_kw': prop:use_kw}

property G: float

Get G.

Returns:

float

property G1: float

Get G1.

Returns:

float

property G1_prof: ProfileFloat

Cost profile :return: Profile

property G2: float

Get G2.

Returns:

float

property G2_prof: ProfileFloat

Cost profile :return: Profile

property G3: float

Get G3.

Returns:

float

property G3_prof: ProfileFloat

Cost profile :return: Profile

property G_prof: ProfileFloat

Cost profile :return: Profile

property Ii: float

Get Ii.

Returns:

float

property Ii1: float

Get Ii1.

Returns:

float

property Ii1_prof: ProfileFloat

Cost profile :return: Profile

property Ii2: float

Get Ii2.

Returns:

float

property Ii2_prof: ProfileFloat

Cost profile :return: Profile

property Ii3: float

Get Ii3.

Returns:

float

property Ii3_prof: ProfileFloat

Cost profile :return: Profile

property Ii_prof: ProfileFloat

Cost profile :return: Profile

property Ir: float

Get Ir.

Returns:

float

property Ir1: float

Get Ir1.

Returns:

float

property Ir1_prof: ProfileFloat

Cost profile :return: Profile

property Ir2: float

Get Ir2.

Returns:

float

property Ir2_prof: ProfileFloat

Cost profile :return: Profile

property Ir3: float

Get Ir3.

Returns:

float

property Ir3_prof: ProfileFloat

Cost profile :return: Profile

property Ir_prof: ProfileFloat

Cost profile :return: Profile

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:Ir, prop:Ir1, prop:Ir2, prop:Ir3, prop:Ii, prop:Ii1, prop:Ii2, prop:Ii3, prop:G, prop:G1, prop:G2, prop:G3, prop:B, prop:B1, prop:B2, prop:B3, prop:n_customers, prop:contract_power)

assign_input_vars_and_params()

property contract_power: float

Return the contracted power

get_B1_at(t: int | None) → float

Parameters:

t

Returns:

get_B2_at(t: int | None) → float

Parameters:

t

Returns:

get_B3_at(t: int | None) → float

Parameters:

t

Returns:

get_B_at(t: int | None) → float

Parameters:

t

Returns:

get_G1_at(t: int | None) → float

Parameters:

t

Returns:

get_G2_at(t: int | None) → float

Parameters:

t

Returns:

get_G3_at(t: int | None) → float

Parameters:

t

Returns:

get_G_at(t: int | None) → float

Parameters:

t

Returns:

get_I1_at(t: int | None) → complex

Parameters:

t

Returns:

get_I2_at(t: int | None) → complex

Parameters:

t

Returns:

get_I3_at(t: int | None) → complex

Parameters:

t

Returns:

get_I_at(t: int | None) → complex

Parameters:

t

Returns:

get_Ii1_at(t: int | None) → float

Parameters:

t

Returns:

get_Ii2_at(t: int | None) → float

Parameters:

t

Returns:

get_Ii3_at(t: int | None) → float

Parameters:

t

Returns:

get_Ii_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir1_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir2_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir3_at(t: int | None) → float

Parameters:

t

Returns:

get_Ir_at(t: int | None) → float

Parameters:

t

Returns:

get_Y1_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y1_conj_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y2_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y2_conj_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y3_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y3_conj_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y_at(t: int | None) → complex

Parameters:

t

Returns:

get_Y_conj_at(t: int | None) → complex

Parameters:

t

Returns:

initialize_rms(rms_event=False)

Parameters:

rms_event

Returns:

property n_customers: int

Return the number of customers

property n_customers_prof: ProfileInt

Cost profile :return: Profile

plot_profiles(time=None, show_fig=True)

Plot the time series results of this object :param time: array of time values :param show_fig: Show the figure?

VeraGridEngine.Devices.Injections.shunt module

class VeraGridEngine.Devices.Injections.shunt.Shunt(name='shunt', idtag=None, code='', G=0.0, B=0.0, active=True, G1=0.0, G2=0.0, G3=0.0, B1=0.0, B2=0.0, B3=0.0, mttf=0.0, mttr=0.0, G0=0, B0=0, capex=0, opex=0, build_status: BuildStatus = Commissioned)

Bases: ShuntParent

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'B': 'B_prof', 'B0': 'B0_prof', 'Ba': 'Ba_prof', 'Bb': 'Bb_prof', 'Bc': 'Bc_prof', 'Cost': 'Cost_prof', 'G': 'G_prof', 'G0': 'G0_prof', 'Ga': 'Ga_prof', 'Gb': 'Gb_prof', 'Gc': 'Gc_prof', 'active': 'active_prof', 'shift_key': 'shift_key_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:G, prop:G0, prop:Ga, prop:Gb, prop:Gc, prop:B, prop:B0, prop:Ba, prop:Bb, prop:Bc, prop:ysh)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:G, prop:G0, prop:Ga, prop:Gb, prop:Gc, prop:B, prop:B0, prop:Ba, prop:Bb, prop:Bc, prop:ysh)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'B': prop:B, 'B0': prop:B0, 'Ba': prop:Ba, 'Bb': prop:Bb, 'Bc': prop:Bc, 'Cost': prop:Cost, 'G': prop:G, 'G0': prop:G0, 'Ga': prop:Ga, 'Gb': prop:Gb, 'Gc': prop:Gc, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'facility': prop:facility, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'technologies': prop:technologies, 'use_kw': prop:use_kw, 'ysh': prop:ysh}

b

g

VeraGridEngine.Devices.Injections.static_generator module

class VeraGridEngine.Devices.Injections.static_generator.StaticGenerator(name='StaticGen', idtag=None, code='', P=0.0, Q=0.0, active=True, P1=0.0, P2=0.0, P3=0.0, Q1=0.0, Q2=0.0, Q3=0.0, mttf=0.0, mttr=0.0, Cost=1200.0, Snom=0, capex=0, opex=0, build_status: BuildStatus = Commissioned)

Bases: LoadParent

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

CLASS_PROPERTIES_WITH_PROFILE: Dict[str, str] = {'Cost': 'Cost_prof', 'P': 'P_prof', 'Pa': 'Pa_prof', 'Pb': 'Pb_prof', 'Pc': 'Pc_prof', 'Q': 'Q_prof', 'Qa': 'Qa_prof', 'Qb': 'Qb_prof', 'Qc': 'Qc_prof', 'active': 'active_prof', 'shift_key': 'shift_key_prof'}

CLASS_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pa, prop:Pb, prop:Pc, prop:Q, prop:Qa, prop:Qb, prop:Qc, prop:Snom)

CLASS_PROPERTY_LIST: Tuple[GCProp, ...] = (prop:idtag, prop:name, prop:code, prop:rdfid, prop:action, prop:comment, prop:diff_changes, prop:modelling_authority, prop:commissioned_date, prop:decommissioned_date, prop:build_status, prop:owners, prop:rms_model, prop:emt_model, prop:rms_template, prop:emt_template, prop:rms_fmu_template, prop:emt_fmu_template, prop:rms_fmu_import_config, prop:emt_fmu_import_config, prop:rms_fmu_me_import_config, prop:emt_fmu_me_import_config, prop:bus, prop:active, prop:color, prop:mttf, prop:mttr, prop:capex, prop:opex, prop:Cost, prop:facility, prop:technologies, prop:scalable, prop:shift_key, prop:longitude, prop:latitude, prop:use_kw, prop:conn, prop:bus_pos, prop:P, prop:Pa, prop:Pb, prop:Pc, prop:Q, prop:Qa, prop:Qb, prop:Qc, prop:Snom)

CLASS_REGISTERED_PROPERTIES: Dict[str, GCProp] = {'Cost': prop:Cost, 'P': prop:P, 'Pa': prop:Pa, 'Pb': prop:Pb, 'Pc': prop:Pc, 'Q': prop:Q, 'Qa': prop:Qa, 'Qb': prop:Qb, 'Qc': prop:Qc, 'Snom': prop:Snom, 'action': prop:action, 'active': prop:active, 'build_status': prop:build_status, 'bus': prop:bus, 'bus_pos': prop:bus_pos, 'capex': prop:capex, 'code': prop:code, 'color': prop:color, 'comment': prop:comment, 'commissioned_date': prop:commissioned_date, 'conn': prop:conn, 'decommissioned_date': prop:decommissioned_date, 'diff_changes': prop:diff_changes, 'emt_fmu_import_config': prop:emt_fmu_import_config, 'emt_fmu_me_import_config': prop:emt_fmu_me_import_config, 'emt_fmu_template': prop:emt_fmu_template, 'emt_model': prop:emt_model, 'emt_template': prop:emt_template, 'facility': prop:facility, 'idtag': prop:idtag, 'latitude': prop:latitude, 'longitude': prop:longitude, 'modelling_authority': prop:modelling_authority, 'mttf': prop:mttf, 'mttr': prop:mttr, 'name': prop:name, 'opex': prop:opex, 'owners': prop:owners, 'rdfid': prop:rdfid, 'rms_fmu_import_config': prop:rms_fmu_import_config, 'rms_fmu_me_import_config': prop:rms_fmu_me_import_config, 'rms_fmu_template': prop:rms_fmu_template, 'rms_model': prop:rms_model, 'rms_template': prop:rms_template, 'scalable': prop:scalable, 'shift_key': prop:shift_key, 'technologies': prop:technologies, 'use_kw': prop:use_kw}

LOCAL_PROPERTY_DECLARATIONS: Tuple[GCProp, ...] = (prop:Snom,)

property Snom

Return the reactive power lower limit :return: value

Module contents