Ctrl+K

dss.IPVSystems

dss.IPVSystems#

Module Contents#

Classes#

IPVSystems

API#

class dss.IPVSystems.IPVSystems(api_util)#

Bases: dss._cffi_api_util.Iterable

property AllNames: List[str]#

Array of all names of this object type

property Count: int#

Number of objects of this type

property First: int#

Sets the first object of this type active. Returns 0 if none.

property Irradiance: float#

Get/set the present value of the Irradiance property in kW/m²

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

property IrradianceNow: float#

Returns the current irradiance value for the active PVSystem. Use it to know what’s the current irradiance value for the PV during a simulation.

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

property Name: str#

Gets the current name or sets the active object of this type by name

property Next: int#

Sets next object of this type active. Returns 0 if no more.

property PF: float#

Get/set the power factor for the active PVSystem

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

property Pmpp: float#

Gets/sets the rated max power of the PV array for 1.0 kW/m² irradiance and a user-selected array temperature of the active PVSystem.

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

property RegisterNames: List[str]#

Array of PVSystem energy meter register names

See also the enum GeneratorRegisters.

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

property RegisterValues: dss._types.Float64Array#

Array of doubles containing values in PVSystem registers.

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

property Sensor: str#

Name of the sensor monitoring this element.

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

property Tdaily: str#

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.

(API Extension)

property Tduty: str#

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.

(API Extension)

property Tyearly: str#

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.

(API Extension)

__init__(api_util)#
__iter__() → Iterator[dss._cffi_api_util.Iterable]#

Get an iterator of the object collection.

Note that OpenDSS, via the classic APIs, only allow a single object of a specific type to be activated. That is, you cannot use references of distinct objects and interact with both at the same time, or keep a reference to use later. You need to reactivate the target object or ensure it is the active one.

For an alternative, consider using our AltDSS-Python package.

(API Extension)

__len__() → int#
property daily: str#

Name of the 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.

(API Extension)

property duty: str#

Name of the 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.

(API Extension)

property idx: int#

Gets the current index or sets the active object of this type by index

While the official API included this for some classes, this is an API Extension for:

  • Capacitors

  • CapControls

  • ISources

  • LineCodes

  • Lines

  • LoadShapes

  • Meters

  • Monitors

  • RegControls

  • Sensors

  • SwtControls

  • Transformers

  • Vsources

  • XYCurves

(API Extension)

property kVArated: float#

Get/set Rated kVA of the PVSystem

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

property kW: float#

Get kW output

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

property kvar: float#

Get/set kvar output value

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

property yearly: str#

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.

(API Extension)

Contents