Skip to content
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.

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

Implement expected analysis #236

Merged
merged 90 commits into from
Dec 20, 2024
Merged

Implement expected analysis #236

merged 90 commits into from
Dec 20, 2024

Conversation

paulf81
Copy link
Collaborator

@paulf81 paulf81 commented Nov 6, 2024

Implement expected analysis

Feature or improvement description
This branch will implement the methods of uplift analysis described in AWC validation methodology. It also makes some changes to names of existing functions to better clarify the operation of the seperate methods for analyzing data and quantifying uplift.

Changes to be included:

  • Renaming EnergyRatioInput to AnalysisInput to make clear can be used for both
  • Providing an alias to EnergyRatioInput with deprecation warning to avoid breaking changes
  • Renaming ComputeTotalUplift to TotalUpliftPowerRatio to clarify the method of analysis
  • Add an alias with deprecation warning
  • Updating all references in code
  • Adding new module expected_power_analyisis.py which will implement the methods in AWC validation methodology
  • Add new module expected_power_analysis_output.py for catching the output of functions in expected_power_analysis and provided post-processing operations
  • Adding tests for any new function
  • Add an example
  • Adding documentation

@paulf81 paulf81 added the enhancement An improvement of an existing feature label Nov 6, 2024
@paulf81 paulf81 requested review from misi9170 and ejsimley November 6, 2024 19:06
@paulf81 paulf81 marked this pull request as ready for review December 20, 2024 22:20
@paulf81 paulf81 merged commit 58285a5 into develop Dec 20, 2024
6 checks passed
@paulf81 paulf81 deleted the feature/expected_power branch December 20, 2024 22:20
@paulf81 paulf81 mentioned this pull request Dec 20, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement An improvement of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants