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

DOC: interpolate: Extrapolation tips and tricks #17299

Merged
merged 8 commits into from Nov 14, 2022

Conversation

ev-br
Copy link
Member

@ev-br ev-br commented Oct 27, 2022

Reference issue

closes gh-16338, closes gh-14386, closes gh-14472

What does this implement/fix?

Add a tutorial page with several worked examples of extrapolation--- handling out-of-bounds data --- in several interpolators. In general, extrapolation is not entirely consistent in scpy.interpolate, default modes are not always useful, and in some cases manual work on the user side is needed. There are four examples, of both using the existing keyword switches etc, and DIY implementations.

Additional information

Two out of four examples are provided by users, in gh-14386 and gh-14472. Am crediting the users in the commit messages, will comment on the issues to see if they want to be listed as commit co-authors.

@ev-br
Copy link
Member Author

ev-br commented Oct 28, 2022

CI failures are unrelated, as it is a pure DOC change.

Copy link
Contributor

@mdhaber mdhaber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is all new and the information is correct/useful, I think we can merge this pretty quickly.

I agree that this closes the issues if you think it would make the API too messy to include options for these things.

I've only made it halfway through. Next pass I'll start from "Manually implement the asymptotic".

doc/source/tutorial/interpolate.rst Outdated Show resolved Hide resolved
doc/source/tutorial/interpolate/extrapolation_examples.rst Outdated Show resolved Hide resolved
doc/source/tutorial/interpolate/extrapolation_examples.rst Outdated Show resolved Hide resolved
doc/source/tutorial/interpolate/extrapolation_examples.rst Outdated Show resolved Hide resolved
doc/source/tutorial/interpolate/extrapolation_examples.rst Outdated Show resolved Hide resolved
doc/source/tutorial/interpolate/extrapolation_examples.rst Outdated Show resolved Hide resolved
@ev-br ev-br moved this from Ready for review to In review in scipy.interpolate Oct 31, 2022
@ev-br ev-br force-pushed the extrapolate_tips_and_tricks branch from 8c0f9b7 to c18c3b5 Compare November 1, 2022 07:28
[skip cirrus] [skip azp] [skip actions]
@ev-br
Copy link
Member Author

ev-br commented Nov 6, 2022

I think the last commit addresses all review suggestions.

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few minor comments

[skip azp] [skip cirrus] [skip actions]
@ev-br
Copy link
Member Author

ev-br commented Nov 7, 2022

Thanks Jake for the review, I tried to address your comments in the last commit in this branch.

@mdhaber
Copy link
Contributor

mdhaber commented Nov 8, 2022

I wanted to finish my review, but the rendered artifacts are not available right now for some reason (looks like a CircleCI issue). Since I'm not very familiar with these functions, the rendered documentation is important, so I'll have to come back. I'll try to look at the rest (starting at "Manually Implement the Asymptotics") on Thursday.

Copy link
Member

@j-bowhay j-bowhay left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ev-br that is my comments addressed

@mdhaber
Copy link
Contributor

mdhaber commented Nov 11, 2022

My original comments have been resolved, I don't have any new ones, and this is very useful. Thanks @ev-br @j-bowhay!

@mdhaber
Copy link
Contributor

mdhaber commented Nov 11, 2022

Oh, the only question is what we should do about co-authorship of @chausies. I see you asked whether they'd like to be credited, but there is no response. What would you like to do? Besides #14472 (comment), you can usually find real email addresses by adding .patch to the URL of any commit. e.g., https://github.com/chausies/myconfigs/commit/b33ded48276f9bcdfcee667c4b7c9dad783cc9e0.patch .

@ev-br
Copy link
Member Author

ev-br commented Nov 11, 2022

I think the lack of response on GH for a reasonable time can be interpreted as a lazy agreement to the attribution in the commit message of 4237531 --- this used the information which is already made public by @chausies.

The comment on gh-14386 has two weeks, we can probably wait some more.

@mdhaber mdhaber merged commit 61ff61f into scipy:main Nov 14, 2022
scipy.interpolate automation moved this from In review to Done Nov 14, 2022
@j-bowhay j-bowhay added this to the 1.10.0 milestone Nov 14, 2022
@ev-br
Copy link
Member Author

ev-br commented Nov 15, 2022

Thanks Matt, Jake for the reviews!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.interpolate
Projects
3 participants