cta-observatory / pyirf

Python IRF builder
https://pyirf.readthedocs.io/en/stable/
MIT License
15 stars 25 forks source link

Extend and rework IRF interpolation docs #255

Closed RuneDominik closed 12 months ago

RuneDominik commented 1 year ago

I tried to produce a more comprehensive version of the interpolation docs, especially the interpolation main-page. Suggestions very welcome.

codecov[bot] commented 1 year ago

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (12a6095) 94.84% compared to head (59b9408) 94.84%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #255 +/- ## ======================================= Coverage 94.84% 94.84% ======================================= Files 60 60 Lines 3083 3083 ======================================= Hits 2924 2924 Misses 159 159 ``` | [Files Changed](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory) | Coverage Δ | | |---|---|---| | [pyirf/interpolation/griddata\_interpolator.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9ncmlkZGF0YV9pbnRlcnBvbGF0b3IucHk=) | `100.00% <ø> (ø)` | | | [pyirf/interpolation/nearest\_neighbor\_searcher.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9uZWFyZXN0X25laWdoYm9yX3NlYXJjaGVyLnB5) | `100.00% <ø> (ø)` | | | [pyirf/interpolation/utils.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi91dGlscy5weQ==) | `97.61% <ø> (ø)` | | | [pyirf/interpolation/base\_extrapolators.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9iYXNlX2V4dHJhcG9sYXRvcnMucHk=) | `100.00% <100.00%> (ø)` | | | [pyirf/interpolation/component\_estimators.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9jb21wb25lbnRfZXN0aW1hdG9ycy5weQ==) | `99.27% <100.00%> (ø)` | | | [pyirf/interpolation/moment\_morph\_interpolator.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9tb21lbnRfbW9ycGhfaW50ZXJwb2xhdG9yLnB5) | `100.00% <100.00%> (ø)` | | | [...yirf/interpolation/nearest\_simplex\_extrapolator.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9uZWFyZXN0X3NpbXBsZXhfZXh0cmFwb2xhdG9yLnB5) | `100.00% <100.00%> (ø)` | | | [pyirf/interpolation/quantile\_interpolator.py](https://app.codecov.io/gh/cta-observatory/pyirf/pull/255?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=cta-observatory#diff-cHlpcmYvaW50ZXJwb2xhdGlvbi9xdWFudGlsZV9pbnRlcnBvbGF0b3IucHk=) | `98.24% <100.00%> (ø)` | |

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