Work Package Configuration Options
There are various elements that must be configured to successfully create an OpenDSS model from the input data, which are then used to run a Hosting Capacity Model work package. This page describes the configuration options available in running a Work Package via the Python API.
This section outlines how the Hosting Capacity Module work packages are configured. These work packages represent a 'job' within the Hosting Capacity Module, and have a defined set of scope and configuration:
The scope of the modelling to be undertaken is defined as the overall WorkPackageConfig object, which includes:
- A name for the work package
- Either a
forecast_configorfeeder_configsobject, which defines the scope of the work package in terms of:- Scenarios (in terms of the set(s) of uptake forecasts to be used)
- Years (in terms of the calendar years to model or forecast)
- Feeders (in terms of a list of feeders to model)
- A time period that defines a set of AMI/NMI load data, which is to be used as the basis for the work package and adjusted by the selected forecasts.
- A generator_config object, which defines how the underlying power flow models are to be generated and solved, including:
- Model configuration (in terms of how the power flow model is to be built, including what 'fixes' are to be applied to the model to help give better results from incomplete or inaccurate data)
- Solve configuration (in terms of how the power flow model is to be solved)
- Raw results configuration (in terms of what raw results are to be written out to storage)
- Node Level Results Config (if applicable) (in terms of what node level results are to be included during the power flow solve)
- A result_processor_config object, which defines how the results of the work package are to be processed and written out, including:
- Writer configuration, which controls what metrics are included, and how they are to be stored (although generally your administrator will have only deployed one output/storage option as part of deployment)
- Stored results configuration (in terms of what stored results are to be written out)
- Metrics configuration (in terms of what metrics are to be calculated and written out)
- A parameter called
quality_assurance_processingthat is part of the umbrella WorkPackage Config object, which is used to enable extra reporting in the raw OpenDSS file, and is only relevant in the context of the OpenDSS Exporting.
For examples, see the Hosting Capacity Runner repo.
Option Descriptions and Defaults
The default values listed below are the underlying HCM defaults, and may be overridden based on your organisation's deployment. Please check with Zepben for any questions about default values in your environment.
Work Package Config
The Work Package Config is the main configuration object that contains all the necessary configurations for running a Hosting Capacity Model work package. It includes the forecast configuration, generator configuration, result processor configuration, and quality assurance processing flag (quality_assurance_processing).
Forecast & Feeder Scope Config
These parameters define the scope of the work package — which feeders, scenarios, years, and load time period to use. Pass either a forecast_config (one set of scenarios and years applied to all feeders) or feeder_configs (individual settings per feeder) to WorkPackageInput. You cannot set both.
Note that base scenario is a hardcoded scenario that is always included in addition to any scenarios you provide in the configuration. The base scenario represents the current state of the network without any additional DER uptake, and is used as a reference point for comparing the impact of other scenarios. Do not name a scenario base as this will break things.
Reactive Power (VAr) values for loads and generators can be specified from multiple sources, including the load database, load overrides, and power factor settings. See note below for more details.
GeneratorConfig Parameters
The GeneratorConfig object is used to define the configuration for generating the power flow models. It includes the model configuration, solve configuration, raw results configuration, and optionally node level results configuration for advanced result collection capabilities.
Model Config Parameters
All parameters below are part of the same flat model config object — the groupings are for readability only.
Voltage & Load Modelling
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| load_v_min_pu | float | 0.80 | Minimum per unit voltage for which the load model selected is assumed to apply. Below this value, the load model reverts to a constant impedance model. |
| load_v_max_pu | float | 1.15 | Maximum per unit voltage for which the load model selected is assumed to apply. Above this value, the load model reverts to a constant impedance model. |
| gen_v_min_pu | float | 0.70 | Minimum per unit voltage for which the generator model selected is assumed to apply. Below this value, the generator model reverts to a constant impedance model. |
| gen_v_max_pu | float | 2.00 | Maximum per unit voltage for which the generator model selected is assumed to apply. Above this value, the generator model reverts to a constant impedance model. |
| load_model | int | 1 | Load modelling mode (1 to 7): Specifies how loads in OpenDSS should be modelled. Mode 1 is the default and is recommended. See Load Modelling Mode |
Network Topology & Power Factors
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| collapse_swer | bool | false | Flag to control the collapse of SWER networks back to their Isolation Transformers, to simplify models. When enabled, all equipment below SWER transformers (except EnergyConsumers and RegulatingCondEqs) is replaced with connectivity nodes at 250V. Phase information is lost in this process. Recommended only when SWER topology details are not needed for analysis. |
| collapse_lv_networks | bool | false | Flag to control whether to collapse Low Voltage (less than 1000V) networks below distribution transformers into single connectivity nodes. When enabled, all LV equipment except EnergyConsumers and RegulatingCondEqs is removed and replaced with a single bus. Useful for bus-branch models where LV network detail is not needed. Disable to preserve secondary feeder topology and detailed LV structure. |
| use_span_level_threshold | bool | false | Controls whether the system uses span level ratings (designedrating from CIM) or only normal current rating (ratedcurrent from CIM) values during the Rating Normalising step. Warning: When enabling this feature (setting to true), ensure you also set an appropriate rating_threshold value between 0 and 100 (e.g., 5 for 5%). |
| rating_threshold | float | null | Percentage threshold used for current rating comparisons in the network normaliser. Value should be between 0 and 100, where 5 = 5%, 12.5 = 12.5%, etc. A value of 0 (0%) finds exact matches only, while higher values allow for more network simplification and thus faster solve times. Valid range: 0.0 to 100.0 (values higher than ~10 could lead to model oversimplification). See detailed section below for more information. |
| simplify_plsi_threshold | float | null | Percentage threshold used for PerLengthSequenceImpedance (PLSI) comparisons in the network normaliser. When set, consecutive conductors with similar impedance values (r, x, r0, x0) within this percentage tolerance are grouped and normalised to a single weighted-average impedance value, reducing model complexity. Value should be between 0 and 100, where 0 finds exact matches only, 5 = 5% tolerance. Values higher than ~10 could lead to model oversimplification. Leave as null (disabled) to preserve exact impedance values from source data. Only active when simplify_network is true. See detailed section below for more information. |
| transformer_tap_settings | str | null | The name of the set of distribution transformer tap settings to be applied to the model from the Calibration results (calibrated_taps table). If null, tap settings from the network model will be applied. |
| p_factor_base_exports | float | null | Power factor for base model generators. If null the model will use the reactive power specified in the load profiles. |
| p_factor_forecast_pv | float | 1.0 | Power factor to set for scenario (forecast) model Generators during model translation. |
| p_factor_base_imports | float | null | Power factor to set for base model Loads during model translation. If null the model will use the reactive power specified in the load profiles. |
| simplify_network | bool | true | Flag to control whether the network model simplification steps will run, as configured in other parameters. If false, no network collapsing, simplifying or normalising will occur — specifically collapse_swer, collapse_lv, collapse_negligible_impedances, combine_common_impedances, and simplify_plsi_threshold will all be overridden to false. |
| collapse_negligible_impedances | bool | true | Flag to control whether to collapse conductors with negligible impedance during network simplification. When true, uses the thresholds below for HV and LV to collapse lines with very low impedance. This will speed up model solve time and decrease non-convergence risk from conductors with nonsensical impedance values. Leaving this as true is recommended. |
| negligible_impedance_min_hv_threshold | float | 0.001 | Sets the threshold, in Ohms, for negligible impedance in the HV network. Only applies when collapse_negligible_impedances = true. |
| negligible_impedance_min_lv_threshold | float | 0.0001 | Sets the threshold, in Ohms, for negligible impedance in the LV network. Only applies when collapse_negligible_impedances = true. |
| combine_common_impedances | bool | true | Flag to control whether to combine conductors with common impedance during network simplification. Leaving this as true is recommended. If false, other parameters that control common impedance collapsing will not run. |
| emerg_amp_scaling | float | 1.5 | Scaling factor for emergency current rating in lineCodes (1.5 means the emergency threshold is 150% of the normal current threshold). |
| split_phase_lvkv | float | 0.25 | Split phase LV voltage. |
| swer_voltage_to_line_voltage | List[List[int]] | [230,400] [240,415] [250,433] [6350,11000] [6400,11000] [12700,22000] [19100,33000] | Mapping of SWER voltages to line-to-line voltages. |
Auto-fix
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| fix_single_phase_loads | bool | true | When true, enables this fixer. Modest solve time impact. Finds consumers with a peak load (within the modelled time period) greater than the configured max_single_phase_load value. Upgrades these consumers to three-phase loads to correct data inaccuracies in reported phase numbers. Traces upstream to the distribution transformer and spreads 3 phases (ABCN) back to the transformer where possible. |
| max_single_phase_load | float | 30000.0 | The max peak load for a single phase customer in Watts (W), beyond which will trigger the single phase load fixing algorithm. |
| fix_overloading_consumers | bool | true | When true, enables this fixer. Modest solve time impact. Finds consumers that have peak load or generation (within the modelled time period) greater than the capacity of the transformer they are attached to by a configurable factor, and then reconfigures them to be HV consumers (attached above the transformer). The aim is to identify HV consumers that have been incorrectly connected as LV consumers, and resolve this connectivity. |
| max_load_tx_ratio | float | 3.0 | The maximum load to transformer rating ratio for a single consumer to trigger the overloading consumer fixer. For a ratio of 2, if a customer with a peak 30kW load was downstream of a 10kVA transformer, this would be a ratio of 3:1 and thus trigger the overloading consumers fixer. |
| max_gen_tx_ratio | float | 10.0 | The maximum generation to transformer rating ratio for a single consumer to trigger the overloading consumer fixer. For a ratio of 2, if a customer with peak generation of 30kW was downstream of a 10kVA transformer, this would be a ratio of 3:1 and thus trigger the overloading consumers fixer. |
| fix_undersized_service_lines | bool | true | When true, enables this fixer. Moderate solve time impact. Finds consumers that have a peak load (within the modelled time period) greater than the capacity of the service line of the consumer by a configured factor. The intent is to find service lines that have unrealistically low current ratings which would stop convergence, and upgrade them to sensible ratings. When a conductors rating is upgraded, the impedance is also upgraded to match, utilising a pre-configured catalogue of rating and impedance data, and matching the phase configuration of the consumer. |
| max_load_service_line_ratio | float | 1.5 | The maximum load to service line rating ratio to trigger the undersized service lines fixer. For example given a ratio of 2, if a customer with peak load of 10kW had a service line supporting only 5kVA, this would be a ratio of 2:1 and thus trigger the undersized service line fixer. Note: service lines are generally considered to be the conductors immediately connecting to a consumer. |
| fix_undersized_lv_lines | bool | true | When true, enables this fixer. Moderate solve time impact. Finds consumers that have a peak load (within the modelled time period) greater than the capacity of the LV conductors upstream of them by a configured factor. The intent is to find LV backbone conductors that have unrealistically low current ratings which would stop convergence, and upgrade them to sensible ratings. When a conductors rating is upgraded, the impedance is also upgraded to match, utilising a pre-configured catalogue of rating and impedance data, and matching the phase configuration of the consumer. The fixer traces upstream from the consumer up to the distribution transformer. |
| max_load_lv_line_ratio | float | 2.0 | The maximum load to LV line rating ratio to trigger the undersized service lines fixer for LV conductors. For example given a ratio of 5, if a customer with peak load of 50kW was connected to LV backbone conductors supporting only 10kVA, this would be a ratio of 5:1 and thus trigger the undersized service line fixer for the LV conductors. Note the LV line fixer will fix all conductors upstream of the consumer up to the distribution transformer they are connected to. |
Closed-Loop Voltage Control
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| closed_loop_v_reg_enabled | bool | true | Enable CLVC at zone substations. If false, existing regulators are modelled as-is using their LDC settings from the network model. Zone substations with no existing regulator will have no active voltage control. See CLVC for details. |
| closed_loop_v_reg_replace_all | bool | true | Replace all existing voltage regulators with CLVC. If false, only add CLVC where no regulator exists; existing regulators are left as-is. See CLVC for details. |
| closed_loop_v_reg_set_point | float | 0.985 | Target voltage at the sensing point as a scaling factor of nominal (e.g., 0.985 = 98.5%). Lower values increase overvoltage headroom for generation-heavy networks but may worsen undervoltage on long feeders under high load. See CLVC for details. |
| closed_loop_v_band | float | 2.0 | Deadband in percentage (e.g., 2.0 = 2%) around setpoint. Regulator takes no action while voltage remains within this band, preventing tap hunting. Tighter band = more tap operations but tighter voltage control; wider band = fewer tap operations but more voltage drift. See CLVC for details. |
| closed_loop_time_delay | int | 100 | Time in seconds voltage must remain outside deadband before a tap change is triggered. In multi-regulator systems, determines response priority: shorter delays act first. Allows upstream regulators (zone sub) to correct voltage before downstream regulators (distribution) respond, reducing unnecessary tap operations and improving system stability. |
| closed_loop_v_limit | float | 1.1 | Hard voltage ceiling in per unit (e.g., 1.1 = 110% of nominal). The regulator will act to prevent voltage from exceeding this value regardless of other settings. |
| default_tap_changer_time_delay | int | 100 | Tap changer time delay (seconds). |
| default_tap_changer_set_point_pu | float | 1.0 | Tap changer set point. |
| default_tap_changer_band | float | 2.0 | Tap changer band value. |
Load Data & Defaults
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| load_placement | LoadPlacement | PER_USAGE_POINT | Create loads per UsagePoint (PER_USAGE_POINT) or EnergyConsumer (PER_ENERGY_CONSUMER). |
| load_interval_length_hours | float | 0.5 | Load interval in fractions of an hour, 0.5 = 30 minute intervals. Leave as default, other values not supported. |
| default_load_watts | List[float] | null | A list of readings to be used as default load watts when no load data is found for a customer. Can be either a yearly or daily profile matching the configured load_interval_length_hours. |
| default_gen_watts | List[float] | null | A list of readings to be used as default gen watts when no load data is found for a customer. Can be either a yearly or daily profile matching the configured load_interval_length_hours. |
| default_load_var | List[float] | null | A list of readings to be used as default load VAr when no load data is found for a customer. Can be either a yearly or daily profile matching the configured load_interval_length_hours. |
| default_gen_var | List[float] | null | A list of readings to be used as default gen VAr when no load data is found for a customer. Can be either a yearly or daily profile matching the configured load_interval_length_hours. |
Metering & Other
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| meter_placement_config | MeterPlacementConfig | MeterPlacementConfig() | Configuration to determine where to place EnergyMeters for collecting results, see below for details. |
| inverter_control_config | PVVoltVARVoltWattConfig | null | Controls the 'Advanced PV' functions, such as Volt-VAR and Volt-Watt control modes. See detailed section below for more information. |
| feeder_scenario_allocation_strategy | str | ADDITIVE | Strategy for scenario EV, PV and BESS allocation. ADDITIVE means each year is built upon the last year's allocation, while RANDOM uses a different allocation every year. |
| seed | int | null | A seed to use when generating the model. Re-using the same seed will result in the same model being generated. This mainly controls the random scattering of DER devices such as solar and batteries within a feeder, matching the forecasts provided. |
| calibration | bool | false | Controls various properties used in the Calibration process. Will be turned on automatically during a Calibration Run, leave as false otherwise. |
| ct_prim_scaling_factor | float | null | The scaling factor to apply to the primary current of CTs in the model. This is used to adjust the primary current readings to match the expected primary current of the transformer. |
Inverter Control Config (PVVoltVARVoltWattConfig)
This feature is only available to certain customers. If you are interested in using this feature, please contact Zepben for more information.
Also note that this feature makes use of some custom OpenDSS changes, and so if exported using the OpenDSS Exporter tool may give unexpected results when run using a standard install of OpenDSS. Contact Zepben for more information.
The Inverter Control Config is used to determine how PV inverters operate within the network as part of the Advanced PV feature.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| cut_off_date | Datetime | null | Cut-off date to determine which profile to apply to equipment during translation to the OpenDSS model. If supplied, the "commissionedDate" of the equipment is compared against this date. Equipment without a "commissionedDate" will receive the before_cut_off_profile. If null, the after_cut_off_profile is applied to all equipment, installed and to-be-installed (forecast added). |
| before_cut_off_profile | string | null | Name of the profile to apply (profile_id from inverter_control_profiles table) to equipment with a "commissionedDate" before cut_off_date. If null, the equipment will be translated into a regular Generator rather than a PVSystem. |
| after_cut_off_profile | string | null | Name of the profile to apply (profile_id from inverter_control_profiles table) to equipment with a "commissionedDate" after cut_off_date. If null, the equipment will be translated into a regular Generator rather than a PVSystem. |
The commissionedDate for forecast PV systems is set via a back-end config and defaults to January 1st of the forecast year.
Meter Placement Config
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| feeder_head | bool | true | Whether to place a meter, and thus start a measurement_zone, at the voltage source at the feeder head. |
| dist_transformers | bool | true | Whether to place a meter, and thus start a measurement_zone at the secondary winding of each distribution transformer. |
| switch_meter_placement_configs | List[SwitchMeterPlacementConfig] | null | Specifies which switch classes to place meters at, and the regex pattern to match for in the switch names. See below for details. |
| energy_consumer_meter_group | str | null | The ID of the meter group to use for populating EnergyMeters at EnergyConsumers, as per the meter_group_id of the energy_consumer_meters input table. For more information, see the Energy Consumer Meters section of the Input Tables documentation. Deprecated in favour of Node Level Results |
If a downstream trace encounters an LV circuit loop (where tracing returns to the original fuse), the system detects this condition and creates the measurement_zone at the transformer only, excluding downstream fuses. This ensures consistent, reproducible measurement_zones across multiple runs.
SwitchMeterPlacementConfig
This config object is to create more granular measurement zones, such as at an LV circuit level. It is used within the MeterPlacementConfig to specify which switch classes to place meters at, and the regex pattern to match for in the switch names. This allows for more granular control over where meters are placed, for example only placing meters at disconnectors with 'Circuit Head Switch' in their name.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| meter_switch_class | SwitchClass | null | The CIM class of Switch to create meters at. Options are BREAKER, DISCONNECTOR, FUSE, JUMPER, LOAD_BREAK_SWITCH or RECLOSER |
| name_pattern | str | null | A regex pattern to match on Switch names. E.g., ".Circuit Head Switch." and DISCONNECTOR set for meter_switch_class places energy meters (and thus measurement zones) on all switches of class 'DISCONNECTOR' with a name that includes the string 'Circuit Head Switch' in it. See external website regexr.com for more information on regular expressions and to test that your pattern matches your needs. |
A work package can have multiple SwitchMeterPlacementConfig objects, such as one that places meters at all DISCONNECTORs with "Circuit Head Switch" in the name, and another that places meters at all FUSEs with "Service Cutout" in the name, allowing for flexible and customisable meter placement strategies to create measurement zones that are fit for purpose for different use cases.
Solve Config
The Solve Config contains options used in the OpenDSS model. Can usually leave as default values.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| norm_vmin_pu | float | 0.9 | Normal minimum per unit voltage. Used only for internal OpenDSS calculations, does not affect voltage limits (eg under and over voltage) for tables such as Network Performance Metrics Enhanced. Can typically be left at default values. |
| norm_vmax_pu | float | 1.054 | Normal maximum per unit voltage. Used only for internal OpenDSS calculations, does not affect voltage limits (eg under and over voltage) for tables such as Network Performance Metrics Enhanced. Can typically be left at default values. |
| emerg_vmin_pu | float | 0.8 | Emergency minimum per unit voltage. Used only for internal OpenDSS calculations, does not affect voltage limits (eg under and over voltage) for tables such as Network Performance Metrics Enhanced. Can typically be left at default values. |
| emerg_vmax_pu | float | 1.1 | Emergency maximum per unit voltage. Used only for internal OpenDSS calculations, does not affect voltage limits (eg under and over voltage) for tables such as Network Performance Metrics Enhanced. Can typically be left at default values. |
| base_frequency | int | 50 | Base frequency for the simulation, in Hz |
| voltage_bases | List[float] | (0.4, 0.433, 6.6, 11.0, 22.0, 33.0, 66.0, 132.0) | List of voltage base values, in kV |
| max_iter | int | 25 | Max solve iterations to run in the underlying OpenDSS simulation before failing. |
| max_control_iter | int | 20 | Max control iterations to run in the underlying OpenDSS before failing. |
| mode | str | YEARLY | Run OpenDSS in YEARLY or DAILY mode. |
| step_size_minutes | float | 30 | The step size for the solver in minutes. |
NodeLevelResultsConfig
This feature is in active development and is only available to select customers. If you are interested in using this feature, please contact Zepben for more information.
Using Node Level Results for work packages of more than 1 feeder is not officially supported and will generate an extreme amount of results - use at your own risk.
The Node Level Results Config controls the collection of detailed electrical measurements at specific points in the network during power flow simulations. If any parameter is set to a non-null/non-false value, the node_level_results table will be populated. See the Node Level Results page for full details, including output table structure and configuration examples.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| collect_voltage | bool | true | Include voltage values in node level results. |
| collect_current | bool | true | Include current values in node level results. |
| collect_power | bool | true | Include power values in node level results. |
| mrids_to_collect | List[str] | null | A list of MRIDs to collect node level results at. MRIDs not present in the final OpenDSS model (e.g. due to network simplification) will produce no results. |
| collect_all_switches | bool | false | Collect node level results at all switches in the feeders that are part of this work package. |
| collect_all_transformers | bool | false | Collect node level results at all transformers in the feeders that are part of this work package. |
| collect_all_conductors | bool | false | Collect node level results at all conductors in the feeders that are part of this work package. |
| collect_all_energy_consumers | bool | false | Collect node level results at all energy consumers in the feeders that are part of this work package. |
Equipment collapsed or removed during network simplification will not appear in node level results. See Node Level Results for more details.
Solve Config
These parameters rarely need to be changed from their defaults.
ResultProcessorConfig
The Result Processor Config is used to configure how the results of the work package are processed and stored. Includes sub-configs; WriterConfig (containing the WriterOutputConfig, which itself contains the EnhancedMetricsConfig), the StoredResultsConfig and MetricsResultsConfig.
WriterConfig
The Writer Config is used to configure how the results of the work package are written. It includes the type of writer (Postgres or Parquet) and the configuration for the output writer.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| writer_type | WriterType | POSTGRES or PARQUET | Whether to write output to Parquet files or a Postgres database. Check with your administrator which result types are supported for your environment. |
| output_writer_config | WriterOutputConfig | The configuration for the output writer and which details to store. |
WriterOutputConfig contains only the EnhancedMetricsConfig, as below.
EnhancedMetricsConfig
This config covers two distinct concerns:
calculate_*parameters control which columns are included within the Network Performance Metrics Enhanced table. Leaving these on by default is fine as they do not use much additional resources.populate_*parameters control whether additional output tables are generated alongside it. Enable as needed, noting thatenhanced_metrics_profile_rawis a very large raw table and should be used with caution. Each table is independent, eg you can enablepopulate_enhanced_metricsbut disablepopulate_enhanced_metrics_profilewith no issue.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| populate_enhanced_metrics | bool | false | Whether to populate and store the Network Performance Metrics Enhanced table. |
| populate_enhanced_metrics_profile | bool | false | Whether to populate and store the Metrics Enhanced Profile Raw table - a raw per-interval capture. This table is very large; only enable if necessary. |
| populate_duration_curves | bool | false | Whether to populate and store the Duration Curves table. |
| populate_constraints | bool | false | Whether to populate and store the Constraints table. |
| populate_weekly_reports | bool | false | Whether to populate and store the Weekly Reports table. |
| calculate_normal_for_load_thermal | bool | false | Whether to calculate normal-rating load thermal columns in the Network Performance Metrics Enhanced table. |
| calculate_emerg_for_load_thermal | bool | false | Whether to calculate emergency-rating load thermal columns in the Network Performance Metrics Enhanced table. |
| calculate_normal_for_gen_thermal | bool | false | Whether to calculate normal-rating generator thermal columns in the Network Performance Metrics Enhanced table. |
| calculate_emerg_for_gen_thermal | bool | false | Whether to calculate emergency-rating generator thermal columns in the Network Performance Metrics Enhanced table. |
| calculate_co_2 | bool | false | Whether to calculate CO2 cost columns in the Network Performance Metrics Enhanced table. |
StoredResultsConfig
Controls whether raw result tables are stored. All options default to false.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| energy_meter_voltages_raw | bool | false | Whether to store the Energy Meter Voltages Raw table. |
| energy_meters_raw | bool | false | Whether to store the Energy Meters Raw table. |
| overloads_raw | bool | false | Whether to store the Overloads Raw table. |
| voltage_exceptions_raw | bool | false | Whether to store the Voltage Exceptions Raw table. |
Storing raw results will utilise a lot of storage space and should be done only very carefully, and likely avoided for large Work Packages.
MetricsResultsConfig
The Metrics Results Config controls the basic (and deprecated) Network Performance Metrics table. Prefer using populate_enhanced_metrics in the EnhancedMetricsConfig above instead.
| Variable Name | Data Type | Default | Description |
|---|---|---|---|
| calculate_performance_metrics | bool | false | Whether to populate the (deprecated) Network Performance Metrics table. |