sxs-collaboration / sxs

Python code for manipulating data from the SXS collaboration
MIT License
25 stars 18 forks source link

Add dox for how to get individual modes. #76

Closed markscheel closed 1 year ago

markscheel commented 1 year ago

This appears to be undocumented (or at least if it is documented somewhere, I can't find it).

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage: 66.66% and no project coverage change.

Comparison is base (b4c0a51) 42.29% compared to head (058042e) 42.29%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #76 +/- ## ======================================= Coverage 42.29% 42.29% ======================================= Files 70 70 Lines 5578 5578 Branches 1109 1109 ======================================= Hits 2359 2359 Misses 3010 3010 Partials 209 209 ``` | [Impacted Files](https://app.codecov.io/gh/sxs-collaboration/sxs/pull/76?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sxs-collaboration) | Coverage Δ | | |---|---|---| | [sxs/waveforms/waveform\_modes.py](https://app.codecov.io/gh/sxs-collaboration/sxs/pull/76?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sxs-collaboration#diff-c3hzL3dhdmVmb3Jtcy93YXZlZm9ybV9tb2Rlcy5weQ==) | `83.39% <ø> (ø)` | | | [...veforms/rotating\_paired\_diff\_multishuffle\_bzip2.py](https://app.codecov.io/gh/sxs-collaboration/sxs/pull/76?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=sxs-collaboration#diff-c3hzL3dhdmVmb3Jtcy9yb3RhdGluZ19wYWlyZWRfZGlmZl9tdWx0aXNodWZmbGVfYnppcDIucHk=) | `52.56% <66.66%> (ø)` | |

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.