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

delete pyrecomponents #8

Open
wants to merge 2 commits into
base: next
Choose a base branch
from
Open

delete pyrecomponents #8

wants to merge 2 commits into from

Conversation

KyleQianliMa
Copy link
Collaborator

@KyleQianliMa KyleQianliMa commented Dec 16, 2024

Short description of the changes:

Pyre.component is not really used in multiphonon. The associated Histogram.pyrecomponent.Plotter class is not called in multiphonon either.

But Pyre.component is used in mcvine. Pyre.component imports pyre.inventory. Incorporating pyre.inventory into histogram histogram would be complicated due to Pyre.inventory is convoluted with other pyre classes. For testing purpose I temporarily deprecated pyre.components in histogram.

If issue arises during useage of multiphonon this will give us clues on what part of pyre.component is being used.

I've tested that removing pyre.component in histogram doesn't produce failed tests in multiphonon. This PR will allow us to test Histogram without pyre.component.

Instructions to test:
Git clone latest multiphonon-next branch at git@github.com:neutrons/multiphonon.git.
In the environment.yml file, commenting out last line that pip install histogram from the repository.
conda env create. This wil create an multiphonon environment without histogram.

Git clone pre_component branch from histogram repo.
cd into histogram folder and pip install -e . the histogram that deprecated pyre.component.

run pytest in both histogram and multiphonon. All tests should pass.

Multiphonon tests take some time (~1hr) to run. Be patient.

Long description of the changes:

Check list for the pull request

  • I have read the [CONTRIBUTING]
  • I have read the [CODE_OF_CONDUCT]
  • I have added tests for my changes
  • I have updated the documentation accordingly

Check list for the reviewer

  • I have read the [CONTRIBUTING]
  • I have verified the proposed changes
  • best software practices
    • all internal functions have an underbar, as is python standard
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

Manual test for the reviewer

References

@codecov-commenter
Copy link

codecov-commenter commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.71%. Comparing base (ef929b9) to head (acd5bda).

Additional details and impacted files
@@            Coverage Diff             @@
##             next       #8      +/-   ##
==========================================
+ Coverage   78.22%   78.71%   +0.48%     
==========================================
  Files          61       59       -2     
  Lines        3545     3523      -22     
==========================================
  Hits         2773     2773              
+ Misses        772      750      -22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

just deleting the folder-pyrecomponents
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