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

Patch reset cavern sg on new stage start #25

Merged
merged 10 commits into from
Oct 1, 2024
Merged

Conversation

dbhart
Copy link
Collaborator

@dbhart dbhart commented Sep 17, 2024

The initial release of sansmic is supposed to mimic exactly the behavior of the old SANSMIC program. The sansmic code was set up to match the behavior stated in the SANSMIC documentation; the old documentation did not, however, match the actual behavior of the code. This patch returns the code to mimic the behavior of SANSMIC, and issues a warning that this behavior will be changed in the next release.

@dbhart dbhart requested a review from hgmaure September 17, 2024 15:15
@dbhart
Copy link
Collaborator Author

dbhart commented Sep 17, 2024

@hgmaure if you don't mind reviewing the changes in this PR since you found the bug, I'd appreciate it!

Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.14%. Comparing base (a7dbc83) to head (ec92f04).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #25      +/-   ##
==========================================
- Coverage   86.21%   86.14%   -0.08%     
==========================================
  Files           8        8              
  Lines        2010     1992      -18     
==========================================
- Hits         1733     1716      -17     
+ Misses        277      276       -1     
Components Coverage Δ
python code 82.87% <100.00%> (-0.13%) ⬇️
C++ code ∅ <ø> (∅)
tests 99.74% <100.00%> (ø)

@dbhart dbhart added bug Something isn't working github_actions Pull requests that update GitHub Actions code labels Sep 22, 2024
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This is pulling in build process changes and is not related to the bug fix

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not part of the bugfix, this change helps VSCode users not check in private workspace files

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not part of the bugfix, this provides links to badges on pypi

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Related to the bugfix. This moved the assignment to the outside of the for loop (which was unnecessary)

Unrelated to the bugfix, adds more explicit license details

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updates warnings and does not reset cavern sg on "repeat"; this returns sansmic to previous behavior.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Bug fix: removes the override-to-0 of the cavern SG on "REPEAT" stages that was in the Stage creation section.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Bug fix: verifies that value was not changed when specified as non-zero in a REPEAT section.

@dbhart dbhart merged commit fdb71c2 into sandialabs:main Oct 1, 2024
15 of 16 checks passed
@dbhart dbhart linked an issue Oct 2, 2024 that may be closed by this pull request
@dbhart dbhart deleted the patch branch October 8, 2024 17:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working github_actions Pull requests that update GitHub Actions code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PyPI release action
2 participants