feat: initial commit on getmud module #175
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #175 +/- ##
==========================================
+ Coverage 99.31% 99.33% +0.02%
==========================================
Files 5 6 +1
Lines 292 302 +10
==========================================
+ Hits 290 300 +10
Misses 2 2
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
please see comments. I am a little confused what is going on here. Do we have UCs for these functionalities? What is the user wanting to do? Once we know that we can design what the functions should do and capture that in tests. Only then do we write any functions.
| "mud": 2.0, | ||
| "diameter": 1.5, | ||
| "sample_composition": "ZrO2", | ||
| "energy": 20, |
There was a problem hiding this comment.
it is probably a better test if we use reasonable energies. These would be Cu Kalpha, Mo Kalpha, Ag Kalpha. They don't have to be exact but ballpark,
| mu = compute_mu_using_xraydb( | ||
| sample_composition, energy, sample_mass_density, packing_fraction | ||
| ) | ||
| return mud / mu |
| diameter : float | ||
| The given diameter of the sample capillary in mm. | ||
| """ | ||
| mu = compute_mu_using_xraydb( |
There was a problem hiding this comment.
comment out and replace with pass. Let's just work on tests to begin with, until we learn what we want the function to do.
| mud : float | ||
| The given product of attenuation coefficient mu | ||
| in mm^{-1} and capillary diameter in mm. | ||
| sample_composition : str |
There was a problem hiding this comment.
These are not needed presumably. If I know mud and I know mu then nothing else matters.
closes #166
Initial commit. Probably needs a bit more discussion on what's the most useful here.