Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clean up the validators, now only with FARM_SISO and FARM_MIMO #327

Merged
merged 1 commit into from
Dec 18, 2023

Conversation

wanghy-anl
Copy link
Contributor

@wanghy-anl wanghy-anl commented Dec 18, 2023


Pull Request Description

What issue does this change request address?

No related issues, but to clean up the validators list for FARM 2024 March 31 deliverable

What are the significant changes in functionality due to this change request?
  1. Removed the prototype validators "FARM_Beta" and "FARM_Gamma_LTI"
  2. Renamed the "FARM_Gamma_FMU" as "FARM_SISO"
  3. Renamed the "FARM_Delta_FMU" as "FARM_MIMO"

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.

@wanghy-anl
Copy link
Contributor Author

@PaulTalbot-INL @dylanjm Gents, I would like to clean up the FARM validator list from HERON/src/validators/Factory.py.
Now there are only two validators left:

  • FARM_SISO (which is FARM_Gamma_FMU in the past) and
  • FARM_MIMO (which is FARM_Delta_FMU in the past).

After this clean-up, a lot of repetition in the user manual could be cleared. The capabilities of FARM_Beta and FARM_Gamma_LTI has been merged into FARM_SISO.

Could you review and merge this PR?
Thanks,
Haoyu

@wanghy-anl wanghy-anl changed the title clean up the validators, not only with FARM_SISO and FARM_MIMO clean up the validators, now only with FARM_SISO and FARM_MIMO Dec 18, 2023
Copy link
Collaborator

@dylanjm dylanjm left a comment

Choose a reason for hiding this comment

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

Changes look good and all tests pass. Approved to merge.

@dylanjm dylanjm merged commit bec6cb7 into idaholab:devel Dec 18, 2023
4 checks passed
@dylanjm
Copy link
Collaborator

dylanjm commented Dec 18, 2023

@wanghy-anl This has been merged, please submit a submodule update to RAVEN if you need these features in the upcoming release of RAVEN.

@wanghy-anl
Copy link
Contributor Author

@dylanjm Thank you Dylan. Do you have any plan on updating the HERON submodule in the next weeks? I would like to coordinate the development of FARM based on your schedule, so we can have FARM validator working together with HERON at the same time.

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.

2 participants