Yoshiurr/pyomoexpression

yoshiurr-INL commented 2 years ago

Pull Request Description

What issue does this change request address?

Issue #42

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

When triggered, TEAL will accept pyomo expression as an acceptable format and vprints are changed accordingly. In that case, the output should be equation expressions instead of float values.

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.
[ ] 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 2 years ago

@worseliz this is the PR looking at adding pyomo-compatible cash flow analysis. The need comes from the DISPATCHES project requiring TEAL as a source for CashFlow expression constructions in their pyomo environment. We can have a chat about details if you want.

PaulTalbot-INL commented 2 years ago

@yoshiurr-INL for the test, you can use required_libraries = 'pyomo' to cause the system to skip the test if pyomo isn't detected in the python env. For example, for a test in RAVEN that uses the optional imageio library:

  [./votingRegressor_plotting]
    type = 'RavenFramework'
    input = 'votingRegressor_plotting.xml'
    csv = 'data/outVotingRegressor_plotting.csv'
    image = 'data/votingRegressor_scatter-scatter-scatter-scatter-scatter.png'
    required_libraries = 'imageio'
    rel_err = 0.1
  [../]

PaulTalbot-INL commented 2 years ago

Any progress on the test for this?

idaholab / TEAL