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

Add example notebook for PlasmaPy particles #32

Draft
wants to merge 17 commits into
base: fix-broken-examples
Choose a base branch
from

Conversation

namurphy
Copy link

@namurphy namurphy commented Jul 5, 2022

This PR is to add a notebook that goes through some examples in plasmapy.particles. I copied it directly from the PlasmaPy documentation, and converted it with jupytext to a .py file.

mwhv2 and others added 8 commits February 14, 2022 13:30
Added aiapy to the list.
Added a link to the aiapy documentation.
This new example for the PyHC gallery utilizes the SunPy, aiapy, and AstroPy packages to download, convert, deconvolve, and compress an AIA FITS file.
Include Transforming Coordinates Between SpacePy, Astropy, and SunPy demo.
Based on particles notebook in PlasmaPy
@namurphy namurphy marked this pull request as draft July 5, 2022 15:36
@sapols
Copy link
Contributor

sapols commented Jul 5, 2022

Thanks for the new example, Nick! And thanks for opening issue #33. This gallery is in a weird state right now; the fix-broken-examples branch got ahead of main so it is the branch I've been merging new examples into. Can you do me a favor and see if the spacepy wheels build when you use the fix-broken-examples branch instead?

I am going to revisit migrating this gallery to JupyterBook in a month, at which point adding a new example will be as easy as adding a .ipynb file. Depending how things go it might make sense to wait and add this new PlasmaPy example to the newly-deployed JupyterBook gallery.

@namurphy namurphy changed the base branch from main to fix-broken-examples July 6, 2022 14:25
@namurphy
Copy link
Author

namurphy commented Jul 6, 2022

@sapols — done! I didn't get a spacepy install error, but now rather an error that the most recent version of PlasmaPy can't be found.

Depending how things go it might make sense to wait and add this new PlasmaPy example to the newly-deployed JupyterBook gallery.

An excuse to procrastinate? Count me in! 😹

Have you looked into Myst-NB? That looks like a really handy way to build Jupyter notebooks out of MyST Markdown files, though it's still in beta. We tried a pull request in PlasmaPy but there were some features that we depend on that it didn't have yet (PlasmaPy/PlasmaPy#1472).

@namurphy
Copy link
Author

namurphy commented Jul 6, 2022

I also copied over and adapted a GitHub Action from PlasmaPy as an attempt to have GitHub Actions do the doc build. It still needs some work.

@namurphy
Copy link
Author

namurphy commented Jul 6, 2022

I had to change the settings in conf.py a little bit, but was able to get the GitHub Action to mostly work. Right now the error is not due to the package setup, but rather a problem with the notebook. Since my plan is to wait to add this until after the Jupyterbook gallery is set up in order to add this, I'm going to let this sit for a while.

@sapols
Copy link
Contributor

sapols commented Jul 6, 2022

Good deal, I'll ping back here when the Jupyter Book work starts! 👍

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