ImperialCollegeLondon / virtual_ecosystem

This repository is the home for the codebase for the Virtual Ecosystem project.
https://virtual-ecosystem.readthedocs.io
BSD 3-Clause "New" or "Revised" License
8 stars 1 forks source link

Simplify the `jupyter-kernelspec` setup #427

Closed davidorme closed 3 months ago

davidorme commented 3 months ago

Is your feature request related to a problem? Please describe.

I think we can retire some of the complications in the markdown/jupyterlab setup. At the moment, we use jupyter-kernelspec to create an explicit link for the ve_python3 kernel. However, that needs to be kept up to date - Taran and I ran into issues yesterday where the kernel was pointing to an old VR environment.

From looking at the the jupyter kernels, though, it is pretty clear that poetry shell is automatically updating the python3 kernel link to point at the activated development environment. So I think that if we use the python3 kernel name in our notebooks, all of the notebooks get run in the right environment as long as we're in poetry shell. That should work for local jupyter use in developing notebooks and within sphinx when it builds notebooks for the website.

So - I think we can ditch the specific name and the kernel spec stuff and just rely on poetry setting the environment correctly. It's simpler and less brittle so seems like a sensible thing to do.