altdss.PVSystem

Module Contents

Classes

IPVSystem
PVSystem
PVSystemBatch
PVSystemBatchProperties	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)
PVSystemProperties	dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

API

class altdss.PVSystem.IPVSystem(iobj)

Bases: altdss.DSSObj.IDSSObj, altdss.PVSystem.PVSystemBatch

AmpLimit: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

The current limiter per phase for the IBR when operating in GFM mode. This limit is imposed to prevent the IBR to enter into Safe Mode when reaching the IBR power ratings. Once the IBR reaches this value, it remains there without moving into Safe Mode. This value needs to be set lower than the IBR Amps rating.

DSS property name: AmpLimit, DSS property index: 49.

AmpLimitGain: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Use it for fine tunning the current limiter when active, by default is 0.8, it has to be a value between 0.1 and 1. This value allows users to fine tune the IBRs current limiter to match with the user requirements.

DSS property name: AmpLimitGain, DSS property index: 50.

Balanced: List[bool]

‘property(…)’

{Yes | No*} Default is No. Force balanced current only for 3-phase PVSystems. Forces zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 21.

BaseFreq: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Base Frequency for ratings.

DSS property name: BaseFreq, DSS property index: 52.

Bus1: List[str]

‘property(…)’

Bus to which the PVSystem element is connected. May include specific node specification.

DSS property name: Bus1, DSS property index: 2.

Class: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

An arbitrary integer number representing the class of PVSystem element so that PVSystem values may be segregated by class.

DSS property name: Class, DSS property index: 29.

ComplexSeqCurrents() → altdss.types.ComplexArray

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqCurrents.html

ComplexSeqVoltages() → altdss.types.ComplexArray

Complex double array of Sequence Voltage for all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqVoltages1.html

Conn: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

={wye|LN|delta|LL}. Default is wye.

DSS property name: Conn, DSS property index: 9.

Conn_str: List[str]

‘property(…)’

={wye|LN|delta|LL}. Default is wye.

DSS property name: Conn, DSS property index: 9.

ControlMode: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

Defines the control mode for the inverter. It can be one of {GFM | GFL*}. By default it is GFL (Grid Following Inverter). Use GFM (Grid Forming Inverter) for energizing islanded microgrids, but, if the device is connected to the grid, it is highly recommended to use GFL.

GFM control mode disables any control action set by the InvControl device.

DSS property name: ControlMode, DSS property index: 48.

ControlMode_str: List[str]

‘property(…)’

Defines the control mode for the inverter. It can be one of {GFM | GFL*}. By default it is GFL (Grid Following Inverter). Use GFM (Grid Forming Inverter) for energizing islanded microgrids, but, if the device is connected to the grid, it is highly recommended to use GFL.

GFM control mode disables any control action set by the InvControl device.

DSS property name: ControlMode, DSS property index: 48.

Currents() → altdss.types.ComplexArray

Complex array of currents into each conductor of each terminal

Original COM help: https://opendss.epri.com/Currents1.html

CurrentsMagAng() → altdss.types.Float64Array

Currents in magnitude, angle (degrees) format as a array of doubles.

Original COM help: https://opendss.epri.com/CurrentsMagAng.html

Daily: List[altdss.LoadShape.LoadShape]

‘property(…)’

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Daily, DSS property index: 24.

Daily_str: List[str]

‘property(…)’

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Daily, DSS property index: 24.

DebugTrace: List[bool]

‘property(…)’

{Yes | No } Default is no. Turn this on to capture the progress of the PVSystem model for each iteration. Creates a separate file for each PVSystem element named “PVSystem_name.csv”.

DSS property name: DebugTrace, DSS property index: 32.

Duty: List[altdss.LoadShape.LoadShape]

‘property(…)’

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: Duty, DSS property index: 25.

DutyStart: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Starting time offset [hours] into the duty cycle shape for this PVSystem, defaults to 0

DSS property name: DutyStart, DSS property index: 34.

Duty_str: List[str]

‘property(…)’

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: Duty, DSS property index: 25.

DynOut: List[List[str]]

‘property(…)’

The name of the variables within the Dynamic equation that will be used to govern the PVSystem dynamics. This PVsystem model requires 1 output from the dynamic equation:

1. Current.

The output variables need to be defined in the same order.

DSS property name: DynOut, DSS property index: 47.

DynamicEq: List[altdss.DynamicExp.DynamicExp]

‘property(…)’

The name of the dynamic equation (DynamicExp) that will be used for defining the dynamic behavior of the generator. If not defined, the generator dynamics will follow the built-in dynamic equation.

DSS property name: DynamicEq, DSS property index: 46.

DynamicEq_str: List[str]

‘property(…)’

The name of the dynamic equation (DynamicExp) that will be used for defining the dynamic behavior of the generator. If not defined, the generator dynamics will follow the built-in dynamic equation.

DSS property name: DynamicEq, DSS property index: 46.

EffCurve: List[altdss.XYcurve.XYcurve]

‘property(…)’

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14.

EffCurve_str: List[str]

‘property(…)’

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14.

Enabled: List[bool]

‘property(…)’

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: Enabled, DSS property index: 53.

EnergyMeter() → List[altdss.DSSObj.DSSObj]

EnergyMeterName() → List[str]

FullName() → List[str]

Returns the full name (including object type) for all objects in this batch

GUID() → List[str]

GUID/UUID for each object. Currently used only in the CIM-related methods.

Original COM help: https://opendss.epri.com/GUID.html

Handle() → altdss.types.Int32Array

Index of each element into the circuit’s element list.

Original COM help: https://opendss.epri.com/Handle.html

HasOCPDevice() → altdss.types.BoolArray

For each element in the batch: returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

Original COM help: https://opendss.epri.com/HasOCPDevice.html

HasSwitchControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a SwtControl attached.

Original COM help: https://opendss.epri.com/HasSwitchControl.html

HasVoltControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a CapControl or RegControl attached.

Original COM help: https://opendss.epri.com/HasVoltControl.html

Irradiance: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the present irradiance value in kW/sq-m. Used as base value for shape multipliers. Generally entered as peak value for the time period of interest and the yearly, daily, and duty load shape objects are defined as per unit multipliers (just like Loads/Generators).

DSS property name: Irradiance, DSS property index: 4.

IsIsolated() → altdss.types.BoolArray

For each element in the batch: returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

Kp: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

It is the proportional gain for the PI controller within the inverter. Use it to modify the controller response in dynamics simulation mode.

DSS property name: Kp, DSS property index: 42.

Like(value: AnyStr, flags: altdss.enums.SetterFlags = 0)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 54.

LimitCurrent: List[bool]

‘property(…)’

Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSystems similar to Generator Model 7. For 3-phase, limits the positive-sequence current but not the negative-sequence.

DSS property name: LimitCurrent, DSS property index: 22.

Losses() → altdss.types.ComplexArray

For each element in the batch: total losses in the element, in VA (watts, vars).

Original COM help: https://opendss.epri.com/Losses1.html

MaxCurrent(terminal: int) → altdss.types.Float64Array

Returns the maximum current (magnitude) at the specified terminal for each element in this batch. Use -1 as terminal to get the value across all terminals.

Model: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

Integer code (default=1) for the model to use for power output variation with voltage. Valid values are:

1:PVSystem element injects a CONSTANT kW at specified power factor. 2:PVSystem element is modeled as a CONSTANT ADMITTANCE. 3:Compute load injection from User-written Model.

DSS property name: Model, DSS property index: 18.

property Name: List[str]

NumConductors() → altdss.types.Int32Array

Number of conductors per terminal for each element in the batch.

Original COM help: https://opendss.epri.com/NumConductors.html

NumControllers() → altdss.types.Int32Array

Number of controllers connected to each device in the batch.

Original COM help: https://opendss.epri.com/NumControls.html

NumPhases() → altdss.types.Int32Array

Number of Phases for each element in this batch.

Original COM help: https://opendss.epri.com/NumPhases.html

NumTerminals() → altdss.types.Int32Array

Number of terminals for each Circuit Element in the batch.

Original COM help: https://opendss.epri.com/NumTerminals.html

OCPDevice() → List[Union[altdss.DSSObj.DSSObj, None]]

Returns (as a list of Python objects) the OCP device controlling each element.

OCPDeviceIndex() → altdss.types.Int32Array

For each element in the batch: index into each controller list of the OCP Device controlling each circuit element

Original COM help: https://opendss.epri.com/OCPDevIndex.html

OCPDeviceType() → List[dss.enums.OCPDevType]

For each element in the batch: type of OCP controller device

Original COM help: https://opendss.epri.com/OCPDevType.html

PF: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Nominally, the power factor for the output power. Default is 1.0. Setting this property will cause the inverter to operate in constant power factor mode.Enter negative when kW and kvar have opposite signs. A positive power factor signifies that the PVSystem element produces vars as is typical for a generator.

DSS property name: PF, DSS property index: 8.

PFPriority: List[bool]

‘property(…)’

{Yes/No*/True/False} Set inverter to operate with PF priority when in constant PF mode. If “Yes”, value assigned to “WattPriority” is neglected. If controlled by an InvControl with either Volt-Var or DRC or both functions activated, PF priority is neglected and “WattPriority” is considered. Default = No.

DSS property name: PFPriority, DSS property index: 36.

PITol: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

It is the tolerance (%) for the closed loop controller of the inverter. For dynamics simulation mode.

DSS property name: PITol, DSS property index: 43.

PTCurve: List[altdss.XYcurve.XYcurve]

‘property(…)’

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15.

PTCurve_str: List[str]

‘property(…)’

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15.

PhaseLosses() → altdss.types.ComplexArray

Complex array of losses (kVA) by phase

Original COM help: https://opendss.epri.com/PhaseLosses.html

Phases: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

Number of Phases, this PVSystem element. Power is evenly divided among phases.

DSS property name: Phases, DSS property index: 1.

Pmpp: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance and a user-selected array temperature. The P-TCurve should be defined relative to the selected array temperature.

DSS property name: Pmpp, DSS property index: 5.

Powers() → altdss.types.ComplexArray

Complex array of powers (kVA) into each conductor of each terminal, of each element in the batch.

Original COM help: https://opendss.epri.com/Powers.html

SafeMode: List[bool]

‘property(…)’

(Read only) Indicates whether the inverter entered (Yes) or not (No) into Safe Mode.

DSS property name: SafeMode, DSS property index: 45.

SafeVoltage: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the voltage level (%) respect to the base voltage level for which the Inverter will operate. If this threshold is violated, the Inverter will enter safe mode (OFF). For dynamic simulation. By default is 80%

DSS property name: SafeVoltage, DSS property index: 44.

SeqCurrents() → altdss.types.Float64Array

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqCurrents.html

SeqPowers() → altdss.types.ComplexArray

Complex array of sequence powers (kW, kvar) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqPowers.html

SeqVoltages() → altdss.types.Float64Array

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqVoltages1.html

Spectrum: List[altdss.Spectrum.Spectrum]

‘property(…)’

Name of harmonic voltage or current spectrum for this PVSystem element. A harmonic voltage source is assumed for the inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: Spectrum, DSS property index: 51.

Spectrum_str: List[str]

‘property(…)’

Name of harmonic voltage or current spectrum for this PVSystem element. A harmonic voltage source is assumed for the inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: Spectrum, DSS property index: 51.

TDaily: List[altdss.TShape.TShape]

‘property(…)’

Temperature shape to use for daily simulations. Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDaily, DSS property index: 27.

TDaily_str: List[str]

‘property(…)’

Temperature shape to use for daily simulations. Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDaily, DSS property index: 27.

TDuty: List[altdss.TShape.TShape]

‘property(…)’

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDuty, DSS property index: 28.

TDuty_str: List[str]

‘property(…)’

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDuty, DSS property index: 28.

TYearly: List[altdss.TShape.TShape]

‘property(…)’

Temperature shape to use for yearly simulations. Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TYearly, DSS property index: 26.

TYearly_str: List[str]

‘property(…)’

Temperature shape to use for yearly simulations. Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TYearly, DSS property index: 26.

Temperature: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the present Temperature. Used as fixed value corresponding to PTCurve property. A multiplier is obtained from the Pmpp-Temp curve and applied to the nominal Pmpp from the irradiance to determine the net array output.

DSS property name: Temperature, DSS property index: 7.

TotalPowers() → altdss.types.ComplexArray

Returns an array with the total powers (complex, kVA) at all terminals of the circuit elements in this batch.

The resulting array is equivalent to concatenating the TotalPowers for each element.

UserData: List[str]

‘property(…)’

String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model.

DSS property name: UserData, DSS property index: 31.

UserModel: List[str]

‘property(…)’

Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 30.

VMaxpu: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Default = 1.10. Maximum per unit voltage for which the Model is assumed to apply. Above this value, the load model reverts to a constant impedance model.

DSS property name: VMaxpu, DSS property index: 20.

VMinpu: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Default = 0.90. Minimum per unit voltage for which the Model is assumed to apply. Below this value, the load model reverts to a constant impedance model except for Dynamics model. In Dynamics mode, the current magnitude is limited to the value the power flow would compute for this voltage.

DSS property name: VMinpu, DSS property index: 19.

VarFollowInverter: List[bool]

‘property(…)’

Boolean variable (Yes|No) or (True|False). Defaults to False which indicates that the reactive power generation/absorption does not respect the inverter status.When set to True, the PVSystem reactive power generation/absorption will cease when the inverter status is off, due to panel kW dropping below %Cutout. The reactive power generation/absorption will begin again when the panel kW is above %Cutin. When set to False, the PVSystem will generate/absorb reactive power regardless of the status of the inverter.

DSS property name: VarFollowInverter, DSS property index: 33.

Voltages() → altdss.types.ComplexArray

Complex array of voltages at terminals

Original COM help: https://opendss.epri.com/Voltages1.html

VoltagesMagAng() → altdss.types.Float64Array

Voltages at each conductor in magnitude, angle form as array of doubles.

Original COM help: https://opendss.epri.com/VoltagesMagAng.html

WattPriority: List[bool]

‘property(…)’

{Yes/No*/True/False} Set inverter to watt priority instead of the default var priority

DSS property name: WattPriority, DSS property index: 35.

Yearly: List[altdss.LoadShape.LoadShape]

‘property(…)’

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Yearly, DSS property index: 23.

Yearly_str: List[str]

‘property(…)’

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Yearly, DSS property index: 23.

__call__()

__contains__(name: str) → bool

__getitem__(name_or_idx)

__init__(iobj)

__iter__()

__len__() → int

batch(**kwargs)

Creates a new batch handler of (existing) objects

batch_new(names: Optional[List[AnyStr]] = None, *, df=None, count: Optional[int] = None, begin_edit: Optional[bool] = None, **kwargs: typing_extensions.Unpack[altdss.PVSystem.PVSystemBatchProperties]) → altdss.PVSystem.PVSystemBatch

Creates a new batch of PVSystem objects

Either names, count or df is required.

Parameters:

• begin_edit – The argument begin_edit indicates if the user want to leave the elements in the edit state, and requires a call to end_edit() or equivalent. The default begin_edit is set to None. With None, the behavior will be adjusted according the default of how the batch is created.

• **kwargs – Pass keyword arguments equivalent to the DSS properties of the object.

• names – When using a list of names, each new object will match the names from this list. begin_edit defaults to True if no arguments for properties were passed, False otherwise.

• count – When using count, new objects will be created with based on a random prefix, with an increasing integer up to count. begin_edit defaults to True if no arguments for properties were passed, False otherwise.

• df – Currently EXPERIMENTAL AND LIMITED, tries to get the columns from a dataframe to populate the names and the DSS properties. begin_edit defaults to False.

Returns:

Returns the new batch of DSS objects, wrapped in Python.

Note that, to make it easier for new users where the edit context might not be too relevant, AltDSS automatically opens/closes edit contexts for single properties if the object is not in the edit state already.

begin_edit() → None

Marks for editing all DSS objects in the batch

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.PVSystem.PVSystemBatchProperties]) → altdss.PVSystem.PVSystemBatch

Edit this PVSystem batch.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context for objects in the batch. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS BatchEdit command.

Parameters:

**kwargs – Pass keyword arguments equivalent to the DSS properties of the objects.

Returns:

Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None

Leaves the editing states of all DSS objects in the batch

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

find(name_or_idx: Union[AnyStr, int]) → altdss.DSSObj.DSSObj

Returns an object from the collection by name or index; the index must be zero-based.

kV: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Nominal rated (1.0 per unit) voltage, kV, for PVSystem element. For 2- and 3-phase PVSystem elements, specify phase-phase kV. Otherwise, specify actual kV across each branch of the PVSystem element. If 1-phase wye (star or LN), specify phase-neutral kV. If 1-phase delta or phase-phase connected, specify phase-phase kV.

DSS property name: kV, DSS property index: 3.

kVA: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

kVA rating of inverter. Used as the base for Dynamics mode and Harmonics mode values.

DSS property name: kVA, DSS property index: 11.

kVDC: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the rated voltage (kV) at the input of the inverter at the peak of PV energy production. The value is normally greater or equal to the kV base of the PV system. It is used for dynamics simulation ONLY.

DSS property name: kVDC, DSS property index: 41.

kvar: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the present kvar value. Setting this property forces the inverter to operate in constant kvar mode.

DSS property name: kvar, DSS property index: 10.

kvarMax: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the maximum reactive power GENERATION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). Defaults to kVA rating of the inverter.

DSS property name: kvarMax, DSS property index: 39.

kvarMaxAbs: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the maximum reactive power ABSORPTION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). Defaults to kVA rating of the inverter.

DSS property name: kvarMaxAbs, DSS property index: 40.

new(name: AnyStr, *, begin_edit: Optional[bool] = None, activate=False, **kwargs: typing_extensions.Unpack[altdss.PVSystem.PVSystemProperties]) → altdss.PVSystem.PVSystem

Creates a new PVSystem.

Parameters:

• name – The object’s name is a required positional argument.

• activate – Activation (setting activate to true) is useful for integration with the classic API, and some internal OpenDSS commands. If you interact with this object only via the Alt API, no need to activate it (due to performance costs).

• begin_edit – This controls how the edit context is left after the object creation:

• True: The object will be left in the edit state, requiring an end_edit call or equivalent.

• False: No edit context is started.

• None: If no properties are passed as keyword arguments, the object will be left in the edit state (assumes the user will fill the properties from Python attributes). Otherwise, the internal edit context will be finalized.

Parameters:

**kwargs – Pass keyword arguments equivalent to the DSS properties of the object.

Returns:

Returns the new DSS object, wrapped in Python.

Note that, to make it easier for new users where the edit context might not be too relevant, AltDSS automatically opens/closes edit contexts for single properties if the object is not in the edit state already.

pctCutIn: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

DSS property name: %CutIn, DSS property index: 12.

pctCutOut: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

DSS property name: %CutOut, DSS property index: 13.

pctPMinNoVars: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Minimum active power as percentage of Pmpp under which there is no vars production/absorption.

DSS property name: %PMinNoVars, DSS property index: 37.

pctPMinkvarMax: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Minimum active power as percentage of Pmpp that allows the inverter to produce/absorb reactive power up to its kvarMax or kvarMaxAbs.

DSS property name: %PMinkvarMax, DSS property index: 38.

pctPmpp: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Upper limit on active power as a percentage of Pmpp.

DSS property name: %Pmpp, DSS property index: 6.

pctR: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Equivalent percent internal resistance, ohms. Default is 50%. Placed in series with internal voltage source for harmonics and dynamics modes. (Limits fault current to about 2 pu if not current limited – see LimitCurrent)

DSS property name: %R, DSS property index: 16.

pctX: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Equivalent percent internal reactance, ohms. Default is 0%. Placed in series with internal voltage source for harmonics and dynamics modes.

DSS property name: %X, DSS property index: 17.

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns the data (as a list) of the elements in a batch as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON (C-API) for more, or DSSObj.to_json in Python.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

to_list()

class altdss.PVSystem.PVSystem(api_util, ptr)

Bases: altdss.DSSObj.DSSObj, altdss.CircuitElement.CircuitElementMixin, altdss.PCElement.PCElementMixin, altdss.PCElement.ElementHasRegistersMixin

AmpLimit: float

‘property(…)’

The current limiter per phase for the IBR when operating in GFM mode. This limit is imposed to prevent the IBR to enter into Safe Mode when reaching the IBR power ratings. Once the IBR reaches this value, it remains there without moving into Safe Mode. This value needs to be set lower than the IBR Amps rating.

DSS property name: AmpLimit, DSS property index: 49.

AmpLimitGain: float

‘property(…)’

Use it for fine tunning the current limiter when active, by default is 0.8, it has to be a value between 0.1 and 1. This value allows users to fine tune the IBRs current limiter to match with the user requirements.

DSS property name: AmpLimitGain, DSS property index: 50.

Balanced: bool

‘property(…)’

{Yes | No*} Default is No. Force balanced current only for 3-phase PVSystems. Forces zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 21.

BaseFreq: float

‘property(…)’

Base Frequency for ratings.

DSS property name: BaseFreq, DSS property index: 52.

Bus1: str

‘property(…)’

Bus to which the PVSystem element is connected. May include specific node specification.

DSS property name: Bus1, DSS property index: 2.

Class: int

‘property(…)’

An arbitrary integer number representing the class of PVSystem element so that PVSystem values may be segregated by class.

DSS property name: Class, DSS property index: 29.

Close(terminal: int, phase: int) → None

Close the specified terminal and phase, if non-zero, or all conductors at the terminal.

Original COM help: https://opendss.epri.com/Close1.html

ComplexSeqCurrents() → altdss.types.ComplexArray

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqCurrents.html

ComplexSeqVoltages() → altdss.types.ComplexArray

Complex double array of Sequence Voltage for all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqVoltages1.html

Conn: altdss.enums.Connection

‘property(…)’

={wye|LN|delta|LL}. Default is wye.

DSS property name: Conn, DSS property index: 9.

Conn_str: str

‘property(…)’

={wye|LN|delta|LL}. Default is wye.

DSS property name: Conn, DSS property index: 9.

ControlMode: altdss.enums.InverterControlMode

‘property(…)’

Defines the control mode for the inverter. It can be one of {GFM | GFL*}. By default it is GFL (Grid Following Inverter). Use GFM (Grid Forming Inverter) for energizing islanded microgrids, but, if the device is connected to the grid, it is highly recommended to use GFL.

GFM control mode disables any control action set by the InvControl device.

DSS property name: ControlMode, DSS property index: 48.

ControlMode_str: str

‘property(…)’

Defines the control mode for the inverter. It can be one of {GFM | GFL*}. By default it is GFL (Grid Following Inverter). Use GFM (Grid Forming Inverter) for energizing islanded microgrids, but, if the device is connected to the grid, it is highly recommended to use GFL.

GFM control mode disables any control action set by the InvControl device.

DSS property name: ControlMode, DSS property index: 48.

Currents() → altdss.types.ComplexArray

Complex array of currents into each conductor of each terminal

Original COM help: https://opendss.epri.com/Currents1.html

Daily: altdss.LoadShape.LoadShape

‘property(…)’

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Daily, DSS property index: 24.

Daily_str: str

‘property(…)’

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Daily, DSS property index: 24.

DebugTrace: bool

‘property(…)’

{Yes | No } Default is no. Turn this on to capture the progress of the PVSystem model for each iteration. Creates a separate file for each PVSystem element named “PVSystem_name.csv”.

DSS property name: DebugTrace, DSS property index: 32.

DisplayName: str

‘property(…)’

Display name of the object (not necessarily unique)

Original COM help: https://opendss.epri.com/DisplayName.html

Duty: altdss.LoadShape.LoadShape

‘property(…)’

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: Duty, DSS property index: 25.

DutyStart: float

‘property(…)’

Starting time offset [hours] into the duty cycle shape for this PVSystem, defaults to 0

DSS property name: DutyStart, DSS property index: 34.

Duty_str: str

‘property(…)’

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: Duty, DSS property index: 25.

DynOut: List[str]

‘property(…)’

The name of the variables within the Dynamic equation that will be used to govern the PVSystem dynamics. This PVsystem model requires 1 output from the dynamic equation:

1. Current.

The output variables need to be defined in the same order.

DSS property name: DynOut, DSS property index: 47.

DynamicEq: altdss.DynamicExp.DynamicExp

‘property(…)’

The name of the dynamic equation (DynamicExp) that will be used for defining the dynamic behavior of the generator. If not defined, the generator dynamics will follow the built-in dynamic equation.

DSS property name: DynamicEq, DSS property index: 46.

DynamicEq_str: str

‘property(…)’

The name of the dynamic equation (DynamicExp) that will be used for defining the dynamic behavior of the generator. If not defined, the generator dynamics will follow the built-in dynamic equation.

DSS property name: DynamicEq, DSS property index: 46.

EffCurve: altdss.XYcurve.XYcurve

‘property(…)’

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14.

EffCurve_str: str

‘property(…)’

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14.

Enabled: bool

‘property(…)’

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: Enabled, DSS property index: 53.

EnergyMeter() → altdss.DSSObj.DSSObj

Energy Meter this element is assigned to.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/EnergyMeter.html

EnergyMeterName() → str

Name of the Energy Meter this element is assigned to.

Requires an energy meter with an updated zone.

Original COM help: https://opendss.epri.com/EnergyMeter.html

FullName() → str

GUID() → str

Object’s GUID/UUID. Currently used only in the CIM-related methods.

Original COM help: https://opendss.epri.com/GUID.html

GetVariableValue(varIdxName: Union[AnyStr, int]) → float

Handle() → int

Index of this element into the circuit’s element list.

Original COM help: https://opendss.epri.com/Handle.html

HasOCPDevice() → bool

Returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

Original COM help: https://opendss.epri.com/HasOCPDevice.html

HasSwitchControl() → bool

Returns true if the element has a SwtControl attached.

Original COM help: https://opendss.epri.com/HasSwitchControl.html

HasVoltControl() → bool

Returns true if the element has a CapControl or RegControl attached.

Original COM help: https://opendss.epri.com/HasVoltControl.html

Irradiance: float

‘property(…)’

Get/set the present irradiance value in kW/sq-m. Used as base value for shape multipliers. Generally entered as peak value for the time period of interest and the yearly, daily, and duty load shape objects are defined as per unit multipliers (just like Loads/Generators).

DSS property name: Irradiance, DSS property index: 4.

IsIsolated() → bool

Returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

IsOpen(terminal: int, phase: int) → bool

Returns true if the specified terminal and phase are open.

If the phase parameter is zero, returns if any conductor at the terminal is open.

Kp: float

‘property(…)’

It is the proportional gain for the PI controller within the inverter. Use it to modify the controller response in dynamics simulation mode.

DSS property name: Kp, DSS property index: 42.

Like(value: AnyStr)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 54.

LimitCurrent: bool

‘property(…)’

Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSystems similar to Generator Model 7. For 3-phase, limits the positive-sequence current but not the negative-sequence.

DSS property name: LimitCurrent, DSS property index: 22.

Losses() → complex

Total (complex) losses in the element, in VA (watts, vars)

Original COM help: https://opendss.epri.com/Losses1.html

MaxCurrent(terminal: int) → float

Returns the maximum current (magnitude) at the specified terminal. Use -1 as terminal to get the value across all terminals.

Model: altdss.enums.PVSystemModel

‘property(…)’

Integer code (default=1) for the model to use for power output variation with voltage. Valid values are:

1:PVSystem element injects a CONSTANT kW at specified power factor. 2:PVSystem element is modeled as a CONSTANT ADMITTANCE. 3:Compute load injection from User-written Model.

DSS property name: Model, DSS property index: 18.

property Name: str

NodeOrder() → altdss.types.Int32Array

Array of integer containing the node numbers (representing phases, for example) for each conductor of each terminal.

Be sure to run a solution to initialize the values after the circuit is created or modified.

NodeRef() → altdss.types.Int32Array

Array of integers, a copy of the internal NodeRef of the CktElement.

Be sure to run a solution to initialize the values after the circuit is created or modified.

NumConductors() → int

Number of conductors per terminal

Original COM help: https://opendss.epri.com/NumConductors.html

NumControllers() → int

Number of controllers connected to this device.

Original COM help: https://opendss.epri.com/NumControls.html

NumPhases() → int

Number of phases

Original COM help: https://opendss.epri.com/NumPhases.html

NumTerminals() → int

Number of terminals in this circuit element

Original COM help: https://opendss.epri.com/NumTerminals.html

OCPDevice() → Union[altdss.DSSObj.DSSObj, None]

Returns (as a Python object) the OCP device controlling this element, if any.

OCPDeviceIndex() → int

Index into controller list of OCP Device controlling this circuit element

Original COM help: https://opendss.epri.com/OCPDevIndex.html

OCPDeviceType() → dss.enums.OCPDevType

Type of OCP controller device

Original COM help: https://opendss.epri.com/OCPDevType.html

Open(terminal: int, phase: int) → None

Open the specified terminal and phase, if non-zero, or all conductors at the terminal.

Original COM help: https://opendss.epri.com/Open1.html

PF: float

‘property(…)’

Nominally, the power factor for the output power. Default is 1.0. Setting this property will cause the inverter to operate in constant power factor mode.Enter negative when kW and kvar have opposite signs. A positive power factor signifies that the PVSystem element produces vars as is typical for a generator.

DSS property name: PF, DSS property index: 8.

PFPriority: bool

‘property(…)’

{Yes/No*/True/False} Set inverter to operate with PF priority when in constant PF mode. If “Yes”, value assigned to “WattPriority” is neglected. If controlled by an InvControl with either Volt-Var or DRC or both functions activated, PF priority is neglected and “WattPriority” is considered. Default = No.

DSS property name: PFPriority, DSS property index: 36.

PITol: float

‘property(…)’

It is the tolerance (%) for the closed loop controller of the inverter. For dynamics simulation mode.

DSS property name: PITol, DSS property index: 43.

PTCurve: altdss.XYcurve.XYcurve

‘property(…)’

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15.

PTCurve_str: str

‘property(…)’

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15.

PhaseLosses() → altdss.types.ComplexArray

Complex array of losses (kVA) by phase

Original COM help: https://opendss.epri.com/PhaseLosses.html

Phases: int

‘property(…)’

Number of Phases, this PVSystem element. Power is evenly divided among phases.

DSS property name: Phases, DSS property index: 1.

Pmpp: float

‘property(…)’

Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance and a user-selected array temperature. The P-TCurve should be defined relative to the selected array temperature.

DSS property name: Pmpp, DSS property index: 5.

Powers() → altdss.types.ComplexArray

Complex array of powers (kVA) into each conductor of each terminal

Original COM help: https://opendss.epri.com/Powers.html

RegisterNames() → List[str]

List of names of the energy meter registers for this element.

See also the enums EnergyMeterRegisters and GeneratorRegisters.

RegisterValues() → altdss.types.Float64Array

Array of values in this element’s energy meter registers.

Original COM help: https://opendss.epri.com/RegisterValues.html

RegistersDict() → Dict[str, float]

Convenience function: returns a dict of the element’s energy meter register names mapping to their current values.

Residuals() → altdss.types.Float64Array

Residual currents for each terminal: (magnitude, angle in degrees)

Original COM help: https://opendss.epri.com/Residuals.html

SafeMode: bool

‘property(…)’

(Read only) Indicates whether the inverter entered (Yes) or not (No) into Safe Mode.

DSS property name: SafeMode, DSS property index: 45.

SafeVoltage: float

‘property(…)’

Indicates the voltage level (%) respect to the base voltage level for which the Inverter will operate. If this threshold is violated, the Inverter will enter safe mode (OFF). For dynamic simulation. By default is 80%

DSS property name: SafeVoltage, DSS property index: 44.

SeqCurrents() → altdss.types.Float64Array

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqCurrents.html

SeqPowers() → altdss.types.ComplexArray

Complex array of sequence powers (kW, kvar) into each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqPowers.html

SeqVoltages() → altdss.types.Float64Array

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqVoltages1.html

SetVariableValue(varIdxName: Union[AnyStr, int], value: float)

Spectrum: altdss.Spectrum.Spectrum

‘property(…)’

Name of harmonic voltage or current spectrum for this PVSystem element. A harmonic voltage source is assumed for the inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: Spectrum, DSS property index: 51.

Spectrum_str: str

‘property(…)’

Name of harmonic voltage or current spectrum for this PVSystem element. A harmonic voltage source is assumed for the inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: Spectrum, DSS property index: 51.

TDaily: altdss.TShape.TShape

‘property(…)’

Temperature shape to use for daily simulations. Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDaily, DSS property index: 27.

TDaily_str: str

‘property(…)’

Temperature shape to use for daily simulations. Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDaily, DSS property index: 27.

TDuty: altdss.TShape.TShape

‘property(…)’

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDuty, DSS property index: 28.

TDuty_str: str

‘property(…)’

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDuty, DSS property index: 28.

TYearly: altdss.TShape.TShape

‘property(…)’

Temperature shape to use for yearly simulations. Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TYearly, DSS property index: 26.

TYearly_str: str

‘property(…)’

Temperature shape to use for yearly simulations. Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TYearly, DSS property index: 26.

Temperature: float

‘property(…)’

Get/set the present Temperature. Used as fixed value corresponding to PTCurve property. A multiplier is obtained from the Pmpp-Temp curve and applied to the nominal Pmpp from the irradiance to determine the net array output.

DSS property name: Temperature, DSS property index: 7.

TotalPowers() → altdss.types.ComplexArray

Returns an array with the total powers (complex, kVA) at ALL terminals of the active circuit element.

Original COM help: https://opendss.epri.com/TotalPowers.html

UserData: str

‘property(…)’

String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model.

DSS property name: UserData, DSS property index: 31.

UserModel: str

‘property(…)’

Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 30.

VMaxpu: float

‘property(…)’

Default = 1.10. Maximum per unit voltage for which the Model is assumed to apply. Above this value, the load model reverts to a constant impedance model.

DSS property name: VMaxpu, DSS property index: 20.

VMinpu: float

‘property(…)’

Default = 0.90. Minimum per unit voltage for which the Model is assumed to apply. Below this value, the load model reverts to a constant impedance model except for Dynamics model. In Dynamics mode, the current magnitude is limited to the value the power flow would compute for this voltage.

DSS property name: VMinpu, DSS property index: 19.

VarFollowInverter: bool

‘property(…)’

Boolean variable (Yes|No) or (True|False). Defaults to False which indicates that the reactive power generation/absorption does not respect the inverter status.When set to True, the PVSystem reactive power generation/absorption will cease when the inverter status is off, due to panel kW dropping below %Cutout. The reactive power generation/absorption will begin again when the panel kW is above %Cutin. When set to False, the PVSystem will generate/absorb reactive power regardless of the status of the inverter.

DSS property name: VarFollowInverter, DSS property index: 33.

VariableNames() → List[str]

VariableValues() → altdss.types.Float64Array

VariablesDict() → Dict[str, float]

Voltages() → altdss.types.ComplexArray

Complex array of voltages at terminals

Original COM help: https://opendss.epri.com/Voltages1.html

VoltagesMagAng() → altdss.types.Float64Array

Voltages at each conductor in magnitude, angle form as array of doubles.

Original COM help: https://opendss.epri.com/VoltagesMagAng.html

WattPriority: bool

‘property(…)’

{Yes/No*/True/False} Set inverter to watt priority instead of the default var priority

DSS property name: WattPriority, DSS property index: 35.

YPrim() → altdss.types.ComplexArray

YPrim matrix, column order, complex numbers

Original COM help: https://opendss.epri.com/Yprim.html

Yearly: altdss.LoadShape.LoadShape

‘property(…)’

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Yearly, DSS property index: 23.

Yearly_str: str

‘property(…)’

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Yearly, DSS property index: 23.

__hash__()

Return hash(self).

__init__(api_util, ptr)

__ne__(other)

Return self!=value.

__repr__()

Return repr(self).

begin_edit() → None

Marks a DSS object for editing

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.PVSystem.PVSystemProperties]) → altdss.PVSystem.PVSystem

Edit this PVSystem.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS Edit command.

Parameters:

**kwargs – Pass keyword arguments equivalent to the DSS properties of the object.

Returns:

Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None

Leaves the editing state of a DSS object

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

kV: float

‘property(…)’

Nominal rated (1.0 per unit) voltage, kV, for PVSystem element. For 2- and 3-phase PVSystem elements, specify phase-phase kV. Otherwise, specify actual kV across each branch of the PVSystem element. If 1-phase wye (star or LN), specify phase-neutral kV. If 1-phase delta or phase-phase connected, specify phase-phase kV.

DSS property name: kV, DSS property index: 3.

kVA: float

‘property(…)’

kVA rating of inverter. Used as the base for Dynamics mode and Harmonics mode values.

DSS property name: kVA, DSS property index: 11.

kVDC: float

‘property(…)’

Indicates the rated voltage (kV) at the input of the inverter at the peak of PV energy production. The value is normally greater or equal to the kV base of the PV system. It is used for dynamics simulation ONLY.

DSS property name: kVDC, DSS property index: 41.

kvar: float

‘property(…)’

Get/set the present kvar value. Setting this property forces the inverter to operate in constant kvar mode.

DSS property name: kvar, DSS property index: 10.

kvarMax: float

‘property(…)’

Indicates the maximum reactive power GENERATION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). Defaults to kVA rating of the inverter.

DSS property name: kvarMax, DSS property index: 39.

kvarMaxAbs: float

‘property(…)’

Indicates the maximum reactive power ABSORPTION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). Defaults to kVA rating of the inverter.

DSS property name: kvarMaxAbs, DSS property index: 40.

pctCutIn: float

‘property(…)’

DSS property name: %CutIn, DSS property index: 12.

pctCutOut: float

‘property(…)’

DSS property name: %CutOut, DSS property index: 13.

pctPMinNoVars: float

‘property(…)’

Minimum active power as percentage of Pmpp under which there is no vars production/absorption.

DSS property name: %PMinNoVars, DSS property index: 37.

pctPMinkvarMax: float

‘property(…)’

Minimum active power as percentage of Pmpp that allows the inverter to produce/absorb reactive power up to its kvarMax or kvarMaxAbs.

DSS property name: %PMinkvarMax, DSS property index: 38.

pctPmpp: float

‘property(…)’

Upper limit on active power as a percentage of Pmpp.

DSS property name: %Pmpp, DSS property index: 6.

pctR: float

‘property(…)’

Equivalent percent internal resistance, ohms. Default is 50%. Placed in series with internal voltage source for harmonics and dynamics modes. (Limits fault current to about 2 pu if not current limited – see LimitCurrent)

DSS property name: %R, DSS property index: 16.

pctX: float

‘property(…)’

Equivalent percent internal reactance, ohms. Default is 0%. Placed in series with internal voltage source for harmonics and dynamics modes.

DSS property name: %X, DSS property index: 17.

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns an element’s data as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features.

By default (options = 0), only the properties explicitly set. The properties are returned in the order they are set in the input. As a reminder, OpenDSS is sensitive to the order of the properties.

The options bit-flags are available in the DSSJSONFlags enum. Values used by this function are:

• Full: if set, all properties are returned, ordered by property index instead.

• SkipRedundant: if used with Full, all properties except redundant and unused ones are returned.

• EnumAsInt: enumerated properties are returned as integer values instead of strings.

• FullNames: any element reference will use the full name ({class name}.{element name}) even if not required.

• Pretty: more whitespace is used in the output for a “prettier” format.

• SkipDSSClass: do not add the “DSSClass” property to the JSON objects.

NOT IMPLEMENTED YET:

• State: include run-time state information

• Debug: include debug information

Other bit-flags are reserved for future uses. Please use DSSJSONFlags enum to avoid potential conflicts.

(API Extension)

class altdss.PVSystem.PVSystemBatch(api_util, **kwargs)

Bases: altdss.Batch.DSSBatch, altdss.CircuitElement.CircuitElementBatchMixin, altdss.PCElement.PCElementBatchMixin

AmpLimit: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

The current limiter per phase for the IBR when operating in GFM mode. This limit is imposed to prevent the IBR to enter into Safe Mode when reaching the IBR power ratings. Once the IBR reaches this value, it remains there without moving into Safe Mode. This value needs to be set lower than the IBR Amps rating.

DSS property name: AmpLimit, DSS property index: 49.

AmpLimitGain: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Use it for fine tunning the current limiter when active, by default is 0.8, it has to be a value between 0.1 and 1. This value allows users to fine tune the IBRs current limiter to match with the user requirements.

DSS property name: AmpLimitGain, DSS property index: 50.

Balanced: List[bool]

‘property(…)’

{Yes | No*} Default is No. Force balanced current only for 3-phase PVSystems. Forces zero- and negative-sequence to zero.

DSS property name: Balanced, DSS property index: 21.

BaseFreq: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Base Frequency for ratings.

DSS property name: BaseFreq, DSS property index: 52.

Bus1: List[str]

‘property(…)’

Bus to which the PVSystem element is connected. May include specific node specification.

DSS property name: Bus1, DSS property index: 2.

Class: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

An arbitrary integer number representing the class of PVSystem element so that PVSystem values may be segregated by class.

DSS property name: Class, DSS property index: 29.

ComplexSeqCurrents() → altdss.types.ComplexArray

Complex double array of Sequence Currents for all conductors of all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqCurrents.html

ComplexSeqVoltages() → altdss.types.ComplexArray

Complex double array of Sequence Voltage for all terminals of active circuit element.

Original COM help: https://opendss.epri.com/CplxSeqVoltages1.html

Conn: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

={wye|LN|delta|LL}. Default is wye.

DSS property name: Conn, DSS property index: 9.

Conn_str: List[str]

‘property(…)’

={wye|LN|delta|LL}. Default is wye.

DSS property name: Conn, DSS property index: 9.

ControlMode: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

Defines the control mode for the inverter. It can be one of {GFM | GFL*}. By default it is GFL (Grid Following Inverter). Use GFM (Grid Forming Inverter) for energizing islanded microgrids, but, if the device is connected to the grid, it is highly recommended to use GFL.

GFM control mode disables any control action set by the InvControl device.

DSS property name: ControlMode, DSS property index: 48.

ControlMode_str: List[str]

‘property(…)’

Defines the control mode for the inverter. It can be one of {GFM | GFL*}. By default it is GFL (Grid Following Inverter). Use GFM (Grid Forming Inverter) for energizing islanded microgrids, but, if the device is connected to the grid, it is highly recommended to use GFL.

GFM control mode disables any control action set by the InvControl device.

DSS property name: ControlMode, DSS property index: 48.

Currents() → altdss.types.ComplexArray

Complex array of currents into each conductor of each terminal

Original COM help: https://opendss.epri.com/Currents1.html

CurrentsMagAng() → altdss.types.Float64Array

Currents in magnitude, angle (degrees) format as a array of doubles.

Original COM help: https://opendss.epri.com/CurrentsMagAng.html

Daily: List[altdss.LoadShape.LoadShape]

‘property(…)’

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Daily, DSS property index: 24.

Daily_str: List[str]

‘property(…)’

Dispatch shape to use for daily simulations. Must be previously defined as a Loadshape object of 24 hrs, typically. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Daily, DSS property index: 24.

DebugTrace: List[bool]

‘property(…)’

{Yes | No } Default is no. Turn this on to capture the progress of the PVSystem model for each iteration. Creates a separate file for each PVSystem element named “PVSystem_name.csv”.

DSS property name: DebugTrace, DSS property index: 32.

Duty: List[altdss.LoadShape.LoadShape]

‘property(…)’

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: Duty, DSS property index: 25.

DutyStart: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Starting time offset [hours] into the duty cycle shape for this PVSystem, defaults to 0

DSS property name: DutyStart, DSS property index: 34.

Duty_str: List[str]

‘property(…)’

Load shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a Loadshape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat.

DSS property name: Duty, DSS property index: 25.

DynOut: List[List[str]]

‘property(…)’

The name of the variables within the Dynamic equation that will be used to govern the PVSystem dynamics. This PVsystem model requires 1 output from the dynamic equation:

1. Current.

The output variables need to be defined in the same order.

DSS property name: DynOut, DSS property index: 47.

DynamicEq: List[altdss.DynamicExp.DynamicExp]

‘property(…)’

The name of the dynamic equation (DynamicExp) that will be used for defining the dynamic behavior of the generator. If not defined, the generator dynamics will follow the built-in dynamic equation.

DSS property name: DynamicEq, DSS property index: 46.

DynamicEq_str: List[str]

‘property(…)’

The name of the dynamic equation (DynamicExp) that will be used for defining the dynamic behavior of the generator. If not defined, the generator dynamics will follow the built-in dynamic equation.

DSS property name: DynamicEq, DSS property index: 46.

EffCurve: List[altdss.XYcurve.XYcurve]

‘property(…)’

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14.

EffCurve_str: List[str]

‘property(…)’

An XYCurve object, previously defined, that describes the PER UNIT efficiency vs PER UNIT of rated kVA for the inverter. Inverter output power is discounted by the multiplier obtained from this curve.

DSS property name: EffCurve, DSS property index: 14.

Enabled: List[bool]

‘property(…)’

{Yes|No or True|False} Indicates whether this element is enabled.

DSS property name: Enabled, DSS property index: 53.

EnergyMeter() → List[altdss.DSSObj.DSSObj]

EnergyMeterName() → List[str]

FullName() → List[str]

Returns the full name (including object type) for all objects in this batch

GUID() → List[str]

GUID/UUID for each object. Currently used only in the CIM-related methods.

Original COM help: https://opendss.epri.com/GUID.html

Handle() → altdss.types.Int32Array

Index of each element into the circuit’s element list.

Original COM help: https://opendss.epri.com/Handle.html

HasOCPDevice() → altdss.types.BoolArray

For each element in the batch: returns true if a recloser, relay, or fuse controlling the circuit element.

OCP = Overcurrent Protection

Original COM help: https://opendss.epri.com/HasOCPDevice.html

HasSwitchControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a SwtControl attached.

Original COM help: https://opendss.epri.com/HasSwitchControl.html

HasVoltControl() → altdss.types.BoolArray

For each element in the batch: returns true if the element has a CapControl or RegControl attached.

Original COM help: https://opendss.epri.com/HasVoltControl.html

Irradiance: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the present irradiance value in kW/sq-m. Used as base value for shape multipliers. Generally entered as peak value for the time period of interest and the yearly, daily, and duty load shape objects are defined as per unit multipliers (just like Loads/Generators).

DSS property name: Irradiance, DSS property index: 4.

IsIsolated() → altdss.types.BoolArray

For each element in the batch: returns true if the element is isolated. Note that this only fetches the current value. See also the Topology interface.

Kp: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

It is the proportional gain for the PI controller within the inverter. Use it to modify the controller response in dynamics simulation mode.

DSS property name: Kp, DSS property index: 42.

Like(value: AnyStr, flags: altdss.enums.SetterFlags = 0)

Make like another object, e.g.:

New Capacitor.C2 like=c1 …

DSS property name: Like, DSS property index: 54.

LimitCurrent: List[bool]

‘property(…)’

Limits current magnitude to Vminpu value for both 1-phase and 3-phase PVSystems similar to Generator Model 7. For 3-phase, limits the positive-sequence current but not the negative-sequence.

DSS property name: LimitCurrent, DSS property index: 22.

Losses() → altdss.types.ComplexArray

For each element in the batch: total losses in the element, in VA (watts, vars).

Original COM help: https://opendss.epri.com/Losses1.html

MaxCurrent(terminal: int) → altdss.types.Float64Array

Returns the maximum current (magnitude) at the specified terminal for each element in this batch. Use -1 as terminal to get the value across all terminals.

Model: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

Integer code (default=1) for the model to use for power output variation with voltage. Valid values are:

1:PVSystem element injects a CONSTANT kW at specified power factor. 2:PVSystem element is modeled as a CONSTANT ADMITTANCE. 3:Compute load injection from User-written Model.

DSS property name: Model, DSS property index: 18.

property Name: List[str]

NumConductors() → altdss.types.Int32Array

Number of conductors per terminal for each element in the batch.

Original COM help: https://opendss.epri.com/NumConductors.html

NumControllers() → altdss.types.Int32Array

Number of controllers connected to each device in the batch.

Original COM help: https://opendss.epri.com/NumControls.html

NumPhases() → altdss.types.Int32Array

Number of Phases for each element in this batch.

Original COM help: https://opendss.epri.com/NumPhases.html

NumTerminals() → altdss.types.Int32Array

Number of terminals for each Circuit Element in the batch.

Original COM help: https://opendss.epri.com/NumTerminals.html

OCPDevice() → List[Union[altdss.DSSObj.DSSObj, None]]

Returns (as a list of Python objects) the OCP device controlling each element.

OCPDeviceIndex() → altdss.types.Int32Array

For each element in the batch: index into each controller list of the OCP Device controlling each circuit element

Original COM help: https://opendss.epri.com/OCPDevIndex.html

OCPDeviceType() → List[dss.enums.OCPDevType]

For each element in the batch: type of OCP controller device

Original COM help: https://opendss.epri.com/OCPDevType.html

PF: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Nominally, the power factor for the output power. Default is 1.0. Setting this property will cause the inverter to operate in constant power factor mode.Enter negative when kW and kvar have opposite signs. A positive power factor signifies that the PVSystem element produces vars as is typical for a generator.

DSS property name: PF, DSS property index: 8.

PFPriority: List[bool]

‘property(…)’

{Yes/No*/True/False} Set inverter to operate with PF priority when in constant PF mode. If “Yes”, value assigned to “WattPriority” is neglected. If controlled by an InvControl with either Volt-Var or DRC or both functions activated, PF priority is neglected and “WattPriority” is considered. Default = No.

DSS property name: PFPriority, DSS property index: 36.

PITol: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

It is the tolerance (%) for the closed loop controller of the inverter. For dynamics simulation mode.

DSS property name: PITol, DSS property index: 43.

PTCurve: List[altdss.XYcurve.XYcurve]

‘property(…)’

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15.

PTCurve_str: List[str]

‘property(…)’

An XYCurve object, previously defined, that describes the PV array PER UNIT Pmpp vs Temperature curve. Temperature units must agree with the Temperature property and the Temperature shapes used for simulations. The Pmpp values are specified in per unit of the Pmpp value for 1 kW/sq-m irradiance. The value for the temperature at which Pmpp is defined should be 1.0. The net array power is determined by the irradiance * Pmpp * f(Temperature)

DSS property name: P-TCurve, DSS property index: 15.

PhaseLosses() → altdss.types.ComplexArray

Complex array of losses (kVA) by phase

Original COM help: https://opendss.epri.com/PhaseLosses.html

Phases: altdss.ArrayProxy.BatchInt32ArrayProxy

‘property(…)’

Number of Phases, this PVSystem element. Power is evenly divided among phases.

DSS property name: Phases, DSS property index: 1.

Pmpp: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the rated max power of the PV array for 1.0 kW/sq-m irradiance and a user-selected array temperature. The P-TCurve should be defined relative to the selected array temperature.

DSS property name: Pmpp, DSS property index: 5.

Powers() → altdss.types.ComplexArray

Complex array of powers (kVA) into each conductor of each terminal, of each element in the batch.

Original COM help: https://opendss.epri.com/Powers.html

SafeMode: List[bool]

‘property(…)’

(Read only) Indicates whether the inverter entered (Yes) or not (No) into Safe Mode.

DSS property name: SafeMode, DSS property index: 45.

SafeVoltage: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the voltage level (%) respect to the base voltage level for which the Inverter will operate. If this threshold is violated, the Inverter will enter safe mode (OFF). For dynamic simulation. By default is 80%

DSS property name: SafeVoltage, DSS property index: 44.

SeqCurrents() → altdss.types.Float64Array

Array of symmetrical component currents (magnitudes only) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqCurrents.html

SeqPowers() → altdss.types.ComplexArray

Complex array of sequence powers (kW, kvar) into each 3-phase terminal of each element

Original COM help: https://opendss.epri.com/SeqPowers.html

SeqVoltages() → altdss.types.Float64Array

Double array of symmetrical component voltages (magnitudes only) at each 3-phase terminal

Original COM help: https://opendss.epri.com/SeqVoltages1.html

Spectrum: List[altdss.Spectrum.Spectrum]

‘property(…)’

Name of harmonic voltage or current spectrum for this PVSystem element. A harmonic voltage source is assumed for the inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: Spectrum, DSS property index: 51.

Spectrum_str: List[str]

‘property(…)’

Name of harmonic voltage or current spectrum for this PVSystem element. A harmonic voltage source is assumed for the inverter. Default value is “default”, which is defined when the DSS starts.

DSS property name: Spectrum, DSS property index: 51.

TDaily: List[altdss.TShape.TShape]

‘property(…)’

Temperature shape to use for daily simulations. Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDaily, DSS property index: 27.

TDaily_str: List[str]

‘property(…)’

Temperature shape to use for daily simulations. Must be previously defined as a TShape object of 24 hrs, typically. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDaily, DSS property index: 27.

TDuty: List[altdss.TShape.TShape]

‘property(…)’

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDuty, DSS property index: 28.

TDuty_str: List[str]

‘property(…)’

Temperature shape to use for duty cycle dispatch simulations such as for solar ramp rate studies. Must be previously defined as a TShape object. Typically would have time intervals of 1-5 seconds. Designate the number of points to solve using the Set Number=xxxx command. If there are fewer points in the actual shape, the shape is assumed to repeat. The PVSystem model uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TDuty, DSS property index: 28.

TYearly: List[altdss.TShape.TShape]

‘property(…)’

Temperature shape to use for yearly simulations. Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TYearly, DSS property index: 26.

TYearly_str: List[str]

‘property(…)’

Temperature shape to use for yearly simulations. Must be previously defined as a TShape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. The PVSystem element uses this TShape to determine the Pmpp from the Pmpp vs T curve. Units must agree with the Pmpp vs T curve.

DSS property name: TYearly, DSS property index: 26.

Temperature: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the present Temperature. Used as fixed value corresponding to PTCurve property. A multiplier is obtained from the Pmpp-Temp curve and applied to the nominal Pmpp from the irradiance to determine the net array output.

DSS property name: Temperature, DSS property index: 7.

TotalPowers() → altdss.types.ComplexArray

Returns an array with the total powers (complex, kVA) at all terminals of the circuit elements in this batch.

The resulting array is equivalent to concatenating the TotalPowers for each element.

UserData: List[str]

‘property(…)’

String (in quotes or parentheses) that gets passed to user-written model for defining the data required for that model.

DSS property name: UserData, DSS property index: 31.

UserModel: List[str]

‘property(…)’

Name of DLL containing user-written model, which computes the terminal currents for Dynamics studies, overriding the default model. Set to “none” to negate previous setting.

DSS property name: UserModel, DSS property index: 30.

VMaxpu: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Default = 1.10. Maximum per unit voltage for which the Model is assumed to apply. Above this value, the load model reverts to a constant impedance model.

DSS property name: VMaxpu, DSS property index: 20.

VMinpu: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Default = 0.90. Minimum per unit voltage for which the Model is assumed to apply. Below this value, the load model reverts to a constant impedance model except for Dynamics model. In Dynamics mode, the current magnitude is limited to the value the power flow would compute for this voltage.

DSS property name: VMinpu, DSS property index: 19.

VarFollowInverter: List[bool]

‘property(…)’

Boolean variable (Yes|No) or (True|False). Defaults to False which indicates that the reactive power generation/absorption does not respect the inverter status.When set to True, the PVSystem reactive power generation/absorption will cease when the inverter status is off, due to panel kW dropping below %Cutout. The reactive power generation/absorption will begin again when the panel kW is above %Cutin. When set to False, the PVSystem will generate/absorb reactive power regardless of the status of the inverter.

DSS property name: VarFollowInverter, DSS property index: 33.

Voltages() → altdss.types.ComplexArray

Complex array of voltages at terminals

Original COM help: https://opendss.epri.com/Voltages1.html

VoltagesMagAng() → altdss.types.Float64Array

Voltages at each conductor in magnitude, angle form as array of doubles.

Original COM help: https://opendss.epri.com/VoltagesMagAng.html

WattPriority: List[bool]

‘property(…)’

{Yes/No*/True/False} Set inverter to watt priority instead of the default var priority

DSS property name: WattPriority, DSS property index: 35.

Yearly: List[altdss.LoadShape.LoadShape]

‘property(…)’

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Yearly, DSS property index: 23.

Yearly_str: List[str]

‘property(…)’

Dispatch shape to use for yearly simulations. Must be previously defined as a Loadshape object. If this is not specified, the Daily dispatch shape, if any, is repeated during Yearly solution modes. In the default dispatch mode, the PVSystem element uses this loadshape to trigger State changes.

DSS property name: Yearly, DSS property index: 23.

__call__()

__getitem__(idx0) → altdss.DSSObj.DSSObj

Get element at 0-based index of the batch pointer array

__init__(api_util, **kwargs)

__iter__()

__len__() → int

batch(**kwargs) → altdss.Batch.DSSBatch

Filter a batch using integer or float DSS properties, returning a new batch.

For integers, provide a single value to match.

For floats, provide a range as a 2-valued tuple/list (min value, max value), or an exact value to value (not recommended).

Multiple properties can be listed to allow filtering various conditions.

Example for loads:

    # Create an initial batch using a regular expression
    abc_loads = altdss.Load.batch(re=r'^abc.*$') # a batch of all loads with names starting with "abc"
    abc_loads_filtered = abc_loads.batch(Class=1, Phases=1, kV=(0.1, 1.0))

    # Create an initial batch, already filtered
    abc_loads_filtered = altdss.Load.batch(re=r'^abc.*$', Class=1, Phases=1, kV=(0.1, 1.0))

begin_edit() → None

Marks for editing all DSS objects in the batch

In the editing mode, some final side-effects of changing properties are postponed until end_edit is called. This side-effects can be somewhat costly, like updating the model parameters or internal matrices.

If you don’t have any performance constraint, you may edit each property individually without worrying about using begin_edit and end_edit. For convenience, those are emitted automatically when editing single properties outside an edit block.

edit(**kwargs: typing_extensions.Unpack[altdss.PVSystem.PVSystemBatchProperties]) → altdss.PVSystem.PVSystemBatch

Edit this PVSystem batch.

This method will try to open a new edit context (if not already open), edit the properties, and finalize the edit context for objects in the batch. It can be seen as a shortcut to manually setting each property, or a Pythonic analogous (but extended) to the DSS BatchEdit command.

Parameters:

**kwargs – Pass keyword arguments equivalent to the DSS properties of the objects.

Returns:

Returns itself to allow call chaining.

end_edit(num_changes: int = 1) → None

Leaves the editing states of all DSS objects in the batch

num_changes is required for a few classes to correctly match the official OpenDSS behavior and must be the number of properties modified in the current editing block. As of DSS C-API v0.13, this is only required for the Monitor class, when the Action property is used with the Process value.

kV: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Nominal rated (1.0 per unit) voltage, kV, for PVSystem element. For 2- and 3-phase PVSystem elements, specify phase-phase kV. Otherwise, specify actual kV across each branch of the PVSystem element. If 1-phase wye (star or LN), specify phase-neutral kV. If 1-phase delta or phase-phase connected, specify phase-phase kV.

DSS property name: kV, DSS property index: 3.

kVA: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

kVA rating of inverter. Used as the base for Dynamics mode and Harmonics mode values.

DSS property name: kVA, DSS property index: 11.

kVDC: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the rated voltage (kV) at the input of the inverter at the peak of PV energy production. The value is normally greater or equal to the kV base of the PV system. It is used for dynamics simulation ONLY.

DSS property name: kVDC, DSS property index: 41.

kvar: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Get/set the present kvar value. Setting this property forces the inverter to operate in constant kvar mode.

DSS property name: kvar, DSS property index: 10.

kvarMax: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the maximum reactive power GENERATION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). Defaults to kVA rating of the inverter.

DSS property name: kvarMax, DSS property index: 39.

kvarMaxAbs: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Indicates the maximum reactive power ABSORPTION (un-signed numerical variable in kvar) for the inverter (as an un-signed value). Defaults to kVA rating of the inverter.

DSS property name: kvarMaxAbs, DSS property index: 40.

pctCutIn: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

DSS property name: %CutIn, DSS property index: 12.

pctCutOut: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

DSS property name: %CutOut, DSS property index: 13.

pctPMinNoVars: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Minimum active power as percentage of Pmpp under which there is no vars production/absorption.

DSS property name: %PMinNoVars, DSS property index: 37.

pctPMinkvarMax: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Minimum active power as percentage of Pmpp that allows the inverter to produce/absorb reactive power up to its kvarMax or kvarMaxAbs.

DSS property name: %PMinkvarMax, DSS property index: 38.

pctPmpp: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Upper limit on active power as a percentage of Pmpp.

DSS property name: %Pmpp, DSS property index: 6.

pctR: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Equivalent percent internal resistance, ohms. Default is 50%. Placed in series with internal voltage source for harmonics and dynamics modes. (Limits fault current to about 2 pu if not current limited – see LimitCurrent)

DSS property name: %R, DSS property index: 16.

pctX: altdss.ArrayProxy.BatchFloat64ArrayProxy

‘property(…)’

Equivalent percent internal reactance, ohms. Default is 0%. Placed in series with internal voltage source for harmonics and dynamics modes.

DSS property name: %X, DSS property index: 17.

to_json(options: Union[int, dss.enums.DSSJSONFlags] = 0)

Returns the data (as a list) of the elements in a batch as a JSON-encoded string.

The options parameter contains bit-flags to toggle specific features. See Obj_ToJSON (C-API) for more, or DSSObj.to_json in Python.

Additionally, the ExcludeDisabled flag can be used to excluded disabled elements from the output.

to_list()

class altdss.PVSystem.PVSystemBatchProperties

Bases: typing_extensions.TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

AmpLimit: Union[float, altdss.types.Float64Array]

None

AmpLimitGain: Union[float, altdss.types.Float64Array]

None

Balanced: bool

None

BaseFreq: Union[float, altdss.types.Float64Array]

None

Bus1: Union[AnyStr, List[AnyStr]]

None

Class: Union[int, altdss.types.Int32Array]

None

Conn: Union[AnyStr, int, altdss.enums.Connection, List[AnyStr], List[int], List[altdss.enums.Connection], altdss.types.Int32Array]

None

ControlMode: Union[AnyStr, int, altdss.enums.InverterControlMode, List[AnyStr], List[int], List[altdss.enums.InverterControlMode], altdss.types.Int32Array]

None

Daily: Union[AnyStr, altdss.LoadShape.LoadShape, List[AnyStr], List[altdss.LoadShape.LoadShape]]

None

DebugTrace: bool

None

Duty: Union[AnyStr, altdss.LoadShape.LoadShape, List[AnyStr], List[altdss.LoadShape.LoadShape]]

None

DutyStart: Union[float, altdss.types.Float64Array]

None

DynOut: List[AnyStr]

None

DynamicEq: Union[AnyStr, altdss.DynamicExp.DynamicExp, List[AnyStr], List[altdss.DynamicExp.DynamicExp]]

None

EffCurve: Union[AnyStr, altdss.XYcurve.XYcurve, List[AnyStr], List[altdss.XYcurve.XYcurve]]

None

Enabled: bool

None

Irradiance: Union[float, altdss.types.Float64Array]

None

Kp: Union[float, altdss.types.Float64Array]

None

Like: AnyStr

None

LimitCurrent: bool

None

Model: Union[int, altdss.enums.PVSystemModel, altdss.types.Int32Array]

None

PF: Union[float, altdss.types.Float64Array]

None

PFPriority: bool

None

PITol: Union[float, altdss.types.Float64Array]

None

PTCurve: Union[AnyStr, altdss.XYcurve.XYcurve, List[AnyStr], List[altdss.XYcurve.XYcurve]]

None

Phases: Union[int, altdss.types.Int32Array]

None

Pmpp: Union[float, altdss.types.Float64Array]

None

SafeMode: bool

None

SafeVoltage: Union[float, altdss.types.Float64Array]

None

Spectrum: Union[AnyStr, altdss.Spectrum.Spectrum, List[AnyStr], List[altdss.Spectrum.Spectrum]]

None

TDaily: Union[AnyStr, altdss.TShape.TShape, List[AnyStr], List[altdss.TShape.TShape]]

None

TDuty: Union[AnyStr, altdss.TShape.TShape, List[AnyStr], List[altdss.TShape.TShape]]

None

TYearly: Union[AnyStr, altdss.TShape.TShape, List[AnyStr], List[altdss.TShape.TShape]]

None

Temperature: Union[float, altdss.types.Float64Array]

None

UserData: Union[AnyStr, List[AnyStr]]

None

UserModel: Union[AnyStr, List[AnyStr]]

None

VMaxpu: Union[float, altdss.types.Float64Array]

None

VMinpu: Union[float, altdss.types.Float64Array]

None

VarFollowInverter: bool

None

WattPriority: bool

None

Yearly: Union[AnyStr, altdss.LoadShape.LoadShape, List[AnyStr], List[altdss.LoadShape.LoadShape]]

None

__contains__()

True if the dictionary has the specified key, else False.

__delattr__()

Implement delattr(self, name).

__delitem__()

Delete self[key].

__dir__()

Default dir() implementation.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getitem__()

Return self[key].

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__init__()

Initialize self. See help(type(self)) for accurate signature.

__ior__()

Return self|=value.

__iter__()

Implement iter(self).

__le__()

Return self<=value.

__len__()

Return len(self).

__lt__()

Return self<value.

__ne__()

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__or__()

Return self|value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__reversed__()

Return a reverse iterator over the dict keys.

__ror__()

Return value|self.

__setitem__()

Set self[key] to value.

__sizeof__()

D.sizeof() -> size of D in memory, in bytes

__str__()

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.subclasscheck(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

clear()

D.clear() -> None. Remove all items from D.

copy()

D.copy() -> a shallow copy of D

get()

Return the value for key if key is in the dictionary, else default.

items()

D.items() -> a set-like object providing a view on D’s items

kV: Union[float, altdss.types.Float64Array]

None

kVA: Union[float, altdss.types.Float64Array]

None

kVDC: Union[float, altdss.types.Float64Array]

None

keys()

D.keys() -> a set-like object providing a view on D’s keys

kvar: Union[float, altdss.types.Float64Array]

None

kvarMax: Union[float, altdss.types.Float64Array]

None

kvarMaxAbs: Union[float, altdss.types.Float64Array]

None

pctCutIn: Union[float, altdss.types.Float64Array]

None

pctCutOut: Union[float, altdss.types.Float64Array]

None

pctPMinNoVars: Union[float, altdss.types.Float64Array]

None

pctPMinkvarMax: Union[float, altdss.types.Float64Array]

None

pctPmpp: Union[float, altdss.types.Float64Array]

None

pctR: Union[float, altdss.types.Float64Array]

None

pctX: Union[float, altdss.types.Float64Array]

None

pop()

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault()

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update()

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

D.values() -> an object providing a view on D’s values

class altdss.PVSystem.PVSystemProperties

Bases: typing_extensions.TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s (key, value) pairs dict(iterable) -> new dictionary initialized as if via: d = {} for k, v in iterable: d[k] = v dict(**kwargs) -> new dictionary initialized with the name=value pairs in the keyword argument list. For example: dict(one=1, two=2)

AmpLimit: float

None

AmpLimitGain: float

None

Balanced: bool

None

BaseFreq: float

None

Bus1: AnyStr

None

Class: int

None

Conn: Union[AnyStr, int, altdss.enums.Connection]

None

ControlMode: Union[AnyStr, int, altdss.enums.InverterControlMode]

None

Daily: Union[AnyStr, altdss.LoadShape.LoadShape]

None

DebugTrace: bool

None

Duty: Union[AnyStr, altdss.LoadShape.LoadShape]

None

DutyStart: float

None

DynOut: List[AnyStr]

None

DynamicEq: Union[AnyStr, altdss.DynamicExp.DynamicExp]

None

EffCurve: Union[AnyStr, altdss.XYcurve.XYcurve]

None

Enabled: bool

None

Irradiance: float

None

Kp: float

None

Like: AnyStr

None

LimitCurrent: bool

None

Model: Union[int, altdss.enums.PVSystemModel]

None

PF: float

None

PFPriority: bool

None

PITol: float

None

PTCurve: Union[AnyStr, altdss.XYcurve.XYcurve]

None

Phases: int

None

Pmpp: float

None

SafeMode: bool

None

SafeVoltage: float

None

Spectrum: Union[AnyStr, altdss.Spectrum.Spectrum]

None

TDaily: Union[AnyStr, altdss.TShape.TShape]

None

TDuty: Union[AnyStr, altdss.TShape.TShape]

None

TYearly: Union[AnyStr, altdss.TShape.TShape]

None

Temperature: float

None

UserData: AnyStr

None

UserModel: AnyStr

None

VMaxpu: float

None

VMinpu: float

None

VarFollowInverter: bool

None

WattPriority: bool

None

Yearly: Union[AnyStr, altdss.LoadShape.LoadShape]

None

__contains__()

True if the dictionary has the specified key, else False.

__delattr__()

Implement delattr(self, name).

__delitem__()

Delete self[key].

__dir__()

Default dir() implementation.

__format__()

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__()

Return self>=value.

__getattribute__()

Return getattr(self, name).

__getitem__()

Return self[key].

__getstate__()

Helper for pickle.

__gt__()

Return self>value.

__init__()

Initialize self. See help(type(self)) for accurate signature.

__ior__()

Return self|=value.

__iter__()

Implement iter(self).

__le__()

Return self<=value.

__len__()

Return len(self).

__lt__()

Return self<value.

__ne__()

Return self!=value.

__new__()

Create and return a new object. See help(type) for accurate signature.

__or__()

Return self|value.

__reduce__()

Helper for pickle.

__reduce_ex__()

Helper for pickle.

__repr__()

Return repr(self).

__reversed__()

Return a reverse iterator over the dict keys.

__ror__()

Return value|self.

__setitem__()

Set self[key] to value.

__sizeof__()

D.sizeof() -> size of D in memory, in bytes

__str__()

Return str(self).

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.subclasscheck(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

clear()

D.clear() -> None. Remove all items from D.

copy()

D.copy() -> a shallow copy of D

get()

Return the value for key if key is in the dictionary, else default.

items()

D.items() -> a set-like object providing a view on D’s items

kV: float

None

kVA: float

None

kVDC: float

None

keys()

D.keys() -> a set-like object providing a view on D’s keys

kvar: float

None

kvarMax: float

None

kvarMaxAbs: float

None

pctCutIn: float

None

pctCutOut: float

None

pctPMinNoVars: float

None

pctPMinkvarMax: float

None

pctPmpp: float

None

pctR: float

None

pctX: float

None

pop()

D.pop(k[,d]) -> v, remove specified key and return the corresponding value.

If the key is not found, return the default if given; otherwise, raise a KeyError.

popitem()

Remove and return a (key, value) pair as a 2-tuple.

Pairs are returned in LIFO (last-in, first-out) order. Raises KeyError if the dict is empty.

setdefault()

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

update()

D.update([E, ]**F) -> None. Update D from dict/iterable E and F. If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values()

D.values() -> an object providing a view on D’s values