VeraGridEngine package

Subpackages

Submodules

VeraGridEngine.api module

VeraGridEngine.api.balanced_pf(grid: MultiCircuit, options: PowerFlowOptions = None, opf_options: OptimalPowerFlowOptions = None, engine=VeraGrid) → PowerFlowResults[source]

Run Linear Optimal Power Flow and feed that to a power flow :param grid: MultiCircuit instance :param options: PowerFlowOptions (optional) :param opf_options: Optimal Power Flow Options instance (optional) :param engine: EngineType (optional) :return: PowerFlowResults instance

VeraGridEngine.api.clustering(circuit: MultiCircuit, n_points=100) → ClusteringResults[source]

Perform a clustering analysis for time series This will analyze the loads and non dispatchable generation to get the time indices that best represent the whole time series. It included each sample probability :param circuit: MultiCircuit :param n_points: number of clustering points :return: ClusteringResults

VeraGridEngine.api.contingencies_ts(circuit: MultiCircuit, use_clustering: bool = False, n_points: int = 100, use_srap=False, srap_max_power=1300.0, srap_top_n=5, srap_deadband=10, srap_rever_to_nominal_rating=True, detailed_massive_report=True, contingency_deadband=0.0, contingency_method=Linear) → ContingencyAnalysisTimeSeriesResults[source]

Run a time series contingency analysis :param circuit: MultiCircuit instance :param use_clustering: Use clustering? :param n_points: Number of points for clustering :param use_srap: Use SRAP? :param srap_max_power: Max power in SRAP :param srap_top_n: Top number of SRAP nodes to consider :param srap_deadband: Deadband for SRAP power :param srap_rever_to_nominal_rating: Revert to nominal rating for SRAP flow :param detailed_massive_report: Detailed massive report? :param contingency_deadband: Deadband for contingency analysis :param contingency_method: Contingency analysis method (ContingencyMethod) :return: ContingencyAnalysisTimeSeriesResults

VeraGridEngine.api.contingency_analysis(grid: MultiCircuit, options: ContingencyAnalysisOptions | None = None) → ContingencyAnalysisResults[source]
Parameters:

  • grid

  • options

Returns:

VeraGridEngine.api.continuation_power_flow(grid: ~VeraGridEngine.Devices.multi_circuit.MultiCircuit, options: ~VeraGridEngine.Simulations.ContinuationPowerFlow.continuation_power_flow_options.ContinuationPowerFlowOptions | None = None, pf_options: ~VeraGridEngine.Simulations.PowerFlow.power_flow_options.PowerFlowOptions = .::ced77e92952747299432ea01c0ec9a3b::PowerFlowOptions, pf_results: ~VeraGridEngine.Simulations.PowerFlow.power_flow_results.PowerFlowResults | None = None, factor: ~numpy.ndarray[tuple[~typing.Any, ...], ~numpy.dtype[~numpy.float64]] | float = 2.0, stop_at=CpfStopAt.Full) → ShortCircuitResults[source]

Run continuation power flow circuit :param grid: MultiCircuit instance :param options: ContinuationPowerFlowOptions instance (optional) :param pf_options: Power Flow Options instance (optional) :param pf_results: PowerFlowResults (optional, if none, a power flow is run) :param factor: number or vector to multiply the base power injection to provide the loading direction.

If a vector, it must be the same size as Sbus (optional)

Parameters:

stop_at – Where to stop [CpfStopAt.Full, Nose, ExtraOverloads] (optional)

Returns:

Short circuit results

VeraGridEngine.api.linear_opf(grid: MultiCircuit, options: OptimalPowerFlowOptions = .::42b025793f0e44ad8a8b04be697663e8::Optimal power flow options) → OptimalPowerFlowResults[source]

Run Linear Optimal Power Flow :param grid: MultiCircuit instance :param options: Optimal Power Flow Options instance (optional) :return: Linear Optimal Power Flow results

VeraGridEngine.api.linear_power_flow(grid: MultiCircuit, options: LinearAnalysisOptions | None = None) → LinearAnalysisResults[source]

Run linear power flow on the snapshot :param grid: MultiCircuit instance :param options: LinearAnalysisOptions instance :return: LinearAnalysisResults instance

VeraGridEngine.api.linear_power_flow_ts(grid: MultiCircuit, options: LinearAnalysisOptions | None = None) → LinearAnalysisTimeSeriesResults[source]

Run linear power flow time series :param grid: MultiCircuit instance :param options: LinearAnalysisOptions instance :return: LinearAnalysisTimeSeriesResults instance

VeraGridEngine.api.nonlinear_opf(grid: MultiCircuit, opf_options: OptimalPowerFlowOptions = .::98d833aa94274ae1bcf01560c2fbab86::Optimal power flow options, plot_error: bool = False) → NonlinearOPFResults[source]

Run AC Optimal Power Flow :param grid: MultiCircuit instance :param opf_options: Optimal Power Flow Options instance (optional) :param plot_error: Boolean that selects to plot error :return: AC Optimal Power Flow results

VeraGridEngine.api.open_cgmes(filenames: str | ~typing.List[str], cgmes_version=2.4.15) → MultiCircuit | None[source]

Open CGMES files :param filenames: name of the file (.xml, .zip) or list of files (.xml, .zip) :param cgmes_version: CGMES version :return: MultiCircuit instance

VeraGridEngine.api.open_file(filename: str | List[str], options: FileOpenOptions | None = None) → MultiCircuit[source]

Open file :param filename: name of the file (.veragrid, .ejson, .m, .xml, .zip, etc.) or list of files (.xml, .zip) :param options: FileOpenOptions instance (optional) :return: MultiCircuit instance

VeraGridEngine.api.power_flow(grid: MultiCircuit, options: PowerFlowOptions | None = None, engine=VeraGrid) → PowerFlowResults[source]

Run power flow on the snapshot :param grid: MultiCircuit instance :param options: PowerFlowOptions instance :param engine: Engine to run with :return: PowerFlowResults instance

VeraGridEngine.api.power_flow3ph(grid: MultiCircuit, options: PowerFlowOptions | None = None, engine=VeraGrid) → PowerFlowResults3Ph[source]

Run power flow on the snapshot :param grid: MultiCircuit instance :param options: PowerFlowOptions instance :param engine: Engine to run with :return: PowerFlowResults instance

VeraGridEngine.api.power_flow_ts(grid: MultiCircuit, options: PowerFlowOptions | None = None, time_indices: ndarray[tuple[Any, ...], dtype[int64]] | None = None, clustering_results: ClusteringResults | None = None, auto_expand: bool = True, engine=VeraGrid) → PowerFlowTimeSeriesResults[source]

Run power flow on the time series :param grid: MultiCircuit instance :param options: PowerFlowOptions instance (optional) :param time_indices: Array of time indices to simulate, if None all are used (optional) :param clustering_results: ClusteringResults (optional) :param auto_expand: If true the clustering results are expanded if clustering_results is provided :param engine: Engine to run with (optional, default VeraGrid) :return: PowerFlowResults instance

VeraGridEngine.api.save_cgmes_file(grid: MultiCircuit, filename: str, cgmes_boundary_set_path: str, cgmes_version: CGMESVersions = 2.4.15, pf_results: None | PowerFlowResults = None) → Logger[source]

Save the grid in CGMES format :param grid: MultiCircuit :param filename: name of the CGMES file(.zip) :param cgmes_boundary_set_path: Path to the boundary set in a single zip file :param cgmes_version: CGMESVersions :param pf_results: Matching PowerFlowResults (optional) :return: Logger

VeraGridEngine.api.save_file(grid: MultiCircuit, filename: str, drivers_to_save: List[DriverToSave] | None = None)[source]

Save file :param grid: MultiCircuit instance :param filename: name of the file (.veragrid, .ejson) :param drivers_to_save: List of drivers to save, this structure can be obtained from driver.get_save_data()

VeraGridEngine.api.save_multiverse(mv: MultiVerse, filename: str)[source]

Save file :param mv: MultiVerse instance :param filename: name of the file (.veragrid)

VeraGridEngine.api.short_circuit(grid: MultiCircuit, fault_index: int, fault_type=LG, pf_options: PowerFlowOptions = .::4c67424d911848bda63f4c8dec9a7a9b::PowerFlowOptions, pf_results: PowerFlowResults | None = None, pf_results3ph: PowerFlowResults3Ph | None = None) → ShortCircuitResults[source]

Run short circuit :param grid: MultiCircuit instance :param fault_index: Bus fault index :param fault_type: Short circuit FaultType :param pf_options: Power Flow Options instance (optional) :param pf_results: PowerFlowResults (optional, if none, a power flow is run) :param pf_results3ph: PowerFlowResults3Ph (optional, if none, a power flow is run) :return: Short circuit results

VeraGridEngine.api.simple_opf(grid: MultiCircuit, options: OptimalPowerFlowOptions = .::483d7718df3f4d62bc284243b7bfd1ea::Optimal power flow options) → OptimalPowerFlowResults[source]

Run Linear Optimal Power Flow :param grid: MultiCircuit instance :param options: Optimal Power Flow Options instance (optional) :return: Linear Optimal Power Flow results

VeraGridEngine.basic_structures module

class VeraGridEngine.basic_structures.CDF(data: ndarray[tuple[Any, ...], dtype[float64]] | Series)[source]

Bases: object

Inverse Cumulative density function of a given array of data

expectation() → float | complex[source]

Returns the CDF expected value (AKA the mean) :return: expectation

get_at(prob: float)[source]

Samples a number of uniform distributed points and returns the corresponding probability values given the CDF. @param prob: probability from 0 to 1 @return: Corresponding CDF value

get_sample(npoints=1)[source]

Samples a number of uniform distributed points and returns the corresponding probability values given the CDF. @param npoints: Number of points to sample, 1 by default @return: Corresponding probabilities

plot(plt, LINEWIDTH: int, ax=None)[source]

Plots the CFD :param plt: MatPlotLib plt module :param LINEWIDTH: line width in pixels :param ax: MatPlotLib axis to plot into :return:

class VeraGridEngine.basic_structures.CompressedJsonStruct(fields: List[str] = None, data: List[Any] = None)[source]

Bases: object

Compressed json block

declare_n_entries(n)[source]

Add n entries to the data :param n: :return:

get_col_index(prop)[source]
Parameters:

prop

Returns:

get_data()[source]
Returns:

get_dict_at(i)[source]
Parameters:

i

Returns:

get_final_dict()[source]
Returns:

get_position_dict()[source]
Returns:

get_row_number()[source]
Returns:

set_at(i, col_name, val)[source]

Set value at a position, counts that the data has been declared :param i: column index (object index) :param col_name: name of the property :param val: value to set

set_data(dta: List[Any])[source]

Set the data and check its consistency :param dta: list of lists :return: Nothing

set_fields(fields: List[str])[source]

Set the block fields and initialize the reverse index lookup :param fields: list of property names :return:

class VeraGridEngine.basic_structures.ConvergenceReport[source]

Bases: object

Convergence report

add(method, converged: bool, error: float, elapsed: float, iterations: int)[source]
Parameters:

  • method

  • converged

  • error

  • elapsed

  • iterations

Returns:

converged() → bool[source]
Returns:

elapsed() → float[source]
Returns:

error() → float[source]
Returns:

iterations() → float[source]
Returns:

to_dataframe() → DataFrame[source]
Returns:

class VeraGridEngine.basic_structures.ListSet(iterable=None)[source]

Bases: list

This is a class that behaves like a list except for the query β€œin” where it behaves like a set O(1)

append(value: Bus) → None[source]

Append an item to the list if it’s not already present.

clear()[source]

Remove all items from the list.

copy()[source]

Return a shallow copy of the ListSet.

extend(iterable)[source]

Extend the list by appending elements from the iterable, ensuring uniqueness.

insert(index, value)[source]

Insert an item at a given position if it’s not already present.

pop(index=-1)[source]

Remove and return the item at the given position.

remove(value)[source]

Remove the first occurrence of a value. Raises ValueError if not found.

class VeraGridEngine.basic_structures.LogEntry(time: str | None = None, msg='', severity: LogSeverity = Information, device='', value='', expected_value='', device_class='', device_property='', object_value=None, expected_object_value=None)[source]

Bases: object

Logger entry

to_list() → List[Any][source]

Get list representation of this entry :return:

to_list_reduced() → List[Any][source]

Get list representation of this entry :return:

class VeraGridEngine.basic_structures.Logger[source]

Bases: object

Logger class

add(msg: str, severity: LogSeverity = Error, device='', value='', expected_value='', device_class='', comment='', device_property='', object_value=None, expected_object_value=None)[source]

Add general entry :param msg: :param severity: :param device: :param value: :param expected_value: :param device_class: :param comment: :param device_property: :param object_value: :param expected_object_value: :return:

add_debug(*args)[source]

Add debug entry :param args: :return:

add_divergence(msg, device='', value=0, expected_value=0, tol=1e-06)[source]

Add divergence entry :param msg: :param device: :param value: :param expected_value: :param tol: :return:

add_error(msg: str, device='', value='', expected_value='', device_class='', comment='', device_property='', object_value=None, expected_object_value=None)[source]

Add error entry :param msg: :param device: :param value: :param expected_value: :param device_class: :param comment: :param device_property: :param object_value: :param expected_object_value: :return:

add_info(msg: str, device='', value='', expected_value='', device_class='', comment='', device_property='', object_value=None, expected_object_value=None)[source]

Add info entry :param msg: :param device: :param value: :param expected_value: :param device_class: :param comment: :param device_property: :param object_value: :param expected_object_value: :return:

add_warning(msg: str, device='', value='', expected_value='', device_class='', comment='', device_property='', object_value=None, expected_object_value=None)[source]

Add warning entry :param msg: :param device: :param value: :param expected_value: :param device_class: :param comment: :param device_property: :param object_value: :param expected_object_value: :return:

append(txt: str)[source]

simple text log :param txt: some message text

count_type(severity: LogSeverity) → int[source]

Count the number of entries of a certain severity :param severity: LogSeverity :return: number of occurences

error_count() → int[source]

Count number of errors :return:

has_errors() → bool[source]

Check if there are errors :return:

has_logs() → bool[source]

Are there any logs? :return: True / False

info_count() → int[source]

Count the number of information occurences :return:

parse_df(df: DataFrame)[source]

Parse DataFrame :param df: DataFrame

print(title: str = '') → None[source]

Print the logs

size() → int[source]

Number of logs :return: size

to_csv(fname)[source]

Save to CSV :param fname: file name

to_df() → DataFrame[source]

Get DataFrame :return: DataFrame

to_dict() → Dict[str, Dict[str, List[Tuple[str, str, str, str]]]] | Dict[str, Dict[str, List[List[str]]]][source]

Get the logs sorted by severity and message :return: Dictionary[Dictionary[List[time, device, value, expected value]]]

to_xlsx(fname)[source]

To Excel :param fname: file name

warning_count() → int[source]

Count number of warnings :return:

class VeraGridEngine.basic_structures.Vector(size=0, value=None)[source]

Bases: object

Python implementation of a C++ like std::vector

clear()[source]

Remove all elements.

copy()[source]

Return a deep copy of the vector.

pop_back()[source]

Remove and return the last element.

push_back(value)[source]

Append a value at the end.

resize(new_size, value=None)[source]

Resize the vector like in C++ std::vector.

VeraGridEngine.basic_structures.classify_by_day(t: DatetimeIndex) → list[list[int]][source]

Passes an array of TimeStamps to an array of arrays of indices classified by day of the year @param t: Pandas time Index array @return: list of lists of integer indices

VeraGridEngine.basic_structures.classify_by_hour(t: DatetimeIndex) → List[List[int]][source]

Passes an array of TimeStamps to an array of arrays of indices classified by hour of the year @param t: Pandas time Index array @return: list of lists of integer indices

VeraGridEngine.basic_structures.get_list_dim(a: List[Any]) → int[source]

Get the dimensions of a List, this is for the case were a matrix is represented by lists of lists :param a: some List :return: Dimensions

VeraGridEngine.basic_structures.get_time_groups(t_array: DatetimeIndex, grouping: TimeGrouping) → List[int][source]

Get the indices delimiting a number of groups :param t_array: DatetimeIndex object containing dates :param grouping: TimeGrouping value :return: list of indices that determine the partitions

VeraGridEngine.data_logger module

class VeraGridEngine.data_logger.DataLogEntry[source]

Bases: object

to_list() → List[str][source]

Get list of arguments

to_normal_entry() → LogEntry[source]
class VeraGridEngine.data_logger.DataLogSeverity[source]

Bases: Enum

Divergence = 'Divergence'
Error = 'Error'
Information = 'Information'
Warning = 'Warning'
static argparse(s)[source]
to_normal() → LogSeverity[source]
class VeraGridEngine.data_logger.DataLogger[source]

Bases: object

add(msg, severity: DataLogSeverity = Error, device='', device_class='', device_property='', value='', expected_value='')[source]
Parameters:

  • msg

  • severity

  • device

  • device_class

  • device_property

  • value

  • expected_value

Returns:

add_debug(*args)[source]
Parameters:

args

add_divergence(msg, device='', device_class='', device_property='', value=0, expected_value=0, tol=1e-06)[source]
Parameters:

  • msg

  • device

  • device_class

  • device_property

  • value

  • expected_value

  • tol

Returns:

add_error(msg: str, device: str = '', device_class: str = '', device_property: str = '', value: str | float | int | None = '', expected_value: str | float | int | None = '', comment: str = '')[source]
Parameters:

  • msg

  • device

  • device_class

  • device_property

  • value

  • expected_value

  • comment

Returns:

add_info(msg: str, device: str = '', device_class: str = '', device_property: str = '', value: str | float | int | None = '', expected_value: str | float | int | None = '', comment: str = '')[source]
Parameters:

  • msg

  • device

  • device_class

  • device_property

  • value

  • expected_value

  • comment

Returns:

add_warning(msg: str, device: str = '', device_class: str = '', device_property: str = '', value: str | float | int | None = '', expected_value: str | float | int | None = '', comment: str = '') → None[source]
Parameters:

  • msg

  • device

  • device_class

  • device_property

  • value

  • expected_value

  • comment

Returns:

append(txt: str)[source]
Parameters:

txt

Returns:

debug_entries: List[str]
entries: List[DataLogEntry]
get_logger() → Logger[source]

Convert logger entries :return: List of LogEntry

get_message() → str[source]

Get a diagnostic message :return: message

has_logs() → bool[source]

Has logs?

size() → int[source]

Get size

to_csv(fname)[source]

Save to CSV file :param fname: name of the file

to_df()[source]

Get DataFrame :return:

to_dict()[source]

Get the logs sorted by severity and message :return: Dictionary[Dictionary[List[time, device, value, expected value]]]

to_xlsx(fname, sheet_name='Logs')[source]

Save to excel file :param fname: filename :param sheet_name: sheet name

VeraGridEngine.enumerations module

class VeraGridEngine.enumerations.AcOpfMode(value)[source]

Bases: Enum

AC-OPF problem types

ACOPFMaxInjections = 'ACOPFMaxInjections'
ACOPFslacks = 'ACOPFslacks'
ACOPFstd = 'ACOPFstd'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.ActionType[source]

Bases: Enum

Add = 'Add'
Delete = 'Delete'
Modify = 'Modify'
NoAction = 'No action'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.AvailableTransferMode[source]

Bases: Enum

Generation = 'Generation'
GenerationAndLoad = 'GenerationAndLoad'
InstalledPower = 'InstalledPower'
Load = 'Load'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.BlockScopeMode(value)[source]

Bases: Enum

Block extraction scope modes for DGS block parsing.

DownstreamOnly = 'DownstreamOnly'
FullDependency = 'FullDependency'
InternalOnly = 'InternalOnly'
UpstreamOnly = 'UpstreamOnly'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.BlockType(value)[source]

Bases: Enum

this class contains the existing types of blocks

ABS = 'Abs'
ARBITRARY_WAVEFORM_CURRENT_SOURCE_EMT = 'ARBITRARY_WAVEFORM_CURRENT_SOURCE_EMT'
ARBITRARY_WAVEFORM_VOLTAGE_SOURCE_EMT = 'ARBITRARY_WAVEFORM_VOLTAGE_SOURCE_EMT'
BALANCED_3PH_CURRENT_SOURCE_EMT = 'BALANCED_3PH_CURRENT_SOURCE_EMT'
BALANCED_3PH_VOLTAGE_SOURCE_EMT = 'BALANCED_3PH_VOLTAGE_SOURCE_EMT'
BATTERY_EMT = 'BATTERY_EMT'
BESS_EMT = 'BESS_EMT'
CIGRE_SURGE_CURRENT_SOURCE_EMT = 'CIGRE_SURGE_CURRENT_SOURCE_EMT'
COMPLETE_PSEUDO_VSC_EMT = 'COMPLETE_PSEUDO_VSC_EMT'
CONST = 'CONST'
CONTROLLED_BALANCED_3PH_CURRENT_SOURCE_EMT = 'CONTROLLED_BALANCED_3PH_CURRENT_SOURCE_EMT'
CONTROLLED_BALANCED_3PH_VOLTAGE_SOURCE_EMT = 'CONTROLLED_BALANCED_3PH_VOLTAGE_SOURCE_EMT'
CONTROLLED_CURRENT_SOURCE_EMT = 'CONTROLLED_CURRENT_SOURCE_EMT'
CONTROLLED_DC_CURRENT_SOURCE_EMT = 'CONTROLLED_DC_CURRENT_SOURCE_EMT'
CONTROLLED_DC_VOLTAGE_SOURCE_EMT = 'CONTROLLED_DC_VOLTAGE_SOURCE_EMT'
CONTROLLED_VOLTAGE_SOURCE_EMT = 'CONTROLLED_VOLTAGE_SOURCE_EMT'
CURRENT_SOURCE_EMT = 'CURRENT_SOURCE_EMT'
C_LOAD_EMT = 'C_LOAD_EMT'
DC_CURRENT_SOURCE_EMT = 'DC_CURRENT_SOURCE_EMT'
DC_LOAD_EMT = 'DC_LOAD_EMT'
DC_VOLTAGE_SOURCE_EMT = 'DC_VOLTAGE_SOURCE_EMT'
DIVIDE = 'Divide'
DOUBLE_EXPONENTIAL_CURRENT_SOURCE_EMT = 'DOUBLE_EXPONENTIAL_CURRENT_SOURCE_EMT'
EMTLOAD = 'EMT_LOAD'
EMT_BERGERON_LINE = 'EMT_BERGERON_LINE'
EMT_DC_LINE = 'EMT_DC_LINE'
EMT_GENERATOR = 'EMT_GENERATOR'
EMT_JMARTI_LINE = 'EMT_JMARTI_LINE'
EMT_PI_LINE = 'EMT_PI_LINE'
EMT_THEVENIN = 'EMT_THEVENIN_EMT'
EXCITER_EMT = 'EXCITER_EMT'
EXCITER_RMS = 'EXCITER_RMS'
EXP_LOAD_EMT = 'EXP_LOAD_EMT'
GAIN = 'GAIN'
GENERIC = 'Generic'
GENQEC = 'GENQEC'
GENRAW = 'GENRAW'
GOV_EMT = 'GOVERNOR_EMT'
GOV_RMS = 'GOVERNOR_RMS'
GROUND_EMT = 'GROUND_EMT'
HEIDLER_CURRENT_SOURCE_EMT = 'HEIDLER_CURRENT_SOURCE_EMT'
INDUCTION_MOTOR_EMT = 'INDUCTION_MOTOR_EMT'
INPUT_CONN = 'Bus Connection'
LINE_RMS = 'Line_RMS'
LOAD_RMS = 'Load_RMS'
L_LOAD_EMT = 'L_LOAD_EMT'
NONLINEAR_RESISTOR_EMT = 'NONLINEAR_RESISTOR_EMT'
OUTPUT_CONN = 'EXTERNAL_MAPPING'
PRODUCT = 'PRODUCT'
PV_EMT = 'PV_EMT'
PV_POWER_PLANT_EMT = 'PV_POWER_PLANT_EMT'
RAMP_CURRENT_SOURCE_EMT = 'RAMP_CURRENT_SOURCE_EMT'
RAMP_VOLTAGE_SOURCE_EMT = 'RAMP_VOLTAGE_SOURCE_EMT'
RLC_COMBO_EMT = 'RLC_COMBO_EMT'
R_LOAD_EMT = 'R_LOAD_EMT'
STAB_EMT = 'STABILIZER_EMT'
STAB_RMS = 'STABILIZER_RMS'
STEP_CURRENT_SOURCE_EMT = 'STEP_CURRENT_SOURCE_EMT'
STEP_VOLTAGE_SOURCE_EMT = 'STEP_VOLTAGE_SOURCE_EMT'
SUBSTR = 'SUBSTR'
SUM = 'SUM'
SWITCH_EMT = 'SWITCH_EMT'
TRAFO_EMT = 'TRAFO_EMT'
VOLTAGE_SOURCE_EMT = 'VOLTAGE_SOURCE_EMT'
XFMR_TRANSFORMER = 'XFMR_TRANSFORMER'
ZIP_LOAD_EMT = 'ZIP_LOAD_EMT'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.BranchGroupTypes(value)[source]

Bases: Enum

Branch group types

GenericGroup = 'Generic group'
LineSegmentsGroup = 'Line segments group'
TransformerGroup = 'Transformer group'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.BranchImpedanceMode(value)[source]

Bases: Enum

Enumeration of branch impedance modes

Lower = 2
Specified = 0
Upper = 1
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.BuildStatus(value)[source]

Bases: Enum

Asset build status options

Candidate = 'Candidate'
Commissioned = 'Commissioned'
Decommissioned = 'Decommissioned'
Planned = 'Planned'
PlannedDecommission = 'PlannedDecommission'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.BusGraphicType(value)[source]

Bases: Enum

Bus graphical modes

BusBar = 'BusBar'
Connectivity = 'Connectivity'
Internal = 'Internal'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.BusMode(value)[source]

Bases: Enum

Bus modes

PQV_tpe = 4
PQ_tpe = 1
PV_tpe = 2
P_tpe = 5
Slack_tpe = 3
static argparse(s)[source]
Parameters:

s

Returns:

static as_str(val: int) → str[source]

Get the string representation of the numeric value :param val: :return:

class VeraGridEngine.enumerations.BusReductionMethod(value)[source]

Bases: Enum

GridReductionMethod

Keep = 'Keep'
Reduce = 'Reduce'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.CGMESVersions(value)[source]

Bases: Enum

Enumeration of logs severities

static argparse(s)[source]
Parameters:

s

Returns:

v2_4_15 = '2.4.15'
v3_0_0 = '3.0.0'
class VeraGridEngine.enumerations.CascadeType(value)[source]

Bases: Enum

LatinHypercube = 'LHS'
PowerFlow = ('PowerFlow',)
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.CgmesBoundaryPlaceholderMode(value)[source]

Bases: Enum

Boundary placeholder creation mode for CGMES conversion.

Always = 'Always'
KnownBoundaryOnly = 'KnownBoundaryOnly'
Never = 'Never'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.CgmesExportMode(value)[source]

Bases: Enum

Enumeration of CGMES export output strategies.

BatchZip = 'Batch zip package'
SingleFile = 'Single file'
static argparse(s)[source]

Parse a command-line value into the enumeration.

Parameters:

s – Input string.

Returns:

Parsed enumeration or original input.

class VeraGridEngine.enumerations.CgmesTopologyMode(value)[source]

Bases: Enum

Topology conversion mode for CGMES imports.

Auto = 'Auto'
ConnectivityNode = 'ConnectivityNode'
TopologicalNode = 'TopologicalNode'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.Colormaps(value)[source]

Bases: Enum

Available colormaps

Blue2Gray = 'Blue to gray'
Blues = 'Blue'
Green2Red = 'Green to red'
Greens = 'Green'
Heatmap = 'Heatmap'
Red2Blue = 'Red to blue'
SCADA = 'SCADA'
TSO = 'TSO'
TSO2 = 'TSO 2'
VeraGrid = 'VeraGrid'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ContingencyFilteringMethods(value)[source]

Bases: Enum

Contingency filtering methods

AllActive = 'All active contingencies'
Area = 'Area'
Community = 'Community'
Country = 'Country'
Municipality = 'Municipality'
Region = 'Region'
SensitiveToMonitored = 'Sensitive to monitored'
Zone = 'Zone'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ContingencyMethod(value)[source]

Bases: Enum

Enumeratio of contingency calculation engines

HELM = 'HELM'
Linear = 'Linear'
OptimalPowerFlow = 'Optimal power flow'
PTDF_scan = 'PTDF Scan'
PowerFlow = 'Power flow'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ContingencyOperationTypes(value)[source]

Bases: Enum

Types of contingency operations

Active = 'active'
PowerPercentage = '%'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.ConverterControlType(value)[source]

Bases: str, Enum

Converter control types

Fault1 = 'Fault1'
Fault2 = 'Fault2'
Imax = 'Imax'
P_droop = 'P_droop'
Pac = 'P_ac'
Pdc = 'P_dc'
Pdc_angle_droop = 'P_dc_angle_droop'
Pdc_droop = 'P_dc_droop'
Q_droop = 'Q_droop'
Qac = 'Q_ac'
Va_ac = 'Va_ac'
Vm_ac = 'Vm_ac'
Vm_dc = 'Vm_dc'
static argparse(s)[source]
idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.ConverterFaultControlType(value)[source]

Bases: str, Enum

Converter fault control types

Standard = 'Standard'
WECC_WT_Type_4B = 'WECC_WT_Type_4B'
static argparse(s)[source]
idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.CpfParametrization[source]

Bases: Enum

ArcLength = 'Arc Length'
Natural = 'Natural'
PseudoArcLength = 'Pseudo Arc Length'
class VeraGridEngine.enumerations.CpfStopAt[source]

Bases: Enum

ExtraOverloads = 'Extra overloads'
Full = 'Full curve'
Nose = 'Nose'
class VeraGridEngine.enumerations.DeviceType(value)[source]

Bases: Enum

Device types

AnyLineTemplateDevice = 'Any line template'
AreaDevice = 'Area'
BatteryDevice = 'Battery'
BranchDevice = 'Branch'
BranchGroupDevice = 'Branch group'
BranchTypeDevice = 'Branch template'
BusBarDevice = 'BusBar'
BusDevice = 'Bus'
BusOrBranch = 'BusOrBranch'
CircuitDevice = 'Circuit'
CommunityDevice = 'Community'
ContingencyDevice = 'Contingency'
ContingencyGroupDevice = 'Contingency Group'
ControllableShuntDevice = 'Controllable shunt'
CountryDevice = 'Country'
CurrentInjectionDevice = 'Current injection'
DCLineDevice = 'DC line'
DiagramDevice = 'Diagram'
DynamicModelHostDevice = 'Dynamic Model Host'
DynamicPlotEntry = 'Plot Event'
DynamicPlotGroupDevice = 'Plot Group'
EmissionGasDevice = 'Emission'
EmtEventDevice = 'Emt Event'
EmtEventsGroupDevice = 'Emt Events Group'
EmtModelTemplateDevice = 'EMT template'
ExciterDevice = 'Exciter'
ExternalGridDevice = 'External grid'
FacilityDevice = 'Facility'
FluidInjectionDevice = 'Fluid Injection'
FluidNodeDevice = 'Fluid node'
FluidP2XDevice = 'Fluid P2X'
FluidPathDevice = 'Fluid path'
FluidPumpDevice = 'Fluid Pump'
FluidTurbineDevice = 'Fluid Turbine'
FmuTemplateDevice = 'FMU template'
FuelDevice = 'Fuel'
GeneratorDevice = 'Generator'
GeneratorEmissionAssociation = 'Generator Emission'
GeneratorFuelAssociation = 'Generator Fuel'
GeneratorTechnologyAssociation = 'Generator Technology'
GenericArea = 'Generic Area'
GovernorDevice = 'Governor'
HVDCLineDevice = 'HVDC Line'
IfMeasurementDevice = 'If Measurement'
InterAggregationInfo = 'InterAggregationInfo'
InvestmentDevice = 'Investment'
InvestmentsGroupDevice = 'Investments Group'
ItMeasurementDevice = 'It Measurement'
LambdaDevice = 'Loading from the base situation ($\\lambda$)'
LineDevice = 'Line'
LineLocation = 'Line Location'
LineLocations = 'Line Locations'
LineTypeDevice = 'Line Template'
LoadDevice = 'Load'
LoadLikeDevice = 'Load like'
ModellingAuthority = 'Modelling Authority'
MunicipalityDevice = 'Municipality'
NoDevice = 'NoDevice'
OverheadLineTypeDevice = 'Tower'
Owner = 'Owner'
PfMeasurementDevice = 'Pf Measurement'
PgMeasurementDevice = 'Pg Measurement'
PiMeasurementDevice = 'Pi Measurement'
PtMeasurementDevice = 'Pt Measurement'
QfMeasurementDevice = 'Qf Measurement'
QgMeasurementDevice = 'Qg Measurement'
QiMeasurementDevice = 'Qi Measurement'
QtMeasurementDevice = 'Qt Measurement'
RegionDevice = 'Region'
RemedialActionDevice = 'Remedial action'
RemedialActionGroupDevice = 'Remedial action Group'
RmsEventDevice = 'Rms Event'
RmsEventsGroupDevice = 'Rms Events Group'
RmsModelTemplateDevice = 'RMS template'
SequenceLineDevice = 'Sequence line'
SeriesReactanceDevice = 'Series reactance'
ShortCircuitEvent = 'Short circuit event'
ShuntDevice = 'Shunt'
ShuntLikeDevice = 'Shunt like devices'
SimulationOptionsDevice = 'SimulationOptionsDevice'
StabilizerDevice = 'Stabilizer'
StaticGeneratorDevice = 'Static Generator'
SubstationDevice = 'Substation'
SwitchDevice = 'Switch'
Technology = 'Technology'
TechnologyCategory = 'Technology Category'
TechnologyGroup = 'Technology Group'
TimeDevice = 'Time'
Transformer2WDevice = 'Transformer'
Transformer3WDevice = 'Transformer3W'
TransformerNwDevice = 'TransformerNw'
TransformerTypeDevice = 'Transformer type'
UnderGroundLineDevice = 'Underground line'
UpfcDevice = 'UPFC'
VaMeasurementDevice = 'Va Measurement'
VarFactory = 'Var Factory'
VmMeasurementDevice = 'Vm Measurement'
VoltageLevelDevice = 'Voltage level'
VoltageLevelTemplate = 'Voltage level template'
VscDevice = 'VSC'
WindingDevice = 'Winding'
WireDevice = 'Wire'
ZoneDevice = 'Zone'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.DgsExportMode(value)[source]

Bases: Enum

Enumeration of DGS export output strategies.

BatchZip = 'Batch zip package'
SingleFile = 'Single file'
static argparse(s)[source]

Parse a command-line value into the enumeration.

Parameters:

s – Input string.

Returns:

Parsed enumeration or original input.

class VeraGridEngine.enumerations.DiagramType(value)[source]

Bases: Enum

Types of diagrams

Schematic = 'schematic'
SubstationLineMap = 'substation-line-map'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.DynamicEntrySection[source]

Bases: object

Stable source-tree section labels used for dynamic entries.

PARAMETERS: str = 'Parameters'
VARIABLES: str = 'Variables'
class VeraGridEngine.enumerations.DynamicEventTransitionType(value)[source]

Bases: Enum

Transition profile used by one dynamic runtime event.

Ramp = 'ramp'
Step = 'step'
static argparse(s)[source]
classmethod list()[source]
class VeraGridEngine.enumerations.DynamicIntegrationMethod(value)[source]

Bases: Enum

Dynamic integration methods.

DaeBDF2 = 'DAE_bdf2'
DaeBackEuler = 'DAE_BackEuler'
DaeContinuous = 'DAE_Continuous'
DaeTrapezoidal = 'DAE_Trapezoidal'
OdeEuler = 'ODE_Euler'
OdeRungeKutta4 = 'ODE_Runge_Kutta 4'
static argparse(s)[source]
classmethod list()[source]
class VeraGridEngine.enumerations.DynamicPlotEntryKind(value)[source]

Bases: Enum

Semantic kind of one persistent dynamic plot entry.

PARAMETER = 'PARAMETER'
VARIABLE = 'VARIABLE'
class VeraGridEngine.enumerations.DynamicPlotEntryRole(value)[source]

Bases: Enum

Semantic role played by one persistent dynamic plot entry.

CURVE = 'CURVE'
X_AXIS = 'X_AXIS'
Y_AXIS = 'Y_AXIS'
class VeraGridEngine.enumerations.DynamicPlotMode(value)[source]

Bases: Enum

Plotting mode used by persistent dynamic plot definitions.

TIME_SERIES = 'TIME_SERIES'
XY = 'XY'
class VeraGridEngine.enumerations.DynamicSimulationMode(value)[source]

Bases: Enum

EMT = ('EMT',)
RMS = ('RMS',)
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.EmtInitializationMethod(value)[source]

Bases: Enum

EMT initialization workflow options.

Auto = 'Auto'
ConsistentNewton = 'ConsistentNewton'
Explicit = 'Explicit'
PseudoTransient = 'PseudoTransient'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.EmtInitializationStatus(value)[source]

Bases: Enum

Enumeration to track the progress of the initialization solver.

FAILED = 'FAILED'
PENDING = 'PENDING'
RESOLVED = 'RESOLVED'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.EmtLineTypes[source]

Bases: Enum

Bergeron = 'Bergeron'
J_Marti = 'J_Marti'
PI = 'Pi'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.EmtProblemTypes(value)[source]

Bases: Enum

CurrentBalance = 'EmtProblemDae'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.EmtSolverTypes(value)[source]

Bases: Enum

Jacobian construction backends for implicit solvers.

Automatic = 'automatic'
StructuralAD = 'structuralAD'
StructuralCompiled = 'structuralCompiled'
Symbolic = 'symbolic'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.EngineType(value)[source]

Bases: Enum

Available engines enumeration

Bentayga = 'Bentayga'
GSLV = 'gslv'
NewtonPA = 'Newton Power Analytics'
PGM = 'Power Grid Model'
VeraGrid = 'VeraGrid'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.EraSvdSolverType(value)[source]

Bases: Enum

Enumeration for the SVD solver backend.

FullSvd = 0
TruncatedRandomized = 1
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.ExternalGridMode(value)[source]

Bases: Enum

Modes of operation of external grids

PQ = 'PQ'
PV = 'PV'
VD = 'VD'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.FaultType(value)[source]

Bases: Enum

Short circuit type

LG = 'LG'
LL = 'LL'
LLG = 'LLG'
LLL = 'LLL'
LLLG = 'LLLG'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.FileType(value)[source]

Bases: Enum

Enumeration of logs severities

CGMES = 'CGMES'
CIM = 'CIM'
DGS = 'DGS'
DPX = 'DPX'
EPC = 'EPC'
IPA = 'IPA'
Iidm = 'Iidm'
Matpower = 'Matpower'
PGM = 'Power grid models'
PSSE_raw = 'PSS/e raw'
PSSE_rawx = 'PSS/e rawx'
PWF = 'PWF'
PandaPower = 'Pandapower'
PyPsa = 'PyPsa'
PyPsa_h5 = 'PyPSA H5'
RTE_xml = 'RTE_XML'
UCTE = 'UCTE'
VeraGrid = 'VeraGrid'
VeraGridScenario = 'VeraGrid Scenario'
VeraGrid_delta = 'VeraGrid Delta'
VeraGrid_ejson3 = 'Ejson3'
VeraGrid_h5 = 'VeraGrid H5'
VeraGrid_json = 'VeraGrid Json'
VeraGrid_sqlite = 'VeraGrid SQLite'
VeraGrid_xlsx1 = 'VeraGrid Excel 1'
VeraGrid_xlsx2 = 'VeraGrid Excel 2'
VeraGrid_xlsx3 = 'VeraGrid Excel 3'
VeraGrid_xlsx4 = 'VeraGrid Excel 4'
static argparse(s)[source]
Parameters:

s

Returns:

generic_excel = 'Generic Excel'
class VeraGridEngine.enumerations.FmuTemplateDomain(value)[source]

Bases: Enum

Available VeraGrid domains for reusable FMU templates.

EMT = 'emt'
RMS = 'rms'
class VeraGridEngine.enumerations.FmuTemplateMode(value)[source]

Bases: Enum

FMI 2.0 execution modes supported by the FMU template catalogue.

CO_SIMULATION = 'CoSimulation'
MODEL_EXCHANGE = 'ModelExchange'
class VeraGridEngine.enumerations.GenerationNtcFormulation(value)[source]

Bases: Enum

NTC formulation type

Optimal = 'Optimal'
Proportional = 'Proportional'
class VeraGridEngine.enumerations.GeneratorControlMode(value)[source]

Bases: str, Enum

Modes of operation of generator control modes.

Q = 'Q'
QVDroop = 'Q-V'
V = 'V'
static argparse(s)[source]
idx() → int[source]
class VeraGridEngine.enumerations.GeneratorType(value)[source]

Bases: str, Enum

Machine type of the generator element.

Asynchronous = 'Asynchronous'
Synchronous = 'Synchronous'
static argparse(s)[source]
Parameters:

s

Returns:

idx() → int[source]
class VeraGridEngine.enumerations.GridReductionMethod[source]

Bases: Enum

DiShi = 'DiShi'
PTDF = 'PTDF'
PTDFProjected = 'PTDF projected'
Ward = 'Ward'
WardLinear = 'Ward linear'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.HvdcControlType(value)[source]

Bases: str, Enum

Simple HVDC control types

static argparse(s)[source]
idx() → int[source]
classmethod list()[source]
Returns:

type_0_free = '0:Free'
type_1_Pset = '1:Pdc'
class VeraGridEngine.enumerations.InvestmentEvaluationMethod(value)[source]

Bases: Enum

Investment evaluation methods

CBA_PINT_TOOT = 'CBA PINT-TOOT'
FromPlugin = 'From plugin'
Hyperopt = 'Hyperopt'
MVRSM = 'MVRSM'
MixedVariableGA = 'Mixed Variable NSGA2'
NSGA3 = 'NSGA3'
PINT_TOOT_NSGA3 = 'PINT-TOOT NSGA3'
Random = 'Random'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.InvestmentsEvaluationObjectives(value)[source]

Bases: Enum

Types of investment optimization objectives

FromPlugin = 'From Plugin'
GenerationAdequacy = 'Adequacy'
LinearOptimalPowerFlowTimeSeries = 'Linear OPF time series'
PowerFlow = 'PowerFlow'
SimpleDispatch = 'Simple dispatch'
TimeSeriesPowerFlow = 'TimeSeriesPowerFlow'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.JobStatus(value)[source]

Bases: Enum

Job status types

Cancelled = 'Cancelled'
Done = 'Done'
Failed = 'Failed'
Running = 'Running'
Waiting = 'Waiting'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.LogSeverity(value)[source]

Bases: Enum

Enumeration of logs severities

Divergence = 'Divergence'
Error = 'Error'
Information = 'Information'
Warning = 'Warning'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.MIPFramework(value)[source]

Bases: Enum

MIP framework enumeration

OrTools = 'or-tools'
PuLP = 'PuLP'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.MIPSolvers(value)[source]

Bases: Enum

MIP solvers enumeration

CBC = 'CBC'
CPLEX = 'CPLEX'
GUROBI = 'GUROBI'
HIGHS = 'HIGHS'
PDLP = 'PDLP'
SCIP = 'SCIP'
XPRESS = 'XPRESS'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.MatpowerExportMode(value)[source]

Bases: Enum

Enumeration of MATPOWER export output strategies.

BatchZip = 'Batch zip package'
SingleFile = 'Single file'
static argparse(s)[source]

Parse a command-line value into the enumeration.

Parameters:

s – Input string.

Returns:

Parsed enumeration or original input.

class VeraGridEngine.enumerations.MethodShortCircuit(value)[source]

Bases: Enum

Short circuit type

static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

phases = 'phases'
sequences = 'sequences'
sequences_vsc = 'sequences_vsc'
class VeraGridEngine.enumerations.NodalCapacityMethod(value)[source]

Bases: Enum

Sparse solvers to use

CPF = 'Continuation power flow'
LinearOptimization = 'Linear Optimization'
NonlinearOptimization = 'Nonlinear Optimization'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.OpfDispatchMode(value)[source]

Bases: Enum

OpfGenerationMode

GenerationExpansionPlanning = 'Generation expansion planning'
InterAreaRedispatch = 'Inter-area redispatch'
NodalCapacity = 'Nodal capacity'
Normal = 'Normal'
UnitCommitment = 'Unit commitment'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ParamPowerFlowReferenceType[source]

Bases: Enum

A = 'A'
B = 'B'
Caa = 'Caa'
Cab = 'Cab'
Cac = 'Cac'
Can = 'Can'
Cba = 'Cba'
Cbb = 'Cbb'
Cbc = 'Cbc'
Cbn = 'Cbn'
Cca = 'Cca'
Ccb = 'Ccb'
Ccc = 'Ccc'
Ccn = 'Ccn'
Cna = 'Cna'
Cnb = 'Cnb'
Cnc = 'Cnc'
Cnn = 'Cnn'
D = 'D'
Ii0 = 'Ii0'
Ir0 = 'Ir0'
K = 'K'
Ki = 'Ki'
Kp = 'Kp'
Linv_aa = 'Linv_aa'
Linv_ab = 'Linv_ab'
Linv_ac = 'Linv_ac'
Linv_an = 'Linv_an'
Linv_ba = 'Linv_ba'
Linv_bb = 'Linv_bb'
Linv_bc = 'Linv_bc'
Linv_bn = 'Linv_bn'
Linv_ca = 'Linv_ca'
Linv_cb = 'Linv_cb'
Linv_cc = 'Linv_cc'
Linv_cn = 'Linv_cn'
Linv_na = 'Linv_na'
Linv_nb = 'Linv_nb'
Linv_nc = 'Linv_nc'
Linv_nn = 'Linv_nn'
M = 'M'
NOTHING = 'nothing'
P0 = 'P0'
Pl0 = 'Pl0'
Pl0_A = 'Pl0_A'
Pl0_B = 'Pl0_B'
Pl0_C = 'Pl0_C'
Pmax = 'Pmax'
Pmin = 'Pmin'
Ql0 = 'Ql0'
Ql0_A = 'Ql0_A'
Ql0_B = 'Ql0_B'
Ql0_C = 'Ql0_C'
R1 = 'R1'
Ra = 'Ra'
Raa = 'Raa'
Rab = 'Rab'
Rac = 'Rac'
Ran = 'Ran'
Rba = 'Rba'
Rbb = 'Rbb'
Rbc = 'Rbc'
Rbn = 'Rbn'
Rca = 'Rca'
Rcb = 'Rcb'
Rcc = 'Rcc'
Rcn = 'Rcn'
Rna = 'Rna'
Rnb = 'Rnb'
Rnc = 'Rnc'
Rnn = 'Rnn'
Rs = 'Rs'
Sbase = 'Sbase'
T_aux = 'T_aux'
Td0_2prime = 'Td0_2prime'
Td0_prime = 'Td0_prime'
Tq0_2prime = 'Tq0_2prime'
Tq0_prime = 'Tq0_prime'
Uc = 'Uc'
Uo = 'Uo'
X0 = 'X0'
X1 = 'X1'
Xd = 'Xd'
Xd_2prime = 'Xd_2prime'
Xd_prime = 'Xd_prime'
Xd_prime_minus_Xl = 'Xd_prime_minus_Xl'
Xdaux = 'Xdaux'
Xdaux2 = 'Xdaux2'
Xdaux3 = 'Xdaux3'
Xl = 'Xl'
Xq = 'Xq'
Xq_2prime = 'Xq_2prime'
Xq_prime = 'Xq_prime'
Xq_prime_minus_Xl = 'Xq_prime_minus_Xl'
Xqaux = 'Xqaux'
Xqaux2 = 'Xqaux2'
Xqaux3 = 'Xqaux3'
alpha1 = 'alpha1'
alpha2 = 'alpha2'
alpha3 = 'alpha3'
static argparse(s)[source]
Parameters:

s

Returns:

b = 'b'
battery_charge_efficiency_pu = 'battery_charge_efficiency_pu'
battery_charge_per_cycle_pu = 'battery_charge_per_cycle_pu'
battery_discharge_efficiency_pu = 'battery_discharge_efficiency_pu'
battery_discharge_per_cycle_pu = 'battery_discharge_per_cycle_pu'
battery_enom_mwh = 'battery_enom_mwh'
battery_max_soc_pu = 'battery_max_soc_pu'
battery_min_soc_pu = 'battery_min_soc_pu'
battery_soc_0_pu = 'battery_soc_0_pu'
branch_alpha_per_deg_c = 'branch_alpha_per_deg_c'
branch_rate_mva = 'branch_rate_mva'
branch_temp_base_deg_c = 'branch_temp_base_deg_c'
branch_temp_oper_deg_c = 'branch_temp_oper_deg_c'
bsh = 'bsh'
controllable_shunt_bmax_pu = 'controllable_shunt_bmax_pu'
controllable_shunt_bmin_pu = 'controllable_shunt_bmin_pu'
controllable_shunt_control_mode_code = 'controllable_shunt_control_mode_code'
controllable_shunt_gmax_pu = 'controllable_shunt_gmax_pu'
controllable_shunt_gmin_pu = 'controllable_shunt_gmin_pu'
controllable_shunt_step = 'controllable_shunt_step'
controllable_shunt_vmax_pu = 'controllable_shunt_vmax_pu'
controllable_shunt_vmin_pu = 'controllable_shunt_vmin_pu'
controllable_shunt_vset_pu = 'controllable_shunt_vset_pu'
converter_control_mode_1 = 'converter_control_mode_1'
converter_control_mode_2 = 'converter_control_mode_2'
converter_control_target_1 = 'converter_control_target_1'
converter_control_target_2 = 'converter_control_target_2'
converter_loss_power_0 = 'converter_loss_power_0'
current_injection_ii_pu = 'current_injection_ii_pu'
current_injection_iia_pu = 'current_injection_iia_pu'
current_injection_iib_pu = 'current_injection_iib_pu'
current_injection_iic_pu = 'current_injection_iic_pu'
current_injection_ir_pu = 'current_injection_ir_pu'
current_injection_ira_pu = 'current_injection_ira_pu'
current_injection_irb_pu = 'current_injection_irb_pu'
current_injection_irc_pu = 'current_injection_irc_pu'
dc_line_length_km = 'dc_line_length_km'
dc_line_r_pu = 'dc_line_r_pu'
device_active = 'device_active'
dt = 'dt'
external_grid_mode_code = 'external_grid_mode_code'
external_grid_va_rad = 'external_grid_va_rad'
external_grid_vm_pu = 'external_grid_vm_pu'
fn = 'fn'
freq = 'freq'
g = 'g'
gFe = 'gFe'
generator_control_mode = 'generator_control_mode'
generator_device_sbase_mva = 'generator_device_sbase_mva'
generator_enabled_dispatch = 'generator_enabled_dispatch'
generator_must_run = 'generator_must_run'
generator_p_pu = 'generator_p_pu'
generator_power_factor = 'generator_power_factor'
generator_q_pu = 'generator_q_pu'
generator_qmax_pu = 'generator_qmax_pu'
generator_qmin_pu = 'generator_qmin_pu'
generator_r0_pu = 'generator_r0_pu'
generator_r2_pu = 'generator_r2_pu'
generator_share_enable = 'generator_share_enable'
generator_share_p_ref = 'generator_share_p_ref'
generator_share_q_ref = 'generator_share_q_ref'
generator_snom_mva = 'generator_snom_mva'
generator_use_reactive_power_curve = 'generator_use_reactive_power_curve'
generator_vset_pu = 'generator_vset_pu'
generator_x2_pu = 'generator_x2_pu'
injection_connection_type = 'injection_connection_type'
l = 'l'
line_length_km = 'line_length_km'
load_b_pu = 'load_b_pu'
load_ba_pu = 'load_ba_pu'
load_bb_pu = 'load_bb_pu'
load_bc_pu = 'load_bc_pu'
load_contract_power_pu = 'load_contract_power_pu'
load_g_pu = 'load_g_pu'
load_ga_pu = 'load_ga_pu'
load_gb_pu = 'load_gb_pu'
load_gc_pu = 'load_gc_pu'
load_ii_pu = 'load_ii_pu'
load_iia_pu = 'load_iia_pu'
load_iib_pu = 'load_iib_pu'
load_iic_pu = 'load_iic_pu'
load_ir_pu = 'load_ir_pu'
load_ira_pu = 'load_ira_pu'
load_irb_pu = 'load_irb_pu'
load_irc_pu = 'load_irc_pu'
omega_base = 'omega_base'
omega_ref = 'omega_ref'
p0 = 'p0'
phA = 'phA'
phB = 'phB'
phC = 'phC'
phN = 'phN'
r = 'r'
shunt_b0_pu = 'shunt_b0_pu'
shunt_b_pu = 'shunt_b_pu'
shunt_ba_pu = 'shunt_ba_pu'
shunt_bb_pu = 'shunt_bb_pu'
shunt_bc_pu = 'shunt_bc_pu'
shunt_g0_pu = 'shunt_g0_pu'
shunt_g_pu = 'shunt_g_pu'
shunt_ga_pu = 'shunt_ga_pu'
shunt_gb_pu = 'shunt_gb_pu'
shunt_gc_pu = 'shunt_gc_pu'
static_generator_snom_mva = 'static_generator_snom_mva'
tap_module = 'tap_module'
tap_phase = 'tap_phase'
tm0 = 'tm0'
transformer_connection_clock = 'transformer_connection_clock'
transformer_core_curve_a_prime = 'transformer_core_curve_a_prime'
transformer_core_curve_b_prime = 'transformer_core_curve_b_prime'
transformer_from_connection_aa = 'transformer_from_connection_aa'
transformer_from_connection_ab = 'transformer_from_connection_ab'
transformer_from_connection_ac = 'transformer_from_connection_ac'
transformer_from_connection_ba = 'transformer_from_connection_ba'
transformer_from_connection_bb = 'transformer_from_connection_bb'
transformer_from_connection_bc = 'transformer_from_connection_bc'
transformer_from_connection_ca = 'transformer_from_connection_ca'
transformer_from_connection_cb = 'transformer_from_connection_cb'
transformer_from_connection_cc = 'transformer_from_connection_cc'
transformer_linear_core_inductance_pu_s = 'transformer_linear_core_inductance_pu_s'
transformer_magnetizing_conductance_pu = 'transformer_magnetizing_conductance_pu'
transformer_mutual_inductance_pu_s = 'transformer_mutual_inductance_pu_s'
transformer_nominal_voltage_ratio = 'transformer_nominal_voltage_ratio'
transformer_open_circuit_current_pct = 'transformer_open_circuit_current_pct'
transformer_open_circuit_loss_kw = 'transformer_open_circuit_loss_kw'
transformer_rated_power_mva = 'transformer_rated_power_mva'
transformer_short_circuit_loss_kw = 'transformer_short_circuit_loss_kw'
transformer_short_circuit_resistance_pct = 'transformer_short_circuit_resistance_pct'
transformer_short_circuit_voltage_pct = 'transformer_short_circuit_voltage_pct'
transformer_tap_ratio = 'transformer_tap_ratio'
transformer_terminal_capacitance_pu_s = 'transformer_terminal_capacitance_pu_s'
transformer_to_connection_aa = 'transformer_to_connection_aa'
transformer_to_connection_ab = 'transformer_to_connection_ab'
transformer_to_connection_ac = 'transformer_to_connection_ac'
transformer_to_connection_ba = 'transformer_to_connection_ba'
transformer_to_connection_bb = 'transformer_to_connection_bb'
transformer_to_connection_bc = 'transformer_to_connection_bc'
transformer_to_connection_ca = 'transformer_to_connection_ca'
transformer_to_connection_cb = 'transformer_to_connection_cb'
transformer_to_connection_cc = 'transformer_to_connection_cc'
transformer_total_voltage_ratio = 'transformer_total_voltage_ratio'
transformer_use_linear_core = 'transformer_use_linear_core'
transformer_winding1_inductance_pu_s = 'transformer_winding1_inductance_pu_s'
transformer_winding1_rated_voltage_ll_kv = 'transformer_winding1_rated_voltage_ll_kv'
transformer_winding1_resistance_pu = 'transformer_winding1_resistance_pu'
transformer_winding2_inductance_pu_s = 'transformer_winding2_inductance_pu_s'
transformer_winding2_rated_voltage_ll_kv = 'transformer_winding2_rated_voltage_ll_kv'
transformer_winding2_resistance_pu = 'transformer_winding2_resistance_pu'
vf = 'vf'
vsc_kdp_pu = 'vsc_kdp_pu'
vsc_min_ac_voltage_pu = 'vsc_min_ac_voltage_pu'
vtap_f = 'vtap_f'
vtap_t = 'vtap_t'
ws = 'ws'
x = 'x'
class VeraGridEngine.enumerations.PhasesShortCircuit(value)[source]

Bases: Enum

Short circuit type

a = 'a'
ab = 'ab'
abc = 'abc'
static argparse(s)[source]
Parameters:

s

Returns:

b = 'b'
bc = 'bc'
c = 'c'
ca = 'ca'
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.PlotSimulationType(value)[source]

Bases: Enum

Simulation family used by persistent dynamic plot definitions and handlers.

EMT = 'EMT'
RMS = 'RMS'
class VeraGridEngine.enumerations.ProceduralGridMethods(value)[source]

Bases: Enum

this class contains the existing types of blocks

CatalogueOptimizationOnly = 'Catalogue optimization only'
SteinerAlone = 'Steiner tree'
SteinerAndOptimization = 'Steiner tree + optimization'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ProceduralLogicType(value)[source]

Bases: Enum

Enumeration of procedural logic entry kinds.

AnalogFlipFlop = 'analog_flipflop'
Base = 'base'
DelayedThresholdLatch = 'delayed_threshold_latch'
FixedSample = 'fixed_sample'
FlipFlop = 'flipflop'
GradientLimiter = 'gradient_limiter'
HardSaturation = 'hard_saturation'
MovingAverage = 'moving_average'
PickupDropoff = 'pickup_dropoff'
ResetOnRisingEdge = 'reset_on_rising_edge'
SampledValue = 'sampled_value'
StartupHandover = 'startup_handover'
ThreePhaseCarrierPwm = 'three_phase_carrier_pwm'
TimeDelay = 'time_delay'
ValveState = 'valve_state'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.PrpCat(value)[source]

Bases: Enum

ActionType

All = 'All'
CON = 'Contingencies'
EMT = 'EMT'
INV = 'Investments'
NTC = 'Net Transfer Capacity'
OPF = 'Optimal Power flow'
PF = 'Power flow'
PF3 = 'Power flow (unbalanced)'
REL = 'Reliability'
RMS = 'RMS'
SC = 'Short Circuit'
TP = 'Topology'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.PsseExportMode(value)[source]

Bases: Enum

Enumeration of PSSE export output strategies.

BatchZip = 'Batch zip package'
SingleFile = 'Single file'
static argparse(s)[source]

Parse a command-line value into the enumeration.

Parameters:

s – Input string.

Returns:

Parsed enumeration or original input.

class VeraGridEngine.enumerations.PsseTopologyExportMode(value)[source]

Bases: Enum

Enumeration of PSSE RAW topology export strategies.

BusBranch = 'BusBranch'
NodeBreaker = 'NodeBreaker'
static argparse(s)[source]

Parse a command-line value into the enumeration.

Parameters:

s – Input string.

Returns:

Parsed enumeration or original input.

class VeraGridEngine.enumerations.ReliabilityMode[source]

Bases: Enum

GenerationAdequacy = 'Generation Adequacy'
GridMetrics = 'Grid Metrics'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ResultTypes[source]

Bases: Enum

ActivePowerFlowPerArea = 'Active power flow per area'
AreaAnalysis = 'Area analysis'
AreaBalanceAnalysis = 'Area balance analysis'
AreaGenerationAnalysis = 'Area generation analysis'
AreaLoadAnalysis = 'Area load analysis'
AreaResults = 'Area'
AvailableTransferCapacity = 'Available transfer capacity (final)'
AvailableTransferCapacityAlpha = 'Sensitivity to the exchange'
AvailableTransferCapacityAlphaN1 = 'Sensitivity to the exchange (N-1)'
AvailableTransferCapacityMatrix = 'Available transfer capacity'
AvailableTransferCapacityN = 'Available transfer capacity (N)'
AvailableTransferCapacityReport = 'ATC Report'
BaseFlowReport = 'Ntc: Base flow report'
BatteryEnergy = 'Battery energy'
BatteryInvested = 'Battery invested'
BatteryPower = 'Battery power'
BatteryReactivePower = 'Battery reactive power'
BatteryReactivePowerA = 'Battery reactive power A'
BatteryReactivePowerB = 'Battery reactive power B'
BatteryReactivePowerC = 'Battery reactive power C'
BatteryResults = 'Batteries'
BranchActiveCurrentFrom = 'Irf: Active current "from"'
BranchActiveCurrentFrom0 = 'Branch active current "from" (0)'
BranchActiveCurrentFrom1 = 'Branch active current "from" (1)'
BranchActiveCurrentFrom2 = 'Branch active current "from" (2)'
BranchActiveCurrentFromA = 'Irf: Active current "from" A'
BranchActiveCurrentFromB = 'Irf: Active current "from" B'
BranchActiveCurrentFromC = 'Irf: Active current "from" C'
BranchActiveCurrentTo = 'Irt: Active current "to"'
BranchActiveCurrentToA = 'Irt: Active current "to" A'
BranchActiveCurrentToB = 'Irt: Active current "to" B'
BranchActiveCurrentToC = 'Irt: Active current "to" C'
BranchActiveLosses = 'Pl: Active losses'
BranchActiveLosses0 = 'Branch active losses (0)'
BranchActiveLosses1 = 'Branch active losses (1)'
BranchActiveLosses2 = 'Branch active losses (2)'
BranchActiveLossesA = 'Pl: Active losses A'
BranchActiveLossesB = 'Pl: Active losses B'
BranchActiveLossesC = 'Pl: Active losses C'
BranchActiveLossesPercentage = 'Pl: Active losses (%)'
BranchActiveLossesPercentageA = 'Pl: Active losses (%) A'
BranchActiveLossesPercentageB = 'Pl: Active losses (%) B'
BranchActiveLossesPercentageC = 'Pl: Active losses (%) C'
BranchActivePowerFrom = 'Pf: Active power "from"'
BranchActivePowerFrom0 = 'Branch active power "from" (0)'
BranchActivePowerFrom1 = 'Branch active power "from" (1)'
BranchActivePowerFrom2 = 'Branch active power "from" (2)'
BranchActivePowerFromA = 'PfA: Active power "from" A'
BranchActivePowerFromB = 'PfB: Active power "from" B'
BranchActivePowerFromBase = 'Pf: Active power "from" base case'
BranchActivePowerFromC = 'PfC: Active power "from" C'
BranchActivePowerTo = 'Pt: Active power "to"'
BranchActivePowerToA = 'Pt: Active power "to" A'
BranchActivePowerToB = 'Pt: Active power "to" B'
BranchActivePowerToC = 'Pt: Active power "to" C'
BranchAngles = 'Δθ: Voltage angles drop'
BranchAnglesA = 'Δθ: Voltage angles drop A'
BranchAnglesB = 'Δθ: Voltage angles drop B'
BranchAnglesC = 'Δθ: Voltage angles drop C'
BranchBeq = 'Beq: Equivalent susceptance'
BranchLoading = 'Branch Loading'
BranchLoading0 = 'Branch loading (0)'
BranchLoading1 = 'Branch loading (1)'
BranchLoading2 = 'Branch loading (2)'
BranchLoadingA = 'Branch Loading A'
BranchLoadingAverage = 'loading avg'
BranchLoadingB = 'Branch Loading B'
BranchLoadingC = 'Branch Loading C'
BranchLoadingCDF = 'Loading CDF'
BranchLoadingStd = 'Loading std'
BranchLosses = 'Branch losses'
BranchLossesAverage = 'Losses avg'
BranchLossesCDF = 'Losses CDF'
BranchLossesStd = 'Losses std'
BranchMonitoring = 'Branch monitoring logic'
BranchOverloads = 'Branch overloads'
BranchOverloadsCost = 'Branch overloads cost'
BranchPowerAverage = 'Branch power avg'
BranchPowerCDF = 'Branch power CDF'
BranchPowerStd = 'Branch power std'
BranchReactiveCurrentFrom = 'Iif: Reactive current "from"'
BranchReactiveCurrentFrom0 = 'Branch reactive current "from" (0)'
BranchReactiveCurrentFrom1 = 'Branch reactive current "from" (1)'
BranchReactiveCurrentFrom2 = 'Branch reactive current "from" (2)'
BranchReactiveCurrentFromA = 'Iif: Reactive current "from" A'
BranchReactiveCurrentFromB = 'Iif: Reactive current "from" B'
BranchReactiveCurrentFromC = 'Iif: Reactive current "from" C'
BranchReactiveCurrentTo = 'Iit: Reactive current "to"'
BranchReactiveCurrentToA = 'Iit: Reactive current "to" A'
BranchReactiveCurrentToB = 'Iit: Reactive current "to" B'
BranchReactiveCurrentToC = 'Iit: Reactive current "to" C'
BranchReactiveLosses = 'Ql: Reactive losses'
BranchReactiveLosses0 = 'Branch reactive losses (0)'
BranchReactiveLosses1 = 'Branch reactive losses (1)'
BranchReactiveLosses2 = 'Branch reactive losses (2)'
BranchReactiveLossesA = 'Ql: Reactive losses A'
BranchReactiveLossesB = 'Ql: Reactive losses B'
BranchReactiveLossesC = 'Ql: Reactive losses C'
BranchReactivePowerFrom = 'Qf: Reactive power "from"'
BranchReactivePowerFrom0 = 'Branch reactive power "from" (0)'
BranchReactivePowerFrom1 = 'Branch reactive power "from" (1)'
BranchReactivePowerFrom2 = 'Branch reactive power "from" (2)'
BranchReactivePowerFromA = 'QfA: Reactive power "from" A'
BranchReactivePowerFromB = 'QfB: Reactive power "from" B'
BranchReactivePowerFromC = 'QfC: Reactive power "from" C'
BranchReactivePowerTo = 'Qt: Reactive power "to"'
BranchReactivePowerToA = 'Qt: Reactive power "to" A'
BranchReactivePowerToB = 'Qt: Reactive power "to" B'
BranchReactivePowerToC = 'Qt: Reactive power "to" C'
BranchResults = 'Branch'
BranchTapAngle = '𝜏: Tap angle'
BranchTapModule = 'm: Tap module'
BranchVoltage = 'Ξ”V: Voltage modules drop'
BranchVoltageA = 'Ξ”V: Voltage modules drop A'
BranchVoltageB = 'Ξ”V: Voltage modules drop B'
BranchVoltageC = 'Ξ”V: Voltage modules drop C'
BusActivePower = 'P: Active power'
BusActivePowerA = 'PA: Active power A'
BusActivePowerB = 'PB: Active power B'
BusActivePowerC = 'PC: Active power C'
BusActivePowerIncrement = 'Ξ”P: Active power increment'
BusNodalCapacity = 'Nodal capacity'
BusPower = 'Bus power'
BusPowerCDF = 'Bus power CDF'
BusReactivePower = 'Q: Reactive power'
BusReactivePowerA = 'QA: Reactive power A'
BusReactivePowerB = 'QB: Reactive power B'
BusReactivePowerC = 'QC: Reactive power C'
BusResults = 'Bus'
BusShadowPrices = 'Nodal shadow prices'
BusShortCircuitActiveCurrent = 'Short circuit active current'
BusShortCircuitActiveCurrentA = 'Short circuit active current A'
BusShortCircuitActiveCurrentB = 'Short circuit active current B'
BusShortCircuitActiveCurrentC = 'Short circuit active current C'
BusShortCircuitActivePower = 'Short circuit active power'
BusShortCircuitActivePowerA = 'Short circuit active power A'
BusShortCircuitActivePowerB = 'Short circuit active power B'
BusShortCircuitActivePowerC = 'Short circuit active power C'
BusShortCircuitReactiveCurrent = 'Short circuit reactive current'
BusShortCircuitReactiveCurrentA = 'Short circuit reactive current A'
BusShortCircuitReactiveCurrentB = 'Short circuit reactive current B'
BusShortCircuitReactiveCurrentC = 'Short circuit reactive current C'
BusShortCircuitReactivePower = 'Short circuit reactive power'
BusShortCircuitReactivePowerA = 'Short circuit reactive power A'
BusShortCircuitReactivePowerB = 'Short circuit reactive power B'
BusShortCircuitReactivePowerC = 'Short circuit reactive power C'
BusVoltageAngle = 'ΞΈ: Voltage angle'
BusVoltageAngle0 = 'Voltage angle (0)'
BusVoltageAngle1 = 'Voltage angle (1)'
BusVoltageAngle2 = 'Voltage angle (2)'
BusVoltageAngleA = 'ΞΈA: Voltage angle A'
BusVoltageAngleB = 'ΞΈB: Voltage angle B'
BusVoltageAngleC = 'ΞΈC: Voltage angle C'
BusVoltageAverage = 'Bus voltage avg'
BusVoltageCDF = 'Bus voltage CDF'
BusVoltageModule = 'V: Voltage module'
BusVoltageModule0 = 'Voltage module (0)'
BusVoltageModule1 = 'Voltage module (1)'
BusVoltageModule2 = 'Voltage module (2)'
BusVoltageModuleA = 'VA: Voltage module A'
BusVoltageModuleB = 'VB: Voltage module B'
BusVoltageModuleC = 'VC: Voltage module C'
BusVoltagePolarPlot = 'Voltage plot'
BusVoltageStd = 'Bus voltage std'
ClusteringReport = 'Clustering time series report'
ContingencyAnalysisReport = 'Contingencies report'
ContingencyFlows = 'Contingency flow'
ContingencyFlowsBranchReport = 'Ntc: Contingency flow report. (Branch)'
ContingencyFlowsGenerationReport = 'Ntc: Contingency flow report. (Generation)'
ContingencyFlowsHvdcReport = 'Ntc: Contingency flow report. (Hvdc)'
ContingencyFlowsReport = 'Ntc: Contingency flow report'
ContingencyFrequency = 'Contingency frequency'
ContingencyLoading = 'Contingency loading'
ContingencyOverloadSum = 'Contingency overload sum'
ContingencyRelativeFrequency = 'Contingency relative frequency'
ContingencyStatisticalAnalysisReport = 'Contingencies statistical report'
CountryAnalysis = 'Country analysis'
CountryBalanceAnalysis = 'Country balance analysis'
CountryGenerationAnalysis = 'Country generation analysis'
CountryLoadAnalysis = 'Country load analysis'
DispatchResults = 'Dispatch'
FlowReports = 'Flow Reports'
FluidCurrentLevel = 'Reservoir fluid level'
FluidFlowIn = 'Flow entering the node'
FluidFlowInjection = 'Flow circulating in the device'
FluidFlowOut = 'Flow exiting the node'
FluidFlowPath = 'Flow in the river'
FluidInjectionResults = 'Fluid injections'
FluidNodeResults = 'Fluid nodes'
FluidP2XFlow = 'Flow from the P2X'
FluidP2XResults = 'Fluid P2Xs'
FluidPathResults = 'Fluid paths'
FluidPumpResults = 'Fluid pumps'
FluidSpillage = 'Spillage flow leaving'
FluidTurbineResults = 'Fluid turbines'
GenerationDelta = 'Generation deltas'
GenerationDeltaSlacks = 'Generation delta slacks'
GeneratorCost = 'Generator cost'
GeneratorEmissions = 'Generator emissions'
GeneratorFuels = 'Generator fuels'
GeneratorInvested = 'Generator invested'
GeneratorPower = 'Generator power'
GeneratorProducing = 'Generator producing'
GeneratorReactivePower = 'Generator reactive power'
GeneratorReactivePowerA = 'Generator reactive power A'
GeneratorReactivePowerB = 'Generator reactive power B'
GeneratorReactivePowerC = 'Generator reactive power C'
GeneratorResults = 'Generators'
GeneratorShedding = 'Generator shedding'
GeneratorShuttingDown = 'Generator shutting down'
GeneratorStartingUp = 'Generator starting up'
HvdcLoading = 'HVDC loading'
HvdcLosses = 'HVDC losses'
HvdcODF = 'HVDC ODF'
HvdcOverloads = 'HVDC overloads'
HvdcPTDF = 'HVDC PTDF'
HvdcPowerFrom = 'HVDC power "from"'
HvdcPowerFromA = 'HVDC power "from" A'
HvdcPowerFromB = 'HVDC power "from" B'
HvdcPowerFromC = 'HVDC power "from" C'
HvdcPowerTo = 'HVDC power "to"'
HvdcPowerToA = 'HVDC power "to" A'
HvdcPowerToB = 'HVDC power "to" B'
HvdcPowerToC = 'HVDC power "to" C'
HvdcResults = 'Hvdc'
InfoResults = 'Information'
InterAreaExchange = 'Inter-Area exchange'
InterSpaceBranchLoading = 'Inter-space branch loading'
InterSpaceBranchPower = 'Inter-space branch power'
InvestmentsCombinationsResults = 'Combinations'
InvestmentsFrequencyResults = 'Frequency'
InvestmentsIterationsPlot = 'Iterations plot'
InvestmentsObjectivesResults = 'Objectives'
InvestmentsParetoCombinationsResults = 'Pareto combinations'
InvestmentsParetoFrequencyResults = 'Pareto frequency'
InvestmentsParetoObjectivesResults = 'Pareto objectives'
InvestmentsParetoPlot = 'Pareto plots'
InvestmentsParetoPlotNSGA2 = 'Pareto plot NSGA2'
InvestmentsParetoReportResults = 'Pareto evaluation report'
InvestmentsReportResults = 'Evaluation report'
InvestmentsWhenToMakePlot = 'When to make them plot'
LODF = 'LODF'
LoadNeutralVoltage = 'Load neutral voltage'
LoadPower = 'Load power'
LoadResults = 'Loads'
LoadShedding = 'Load shedding'
LoadSheddingCost = 'Load shedding cost'
LossesPerArea = 'Losses per area'
LossesPerGenPerArea = 'Losses per generation unit in area'
LossesPercentPerArea = 'Losses % per area'
MaxContingencyFlows = 'Max contingency flow'
MaxContingencyLoading = 'Max contingency loading'
MaxOverloads = 'Maximum contingency flow'
MeanContingencyOverLoading = 'Mean contingency overloading'
Modes = 'Modes'
NTCResults = 'NTC'
NetTransferCapacity = 'Net transfer capacity'
NodeSlacks = 'Nodal slacks'
OTDFSimulationError = 'Error'
OpfBalancePlot = 'Balance plot'
OpfNtcTsBaseReport = 'Base flow report'
OpfNtcTsContingencyReport = 'Contingency flow report'
OpfTechnologyPlot = 'Technology plot'
PTDF = 'PTDF'
PTDFBusVoltageSensitivity = 'Bus voltage sensitivity'
ParetoResults = 'Pareto'
ParticipationFactors = 'Participation Factors'
PowerByTechnology = 'Power by technology'
ReliabilityCAIDIResults = 'CAIDI'
ReliabilityENSResults = 'ENS'
ReliabilityLOLEResults = 'LOLE'
ReliabilityLOLETResults = 'LOLET'
ReliabilityLOLFResults = 'LOLF'
ReliabilityLOLFTResults = 'LOLFT'
ReliabilitySAIDIResults = 'SAIDI'
ReliabilitySAIFIResults = 'SAIFI'
ReportsResults = 'Reports'
RmsGeneratorDeltaResults = 'Rms Genqec delta results'
RmsGeneratorOmegaResults = 'Rms Genqec omega results'
RmsGeneratorResults = 'Rms Generator results'
RmsLinePResults = 'Rms Simple Line P results'
RmsLineQResults = 'Rms Simple Line Q results'
RmsLineResults = 'Rms Line results'
RmsLoadPResults = 'Rms Load P results'
RmsLoadQResults = 'Rms Load Q results'
RmsLoadResults = 'Rms load results'
RmsPlotResults = 'Rms plot results'
RmsSimulationReport = 'Rms time series report'
SDomainPlot = 'S-Domain Plot'
SDomainPlotHz = 'S-Domain Plot in Hz'
Sensibilities = 'Sensibilities'
SeriesResults = 'Series'
ShortCircuitInfo = 'Short-circuit information'
ShuntNeutralVoltage = 'Shunt neutral voltage'
ShuntReactivePower = 'Shunt reactive power'
ShuntReactivePowerA = 'Shunt reactive power A'
ShuntReactivePowerB = 'Shunt reactive power B'
ShuntReactivePowerC = 'Shunt reactive power C'
ShuntResults = 'Shunt like devices'
SigmaDistances = 'Sigma distances'
SigmaImag = 'Sigma imaginary'
SigmaPlusDistances = 'Sigma + distances'
SigmaReal = 'Sigma real'
SimulationError = 'Error'
SlacksResults = 'Slacks'
SnapshotResults = 'Snapshot'
SpecialPlots = 'Special plots'
SrapUsedPower = 'Srap used power'
StateMatrix = 'State Matrix'
StatisticResults = 'Statistics'
StdDevContingencyOverLoading = 'Std-dev contingency overloading'
SystemEmissions = 'System emissions'
SystemEnergyCost = 'System energy cost'
SystemEnergyTotalCost = 'System energy total cost'
SystemFuel = 'System fuel consumption'
SystemResults = 'System'
TsAlphaReport = 'Time series sensitivity to the exchange report'
TsBaseFlowReport = 'Time series base flow report'
TsBranchMonitoring = 'Time series branch monitoring logic report'
TsContingencyBranches = 'Time series contingency Branches report'
TsContingencyFlowBranchReport = 'Time series Contingency flow report (Branches)'
TsContingencyFlowGenerationReport = 'Time series contingency flow report. (Generation)'
TsContingencyFlowHvdcReport = 'Time series contingency flow report. (Hvdc)'
TsContingencyFlowReport = 'Time series contingency flow report'
TsCriticalBranches = 'Time series critical Branches report'
TsGenerationDeltaReport = 'Time series generation delta power report'
TsGenerationPowerReport = 'Time series generation power report'
TsWorstAlphaN1Report = 'Time series worst sensitivity to the exchange report (N-1)'
VscLoading = 'Vsc loading'
VscLosses = 'Vsc losses'
VscODF = 'Vsc ODF'
VscPTDF = 'Vsc PTDF'
VscPowerFromNegative = 'Vsc power "from" negative pole'
VscPowerFromPositive = 'Vsc power "from" positive pole'
VscPowerTo = 'Vsc power "to"'
VscPowerToA = 'Vsc power "to" A'
VscPowerToB = 'Vsc power "to" B'
VscPowerToC = 'Vsc power "to" C'
VscResults = 'Vsc'
ZoneAnalysis = 'Zone analysis'
ZoneBalanceAnalysis = 'Zone balance analysis'
ZoneGenerationAnalysis = 'Zone generation analysis'
ZoneLoadAnalysis = 'Zone load analysis'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.RmsInitializationMethod(value)[source]

Bases: Enum

CustomValues = 'CustomValues'
Explicit = 'Explicit'
PseudoTransient = 'PseudoTransient'
ReducedExplicit = 'ReducedExplicit'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.RmsProblemTypes(value)[source]

Bases: Enum

CurrentBalance = 'RmsProblemPhasor'
Multilinear = 'RmsProblemMultilinear'
PowerBalance = 'RmsProblemDae'
PowerBalanceVectorized = 'RmsProblemDaeVectorized'
Tensygrid = 'Tensygrid'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.SchematicAttachmentOwnerKind(value)[source]

Bases: Enum

Schematic attachment owner kinds.

BUS = 'bus'
FLUID = 'fluid'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SchematicAttachmentSide(value)[source]

Bases: Enum

Schematic attachment-side identifiers.

BOTTOM = 'bottom'
DEFAULT = 'default'
LEFT = 'left'
RIGHT = 'right'
TOP = 'top'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SchematicAutoRouteStyle(value)[source]

Bases: Enum

Schematic automatic route styles.

RETICULAR = 'reticular'
STRAIGHT = 'straight'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SchematicBranchEndpoint(value)[source]

Bases: Enum

Schematic branch endpoint identifiers.

FROM = 'from'
TO = 'to'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SchematicRouteKind(value)[source]

Bases: Enum

Schematic route kinds.

AUTO = 'auto'
AUTO_ORTHOGONAL = 'auto-orthogonal'
AUTO_POLYLINE = 'auto-polyline'
MANUAL_ORTHOGONAL = 'manual-orthogonal'
MANUAL_POLYLINE = 'manual-polyline'
ORTHOGONAL = 'orthogonal'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ShuntConnectionType(value)[source]

Bases: str, Enum

Loads, shunts, etc.. connection types

Delta = 'D'
FloatingStar = 'Y'
GroundedStar = 'Yg'
NeutralStar = 'Yn'
static argparse(s)[source]
Parameters:

s

Returns:

idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.ShuntControlMode(value)[source]

Bases: str, Enum

Modes of operation of shunt control modes

Continuous = 'Continuous'
Discrete = 'Discrete'
Locked = 'Locked'
static argparse(s)[source]
idx() → int[source]
class VeraGridEngine.enumerations.SimulationTypes(value)[source]

Bases: Enum

Enumeration of simulation types

Cascade_run = 'Cascade'
CatalogueOptimization_run = 'Catalogue optimization'
CleanRoom_run = 'Clean room'
ClusteringAnalysis_run = 'Clustering Analysis'
ContingencyAnalysisTS_run = 'Contingency analysis time series'
ContingencyAnalysis_run = 'Contingency analysis'
ContinuationPowerFlow_run = 'Voltage collapse'
Delete_and_reduce_run = 'Delete and reduce'
DesignView = 'Design View'
EmtDynamic_run = 'EMT Dynamic'
EmtSmallSignal_run = 'EMT Small Signal stability'
ExportAll = 'export all'
FileOpen = 'file open'
FileSave = 'file save'
InputsAnalysis_run = 'Inputs Analysis'
InvestmentsEvaluation_run = 'Investments evaluation'
LatinHypercube_run = 'Latin Hypercube'
LinearAnalysis_TS_run = 'Linear analysis time series'
LinearAnalysis_run = 'Linear analysis'
MonteCarlo_run = 'Monte Carlo'
NetTransferCapacityTS_run = 'Available transfer capacity time series'
NetTransferCapacity_run = 'Available transfer capacity'
NoSim = 'No simulation'
NodalCapacityTimeSeries_run = 'Nodal capacity time series'
NodeGrouping_run = 'Node groups'
NonLinearAnalysis_TS_run = 'Nonlinear analysis time series'
NonLinearAnalysis_run = 'Nonlinear analysis'
OPFTimeSeries_run = 'Optimal power flow time series'
OPF_NTC_TS_run = 'Optimal net transfer capacity time series'
OPF_NTC_run = 'Optimal net transfer capacity'
OPF_run = 'Optimal power flow'
OptimalNetTransferCapacityTimeSeries_run = 'Optimal net transfer capacity time series'
PowerFlow3ph_run = 'Power flow 3ph'
PowerFlowTimeSeries_run = 'Power flow time series'
PowerFlow_run = 'Power flow'
Reliability_run = 'Reliability'
RmsDynamic_run = 'RMS Dynamic'
RmsSmallSignal_run = 'RMS Small Signal stability'
ShortCircuit_run = 'Short circuit'
SigmaAnalysis_run = 'Sigma Analysis'
StateEstimation_run = 'State estimation'
StochasticPowerFlow = 'Stochastic Power Flow'
TemplateDriver = 'Template'
TopologyProcessor_run = 'Topology Processor'
TopologyReduction_run = 'Topology reduction'
TransientStability_run = 'Transient stability'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SmallSignalEmtBuildTypes(value)[source]

Bases: Enum

Jacobian construction backends for implicit solvers.

Arnoldi = 'Arnoldi'
HybridArnoldi = 'Hybrid Arnoldi'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.SolverType(value)[source]

Bases: Enum

Refer to the Power Flow section for details about the different algorithms supported by VeraGrid.

BFS = 'Backwards-Forward substitution'
BFS_linear = 'Backwards-Forward substitution (linear)'
CONTINUATION_NR = 'Continuation-Newton-Raphson'
Constant_Impedance_linear = 'Constant impedance linear'
Decoupled_LU = 'Decoupled-LU Decomposition'
FASTDECOUPLED = 'Fast decoupled'
GAUSS = 'Gauss-Seidel'
GN = 'Gauss-Newton'
GREEDY_DISPATCH_OPF = 'Greedy dispatch'
HELM = 'Holomorphic Embedding'
IWAMOTO = 'Iwamoto-Newton-Raphson'
LACPF = 'Linear AC'
LINEAR_OPF = 'Linear OPF'
LM = 'Levenberg-Marquardt'
Linear = 'Linear'
NONLINEAR_OPF = 'Nonlinear OPF'
NR = 'Newton Raphson'
NoSolver = 'No Solver'
PowellDogLeg = "Powell's Dog Leg"
Proportional_OPF = 'Proportional OPF'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SparseSolver(value)[source]

Bases: Enum

Sparse solvers to use

GMRES = 'GMRES'
ILU = 'ILU'
KLU = 'KLU'
Pardiso = 'Pardiso'
SuperLU = 'SuperLU'
UMFPACK = 'UmfPack'
UMFPACKTriangular = 'UmfPackTriangular'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.StudyResultsType(value)[source]

Bases: Enum

Types of simulation results

AvailableTransferCapacity = 'AvailableTransferCapacity'
AvailableTransferCapacityTimeSeries = 'AvailableTransferCapacityTimeSeries'
Clustering = 'Clustering'
ContingencyAnalysis = 'ContingencyAnalysis'
ContingencyAnalysisTimeSeries = 'ContingencyAnalysisTimeSeries'
ContinuationPowerFlow = 'ContinuationPowerFlow'
EmtSimulation = 'EmtSimulation'
InputsAnalysis = 'InputsAnalysis'
InvestmentEvaluations = 'InvestmentEvaluations'
LinearAnalysis = 'LinearAnalysis'
LinearAnalysisTimeSeries = 'LinearAnalysisTimeSeries'
NetTransferCapacity = 'NetTransferCapacity'
NetTransferCapacityTimeSeries = 'NetTransferCapacityTimeSeries'
NodeGroups = 'NodeGroups'
OptimalPowerFlow = 'PowerFlow'
OptimalPowerFlowTimeSeries = 'PowerFlowTimeSeries'
PowerFlow = 'PowerFlow'
PowerFlowTimeSeries = 'PowerFlowTimeSeries'
RmsSimulation = 'RmsSimulation'
ShortCircuit = 'ShortCircuit'
SigmaAnalysis = 'SigmaAnalysis'
SmallSignalStability = 'SmallSignalStability'
StateEstimation = 'StateEstimation'
StochasticPowerFlow = 'StochasticPowerFlow'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.SubObjectType(value)[source]

Bases: Enum

Types of objects that act as complicated variable types

AdmittanceMatrix = 'Admittance Matrix'
Array = 'Array'
Associations = 'AssociationsList'
ConstType = 'ConstType'
DaeBlockType = 'DaeBlock'
GeneratorQCurve = 'Generator Q curve'
LineLocations = 'Line locations'
ListOfWires = 'ListOfWires'
MergeInformation = 'MergeInformation'
ObjectsList = 'ObjectsList'
Profile = 'Profile'
TapChanger = 'Tap changer'
VarType = 'VarType'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.SwitchGraphicType(value)[source]

Bases: Enum

Bus graphical modes

CircuitBreaker = 'CircuitBreaker'
Disconnector = 'Disconnector'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.SyncIssueType(value)[source]

Bases: Enum

Sync issues enumeration

Added = 'Added'
Conflict = 'Conflict'
Deleted = 'Deleted'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.TapChangerTypes(value)[source]

Bases: Enum

Types of objects that act as complicated variable types

Asymmetrical = 'Asymmetrical'
NoRegulation = 'NoRegulation'
Symmetrical = 'Symmetrical'
VoltageRegulation = 'VoltageRegulation'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.TapModuleControl(value)[source]

Bases: str, Enum

Tap module control types

Qf = 'Qf'
Qt = 'Qt'
Vm = 'Vm'
static argparse(s)[source]
fixed = 'Fixed'
idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.TapPhaseControl(value)[source]

Bases: str, Enum

Tap angle control types

Pf = 'Pf'
Pt = 'Pt'
static argparse(s)[source]
fixed = 'Fixed'
idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.TerminalType(value)[source]

Bases: Enum

Terminal types

AC = 'AC'
DC_N = 'DC-'
DC_P = 'DC+'
OTHER = 'Other'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.TimeFrame(value)[source]

Bases: Enum

Time frame

Continuous = 'Continuous'
class VeraGridEngine.enumerations.TimeGrouping(value)[source]

Bases: Enum

Time groupings enumeration

Daily = 'Daily'
Hourly = 'Hourly'
Monthly = 'Monthly'
NoGrouping = 'No grouping'
Weekly = 'Weekly'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.TimeSeriesSearchPoint[source]

Bases: Enum

HighestLoad = 'Highest Load'
LowestLoad = 'Lowest load'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.TreeStateNodeKind(value)[source]

Bases: Enum

Stable semantic node kinds used to preserve tree-view state.

DEVICE = 'device'
DEVICE_TYPE = 'device_type'
PARAMETER = 'parameter'
PLOT_ENTRY = 'plot_entry'
PLOT_GROUP = 'plot_group'
ROOT = 'root'
SECTION = 'section'
SOURCE = 'source'
VARIABLE = 'variable'
class VeraGridEngine.enumerations.UcteExportMode(value)[source]

Bases: Enum

Enumeration of UCTE export output strategies.

BatchZip = 'Batch zip package'
SingleFile = 'Single file'
static argparse(s)[source]

Parse a command-line value into the enumeration.

Parameters:

s – Input string.

Returns:

Parsed enumeration or original input.

class VeraGridEngine.enumerations.ValveEmtModelVariant(value)[source]

Bases: Enum

Enumeration of EMT valve modelling variants.

Complete = 'Complete'
Ideal = 'Ideal'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ValveEmtType(value)[source]

Bases: Enum

Enumeration of EMT valve physical types.

Diode = 'Diode'
Igbt = 'IGBT'
Thyristor = 'Thyristor'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.ValveInitializationState(value)[source]

Bases: Enum

Enumeration of valve initialization states.

Blocked = 'Blocked'
ForwardConducting = 'Forward conducting'
FromPowerFlow = 'From power flow'
ReverseConducting = 'Reverse conducting'
static argparse(s)[source]
Parameters:

s

Returns:

class VeraGridEngine.enumerations.VarPowerFlowReferenceType[source]

Bases: Enum

DcPathModeSeed = 'DcPathModeSeed'
I_complex = 'I_complex'
Idc = 'Idc'
If_complex = 'If_complex'
If_dc = 'If_dc'
If_vsc = 'If_vsc'
Ii = 'Ii'
Iif = 'Iif'
Iit = 'Iit'
Im = 'Im'
Ipk = 'Ipk'
Ir = 'Ir'
Irf = 'Irf'
Irt = 'Irt'
It_complex = 'It_complex'
It_dc = 'It_dc'
It_vsc = 'It_vsc'
NOTHING = 'nothing'
P = 'P'
P_A = 'P_A'
P_B = 'P_B'
P_C = 'P_C'
P_N = 'P_N'
Pf = 'Pf'
Pf_hvdc = 'Pf_hvdc'
Pfn_vsc = 'Pfn_vsc'
Pfp_vsc = 'Pfp_vsc'
Pt = 'Pt'
Pt_hvdc = 'Pt_hvdc'
Q = 'Q'
Q_A = 'Q_A'
Q_B = 'Q_B'
Q_C = 'Q_C'
Q_N = 'Q_N'
Qf = 'Qf'
Qt = 'Qt'
S_complex = 'S_complex'
Sf_A = 'Sf_A'
Sf_B = 'Sf_B'
Sf_C = 'Sf_C'
Sf_complex = 'Sf_complex'
St_A = 'St_A'
St_B = 'St_B'
St_C = 'St_C'
St_complex = 'St_complex'
St_vsc = 'St_vsc'
V_complex = 'V_complex'
Va = 'Va'
Vaf = 'Vaf'
Vat = 'Vat'
Vdc = 'Vdc'
Vf_complex = 'Vf_complex'
Vf_dc = 'Vf_dc'
Vi = 'Vi'
Vif = 'Vif'
Vit = 'Vit'
Vm = 'Vm'
Vmf = 'Vmf'
Vmt = 'Vmt'
Vpk = 'Vpk'
Vr = 'Vr'
Vrf = 'Vrf'
Vrt = 'Vrt'
Vt_complex = 'Vt_complex'
Vt_dc = 'Vt_dc'
static argparse(s)[source]
Parameters:

s

Returns:

d_v_A = 'd_v_A'
d_v_A_f = 'd_v_A_f'
d_v_A_t = 'd_v_A_t'
d_v_B = 'd_v_B'
d_v_B_f = 'd_v_B_f'
d_v_B_t = 'd_v_B_t'
d_v_C = 'd_v_C'
d_v_C_f = 'd_v_C_f'
d_v_C_t = 'd_v_C_t'
d_v_N = 'd_v_N'
d_v_N_f = 'd_v_N_f'
d_v_N_t = 'd_v_N_t'
i_A = 'i_A'
i_B = 'i_B'
i_C = 'i_C'
i_N = 'i_N'
if_A = 'if_A'
if_B = 'if_B'
if_C = 'if_C'
if_N = 'if_N'
it_A = 'it_A'
it_B = 'it_B'
it_C = 'it_C'
it_N = 'it_N'
phi = 'phi'
phi_v = 'phi_v'
v_A = 'v_A'
v_B = 'v_B'
v_C = 'v_C'
v_N = 'v_N'
vf_A = 'vf_A'
vf_B = 'vf_B'
vf_C = 'vf_C'
vf_N = 'vf_N'
vt_A = 'vt_A'
vt_B = 'vt_B'
vt_C = 'vt_C'
vt_N = 'vt_N'
class VeraGridEngine.enumerations.VoltageLevelTypes(value)[source]

Bases: Enum

Types of substation types

BreakerAndAHalf = 'Breaker and a half'
DoubleBar = 'Double bar'
DoubleBarDuplex = 'Double bar duplex'
DoubleBarWithBypass = 'Double bar with bypass'
DoubleBarWithTransference = 'Double bar with transference bar'
Ring = 'Ring'
SingleBar = 'Single bar'
SingleBarWithBypass = 'Single bar with bypass'
SingleBarWithSplitter = 'Single bar with splitter'
static argparse(s)[source]
Parameters:

s

Returns:

classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.WindingType(value)[source]

Bases: str, Enum

Transformer windings connection types

Delta = 'D'
FloatingStar = 'Y'
GroundedStar = 'Yg'
NeutralStar = 'Yn'
ZigZag = 'Z'
static argparse(s)[source]
Parameters:

s

Returns:

idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.WindingsConnection(value)[source]

Bases: str, Enum

Transformer windings connection types

DD = 'DD'
GD = 'GD'
GG = 'GG'
GS = 'GS'
SD = 'SD'
SS = 'SS'
static argparse(s)[source]
Parameters:

s

Returns:

idx() → int[source]
classmethod list()[source]
Returns:

class VeraGridEngine.enumerations.ZonalGrouping(value)[source]

Bases: Enum

Zonal groupings enumeration

All = 'All (copper plate)'
Area = 'Area'
NoGrouping = 'No grouping'
static argparse(s)[source]
Parameters:

s

Returns:

VeraGridEngine.setup module

Module contents