Libray Enumerations
This page provides details on the enumerated classes part of the PyPSSE library.Enumerations map directly to .
ApiCommands
| Key | Value |
|---|---|
| pypsse.enumerations.ApiCommands.RUN_SIMUALTION | run_simulation |
| pypsse.enumerations.ApiCommands.STATUS | status |
| pypsse.enumerations.ApiCommands.SOLVE_STEP | run_step |
| pypsse.enumerations.ApiCommands.OPEN_CASE | open_case |
| pypsse.enumerations.ApiCommands.CLOSE_CASE | close_case |
| pypsse.enumerations.ApiCommands.UDPATE_MODEL | update_model |
| pypsse.enumerations.ApiCommands.UPDATE_PARAMETERS | update_settings |
| pypsse.enumerations.ApiCommands.QUERY_ALL | query_all |
| pypsse.enumerations.ApiCommands.QUERY_BY_ID | query_by_asset |
| pypsse.enumerations.ApiCommands.QUERY_BY_PPTY | query_by_ppty |
| pypsse.enumerations.ApiCommands.QUERY_ASSET_LIST | query_asset_list |
AreaProperties
| Key | Value |
|---|---|
| pypsse.enumerations.AreaProperties.LOAD | LOAD |
| pypsse.enumerations.AreaProperties.LOADID | LOADID |
| pypsse.enumerations.AreaProperties.LGDN | LGDN |
| pypsse.enumerations.AreaProperties.LDGNLD | LDGNLD |
| pypsse.enumerations.AreaProperties.GEN | GEN |
| pypsse.enumerations.AreaProperties.AREANAME | AREANAME |
| pypsse.enumerations.AreaProperties.AREANUMBER | AREANUMBER |
BranchProperties
| Key | Value |
|---|---|
| pypsse.enumerations.BranchProperties.RATEn | RATEn |
| pypsse.enumerations.BranchProperties.RATEA | RATEA |
| pypsse.enumerations.BranchProperties.RATEB | RATEB |
| pypsse.enumerations.BranchProperties.RATEC | RATEC |
| pypsse.enumerations.BranchProperties.RATE | RATE |
| pypsse.enumerations.BranchProperties.LENGTH | LENGTH |
| pypsse.enumerations.BranchProperties.CHARG | CHARG |
| pypsse.enumerations.BranchProperties.CHARGZ | CHARGZ |
| pypsse.enumerations.BranchProperties.FRACT1 | FRACT1 |
| pypsse.enumerations.BranchProperties.FRACT2 | FRACT2 |
| pypsse.enumerations.BranchProperties.FRACT3 | FRACT3 |
| pypsse.enumerations.BranchProperties.FRACT4 | FRACT4 |
| pypsse.enumerations.BranchProperties.RX | RX |
| pypsse.enumerations.BranchProperties.ISHNT | ISHNT |
| pypsse.enumerations.BranchProperties.JSHNT | JSHNT |
| pypsse.enumerations.BranchProperties.RXZ | RXZ |
| pypsse.enumerations.BranchProperties.ISHNTZ | ISHNTZ |
| pypsse.enumerations.BranchProperties.JSHNTZ | JSHNTZ |
| pypsse.enumerations.BranchProperties.LOSSES | LOSSES |
| pypsse.enumerations.BranchProperties.O_LOSSES | O_LOSSES |
| pypsse.enumerations.BranchProperties.MVA | MVA |
| pypsse.enumerations.BranchProperties.AMPS | AMPS |
| pypsse.enumerations.BranchProperties.PUCUR | PUCUR |
| pypsse.enumerations.BranchProperties.CURANG | CURANG |
| pypsse.enumerations.BranchProperties.P | P |
| pypsse.enumerations.BranchProperties.O_P | O_P |
| pypsse.enumerations.BranchProperties.Q | Q |
| pypsse.enumerations.BranchProperties.O_Q | O_Q |
| pypsse.enumerations.BranchProperties.PLOS | PLOS |
| pypsse.enumerations.BranchProperties.O_PLOS | O_PLOS |
| pypsse.enumerations.BranchProperties.QLOS | QLOS |
| pypsse.enumerations.BranchProperties.O_QLOS | O_QLOS |
BulkWriteModes
| Key | Value |
|---|---|
| pypsse.enumerations.BulkWriteModes.CSV | csv |
| pypsse.enumerations.BulkWriteModes.PKL | pkl |
BusProperties
| Key | Value |
|---|---|
| pypsse.enumerations.BusProperties.BASE | BASE |
| pypsse.enumerations.BusProperties.FREQ | FREQ |
| pypsse.enumerations.BusProperties.PU | PU |
| pypsse.enumerations.BusProperties.KV | KV |
| pypsse.enumerations.BusProperties.ANGLE | ANGLE |
| pypsse.enumerations.BusProperties.ANGLED | ANGLED |
| pypsse.enumerations.BusProperties.NVLMHI | NVLMHI |
| pypsse.enumerations.BusProperties.NVLMLO | NVLMLO |
| pypsse.enumerations.BusProperties.EVLMHI | EVLMHI |
| pypsse.enumerations.BusProperties.EVLMLO | EVLMLO |
ChannelTypes
| Key | Value |
|---|---|
| pypsse.enumerations.ChannelTypes.BUSES | buses |
| pypsse.enumerations.ChannelTypes.LOADS | loads |
| pypsse.enumerations.ChannelTypes.MACHINES | machines |
DCLineProperties
| Key | Value |
|---|---|
| pypsse.enumerations.DCLineProperties.DCLINENAME | DCLINENAME |
| pypsse.enumerations.DCLineProperties.MDC | MDC |
| pypsse.enumerations.DCLineProperties.RECT | RECT |
| pypsse.enumerations.DCLineProperties.INV | INV |
| pypsse.enumerations.DCLineProperties.METER | METER |
| pypsse.enumerations.DCLineProperties.NBR | NBR |
| pypsse.enumerations.DCLineProperties.NBI | NBI |
| pypsse.enumerations.DCLineProperties.ICR | ICR |
| pypsse.enumerations.DCLineProperties.ICI | ICI |
| pypsse.enumerations.DCLineProperties.NDR | NDR |
| pypsse.enumerations.DCLineProperties.NDI | NDI |
Enum
| Key | Value |
|---|---|
ExportModes
| Key | Value |
|---|---|
| pypsse.enumerations.ExportModes.JSON | json |
| pypsse.enumerations.ExportModes.CSV | csv |
| pypsse.enumerations.ExportModes.H5 | h5 |
FixedShuntProperties
| Key | Value |
|---|---|
| pypsse.enumerations.FixedShuntProperties.ACT | ACT |
| pypsse.enumerations.FixedShuntProperties.O_ACT | O_ACT |
| pypsse.enumerations.FixedShuntProperties.NOM | NOM |
| pypsse.enumerations.FixedShuntProperties.O_NOM | O_NOM |
| pypsse.enumerations.FixedShuntProperties.PQZERO | PQZERO |
| pypsse.enumerations.FixedShuntProperties.PQZ | PQZ |
| pypsse.enumerations.FixedShuntProperties.O_PQZ | O_PQZ |
HelicsCoreTypes
| Key | Value |
|---|---|
| pypsse.enumerations.HelicsCoreTypes.ZMQ | zmq |
InductionGeneratorProperties
| Key | Value |
|---|---|
| pypsse.enumerations.InductionGeneratorProperties.MBASE | MBASE |
| pypsse.enumerations.InductionGeneratorProperties.RATEKV | RATEKV |
| pypsse.enumerations.InductionGeneratorProperties.PSET | PSET |
| pypsse.enumerations.InductionGeneratorProperties.RA | RA |
| pypsse.enumerations.InductionGeneratorProperties.XA | XA |
| pypsse.enumerations.InductionGeneratorProperties.R1 | R1 |
| pypsse.enumerations.InductionGeneratorProperties.X1 | X1 |
| pypsse.enumerations.InductionGeneratorProperties.R2 | R2 |
| pypsse.enumerations.InductionGeneratorProperties.X2 | X2 |
| pypsse.enumerations.InductionGeneratorProperties.X3 | X3 |
| pypsse.enumerations.InductionGeneratorProperties.E1 | E1 |
| pypsse.enumerations.InductionGeneratorProperties.SE1 | SE1 |
| pypsse.enumerations.InductionGeneratorProperties.E2 | E2 |
| pypsse.enumerations.InductionGeneratorProperties.SE2 | SE2 |
| pypsse.enumerations.InductionGeneratorProperties.IA1 | IA1 |
| pypsse.enumerations.InductionGeneratorProperties.IA2 | IA2 |
| pypsse.enumerations.InductionGeneratorProperties.XAMULT | XAMULT |
| pypsse.enumerations.InductionGeneratorProperties.TRQA | TRQA |
| pypsse.enumerations.InductionGeneratorProperties.TRQB | TRQB |
| pypsse.enumerations.InductionGeneratorProperties.TRQD | TRQD |
| pypsse.enumerations.InductionGeneratorProperties.TRQE | TRQE |
| pypsse.enumerations.InductionGeneratorProperties.H | H |
| pypsse.enumerations.InductionGeneratorProperties.IRATIO | IRATIO |
| pypsse.enumerations.InductionGeneratorProperties.ROVERX | ROVERX |
| pypsse.enumerations.InductionGeneratorProperties.RZERO | RZERO |
| pypsse.enumerations.InductionGeneratorProperties.XZERO | XZERO |
| pypsse.enumerations.InductionGeneratorProperties.RGRND | RGRND |
| pypsse.enumerations.InductionGeneratorProperties.XGRND | XGRND |
| pypsse.enumerations.InductionGeneratorProperties.P | P |
| pypsse.enumerations.InductionGeneratorProperties.O_P | O_P |
| pypsse.enumerations.InductionGeneratorProperties.Q | Q |
| pypsse.enumerations.InductionGeneratorProperties.O_Q | O_Q |
| pypsse.enumerations.InductionGeneratorProperties.MVA | MVA |
| pypsse.enumerations.InductionGeneratorProperties.O_MVA | O_MVA |
| pypsse.enumerations.InductionGeneratorProperties.SLIP | SLIP |
| pypsse.enumerations.InductionGeneratorProperties.ZA | ZA |
| pypsse.enumerations.InductionGeneratorProperties.Z1 | Z1 |
| pypsse.enumerations.InductionGeneratorProperties.Z2 | Z2 |
| pypsse.enumerations.InductionGeneratorProperties.ZZERO | ZZERO |
| pypsse.enumerations.InductionGeneratorProperties.ZGRND | ZGRND |
| pypsse.enumerations.InductionGeneratorProperties.PQ | PQ |
| pypsse.enumerations.InductionGeneratorProperties.O_PQ | O_PQ |
IntEnum
| Key | Value |
|---|---|
LoadProperties
| Key | Value |
|---|---|
| pypsse.enumerations.LoadProperties.MVA | MVA |
| pypsse.enumerations.LoadProperties.IL | IL |
| pypsse.enumerations.LoadProperties.YL | YL |
| pypsse.enumerations.LoadProperties.TOTAL | TOTAL |
| pypsse.enumerations.LoadProperties.YNEG | YNEG |
| pypsse.enumerations.LoadProperties.YZERO | YZERO |
| pypsse.enumerations.LoadProperties.FmA | FmA |
| pypsse.enumerations.LoadProperties.FmB | FmB |
| pypsse.enumerations.LoadProperties.FmC | FmC |
| pypsse.enumerations.LoadProperties.FmD | FmD |
| pypsse.enumerations.LoadProperties.Fel | Fel |
| pypsse.enumerations.LoadProperties.PFel | PFel |
| pypsse.enumerations.LoadProperties.TD | TD |
| pypsse.enumerations.LoadProperties.TC | TC |
LoggingLevels
| Key | Value |
|---|---|
| pypsse.enumerations.LoggingLevels.NOTSET | 0 |
| pypsse.enumerations.LoggingLevels.DEBUG | 10 |
| pypsse.enumerations.LoggingLevels.INFO | 20 |
| pypsse.enumerations.LoggingLevels.WARN | 30 |
| pypsse.enumerations.LoggingLevels.ERROR | 40 |
| pypsse.enumerations.LoggingLevels.CRITICAL | 50 |
MachinesProperties
| Key | Value |
|---|---|
| pypsse.enumerations.MachinesProperties.QMAX | QMAX |
| pypsse.enumerations.MachinesProperties.O_QMAX | O_QMAX |
| pypsse.enumerations.MachinesProperties.QMIN | QMIN |
| pypsse.enumerations.MachinesProperties.O_QMIN | O_QMIN |
| pypsse.enumerations.MachinesProperties.PMAX | PMAX |
| pypsse.enumerations.MachinesProperties.O_PMAX | O_PMAX |
| pypsse.enumerations.MachinesProperties.PMIN | PMIN |
| pypsse.enumerations.MachinesProperties.O_PMIN | O_PMIN |
| pypsse.enumerations.MachinesProperties.MBASE | MBASE |
| pypsse.enumerations.MachinesProperties.MVA | MVA |
| pypsse.enumerations.MachinesProperties.O_MVA | O_MVA |
| pypsse.enumerations.MachinesProperties.P | P |
| pypsse.enumerations.MachinesProperties.O_P | O_P |
| pypsse.enumerations.MachinesProperties.Q | Q |
| pypsse.enumerations.MachinesProperties.O_Q | O_Q |
| pypsse.enumerations.MachinesProperties.PERCENT | PERCENT |
| pypsse.enumerations.MachinesProperties.GENTAP | GENTAP |
| pypsse.enumerations.MachinesProperties.VSCHED | VSCHED |
| pypsse.enumerations.MachinesProperties.WPF | WPF |
| pypsse.enumerations.MachinesProperties.RMPCT | RMPCT |
| pypsse.enumerations.MachinesProperties.RPOS | RPOS |
| pypsse.enumerations.MachinesProperties.XSUBTR | XSUBTR |
| pypsse.enumerations.MachinesProperties.XTRANS | XTRANS |
| pypsse.enumerations.MachinesProperties.XSYNCH | XSYNCH |
| pypsse.enumerations.MachinesProperties.PQ | PQ |
| pypsse.enumerations.MachinesProperties.O_PQ | O_PQ |
| pypsse.enumerations.MachinesProperties.ZSORCE | ZSORCE |
| pypsse.enumerations.MachinesProperties.XTRAN | XTRAN |
| pypsse.enumerations.MachinesProperties.ZPOS | ZPOS |
| pypsse.enumerations.MachinesProperties.ZNEG | ZNEG |
| pypsse.enumerations.MachinesProperties.ZZERO | ZZERO |
| pypsse.enumerations.MachinesProperties.ZGRND | ZGRND |
ModelProperties
| Key | Value |
|---|---|
| pypsse.enumerations.ModelProperties.PU | PU |
| pypsse.enumerations.ModelProperties.FREQ | FREQ |
| pypsse.enumerations.ModelProperties.ANGLE | ANGLE |
| pypsse.enumerations.ModelProperties.ANGLED | ANGLED |
ModelTypes
| Key | Value |
|---|---|
| pypsse.enumerations.ModelTypes.BUSES | Buses |
| pypsse.enumerations.ModelTypes.BRANCHES | Branches |
| pypsse.enumerations.ModelTypes.LOADS | Loads |
| pypsse.enumerations.ModelTypes.GENERATORS | Induction_generators |
| pypsse.enumerations.ModelTypes.MACHINES | Machines |
| pypsse.enumerations.ModelTypes.FIXED_SHUNTS | Fixed_shunts |
| pypsse.enumerations.ModelTypes.SWITCHED_SHUNTS | Switched_shunts |
| pypsse.enumerations.ModelTypes.TRANSFORMERS | Transformers |
| pypsse.enumerations.ModelTypes.AREAS | Areas |
| pypsse.enumerations.ModelTypes.ZONES | Zones |
| pypsse.enumerations.ModelTypes.DC_LINES | DCtransmissionlines |
| pypsse.enumerations.ModelTypes.STATIONS | Stations |
PSSE_VERSIONS
| Key | Value |
|---|---|
| pypsse.enumerations.PSSE_VERSIONS.PSSE34 | psse34 |
| pypsse.enumerations.PSSE_VERSIONS.PSSE35 | psse35 |
| pypsse.enumerations.PSSE_VERSIONS.PSSE36 | psse36 |
ProjectFolders
| Key | Value |
|---|---|
| pypsse.enumerations.ProjectFolders.CASESTUDY | case_study |
| pypsse.enumerations.ProjectFolders.EXPORTS | exports |
| pypsse.enumerations.ProjectFolders.GISDATA | gis_data |
| pypsse.enumerations.ProjectFolders.LOGS | logs |
| pypsse.enumerations.ProjectFolders.PROFILES | profiles |
SimulationModes
| Key | Value |
|---|---|
| pypsse.enumerations.SimulationModes.PCM | PCM |
| pypsse.enumerations.SimulationModes.SNAP | Snap |
| pypsse.enumerations.SimulationModes.STATIC | Steady-state |
| pypsse.enumerations.SimulationModes.DYNAMIC | Dynamic |
SimulationStatus
| Key | Value |
|---|---|
| pypsse.enumerations.SimulationStatus.NOT_INITIALIZED | Instance not initialized |
| pypsse.enumerations.SimulationStatus.STARTING_INSTANCE | Starting PyPSSE instance |
| pypsse.enumerations.SimulationStatus.INITIALIZATION_COMPLETE | PyPSSE initialization complete |
| pypsse.enumerations.SimulationStatus.RUNNING_SIMULATION | Running simulation |
| pypsse.enumerations.SimulationStatus.SIMULATION_COMPLETE | Simulation complete |
| pypsse.enumerations.SimulationStatus.STARTING_RESULT_EXPORT | Starting exports |
| pypsse.enumerations.SimulationStatus.RESULT_EXPORT_COMPLETE | Export coplete |
StationProperties
| Key | Value |
|---|---|
| pypsse.enumerations.StationProperties.SUBNAME | SUBNAME |
| pypsse.enumerations.StationProperties.SUBNUMBER | SUBNUMBER |
| pypsse.enumerations.StationProperties.BUSES | BUSES |
| pypsse.enumerations.StationProperties.GENERATORS | GENERATORS |
| pypsse.enumerations.StationProperties.TRANSFORMERS | TRANSFORMERS |
| pypsse.enumerations.StationProperties.NOMKV | NOMKV |
| pypsse.enumerations.StationProperties.LOADMW | LOADMW |
| pypsse.enumerations.StationProperties.GENMW | GENMW |
StreamedWriteModes
| Key | Value |
|---|---|
| pypsse.enumerations.StreamedWriteModes.H5 | h5 |
SubscriptionFileRequiredColumns
| Key | Value |
|---|---|
| pypsse.enumerations.SubscriptionFileRequiredColumns.bus_subsystem_id | bus_subsystem_id |
| pypsse.enumerations.SubscriptionFileRequiredColumns.element_type | element_type |
| pypsse.enumerations.SubscriptionFileRequiredColumns.element_id | element_id |
| pypsse.enumerations.SubscriptionFileRequiredColumns.element_property | element_property |
| pypsse.enumerations.SubscriptionFileRequiredColumns.sub_tag | sub_tag |
| pypsse.enumerations.SubscriptionFileRequiredColumns.scaler | scaler |
| pypsse.enumerations.SubscriptionFileRequiredColumns.bus | bus |
SwitchedShuntProperties
| Key | Value |
|---|---|
| pypsse.enumerations.SwitchedShuntProperties.VSWHI | VSWHI |
| pypsse.enumerations.SwitchedShuntProperties.VSWLO | VSWLO |
| pypsse.enumerations.SwitchedShuntProperties.RMPCT | RMPCT |
| pypsse.enumerations.SwitchedShuntProperties.BINIT | BINIT |
| pypsse.enumerations.SwitchedShuntProperties.O_BINIT | O_BINIT |
TransformerProperties
| Key | Value |
|---|---|
| pypsse.enumerations.TransformerProperties.RATIO | RATIO |
| pypsse.enumerations.TransformerProperties.RATIO2 | RATIO2 |
| pypsse.enumerations.TransformerProperties.ANGLE | ANGLE |
| pypsse.enumerations.TransformerProperties.RMAX | RMAX |
| pypsse.enumerations.TransformerProperties.RMIN | RMIN |
| pypsse.enumerations.TransformerProperties.VMAX | VMAX |
| pypsse.enumerations.TransformerProperties.VMIN | VMIN |
| pypsse.enumerations.TransformerProperties.STEP | STEP |
| pypsse.enumerations.TransformerProperties.CR | CR |
| pypsse.enumerations.TransformerProperties.CX | CX |
| pypsse.enumerations.TransformerProperties.CNXANG | CNXANG |
| pypsse.enumerations.TransformerProperties.SBASE1 | SBASE1 |
| pypsse.enumerations.TransformerProperties.NOMV1 | NOMV1 |
| pypsse.enumerations.TransformerProperties.NOMV2 | NOMV2 |
| pypsse.enumerations.TransformerProperties.GMAGNT | GMAGNT |
| pypsse.enumerations.TransformerProperties.BMAGNT | BMAGNT |
| pypsse.enumerations.TransformerProperties.RG1 | RG1 |
| pypsse.enumerations.TransformerProperties.XG1 | XG1 |
| pypsse.enumerations.TransformerProperties.R01 | R01 |
| pypsse.enumerations.TransformerProperties.X01 | X01 |
| pypsse.enumerations.TransformerProperties.RG2 | RG2 |
| pypsse.enumerations.TransformerProperties.XG2 | XG2 |
| pypsse.enumerations.TransformerProperties.R02 | R02 |
| pypsse.enumerations.TransformerProperties.X02 | X02 |
| pypsse.enumerations.TransformerProperties.RNUTRL | RNUTRL |
| pypsse.enumerations.TransformerProperties.XNUTRL | XNUTRL |
| pypsse.enumerations.TransformerProperties.RX1_2 | RX1-2 |
| pypsse.enumerations.TransformerProperties.RX2_3 | RX2-3 |
| pypsse.enumerations.TransformerProperties.RX3_1 | RX3-1 |
| pypsse.enumerations.TransformerProperties.YMAGNT | YMAGNT |
| pypsse.enumerations.TransformerProperties.ZG1 | ZG1 |
| pypsse.enumerations.TransformerProperties.Z01 | Z01 |
| pypsse.enumerations.TransformerProperties.ZG2 | ZG2 |
| pypsse.enumerations.TransformerProperties.Z02 | Z02 |
| pypsse.enumerations.TransformerProperties.ZG3 | ZG3 |
| pypsse.enumerations.TransformerProperties.Z03 | Z03 |
| pypsse.enumerations.TransformerProperties.ZNUTRL | ZNUTRL |
UseModes
| Key | Value |
|---|---|
| pypsse.enumerations.UseModes.REGEX | regex |
| pypsse.enumerations.UseModes.LIST | list |
| pypsse.enumerations.UseModes.ALL | all |
WritableModelTypes
| Key | Value |
|---|---|
| pypsse.enumerations.WritableModelTypes.LOAD | Load |
| pypsse.enumerations.WritableModelTypes.PLANT | Plant |
| pypsse.enumerations.WritableModelTypes.MACHINE | Machine |
| pypsse.enumerations.WritableModelTypes.GENERATOR | Induction_machine |
ZoneProperties
| Key | Value |
|---|---|
| pypsse.enumerations.ZoneProperties.LOAD | LOAD |
| pypsse.enumerations.ZoneProperties.LOADID | LOADID |
| pypsse.enumerations.ZoneProperties.LGDN | LGDN |
| pypsse.enumerations.ZoneProperties.LDGNLD | LDGNLD |
| pypsse.enumerations.ZoneProperties.GEN | GEN |
| pypsse.enumerations.ZoneProperties.ZONENAME | ZONENAME |
| pypsse.enumerations.ZoneProperties.ZONENUMBER | ZONENUMBER |