nebari-dev / nebari-dev/nebari-docs

[DOC] - Must completely unload env from notebook with every env rebuild

Open
#299 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: documentation 📖 area: integration/conda-store area: integration/Jupyterlab area: user experience 👩🏻‍💻 good first issue
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
Summary

Every time conda-store rebuilds an environment, its actually storing it as a hashed version of the displayed env name. Because of the way jupyter works, if you update an env you're using in a notebook, the notebook will still be using the old environment.

This has to do with the juypter server caching the absolute path to the current kernel.
How conda store works:

  • symlink global/dashboard -> /path/to/environment/dashboard-1
    When you build a new environment conda-store changes the symlink
  • /path/to/environment/dashboard-1 (exists but not symlinked)
  • symlink global/dashboard -> /path/to/environment/dashboard-2

Jupyter server or something along those lines while we give it the symlink it resolves the path an "remembers" /path/to/environment/dashboard-1

We need a note in our environment building docs and maybe the FAQ that mentions at a high level that when you rebuild your environment, you'll need to

  1. switch from you environment to a different kernel
  2. switch back to your desired environment
    Restart will not be effective here.
Steps to Resolve this Issue

Proper resolution lies with the conda-store project. We just need to document existing functionality.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the environment-building documentation and FAQ, then review how they describe rebuilding environments and switching kernels. Document that Jupyter may retain the old hashed environment path, and that users should switch to another kernel and back; make clear that restarting alone is ineffective.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.