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

Return mapping from createRepresentativeBlocksUsingExistingBlocks #1217

Merged
merged 9 commits into from
Apr 12, 2023

Conversation

mgjarrett
Copy link
Contributor

@mgjarrett mgjarrett commented Mar 20, 2023

Description

When creating new representative blocks from existing blocks, return a mapping of the original XS IDs to the new XS IDs.
This mapping was already created in the method, but it wasn't being returned.


Checklist

  • This PR has only one purpose or idea.
  • Tests have been added/updated to verify that the new/changed code works.
  • The release notes (location doc/release/0.X.rst) are up-to-date with any bug fixes or new features.
  • The documentation is still up-to-date in the doc folder.
  • The dependencies are still up-to-date in setup.py.

@mgjarrett mgjarrett changed the title Update the XS Group Manager Return mapping from creatingRepresentativeBlocksUsingExistingBlocks Mar 20, 2023
@mgjarrett mgjarrett changed the title Return mapping from creatingRepresentativeBlocksUsingExistingBlocks Return mapping from createRepresentativeBlocksUsingExistingBlocks Mar 20, 2023
@mgjarrett mgjarrett added the enhancement New feature or request label Mar 20, 2023
Copy link
Member

@opotowsky opotowsky left a comment

Choose a reason for hiding this comment

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

If this PR is ready for review, I approve. If not, ignore my approval 😉

@mgjarrett mgjarrett marked this pull request as ready for review March 25, 2023 04:01

Returns
-------
blockCollectionByXsGroup : dict
Mapping between XS IDs and the new block collections
modifiedReprBlocks : dict
Mapping between XS IDs and the new representative blocks
origXSIDsFromNew : dict
Mapping of original XS IDs to new
Copy link
Member

Choose a reason for hiding this comment

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

can we call out at a high level why it might have a new? something like

Mapping of original XS IDs to new XS ID typically due to some time of perturbation (eg: isotope temperature)

Copy link
Member

@onufer onufer left a comment

Choose a reason for hiding this comment

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

left a docstring comment and approving.

@mgjarrett mgjarrett merged commit 26bda05 into terrapower:main Apr 12, 2023
@mgjarrett mgjarrett deleted the newXSGM branch April 12, 2023 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants