spolson/pyhc-gallery-w-executable-paper repository overview

This pyhc-gallery-w-executable-paper image has all the notebook examples from the Python in Heliophysics Community (PyHC) Gallery⁠, along with the executable paper "Making an executable paper with the Python in Heliophysics Community to foster open science and improve reproducibility⁠" by Polson et al., running in JupyterLab with an environment containing every published PyHC package.

Use the pyhc-environment⁠ image if you just want the PyHC environment without the extra cruft of the gallery and executable paper files.

⁠Inspiration

The environment used by this JupyterLab session is backed by the pyhc-docker-environment⁠ GitHub repo. That repo maintains up-to-date package version requirements for a unified Python virtual environment holding the latest versions of each PyHC package, automated by GitHub Actions.

⁠Caveats

It is difficult with so many dependency requirements to create a valid Python virtual environment capable of even importing all these PyHC packages. The Gallery notebooks and executable paper successfully execute, and there is an additional import-test.ipynb notebook added to demonstrate that all the imports do work, but little further compatibility testing has been done.