Skip to content

changelog.md

Latest commit

 

History

History
351 lines (264 loc) · 12.1 KB

changelog.md

File metadata and controls

351 lines (264 loc) · 12.1 KB

EAS Python client

[0.30.0] - UNRELEASED

Breaking Changes

  • Deprecated methods in EasClient:
    • aclose
    • get_work_package_cost_estimation
    • run_hosting_capacity_work_package
    • cancel_hosting_capacity_work_package
    • get_hosting_capacity_work_packages_progress
    • run_feeder_load_analysis_report
    • get_feeder_load_analysis_report_status
    • upload_study
    • run_ingestor
    • get_ingestor_run
    • get_ingestor_run_list
    • run_hosting_capacity_calibration
    • get_hosting_capacity_calibration_run
    • get_hosting_capacity_calibration_sets
    • get_transformer_tap_settings
    • run_opendss_export
    • get_paged_opendss_models
    • get_opendss_model
  • Most Input object will need to be migrated over to the new data model

New Features

  • None.

Enhancements

  • EasClient has new query and mutation methods that will accept Query and Mutation objects respectively.
    • Available queries and mutations can be found as @classmethods on Queries and Mutations.

Fixes

  • Patched ariadne-codegen while waiting for release of dependent code.

Notes

  • None.

[0.29.0] - 2026-02-25

Breaking Changes

  • Removed token fetcher, client id/secret, and username/password auth from EasClient. You must now use access token for auth, generated from the UI.
  • Moved all imports to the top level - you can now reconfigure all imports to be from zepben.eas import .... Existing imports using from zepben.eas.client import ... will no longer work.

New Features

  • None.

Enhancements

  • None.

Fixes

  • None.

Notes

  • None.

[0.28.0] - 2026-02-25

Breaking Changes

  • For CandidateGenerationConfig, replaced voltage_delta_avg_threshold with average_voltage_spread_threshold, which serves the same purpose but is in volts instead of voltage per-unit.
    • EAS must support this change in the GraphQL schema (v2.10.0 and above).

New Features

  • Added function get_feeder_load_analysis_report_status to request feeder load analysis report status to eas client.

Enhancements

  • None.

Fixes

  • Fixed bug where geographical regions were not getting passed in the feeder load analysis input.

Notes

  • None.

[0.27.0] - 2026-01-21

Breaking Changes

  • Bumping urllib3 to v2.5.0, and pulling in zepben.auth via the SDK.
  • EAS must support unspecified allocationLimitPerYear and yearRange in the intervention config.

New Features

  • None.

Enhancements

  • To reduce confusion when running certain classes of intervention, the following fields are no longe required in InterventionConfig, and are defaulted to sensible values server-side:
    • yearRange
    • allocation_limit_per_year

Fixes

  • None.

Notes

  • None.

[0.26.0] - 2025-10-16

Breaking Changes

  • None.

New Features

  • Added fla_forecast_config to FeederLoadAnalysisInput which holds the config for forecast portion of feeder-load-analysis studies.
    • scenario_id : The id of forecast scenario
    • year: The year for forecast model
    • pv_upgrade_threshold: Watts threshold to indicate if a customer site will gain additional pv during scenario application (Default to 5000).
    • bess_upgrade_threshold: Watts threshold to indicate if a customer site will gain additional battery during scenario application (Default to 5000).
    • seed: Seed for scenario application (Default to 123).

Enhancements

  • None.

Fixes

  • The generationSpec property returned by the get_paged_opendss_models functions in the EAS client is now a string instead of an object.

Notes

  • None.

[0.25.1] - 2025-10-16

Fixes

  • The generationSpec property returned by the get_paged_opendss_models functions in the EAS client is now a string instead of an object.

[0.25.0] - 2025-10-09

Breaking Changes

  • The beforeCutOffProfile and afterCutOffProfile fields in PVVoltVARVoltWattConfig have been renamed to snake case and are now before_cut_off_profile and after_cut_off_profile respectively.

New Features

  • None.

Enhancements

  • None.

Fixes

  • None.

Notes

  • None.

[0.24.0] - 2025-10-02

Breaking Changes

  • None.

New Features

  • Added optional field inverterControlConfig to ModelConfig. This PVVoltVARVoltWattConfig allows the configuration of advanced inverter control profiles.

Enhancements

  • None.

Fixes

  • TimePeriod no longer truncates the start_time and end_time to midnight(00:00:00). TimePeriod will now preserve arbitrary start and end times to minute precision.

Notes

  • None.

[0.23.0] - 2025-09-10

Breaking Changes

  • Renamed the parameter calibration_id to calibration_name for the following methods get_transformer_tap_settings and async_get_transformer_tap_settings. This better reflects that this parameter is the user supplied calibration name rather than EAS's internal calibration run ID.

New Features

  • Added optional fields to ModelConfig to control network simplification: simplify_network, collapse_negligible_impedances, and combine_common_impedances.
  • Added optional node_level_results field to GeneratorConfig. This NodeLevelResultsConfig allows the configuration of node level power flow results from OpenDss.
  • Introduce span_level_threshold and simplify_plsi into work_package so it can be passed through for hosting capacity studies.
  • Introduce new variables into work_package so it can be passed through for hosting capacity studies.
    • use_span_level_threshold
    • rating_threshold
    • simplify_plsi_threshold
    • emerg_amp_scaling
  • Added optional field inverterControlConfig to ModelConfig. This PVVoltVARVoltWattConfig allows the configuration of advanced inverter control profiles.

Enhancements

  • None.

Fixes

  • TimePeriod no longer truncates the start_time and end_time to midnight(00:00:00). TimePeriod will now preserve arbitrary start and end times to minute precision.

Notes

  • None.

[0.22.0] - 2025-08-14

Breaking Changes

  • None.

New Features

  • Added basic client method run_ingestor to run ingestors via EAS's executeIngestor graphql mutation.
  • Added basic client methods get_ingestor_run and get_ingestor_run_list to retrieve the records of previous ingestor runs.

Enhancements

  • 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.

Notes

  • None.

[0.21.0] - 2025-08-07

New Features

  • Added EasClient.get_transformer_tap_settings for retrieving tap settings for a calibration run.

[0.20.1] - 2025-08-06

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.

[0.20.0] - 2025-07-30

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.

[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

  • Added FeederLoadAnalysisInput which holds the config for feeder-load-analysis studies.
    • These then can be utilized in the run_feeder_load_analysis_report and async_run_feeder_load_analysis_report functions

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.