Skip to content

DEV-3643 Accept generator config overrides for calibration #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kgreav merged 4 commits into from
Aug 13, 2025
Merged

DEV-3643 Accept generator config overrides for calibration #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05048c7
TODO:update tests and changelog
vincewhite Aug 7, 2025
50d769c
updated tests
vincewhite Aug 13, 2025
dda05c9
undo formatting
vincewhite Aug 13, 2025
f0aa88c
pull out transformer tap settings
vincewhite Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@
* Added basic client methods `get_ingestor_run` and `get_ingestor_run_list` to retrieve the records of previous ingestor runs.

### Enhancements
* None.

* Added optional `generator_config` argument to `run_hosting_capacity_calibration`. This allows the user to override the
default values in the `WorkPackageConfig` used by calibration. Note: The following fields cannot be overridden during
calibration: GeneratorConfig.model.calibration, GeneratorConfig.model.meter_placement_config,
GeneratorConfig.solve.step_size_minutes, and GeneratorConfig.raw_results.
* Added optional `transformer_tap_settings` argument to `run_hosting_capacity_calibration`. This is the equivalent to supplying a `generator_config`
with `generator_config.model.transformer_tap_settings` set. If `transformer_tap_settings` is supplied, it will take precedence over any `transformer_tap_settings`
configured in the `generator_config`.

### Fixes
* None.
Expand Down
135 changes: 123 additions & 12 deletions src/zepben/eas/client/eas_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@
from zepben.eas.client.study import Study
from zepben.eas.client.ingestor import IngestorConfigInput, IngestorRunsFilterInput, IngestorRunsSortCriteriaInput
from zepben.eas.client.util import construct_url
from zepben.eas.client.work_package import WorkPackageConfig, FixedTime, TimePeriod, ForecastConfig, FeederConfigs
from zepben.eas.client.work_package import WorkPackageConfig, FixedTime, TimePeriod, ForecastConfig, FeederConfigs, \
GeneratorConfig, ModelConfig

__all__ = ["EasClient"]

Expand Down Expand Up @@ -1044,42 +1045,149 @@ async def async_get_ingestor_run_list(self, query_filter: Optional[IngestorRunsF
else:
raise response.raise_for_status()

def run_hosting_capacity_calibration(self, calibration_name: str, local_calibration_time: Optional[str] = None, feeders: Optional[List[str]] = None):
def run_hosting_capacity_calibration(self, calibration_name: str, local_calibration_time: datetime,
feeders: Optional[List[str]] = None,
transformer_tap_settings: Optional[str] = None,
generator_config: Optional[GeneratorConfig] = None):
"""
Send request to run hosting capacity calibration
:param calibration_name: A string representation of the calibration name
:param local_calibration_time: A string representation of the calibration time, in model time.
:param local_calibration_time: A datetime representation of the calibration time, in the timezone of your pqv data ("model time").
:param feeders: A list of feeder ID's to run the calibration over. If not supplied then the calibration is run over all feeders in the network.
:param transformer_tap_settings: A set of transformer tap settings to apply before running the calibration work package.
If provided, this will take precedence over any 'transformer_tap_settings' supplied in via the generator_config parameter
:param generator_config: A `GeneratorConfig` object that overrides the default values in the `WorkPackageConfig` used by calibration.
Note: The following fields cannot be overridden during calibration: generator_config.model.calibration, generator_config.model.meter_placement_config, generator_config.solve.step_size_minutes, and generator_config.raw_results.


:return: The HTTP response received from the Evolve App Server after attempting to run the calibration
"""
return get_event_loop().run_until_complete(
self.async_run_hosting_capacity_calibration(calibration_name, local_calibration_time, feeders))
self.async_run_hosting_capacity_calibration(calibration_name, local_calibration_time, feeders,
transformer_tap_settings,
generator_config))

async def async_run_hosting_capacity_calibration(self, calibration_name: str, calibration_time_local: datetime, feeders: Optional[List[str]] = None):
async def async_run_hosting_capacity_calibration(self, calibration_name: str,
calibration_time_local: datetime,
feeders: Optional[List[str]] = None,
transformer_tap_settings: Optional[str] = None,
generator_config: Optional[GeneratorConfig] = None):
"""
Send asynchronous request to run hosting capacity calibration
:param calibration_name: A string representation of the calibration name
:param calibration_time_local: a datetime representation of the calibration time, in the timezone of your pqv data ("model time").
:param calibration_time_local: A datetime representation of the calibration time, in the timezone of your pqv data ("model time").
:param feeders: A list of feeder ID's to run the calibration over. If not supplied then the calibration is run over all feeders in the network.
:param transformer_tap_settings: A set of transformer tap settings to apply before running the calibration work package.
If provided, this will take precedence over any 'transformer_tap_settings' supplied in via the generator_config parameter
:param generator_config: A `GeneratorConfig` object that overrides the default values in the `WorkPackageConfig` used by calibration.
Note: The following fields cannot be overridden during calibration: generator_config.model.calibration, generator_config.model.meter_placement_config, generator_config.solve.step_size_minutes, and generator_config.raw_results.

:return: The HTTP response received from the Evolve App Server after attempting to run the calibration
"""

# Only replace microsecond, as in database we only have down to second precision.
# tzinfo will be whatever the user passed through, which should be the timezone of their load data.
parsed_time = calibration_time_local.replace(microsecond=0, tzinfo=None)

if transformer_tap_settings:
if generator_config:
if generator_config.model:
generator_config.model.transformer_tap_settings = transformer_tap_settings
else:
generator_config.model = ModelConfig(transformer_tap_settings=transformer_tap_settings)
else:
generator_config = GeneratorConfig(model=ModelConfig(transformer_tap_settings=transformer_tap_settings))

with warnings.catch_warnings():
if not self._verify_certificate:
warnings.filterwarnings("ignore", category=InsecureRequestWarning)
json = {
"query": """
mutation runCalibration($calibrationName: String!, $calibrationTimeLocal: LocalDateTime, $feeders: [String!]) {
runCalibration(calibrationName: $calibrationName, calibrationTimeLocal: $calibrationTimeLocal, feeders: $feeders)
mutation runCalibration($calibrationName: String!, $calibrationTimeLocal: LocalDateTime, $feeders: [String!], $generatorConfig: HcGeneratorConfigInput) {
runCalibration(calibrationName: $calibrationName, calibrationTimeLocal: $calibrationTimeLocal, feeders: $feeders, generatorConfig: $generatorConfig)
}
""",
"variables": {
"calibrationName": calibration_name,
"calibrationTimeLocal": parsed_time.isoformat(),
"feeders": feeders
"feeders": feeders,
"generatorConfig": generator_config and {
"model": generator_config.model and {
"vmPu": generator_config.model.vm_pu,
"loadVMinPu": generator_config.model.load_vmin_pu,
"loadVMaxPu": generator_config.model.load_vmax_pu,
"genVMinPu": generator_config.model.gen_vmin_pu,
"genVMaxPu": generator_config.model.gen_vmax_pu,
"loadModel": generator_config.model.load_model,
"collapseSWER": generator_config.model.collapse_swer,
"calibration": generator_config.model.calibration,
"pFactorBaseExports": generator_config.model.p_factor_base_exports,
"pFactorForecastPv": generator_config.model.p_factor_forecast_pv,
"pFactorBaseImports": generator_config.model.p_factor_base_imports,
"fixSinglePhaseLoads": generator_config.model.fix_single_phase_loads,
"maxSinglePhaseLoad": generator_config.model.max_single_phase_load,
"fixOverloadingConsumers": generator_config.model.fix_overloading_consumers,
"maxLoadTxRatio": generator_config.model.max_load_tx_ratio,
"maxGenTxRatio": generator_config.model.max_gen_tx_ratio,
"fixUndersizedServiceLines": generator_config.model.fix_undersized_service_lines,
"maxLoadServiceLineRatio": generator_config.model.max_load_service_line_ratio,
"maxLoadLvLineRatio": generator_config.model.max_load_lv_line_ratio,
"collapseLvNetworks": generator_config.model.collapse_lv_networks,
"feederScenarioAllocationStrategy": generator_config.model.feeder_scenario_allocation_strategy and generator_config.model.feeder_scenario_allocation_strategy.name,
"closedLoopVRegEnabled": generator_config.model.closed_loop_v_reg_enabled,
"closedLoopVRegReplaceAll": generator_config.model.closed_loop_v_reg_replace_all,
"closedLoopVRegSetPoint": generator_config.model.closed_loop_v_reg_set_point,
"closedLoopVBand": generator_config.model.closed_loop_v_band,
"closedLoopTimeDelay": generator_config.model.closed_loop_time_delay,
"closedLoopVLimit": generator_config.model.closed_loop_v_limit,
"defaultTapChangerTimeDelay": generator_config.model.default_tap_changer_time_delay,
"defaultTapChangerSetPointPu": generator_config.model.default_tap_changer_set_point_pu,
"defaultTapChangerBand": generator_config.model.default_tap_changer_band,
"splitPhaseDefaultLoadLossPercentage": generator_config.model.split_phase_default_load_loss_percentage,
"splitPhaseLVKV": generator_config.model.split_phase_lv_kv,
"swerVoltageToLineVoltage": generator_config.model.swer_voltage_to_line_voltage,
"loadPlacement": generator_config.model.load_placement and generator_config.model.load_placement.name,
"loadIntervalLengthHours": generator_config.model.load_interval_length_hours,
"meterPlacementConfig": generator_config.model.meter_placement_config and {
"feederHead": generator_config.model.meter_placement_config.feeder_head,
"distTransformers": generator_config.model.meter_placement_config.dist_transformers,
"switchMeterPlacementConfigs": generator_config.model.meter_placement_config.switch_meter_placement_configs and [
{
"meterSwitchClass": spc.meter_switch_class and spc.meter_switch_class.name,
"namePattern": spc.name_pattern
} for spc in
generator_config.model.meter_placement_config.switch_meter_placement_configs
],
"energyConsumerMeterGroup": generator_config.model.meter_placement_config.energy_consumer_meter_group
},
"seed": generator_config.model.seed,
"defaultLoadWatts": generator_config.model.default_load_watts,
"defaultGenWatts": generator_config.model.default_gen_watts,
"defaultLoadVar": generator_config.model.default_load_var,
"defaultGenVar": generator_config.model.default_gen_var,
"transformerTapSettings": generator_config.model.transformer_tap_settings,
"ctPrimScalingFactor": generator_config.model.ct_prim_scaling_factor,
},
"solve": generator_config.solve and {
"normVMinPu": generator_config.solve.norm_vmin_pu,
"normVMaxPu": generator_config.solve.norm_vmax_pu,
"emergVMinPu": generator_config.solve.emerg_vmin_pu,
"emergVMaxPu": generator_config.solve.emerg_vmax_pu,
"baseFrequency": generator_config.solve.base_frequency,
"voltageBases": generator_config.solve.voltage_bases,
"maxIter": generator_config.solve.max_iter,
"maxControlIter": generator_config.solve.max_control_iter,
"mode": generator_config.solve.mode and generator_config.solve.mode.name,
"stepSizeMinutes": generator_config.solve.step_size_minutes
},
"rawResults": generator_config.raw_results and {
"energyMeterVoltagesRaw": generator_config.raw_results.energy_meter_voltages_raw,
"energyMetersRaw": generator_config.raw_results.energy_meters_raw,
"resultsPerMeter": generator_config.raw_results.results_per_meter,
"overloadsRaw": generator_config.raw_results.overloads_raw,
"voltageExceptionsRaw": generator_config.raw_results.voltage_exceptions_raw
}
}
}
}

Expand Down Expand Up @@ -1185,14 +1293,17 @@ async def async_get_hosting_capacity_calibration_sets(self):
else:
response.raise_for_status()

def get_transformer_tap_settings(self, calibration_id: str, feeder: Optional[str] = None, transformer_mrid: Optional[str] = None):
def get_transformer_tap_settings(self, calibration_id: str, feeder: Optional[str] = None,
transformer_mrid: Optional[str] = None):
"""
Retrieve distribution transformer tap settings from a calibration set in the hosting capacity input database.
:return: The HTTP response received from the Evolve App Server after requesting transformer tap settings for the calibration id
"""
return get_event_loop().run_until_complete(self.async_get_transformer_tap_settings(calibration_id, feeder, transformer_mrid))
return get_event_loop().run_until_complete(
self.async_get_transformer_tap_settings(calibration_id, feeder, transformer_mrid))

async def async_get_transformer_tap_settings(self, calibration_id: str, feeder: Optional[str] = None, transformer_mrid: Optional[str] = None):
async def async_get_transformer_tap_settings(self, calibration_id: str, feeder: Optional[str] = None,
transformer_mrid: Optional[str] = None):
"""
Retrieve distribution transformer tap settings from a calibration set in the hosting capacity input database.
:return: The HTTP response received from the Evolve App Server after requesting transformer tap settings for the calibration id
Expand Down
Loading