Skip to content

Add off-grid capability and tax suffixes#328

Merged
rathod-b merged 8 commits into
developfrom
add_offgrid
Jul 14, 2022
Merged

Add off-grid capability and tax suffixes#328
rathod-b merged 8 commits into
developfrom
add_offgrid

Conversation

@rathod-b
Copy link
Copy Markdown
Collaborator

@rathod-b rathod-b commented Jun 24, 2022

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

  • CHANGELOG.md is updated
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

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:

Add off-grid capability to API v3, add name changes to include before/after tax in result keys to api output models.
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Jun 24, 2022

CLA assistant check
All committers have signed the CLA.

@rathod-b rathod-b linked an issue Jun 24, 2022 that may be closed by this pull request
rathod-b and others added 2 commits June 27, 2022 12:00
Document changes made via help_text / comments. Updated Changelog.md to reflect changes as well.
@rathod-b rathod-b marked this pull request as ready for review June 27, 2022 16:07
@rathod-b rathod-b requested a review from adfarth June 28, 2022 20:55
Comment thread job/models.py Outdated
Comment thread job/src/run_jump_model.py
rathod-b added 2 commits July 6, 2022 15:33
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.
@rathod-b rathod-b requested a review from Bill-Becker July 8, 2022 20:20
Comment thread job/test/test_job_endpoint.py
Comment thread job/validators.py
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.
Copy link
Copy Markdown
Collaborator

@Bill-Becker Bill-Becker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CHANGELOG.md Outdated
Comment thread job/test/test_job_endpoint.py
rathod-b added 2 commits July 13, 2022 11:45
- 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.
@rathod-b rathod-b merged commit 263836d into develop Jul 14, 2022
@rathod-b rathod-b deleted the add_offgrid branch July 14, 2022 18:40
@hdunham hdunham mentioned this pull request Jul 26, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add code to job/ app to handle offgrid capability

5 participants