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

Implementation of the drift_bounce_orbit python wrapper #48

Merged
merged 2 commits into from
Apr 9, 2024

Conversation

AntoineBrunet
Copy link
Contributor

This PR follows the issue #47 about having a python wrapper for the drift_bounce_orbit routine. It's a straightforward adaptation of the drift_shell wrapper.

I fixed a small issue in the drift_shell wrapper for the data type of the nposit variable. The documentation mentions a long integer datatype, but that is just IDL lingo for a 4-byte integer (which is simply called an integer everywhere else).

@PluckZK
Copy link

PluckZK commented Apr 9, 2024

Thank you very much!

@mshumko
Copy link
Contributor

mshumko commented Apr 9, 2024

Hi @AntoineBrunet, thanks for wrapping that function! May I suggest an edit to the docs and an addition of a test?

The function has alpha and R0 kwargs that are not included in the docstring. Would you mind adding this in?

R0: float
            The radius, in units of RE, of the reference surface (i.e. altitude) between which 
            the line is traced.
alpha: float
            The local pitch angle.

Also, can you add a function to test_IRBEM.py to automatically validate a subset of the outputs?

@AntoineBrunet
Copy link
Contributor Author

Hi @mshumko,
Good remarks. It's always hard to test this type of output, I've tried to add tests that have a physical sense. Hope that's ok to you.

Copy link
Contributor

@mshumko mshumko left a comment

Choose a reason for hiding this comment

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

Thanks for adding tests @AntoineBrunet!

@mshumko mshumko merged commit b579ea4 into PRBEM:main Apr 9, 2024
9 checks passed
@AntoineBrunet AntoineBrunet deleted the python_drift_bounce_orbit branch April 12, 2024 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants