Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend and rework IRF interpolation docs #255

Merged
merged 4 commits into from
Sep 15, 2023
Merged

Extend and rework IRF interpolation docs #255

merged 4 commits into from
Sep 15, 2023

Conversation

RuneDominik
Copy link
Member

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

@RuneDominik RuneDominik added documentation Improvements or additions to documentation IRF interpolation no-changelog-needed Minor change, no newsfragment/changelog needed labels Sep 6, 2023
@codecov
Copy link

codecov bot commented Sep 6, 2023

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
@@           Coverage Diff           @@
##             main     #255   +/-   ##
=======================================
  Coverage   94.84%   94.84%           
=======================================
  Files          60       60           
  Lines        3083     3083           
=======================================
  Hits         2924     2924           
  Misses        159      159           
Files Changed Coverage Δ
pyirf/interpolation/griddata_interpolator.py 100.00% <ø> (ø)
pyirf/interpolation/nearest_neighbor_searcher.py 100.00% <ø> (ø)
pyirf/interpolation/utils.py 97.61% <ø> (ø)
pyirf/interpolation/base_extrapolators.py 100.00% <100.00%> (ø)
pyirf/interpolation/component_estimators.py 99.27% <100.00%> (ø)
pyirf/interpolation/moment_morph_interpolator.py 100.00% <100.00%> (ø)
...yirf/interpolation/nearest_simplex_extrapolator.py 100.00% <100.00%> (ø)
pyirf/interpolation/quantile_interpolator.py 98.24% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/interpolation.rst Outdated Show resolved Hide resolved
docs/interpolation.rst Outdated Show resolved Hide resolved
docs/interpolation.rst Show resolved Hide resolved
docs/interpolation.rst Outdated Show resolved Hide resolved
@maxnoe maxnoe merged commit 6f8b121 into main Sep 15, 2023
8 checks passed
@maxnoe maxnoe deleted the ReworkDocs branch September 15, 2023 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation IRF interpolation no-changelog-needed Minor change, no newsfragment/changelog needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants