Definitions
Work Package
A work package represents a uniquely identified time series modelling job with a specific set of configuration options.
WorkPackageConfig
A data class representing the configuration for a work package
| Property | Description | Type |
|---|---|---|
| feeders | List of feeder mRIDs for the feeders we want to model in this work package | List[String] |
| scenarios | List of scenario ids that we want apply to the feeders in this work package | List[String] |
| years | List of years to model for each scenario/feeder combination | List[Int] |
| model_config | Configuration for the OpenDSS network model generation step Refer Model Config below | Object |
| solve_config | Configuration for the OpenDSS network model solve step Refer Solve Config below | Object |
| results_config | Configuration for managing the results produced by the work package Refer Results Config below | Object |
| quality_assurance_processing | Flag to enable QA checks for the OpenDSS model | Boolean |
Model Config
A data class representing the configuration for the OpenDSS model generation in a work package
| Property | Description | Type |
|---|---|---|
| load_time | Date time range specifying the period of load data to use in the creation of the OpenDSS model | Object |
| vm_pu | Voltage per-unit of voltage source | Float |
| vmin_pu | Minimum per unit voltage for which the load model selected and generator model is assumed to apply. Below this value, the load/gen model reverts to a constant impedance model. For generator model used, this is used to determine the upper current limit. For example, if Vminpu is 0.90 then the current limit is (1/0.90) = 111% | Float |
| vmax_pu | Maximum per unit voltage for which the load model selected and generator model is assumed to apply. Above this value, the load/gen model reverts to a constant impedance model | Float |
| load_model | Specifies how loads and generators in OpenDSS should be modelled. 1: Standard constant P+jQ load (Default) 2: Constant impedance load 3: Const P, Quadratic Q (like a motor) 4: Nominal Linear P, Quadratic Q (feeder mix). Use this with CVRfactor 5: Constant Current Magnitude 6: Const P, Fixed Q, 7: Const P, Fixed Impedance Q | Int |
| collapse_swer | Whether to collapse SWER network | Boolean |
| meter_at_hv_source | Whether to place a meter at the voltage source. | Boolean |
| meters_at_dist_transformers | Whether to place a meter at the secondary winding of each distribution transformer. | Boolean |
| switch_meter_placement_configs | List of switch meter placement configuration objects that specify which switch classes to place meters at, and the regex pattern to match for in the switch names Refer Switch Meter Placement Config below | List of Objects |
| calibration | Whether to apply calibration modifications to model | Float |
TimePeriod
The time period of the load data to use in OpenDSS model.
| Property | Description | Type |
|---|---|---|
| startTime | Local date time that represents the start of the time period | Datetime |
| endTime | Local date time that represents the end of the time period | Datetime |
Switch Meter Placement Config
Specifies which switch classes to place meters at, and the regex pattern to match for in the switch names.
| Property | Description | Type |
|---|---|---|
| meterSwitchClass | Specifies the switch class to add meters to. Possible values are: 'BREAKER', 'DISCONNECTOR', 'FUSE', 'JUMPER', 'LOAD_BREAK_SWITCH', 'RECLOSER' | String |
| namePattern | Java Regex (https://www.w3schools.com/java/java_regex.asp) that the switch's ID or name must match to get a meter assigned to it | String |