Wanghy/farm gamma validators

[wanghy-anl]

---

Pull Request Description

What issue does this change request address?

Closes #176

1. Please close PR fixed the get_cashflow_loc, and added the get_farm_loc #172. This PR contains the correct version of "get_cashflow_loc" and "get_farm_loc" in src/_utils.py
2. Added the "%FARM%" keyword resolution in src/Placeholder.py, for the user to specify the ARMA ROM enclosed in FARM directory.
3. Added the FARM validators location to src/validators/Factory.py

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

The FARM validators are removed from heron/src/validators, and a bridge was added in heron/src/validators/Factory.py

---

For Change Control Board: Change Request Review

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

• 1. Review all computer code.
• 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).
• 3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
• 4. Automated Tests should pass.
• 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.
• 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.
• 7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
• 8. If an analytic test is changed/added, the the analytic documentation must be updated/added.
• 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]

The failed test shows the following failure for HERON:

Starting HERON ...
 ... RAVEN located at "/home/civet/civet/build_0/raven"
 ... Activating CONDA environment ...
CONDA
raven_libraries_alt      /home/civet/.conda/envs/raven_libraries_alt
raven_libraries       *  /home/civet/miniconda3/envs/raven_libraries
Running HERON ...
Loading plugin "TEAL" at /home/civet/civet/build_0/raven/plugins/TEAL
 ... successfully imported "TEAL" ...
Loading plugin "HERON" at /home/civet/civet/build_0/HERON
 ... successfully imported "HERON" ...
Loading plugin "SR2ML" at /home/civet/civet/build_0/raven/plugins/SR2ML
 ... successfully imported "SR2ML" ...
Loading plugin "LOGOS" at /home/civet/civet/build_0/raven/plugins/LOGOS
 ... successfully imported "LOGOS" ...
Loading plugin "SRAW" at /home/civet/civet/build_0/raven/plugins/SRAW
 ... successfully imported "SRAW" ...
Loading plugin "FARM" at /home/civet/civet/build_0/raven/plugins/FARM
 ... successfully imported "FARM" ...
Loading plugin "ExamplePlugin" at /home/civet/civet/build_0/raven/plugins/ExamplePlugin
 ... successfully imported "ExamplePlugin" ...
Traceback (most recent call last):
  File "/home/civet/civet/build_0/HERON/src/main.py", line 10, in <module>
    import input_loader
  File "/home/civet/civet/build_0/HERON/src/input_loader.py", line 10, in <module>
    import Cases
  File "/home/civet/civet/build_0/HERON/src/Cases.py", line 25, in <module>
    from validators.Factory import known as known_validators
  File "/home/civet/civet/build_0/HERON/src/validators/Factory.py", line 19, in <module>
    from FARM.src.FARMValidatorsForHeron import FARM_Beta, FARM_Gamma_LTI, FARM_Gamma_FMU
ModuleNotFoundError: No module named 'FARM.src.FARMValidatorsForHeron'
 ... Errors were encountered while running HERON.

[wanghy-anl]

@PaulTalbot-INL Paul, I see the issue. I haven't updated the submodule version of FARM yet, and this error should disappear after that change. Let me work with Congjian to get it fixed. I will keep you posted. Thanks, Haoyu

[wanghy-anl]

Hey Paul, Congjian merged my raven PR idaholab/raven#1846 and the FARM submodule ID is updated.
Could you re-start the check on CentOS 8 server?
@PaulTalbot-INL

[moosebuild]

Job CentOS 8 on cd1b049 : invalidated by @dgarrett622

Restart due to submodule update

[wanghy-anl]

It seems that this PR passed all the tests.
@PaulTalbot-INL @dgarrett622 Gents, could you merge this PR and update the HERON submodule ID in raven?
Thanks,
Haoyu

[dgarrett622]

One minor comment and a general question. We have a test for the Example validator, should there also be a test or tests for FARM validators, or is that out of HERON scope? @PaulTalbot-INL @dylanjm

[dgarrett622]

@wanghy-anl All HERON PRs need to be tied to an issue. I don't see an issue related to this PR, could you open an issue and link this PR to that issue?

[PaulTalbot-INL]

Once @dgarrett622 approves and merges this, it might be a couple days before we update the HERON submodule in RAVEN, just so we can get a couple other changes merged in as well. Will that cause any issue for you @wanghy-anl ?

[wanghy-anl]

Once @dgarrett622 approves and merges this, it might be a couple days before we update the HERON submodule in RAVEN, just so we can get a couple other changes merged in as well. Will that cause any issue for you @wanghy-anl ?

No worries Paul, that's not a pressing issue. Keeping the same HERON submodule ID will only cause the FARM validator tests to fail on raven test servers, which is allowed by raven. After updating the HERON submodule ID adopting the changes in this PR, these failed FARM validator tests will pass.

[wanghy-anl]

@wanghy-anl All HERON PRs need to be tied to an issue. I don't see an issue related to this PR, could you open an issue and link this PR to that issue?

Sure, and issue #176 is opened.

[dgarrett622]

Everything looks good. Once the tests pass this can be merged.