New Feature: Ability to keep certain CashFlows out of the NPV calculation

dylanjm commented 3 months ago

Pull Request Description

What issue does this change request address?

Closes #339

What are the significant changes in functionality due to this change request?

This new feature allows users to specify npv_exempt=True in CashFlow definitions to allow the CashFlow to be used in the dispatch optimization, but will not use the cash flow in the NPV calculation. This is considered an advanced user feature and should be used with caution.

Also, I have removed all mention of mult_target in HERON's input files. It is a deprecated feature and since most people start new HERON analyses using pre-built input files, this should reduce the amount of people including it in their input files, making it easier to eventually remove all together.

For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

[x] 1. Review all computer code.
[x] 2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
[x] 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
[x] 4. Automated Tests should pass.
[x] 5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large tes.
[x] 6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
[x] 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
[x] 8. If an analytic test is changed/added, the the analytic documentation must be updated/added.
[x] 9. If any test used as a basis for documentation examples have been changed, the associated documentation must be reviewed and assured the text matches the example.

PaulTalbot-INL commented 3 months ago

Do the exempt cashflows still show up in the debug run cashflow breakdowns? I assume not, right?

dylanjm commented 3 months ago

Do the exempt cashflows still show up in the debug run cashflow breakdowns? I assume not, right?

@PaulTalbot-INL just tested it out and am getting an error when trying to generate the cashflow plot. Will take a look at it.

dylanjm commented 3 months ago

@PaulTalbot-INL figured out the error caused in debug mode by this new feature. I went ahead and added some checks in template_driver.py to avoid adding npv-exempt cashflows to the variable groups in the outer and inner XMLs.

PaulTalbot-INL commented 3 months ago

Changes are good, clear to merge once tests pass.

idaholab / HERON