v0.20.1

Breaking Changes

• run_hosting_capacity_calibration now takes a datetime object rather than a string.

New Features

• None

Enhancements

• None.

Fixes

• Errors from EasClient calls are now raised as a ClientResponseError exception on a failure.

Notes

• None.

v0.20.0

Breaking Changes

• FixedTimeLoadOverride now takes in optional list of floats instead of optional float for its variable.

New Features

• Modification to ModelConfig to allow more customization for model generation
  • Added support for separate vMinPu and vMaxPu with load and generators.
  • Added support for ctPrimScalingFactor which is required when calculating new ctPrim value when feeder proxy loads are not in use.

Enhancements

• Supports passing a list of feeders to run_hosting_capacity_calibration to perform calibration on a subset of the network.

Fixes

• None.

Notes

• None.

v0.19.0

EAS Python client

[0.19.0] - 2025-07-14

Breaking Changes

• FixedTimeLoadOverride now takes in optional list of floats instead of optional float for its variable.

New Features

• None.

Enhancements

• None.

Fixes

• None.

Notes

• None.

[0.18.0] - 2025-06-30

Breaking Changes

• Added load_overrides to both FixedTime and TimePeriod which consist of a list of FixedTimeLoadOverride and TimePeriodLoadOverride
• WorkPackageConfig has some of its variables moved into the new classes ForecastConfig and FeederConfig.
  • Moved feeders, years, scenarios and load_time.
  • WorkPackageConfig now has a new variable syf_config consist of a Union of ForecastConfig, and list of FeederConfig.
  • This is to support feeder specific load override events

New Features

• Update ModelConfig to contain an optional transformer_tap_settings field to specify a set of distribution transformer tap settings to be applied by the model-processor.
• Added basic client method to run a hosting capacity calibration and method to query its status.
• Added basic client method to run a hosting capacity work package cost estimation.
• Added FixedTimeLoadOverride and TimePeriodLoadOverride class
• Added basic client method to run a opendss export, query its information and get a download url for the exported model.

Enhancements

• Added work package config documentation.

Fixes

• Fix inconsistency between GQL and python load override assignment.

Notes

• None.

[0.17.0] - 2025-03-10

Breaking Changes

• None.

New Features

• Update ModelConfig to contain four optional list of values which makes up the default load profile for hosting capacity model generation.
  • default_load_watts Note: expects same size list of values as default_load_var
  • default_gen_watts Note: expects same size list of values as default_gen_var
  • default_load_var
  • default_gen_var

Enhancements

• None.

Fixes

• None.

Notes

• None.

[0.16.0] - 2024-12-02

Breaking Changes

• Updated WorkPackageConfig constructor to reorder the parameters and no longer provide a default value for name. A name must now be provided by the user.

New Features

• Support specifying a seed in ModelConfig to allow reproducible scenarios
• Support for using access tokens for authentication that takes advantage of the new EAS personal access token authentication system. You can now pass an access_token to EasClient which is an EAS provisioned JWT.

Enhancements

• Update requests restrictions to support all version 2 minor versions.
• Removed check that prevented passing a client_secret for "password" grant_type.

Fixes

• Update to released version of zepben.auth (0.12.1) to support up to requests v3.0.0.

Notes

• None.

[0.7.0]

Breaking Changes

• Updated work package data classes to account for latest changes to hosting capacity work package configuration.
• Updated the WorkPackageConfig to include ResultsConfig
• The ModelConfig in a WorkPackageConfig is not optional anymore
• The ModelConfig now includes load time information
• The ModelConfig now includes a flag to signal the model is a calibration model

New Features

• Added basic client method to run hosting capacity work packages
• Added basic client method to cancel hosting capacity work packages
• Added basic client method to request hosting capacity work packages progress
• Added options to WorkPackageaConfig for:
  • Configuring load/export power factor.
  • Configuring running of NetworkFixer steps
• Added 'collapse_lv_networks' field to ModelConfig
• Added 'feeder_scenario_allocation_strategy' field to ModelConfig
• Added 'include_energy_consumer_meter_group' field to ModelConfig
• Added support for specifying a work package name in the WorkPackageConfig.
• Now support auth with Entra ID, including Azure managed identities

Enhancements

• None.

Fixes

• None.

Notes

• None.

v0.18.0

EAS Python client

[0.18.0] - 2025-06-30

Breaking Changes

• Added load_overrides to both FixedTime and TimePeriod which consist of a list of FixedTimeLoadOverride and TimePeriodLoadOverride
• WorkPackageConfig has some of its variables moved into the new classes ForecastConfig and FeederConfig.
  • Moved feeders, years, scenarios and load_time.
  • WorkPackageConfig now has a new variable syf_config consist of a Union of ForecastConfig, and list of FeederConfig.
  • This is to support feeder specific load override events

New Features

• Update ModelConfig to contain an optional transformer_tap_settings field to specify a set of distribution transformer tap settings to be applied by the model-processor.
• Added basic client method to run a hosting capacity calibration and method to query its status.
• Added basic client method to run a hosting capacity work package cost estimation.
• Added FixedTimeLoadOverride and TimePeriodLoadOverride class
• Added basic client method to run a opendss export, query its information and get a download url for the exported model.

Enhancements

• Added work package config documentation.

Fixes

• Fix inconsistency between GQL and python load override assignment.

Notes

• None.

[0.17.0] - 2025-03-10

Breaking Changes

• None.

New Features

• Update ModelConfig to contain four optional list of values which makes up the default load profile for hosting capacity model generation.
  • default_load_watts Note: expects same size list of values as default_load_var
  • default_gen_watts Note: expects same size list of values as default_gen_var
  • default_load_var
  • default_gen_var

Enhancements

• None.

Fixes

• None.

Notes

• None.

[0.16.0] - 2024-12-02

Breaking Changes

• Updated WorkPackageConfig constructor to reorder the parameters and no longer provide a default value for name. A name must now be provided by the user.

New Features

• Support specifying a seed in ModelConfig to allow reproducible scenarios
• Support for using access tokens for authentication that takes advantage of the new EAS personal access token authentication system. You can now pass an access_token to EasClient which is an EAS provisioned JWT.

Enhancements

• Update requests restrictions to support all version 2 minor versions.
• Removed check that prevented passing a client_secret for "password" grant_type.

Fixes

• Update to released version of zepben.auth (0.12.1) to support up to requests v3.0.0.

Notes

• None.

[0.7.0]

Breaking Changes

• Updated work package data classes to account for latest changes to hosting capacity work package configuration.
• Updated the WorkPackageConfig to include ResultsConfig
• The ModelConfig in a WorkPackageConfig is not optional anymore
• The ModelConfig now includes load time information
• The ModelConfig now includes a flag to signal the model is a calibration model

New Features

• Added basic client method to run hosting capacity work packages
• Added basic client method to cancel hosting capacity work packages
• Added basic client method to request hosting capacity work packages progress
• Added options to WorkPackageaConfig for:
  • Configuring load/export power factor.
  • Configuring running of NetworkFixer steps
• Added 'collapse_lv_networks' field to ModelConfig
• Added 'feeder_scenario_allocation_strategy' field to ModelConfig
• Added 'include_energy_consumer_meter_group' field to ModelConfig
• Added support for specifying a work package name in the WorkPackageConfig.
• Now support auth with Entra ID, including Azure managed identities

Enhancements

• None.

Fixes

• None.

Notes

• None.

v0.17.1

EAS Python client

[0.17.1] - 2025-03-10

Enhancements

• Added work package config documentation.

[0.17.0] - 2025-03-10

Breaking Changes

• None.

New Features

• Update ModelConfig to contain four optional list of values which makes up the default load profile for hosting capacity model generation.
  • default_load_watts Note: expects same size list of values as default_load_var
  • default_gen_watts Note: expects same size list of values as default_gen_var
  • default_load_var
  • default_gen_var

Enhancements

• None.

Fixes

• None.

Notes

• None.

[0.16.0] - 2024-12-02

Breaking Changes

• Updated WorkPackageConfig constructor to reorder the parameters and no longer provide a default value for name. A name must now be provided by the user.

New Features

• Support specifying a seed in ModelConfig to allow reproducible scenarios
• Support for using access tokens for authentication that takes advantage of the new EAS personal access token authentication system. You can now pass an access_token to EasClient which is an EAS provisioned JWT.

Enhancements

• Update requests restrictions to support all version 2 minor versions.
• Removed check that prevented passing a client_secret for "password" grant_type.

Fixes

• Update to released version of zepben.auth (0.12.1) to support up to requests v3.0.0.

Notes

• None.

[0.7.0]

Breaking Changes

• Updated work package data classes to account for latest changes to hosting capacity work package configuration.
• Updated the WorkPackageConfig to include ResultsConfig
• The ModelConfig in a WorkPackageConfig is not optional anymore
• The ModelConfig now includes load time information
• The ModelConfig now includes a flag to signal the model is a calibration model

New Features

• Added basic client method to run hosting capacity work packages
• Added basic client method to cancel hosting capacity work packages
• Added basic client method to request hosting capacity work packages progress
• Added options to WorkPackageaConfig for:
  • Configuring load/export power factor.
  • Configuring running of NetworkFixer steps
• Added 'collapse_lv_networks' field to ModelConfig
• Added 'feeder_scenario_allocation_strategy' field to ModelConfig
• Added 'include_energy_consumer_meter_group' field to ModelConfig
• Added support for specifying a work package name in the WorkPackageConfig.
• Now support auth with Entra ID, including Azure managed identities

Enhancements

• None.

Fixes

• None.

Notes

• None.

v0.17.0

New Features

• Update ModelConfig to contain four optional list of values which makes up the default load profile for hosting capacity model generation.
  • default_load_watts Note: expects same size list of values as default_load_var
  • default_gen_watts Note: expects same size list of values as default_gen_var
  • default_load_var
  • default_gen_var

v0.16.0

EAS Python client

[0.16.0] - 2024-12-02

Breaking Changes

• Updated WorkPackageConfig constructor to reorder the parameters and no longer provide a default value for name. A name must now be provided by the user.

New Features

• Support specifying a seed in ModelConfig to allow reproducible scenarios
• Support for using access tokens for authentication that takes advantage of the new EAS personal access token authentication system. You can now pass an access_token to EasClient which is an EAS provisioned JWT.

Enhancements

• Update requests restrictions to support all version 2 minor versions.
• Removed check that prevented passing a client_secret for "password" grant_type.

Fixes

• Update to released version of zepben.auth (0.12.1) to support up to requests v3.0.0.

Notes

• None.

[0.7.0]

Breaking Changes

• Updated work package data classes to account for latest changes to hosting capacity work package configuration.
• Updated the WorkPackageConfig to include ResultsConfig
• The ModelConfig in a WorkPackageConfig is not optional anymore
• The ModelConfig now includes load time information
• The ModelConfig now includes a flag to signal the model is a calibration model

New Features

• Added basic client method to run hosting capacity work packages
• Added basic client method to cancel hosting capacity work packages
• Added basic client method to request hosting capacity work packages progress
• Added options to WorkPackageaConfig for:
  • Configuring load/export power factor.
  • Configuring running of NetworkFixer steps
• Added 'collapse_lv_networks' field to ModelConfig
• Added 'feeder_scenario_allocation_strategy' field to ModelConfig
• Added 'include_energy_consumer_meter_group' field to ModelConfig
• Added support for specifying a work package name in the WorkPackageConfig.
• Now support auth with Entra ID, including Azure managed identities

Enhancements

• None.

Fixes

• None.

Notes

• None.

v0.15.0

EAS Python client

[0.7.0]

Breaking Changes

• Updated work package data classes to account for latest changes to hosting capacity work package configuration.
• Updated the WorkPackageConfig to include ResultsConfig
• The ModelConfig in a WorkPackageConfig is not optional anymore
• The ModelConfig now includes load time information
• The ModelConfig now includes a flag to signal the model is a calibration model

New Features

• Added basic client method to run hosting capacity work packages
• Added basic client method to cancel hosting capacity work packages
• Added basic client method to request hosting capacity work packages progress
• Added options to WorkPackageaConfig for:
  • Configuring load/export power factor.
  • Configuring running of NetworkFixer steps
• Added 'collapse_lv_networks' field to ModelConfig
• Added 'feeder_scenario_allocation_strategy' field to ModelConfig
• Added 'include_energy_consumer_meter_group' field to ModelConfig
• Added support for specifying a work package name in the WorkPackageConfig.
• Now support auth with Entra ID, including Azure managed identities

Enhancements

• None.

Fixes

• None.

Notes

• None.

v0.14.1

[0.14.1]

Fixes

• Use correct version of zepben.auth.

v0.14.0

[0.7.0]

Breaking Changes

• Updated the WorkPackageConfig to include ResultsConfig
• The ModelConfig in a WorkPackageConfig is not optional anymore
• The ModelConfig now includes load time information
• The ModelConfig now includes a flag to signal the model is a calibration model

New Features

• Added basic client method to run hosting capacity work packages
• Added basic client method to cancel hosting capacity work packages
• Added basic client method to request hosting capacity work packages progress
• Added options to WorkPackageaConfig for:
  • Configuring load/export power factor.
  • Configuring running of NetworkFixer steps

Enhancements

• None.

Fixes

• None.

Notes

• None.