fix: corrected mu vs muD usage, remove packing fraction option #198
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yucongalicechen
commented
Jul 8, 2025
| "Specify the chemical formula, incident x-ray energy (in keV), " | ||
| "and packing fraction (0 to 1), " + theoretical_mud_hmsg_suffix | ||
| "sample mass density (in g/cm^3), " | ||
| "and capillary diameter (in mm) " |
There was a problem hiding this comment.
Adding capillary diameter as a requirement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #198 +/- ##
=======================================
Coverage 99.31% 99.31%
=======================================
Files 5 5
Lines 292 292
=======================================
Hits 290 290
Misses 2 2
🚀 New features to boost your workflow:
|
yucongalicechen
commented
Jul 8, 2025
| args.theoretical_from_density | ||
| def _set_theoretical_mud(args): | ||
| """Theoretical estimation of muD from sample composition, energy, sample | ||
| mass density, and capillary diameter.""" |
There was a problem hiding this comment.
Remove packing fraction as an option, add capillary diameter
|
please see my comment in #187. I am honestly a bit confused as it has been some time since we worked on this and there were many many different options. It might be helpful to have a quick meeting, and in preperation for that meeting try and plot out some kind of block-diagram that shows the different flows of what people know, how they will interact with the program, and what functions get run in each case. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #188, closes #187
Docs update for this PR is tracked through docs: update documentation to reflect changes in the CLI structure and mud computation #192.
Here's a screenshot of the GUI:
From the screenshot here I think I like keeping all chemical info in one argument instead of separating it like
-s NaCl -e 10 -d 1.5 -c 1.0for composition, energy, density, and diameter. I can separate arguments for "getmud" subcommand though, if this is easier for CLI users. Thoughts?@sbillinge ready for review.