search

OttoStruve / muler

A Python package for working with pipeline-produced spectra from IGRINS, HPF, and Keck NIRSPEC
https://muler.readthedocs.io
MIT License
15 stars 9 forks source link

Overhaul tutorials to use HTML paths, also use nbstripout #99

Closed gully closed 2 years ago

gully commented 2 years ago

I tried to get read the docs to clone the muler_example_data repo so we could use local paths. I got close, but something was still stuck.

Instead I propose we just use HTML paths in the tutorials. This has the benefit of working for everyone no matter their directory structure, with no need to clone the muler_example_data directory. It has the drawback of not working when offline, so it requires an internet connection. Users in this offline situation could still manually override the notebook path/ variable to an existing local path.

Also I am moving to apply nbstripout before committing the notebooks so that the project repo size doesn't uncessarily bloat everytime we rerun a notebook. The tutorials will be automatically re-rendered on RTD so we get the best of both worlds.

gully commented 2 years ago

Ok, I expect the RTD should fail when we merge this because some of the tutorials require gollum and requests and we don't explicitly install those in the requirements.txt. Let's try and see, and if it fails I'll add them in. gollum is the peskier one to add, though it's technically pip installable.