Skip to content

Commit 5849fde

Browse files
adding ipykernel registration to setup guide (#4)
* Add initial documentation structure and contributing guide * Document manual Jupyter kernel registration steps * Document manual Jupyter kernel registration steps
1 parent 5475b47 commit 5849fde

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/guides/environment_setup.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,34 @@ uv run python my_script.py
8888
uv run jupyter lab
8989
```
9090

91+
### Registering the environment as a Jupyter kernel
92+
93+
uv does not automatically register your virtual environment as a Jupyter kernel. This is by design — uv manages only the environment itself, not the kernel registry that Jupyter uses to discover Python environments. As a result, even after running `uv sync`, your environment will not appear in JupyterLab's kernel picker until you register it manually.
94+
95+
To register it, first make sure `ipykernel` is installed in the environment, then use it to add the kernel to Jupyter's registry:
96+
97+
```bash
98+
uv add ipykernel
99+
uv run python -m ipykernel install --user --name my-experiment --display-name "My Experiment"
100+
```
101+
102+
- `--name` is a short identifier used internally (no spaces).
103+
- `--display-name` is what appears in the JupyterLab UI.
104+
105+
After running this, restart JupyterLab and the kernel will be available in the launcher and the kernel picker.
106+
107+
To list all registered kernels:
108+
109+
```bash
110+
uv run jupyter kernelspec list
111+
```
112+
113+
To remove a kernel you no longer need:
114+
115+
```bash
116+
uv run jupyter kernelspec remove my-experiment
117+
```
118+
91119
### Adding new dependencies
92120

93121
```bash

0 commit comments

Comments
 (0)