GridCal.Engine package

Subpackages

• GridCal.Engine.Core package
  • Submodules
    • GridCal.Engine.Core.calculation_inputs module
    • GridCal.Engine.Core.csc_graph module
    • GridCal.Engine.Core.multi_circuit module
    • GridCal.Engine.Core.numerical_circuit module
• GridCal.Engine.Devices package
  • Submodules
    • GridCal.Engine.Devices.battery module
    • GridCal.Engine.Devices.branch module
    • GridCal.Engine.Devices.bus module
    • GridCal.Engine.Devices.generator module
    • GridCal.Engine.Devices.load module
    • GridCal.Engine.Devices.measurement module
    • GridCal.Engine.Devices.meta_devices module
    • GridCal.Engine.Devices.sequence_line module
    • GridCal.Engine.Devices.shunt module
    • GridCal.Engine.Devices.static_generator module
    • GridCal.Engine.Devices.tower module
    • GridCal.Engine.Devices.transformer module
    • GridCal.Engine.Devices.types module
    • GridCal.Engine.Devices.underground_line module
    • GridCal.Engine.Devices.wire module
• GridCal.Engine.IO package
  • Submodules
    • GridCal.Engine.IO.cim_parser module
    • GridCal.Engine.IO.dgs_parser module
    • GridCal.Engine.IO.dpx_parser module
    • GridCal.Engine.IO.excel_interface module
    • GridCal.Engine.IO.file_handler module
    • GridCal.Engine.IO.h5_interface module
    • GridCal.Engine.IO.ipa_parser module
    • GridCal.Engine.IO.json_parser module
    • GridCal.Engine.IO.matpower_branch_definitions module
    • GridCal.Engine.IO.matpower_bus_definitions module
    • GridCal.Engine.IO.matpower_gen_definitions module
    • GridCal.Engine.IO.matpower_parser module
    • GridCal.Engine.IO.matpower_storage_definitions module
    • GridCal.Engine.IO.psse_parser module
    • GridCal.Engine.IO.sqlite_interface module
    • GridCal.Engine.IO.zip_interface module
• GridCal.Engine.Replacements package
  • Submodules
    • GridCal.Engine.Replacements.mpiserve module
    • GridCal.Engine.Replacements.poap_controller module
    • GridCal.Engine.Replacements.strategy module
    • GridCal.Engine.Replacements.tcpserve module
• GridCal.Engine.Simulations package
  • Subpackages
    • GridCal.Engine.Simulations.ContinuationPowerFlow package
      • Submodules
      • GridCal.Engine.Simulations.ContinuationPowerFlow.continuation_power_flow module
      • GridCal.Engine.Simulations.ContinuationPowerFlow.voltage_collapse_driver module
    • GridCal.Engine.Simulations.Dynamics package
      • Submodules
      • GridCal.Engine.Simulations.Dynamics.dynamic_modules module
      • GridCal.Engine.Simulations.Dynamics.transient_stability_driver module
    • GridCal.Engine.Simulations.OPF package
      • Submodules
      • GridCal.Engine.Simulations.OPF.ac_opf module
      • GridCal.Engine.Simulations.OPF.dc_opf module
      • GridCal.Engine.Simulations.OPF.nelder_mead_opf module
      • GridCal.Engine.Simulations.OPF.opf_driver module
      • GridCal.Engine.Simulations.OPF.opf_results module
      • GridCal.Engine.Simulations.OPF.opf_time_series_driver module
    • GridCal.Engine.Simulations.Optimization package
      • Submodules
      • GridCal.Engine.Simulations.Optimization.optimization_driver module
    • GridCal.Engine.Simulations.PowerFlow package
      • Submodules
    • GridCal.Engine.Simulations.ShortCircuit package
      • Submodules
      • GridCal.Engine.Simulations.ShortCircuit.short_circuit module
      • GridCal.Engine.Simulations.ShortCircuit.short_circuit_driver module
    • GridCal.Engine.Simulations.StateEstimation package
      • Submodules
      • GridCal.Engine.Simulations.StateEstimation.state_estimation module
      • GridCal.Engine.Simulations.StateEstimation.state_stimation_driver module
    • GridCal.Engine.Simulations.Stochastic package
      • Submodules
      • GridCal.Engine.Simulations.Stochastic.blackout_driver module
      • GridCal.Engine.Simulations.Stochastic.lhs_driver module
      • GridCal.Engine.Simulations.Stochastic.monte_carlo_driver module
      • GridCal.Engine.Simulations.Stochastic.monte_carlo_input module
      • GridCal.Engine.Simulations.Stochastic.monte_carlo_results module
      • GridCal.Engine.Simulations.Stochastic.reliability_driver module
    • GridCal.Engine.Simulations.Topology package
      • Submodules
      • GridCal.Engine.Simulations.Topology.topology_driver module
  • Submodules
    • GridCal.Engine.Simulations.result_types module

Submodules

GridCal.Engine.basic_structures module

class GridCal.Engine.basic_structures.BranchImpedanceMode

Bases: enum.Enum

An enumeration.

Lower = 2

Specified = 0

Upper = 1

class GridCal.Engine.basic_structures.BusMode

Bases: enum.Enum

An enumeration.

NONE = (4,)

PQ = (1,)

PV = (2,)

REF = (3,)

STO_DISPATCH = 5

class GridCal.Engine.basic_structures.CDF(data)

Bases: object

Inverse Cumulative density function of a given array of data

get_at(prob)

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)

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(ax=None)

Plots the CFD @param ax: MatPlotLib axis to plot into @return:

class GridCal.Engine.basic_structures.StatisticalCharacterization(gen_P, load_P, load_Q)

Bases: object

Object to store the statistical characterization It is useful because the statistical characterizations can be: - not grouped - grouped by day - grouped by hour

get_sample(load_enabled_idx, gen_enabled_idx, npoints=1)

Returns a 2D array containing for load and generation profiles, shape (time, load) The profile is sampled from the original data CDF functions

@param npoints: number of sampling points @return: PG: generators profile S: loads profile

plot(ax)

Plot this statistical characterization @param ax: matplotlib index @return:

GridCal.Engine.basic_structures.classify_by_day(t: pandas.core.indexes.datetimes.DatetimeIndex)

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

GridCal.Engine.basic_structures.classify_by_hour(t: pandas.core.indexes.datetimes.DatetimeIndex)

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

GridCal.Engine.grid_analysis module

class GridCal.Engine.grid_analysis.TimeSeriesResultsAnalysis(numerical_circuit: GridCal.Engine.Core.numerical_circuit.NumericalCircuit, results: GridCal.Engine.Simulations.PowerFlow.time_series_driver.TimeSeriesResults)

Bases: object

GridCal.Engine.plot_config module