Add off-grid capability and tax suffixes#328
Merged
Merged
Conversation
Add off-grid capability to API v3, add name changes to include before/after tax in result keys to api output models.
Document changes made via help_text / comments. Updated Changelog.md to reflect changes as well.
adfarth
reviewed
Jul 5, 2022
adfarth
reviewed
Jul 5, 2022
Add the ability to set run_bau to false for off-grid runs
Add the ability to override conditional defaults which are set based on off-grid flag.
hdunham
reviewed
Jul 8, 2022
hdunham
reviewed
Jul 8, 2022
Clean up when electrictariff is cleaned if off-grid flag is true, update electrictariff error messages and info messages to alert users that electrictariff is not used when off-grid is true.
Bill-Becker
approved these changes
Jul 12, 2022
Collaborator
Bill-Becker
left a comment
There was a problem hiding this comment.
Looks good! I have just a couple minor comments, with the one about trying to avoid running the optimization model for the tests as just an idea. I'm going to approve.
- Updated validation and endpoint tests for off-grid functionality - Updated migration file to contain all updates/additions in the same file - Updated changelong
Added additional input validations to determine if any input keys are not accepted when off_grid is true to avoid errors from REopt.jl. Added message to users to alert them of techs which can be modeled if off_grid is true.
Bill-Becker
approved these changes
Jul 14, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add off-grid capability to API v3, add name changes to include before/after tax in result keys to api output models.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
Feature: the ability to provide off-grid inputs via Job app and the ability to receive off-grid specific outputs from Job app
Feature: the ability to tell if a calculated monetary value is before or after taxes from the returned keys
What is the current behavior?
Currently, if off-grid inputs were to be provided to REopt via the Job app, they would get ignored because there are no existing models to accept to this data. Furthermore, the input processing can also fail if certain as-is required keys are omitted.
It is not possible to tell if a returned monetary value is before or after tax without looking at documentation.
What is the new behavior (if this is a feature change)?
Now, the user is able to provide off-grid scenarios to REopt via the Job app. Certain required inputs are now conditionally validated based on provided scenario.
It is now possible to tell if a returned monetary value is before or after tax without looking at documentation.
Does this PR introduce a breaking change?
(What changes might users need to make in their application due to this PR?)
Yes, users' result processing scripts might break due to changes in keys names.
Other information: