rs-station / laue-dials

A package for analyzing Laue x-ray crystallography data using the DIALS framework.
https://rs-station.github.io/laue-dials/
MIT License
4 stars 3 forks source link

Minor docs update #36

Open dennisbrookner opened 10 months ago

dennisbrookner commented 10 months ago

So far in this PR, I have

I figure we can leave this PR open while the tutorial continues to take shape.

codecov[bot] commented 10 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (6197f3d) 44.12% compared to head (fc7f785) 44.12%. Report is 56 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #36 +/- ## ======================================= Coverage 44.12% 44.12% ======================================= Files 4 4 Lines 281 281 Branches 19 19 ======================================= Hits 124 124 Misses 152 152 Partials 5 5 ``` | [Flag](https://app.codecov.io/gh/rs-station/laue-dials/pull/36/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=rs-station) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/rs-station/laue-dials/pull/36/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=rs-station) | `44.12% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=rs-station#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

PrinceWalnut commented 10 months ago

I have a couple of edits to make to the notebook based on feedback from Maggie Klureza. I'll make sure to push them by end of week, and perhaps we can include the tutorial into this PR. Let me know if you want to take that on, and what format would be easiest for you to work with @dennisbrookner.