This code has been developed as a pilot function for SCE's CAVA analysis.
Summary of changes and related issue
This code in vulnerability.py allows the user to pass in a series of parameters into the cava_data function and grab the desired data in its raw form or once a metric and threshold are applied to it.
Relevant motivation and context
This is needed as an initial step for a versatile function for SCE (and future IOUs) to use for their CAVA analyses, and potentially be turned into an API to be used in the future.
Dependencies required for this change?
Fixes # (issue), delete if not necessary
Type of change
[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
[ ] Test A
[ ] Test B
Checklist:
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[x] Any dependent changes have been merged and published in downstream modules
Description of PR
This code has been developed as a pilot function for SCE's CAVA analysis.
Summary of changes and related issue This code in
vulnerability.pyallows the user to pass in a series of parameters into thecava_datafunction and grab the desired data in its raw form or once a metric and threshold are applied to it.Relevant motivation and context This is needed as an initial step for a versatile function for SCE (and future IOUs) to use for their CAVA analyses, and potentially be turned into an API to be used in the future.
Dependencies required for this change?
Fixes # (issue), delete if not necessary
Type of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Checklist: