Skip to content

Commit

Permalink
docs: add detail for creating a jupyter kernel from uv .venv
Browse files Browse the repository at this point in the history
  • Loading branch information
tomjholland committed Jan 2, 2025
1 parent f8e2026 commit 35b33bd
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/source/developer_guide/developer_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,15 @@ virtual environment:
uv sync --all-extras --all-groups
The virtual environment is stored in the :code:`PyProBE/.venv` directory inside your and
can be activated with :code:`source .venv/bin/activate`.
can be activated with :code:`source .venv/bin/activate`.

To run a jupyter notebook in VSCode from this environment you can run:

.. code-block:: bash
uv run -m ipykernel install --user --name <your-chosen-name>
This will create a kernel that you can select within VSCode in the usual way.

.. dropdown:: Alternative installation with pip (not recommended)

Expand Down

0 comments on commit 35b33bd

Please sign in to comment.