Skip to content

Commit 7826edb

Browse files
committed
Update Jupyter refs
1 parent b687222 commit 7826edb

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/access/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This documentation guides users through the process of accessing CSCS systems an
3030

3131
JupyterLab is a feature-rich notebook authoring application and editing environment.
3232

33-
[:octicons-arrow-right-24: JupyterLab][ref-jlab]
33+
[:octicons-arrow-right-24: JupyterLab][ref-jupyter]
3434

3535
- :fontawesome-solid-layer-group: __VSCode__
3636

docs/access/jupyterlab.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[](){#ref-jlab}
1+
[](){#ref-jupyter}
22
# JupyterLab
33

44
## Access and setup
@@ -21,7 +21,7 @@ When resources are granted the page redirects to the JupyterLab session, where y
2121
You can check your quota using the command `quota`.
2222

2323

24-
[](){#ref-jlab-runtime-environment}
24+
[](){#ref-jupyter-runtime-environment}
2525
## Runtime environment
2626

2727
A Jupyter session can be started with either a [uenv][ref-uenv] or a [container][ref-container-engine] as a base image. The JupyterHub Spawner form provides a set of default images such as the [prgenv-gnu][ref-uenv-prgenv-gnu] uenv or the [NGC Pytorch container][ref-software-ml] to choose from in a dropdown menu. When using uenv, the software stack will be mounted at `/user-environment`, and the specified view will be activated. For a container, the Jupyter session will launch inside the container filesystem with only a select set of paths mounted from the host. Once you have found a suitable option, you can start the session with `Launch JupyterLab`.
@@ -101,7 +101,7 @@ As a preliminary step to running any code in Jupyter notebooks, a kernel needs t
101101

102102
### Using Python in Jupyter
103103

104-
For Python, the recommended setup consists of a uenv or container as a base image as described [above][ref-jlab-runtime-environment] that includes the stable dependencies of the software stack. Additional packages can be installed in a virtual environment _on top_ of the Python installation in the base image (mandatory for most uenvs). Having the base image loaded, such a virtual environment can be created with
104+
For Python, the recommended setup consists of a uenv or container as a base image as described [above][ref-jupyter-runtime-environment] that includes the stable dependencies of the software stack. Additional packages can be installed in a virtual environment _on top_ of the Python installation in the base image (mandatory for most uenvs). Having the base image loaded, such a virtual environment can be created with
105105

106106
```bash title="Create a virtual environment on top of a base image"
107107
python -m venv --system-site-packages venv-<base-image-version>
@@ -126,7 +126,7 @@ python -m ipykernel install \
126126

127127
The `<kernel-name>` can be replaced by a name specific to the base image/virtual environment.
128128

129-
!!! bug "Python packages from uenv shadowing those from a virtual environment"
129+
!!! bug "Python packages from uenv shadowing those in a virtual environment"
130130
When using uenv with a virtual environment on top, the site-packages under `/user-environment` currently take precedence over those in the activated virtual environment. This is due to the path being included in the `PYTHONPATH` environment variable. As a consequence, despite installing a different version of a package in the virtual environment from what is available in the uenv, the uenv version will still be imported at runtime. A possible workaround is to prepend the virtual environment's site-packages to `PYTHONPATH` whenever activating the virtual environment.
131131
```bash
132132
export PYTHONPATH="$(python -c 'import site; print(site.getsitepackages()[0])'):$PYTHONPATH"
@@ -141,7 +141,7 @@ The `<kernel-name>` can be replaced by a name specific to the base image/virtual
141141

142142
### Using Julia in Jupyter
143143

144-
To run Julia code in Jupyter notebooks, you can use the provided uenv for this language. In particular, you need to use the following in the JupyterHub Spawner `Advanced options` forms mentioned [above][ref-jlab-runtime-environment]:
144+
To run Julia code in Jupyter notebooks, you can use the provided uenv for this language. In particular, you need to use the following in the JupyterHub Spawner `Advanced options` forms mentioned [above][ref-jupyter-runtime-environment]:
145145
!!! important "pass a [`julia`][ref-uenv-julia] uenv and the view `jupyter`."
146146

147147
When Julia is first used within Jupyter, IJulia and one or more Julia kernel need to be installed.

0 commit comments

Comments
 (0)