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.

Sign up for GitHub

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

Jump to bottom

Adding a new ROMExternal that can be used for loading pickled ROMs #1994

Merged
merged 2 commits into from
Oct 13, 2022
Merged

Adding a new ROMExternal that can be used for loading pickled ROMs #1994

merged 2 commits into from
Oct 13, 2022

Conversation

joshua-cogliati-inl
Copy link
Contributor

@joshua-cogliati-inl joshua-cogliati-inl commented Oct 12, 2022 •
edited by PaulTalbot-INL
Loading

Pull Request Description

What issue does this change request address?

#1764 (and see also idaholab/HERON#216 )

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

Adding a new ROMExernal that can be used for loading pickled ROMs
This is different from externalROMloader.ravenROMexternal in that it assumes that ravenframework is already in the path.

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, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must 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 test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
  • 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 is the the analytic documentation updated/added?
  • 9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

@joshua-cogliati-inl joshua-cogliati-inl mentioned this pull request Oct 12, 2022
Merged
9 tasks
@joshua-cogliati-inl
Adding a new ROMExernal that can be used for loading pickled ROMs
c5ff0c0 
This is different from externalROMloader.ravenROMexternal in that
it assumes that ravenframework is already in the path.
joshua-cogliati-inl
joshua-cogliati-inl commented Oct 12, 2022
View reviewed changes
ravenframework/ROMExternal.py
@@ -0,0 +1,106 @@
# Copyright 2017 Battelle Energy Alliance, LLC
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm, if there is a better name than ROMExternal (or ROMLoader), I would be happy to change it.

Copy link
Collaborator

@PaulTalbot-INL PaulTalbot-INL Oct 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I don't know of anything better (to name this class) offhand. Since it's being used externally we might consider RavenROM or something? Maybe we can make a poll for the RAVEN team.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The other change I contemplated is putting it inside of ravenframework.CustomDrivers, since it sorta is a driver.

Copy link
Collaborator

Choose a reason for hiding this comment

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

hmmmm, yeah, I could see that. Maybe that's something that should be looked at in the future, as the existing drivers all use RAVEN workflows, whereas this tool wraps a single model.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't see much movement on the name front, so I think we can merge this and change it later if we need to.

@joshua-cogliati-inl joshua-cogliati-inl changed the title Adding a new ROMExernal that can be used for loading pickled ROMs Adding a new ROMExternal that can be used for loading pickled ROMs Oct 12, 2022
@moosebuild
Copy link

Job Test CentOS 8 on cda0871 : invalidated by @joshua-cogliati-inl

FAILED: Diff tests/framework/PostProcessors/EconomicRatio/timeDepDataset

PaulTalbot-INL
PaulTalbot-INL approved these changes Oct 13, 2022
View reviewed changes
Copy link
Collaborator

@PaulTalbot-INL PaulTalbot-INL left a comment

Choose a reason for hiding this comment

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

Code changes look good, but with two comments to consider.

ravenframework/ROMExternal.py
@@ -0,0 +1,106 @@
# Copyright 2017 Battelle Energy Alliance, LLC
Copy link
Collaborator

@PaulTalbot-INL PaulTalbot-INL Oct 13, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

I don't know of anything better (to name this class) offhand. Since it's being used externally we might consider RavenROM or something? Maybe we can make a poll for the RAVEN team.

ravenframework/ROMExternal.py
This constructor un-serializes the ROM generated by RAVEN and
it makes the ROM available for external usage
@ In, binaryFileName, str, the location of the serialized (pickled) ROM that needs to be imported
@ In, _whereFrameworkIs, None, ignored
Copy link
Collaborator

Choose a reason for hiding this comment

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

this is to be consistent with the external ROM loader?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, that was the reason I left it. (Of course, in HERON, I immediately removed the second argument when I changed the import, so maybe it should just be removed.)

@PaulTalbot-INL
Copy link
Collaborator

Once we've converged on the name, this can be merged, unless further changes are made.

@PaulTalbot-INL PaulTalbot-INL merged commit 7a8f8a3 into idaholab:devel Oct 13, 2022
@joshua-cogliati-inl joshua-cogliati-inl deleted the rom_external branch October 13, 2022 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@PaulTalbot-INL PaulTalbot-INL PaulTalbot-INL approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@joshua-cogliati-inl @moosebuild @PaulTalbot-INL