Updating Jupyter docs with feedback from summer school in Heilbronn (#172)

lukasgd · RMeli · bcumming · web-flow · commit 602f4aacbd79 · 2025-07-07T08:47:07.000Z
* Updating Jupyter docs with feedback from summer school in Heilbronn * Update Jupyter refs * Fixing CE example * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Update docs/access/jupyterlab.md Co-authored-by: Rocco Meli <r.meli@bluemail.ch> * Use torch.distributed.run instead of torchrun by default * Update comment on torchrun with virtual environments * Fix merge (update Jupyter refs) * Update jupyterlab.md Small changes * Update jupyterlab.md wording * Note about multi-GPU training from a single process * fix that parasitic broken link * Apply suggestion from @msimberg * Apply suggestion from @msimberg * Apply suggestion from @msimberg * Apply suggestion from @msimberg * Apply suggestion from @msimberg --------- Co-authored-by: Rocco Meli <r.meli@bluemail.ch> Co-authored-by: Ben Cumming <bcumming@cscs.ch> Co-authored-by: twrobinson <robinson@cscs.ch> Co-authored-by: Mikael Simberg <mikael.simberg@iki.fi>
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,5 +1,5 @@
 * @bcumming @msimberg @RMeli
-docs/services/jupyterlab.md @rsarm
+docs/access/jupyterlab.md @rsarm
 docs/services/firecrest @jpdorsch @ekouts
 docs/software/communication @Madeeks @msimberg
 docs/software/devtools/linaro @jgphpc
diff --git a/docs/access/index.md b/docs/access/index.md
@@ -26,6 +26,12 @@ This documentation guides users through the process of accessing CSCS systems an
 
     [:octicons-arrow-right-24: SSH][ref-ssh]
 
+-   :simple-jupyter: __JupyterLab__
+
+    JupyterLab is a feature-rich notebook authoring application and editing environment.
+
+    [:octicons-arrow-right-24: JupyterLab][ref-jupyter]
+
 -   :fontawesome-solid-layer-group: __VSCode__
 
     How to connect VSCode IDE on your laptop with Alps
diff --git a/docs/access/jupyterlab.md b/docs/access/jupyterlab.md
diff --git a/docs/clusters/eiger.md b/docs/clusters/eiger.md
@@ -29,7 +29,7 @@ Eiger is an Alps cluster that provides compute nodes and file systems designed t
     ### Unimplemented features
 
     !!! under-construction "Jupyter is not yet available"
-        [Jupyter][ref-jlab] has not yet been configured on `Eiger.Alps`.
+        [Jupyter][ref-jupyter] has not yet been configured on `Eiger.Alps`.
 
         **It will be deployed as soon as possible and this documentation will be updated accordingly**
 
@@ -160,7 +160,7 @@ See the Slurm documentation for instructions on how to run jobs on the [AMD CPU
 
 ### JupyterHub 
 
-A JupyterHub service for Eiger is available at [https://jupyter-eiger.cscs.ch](https://jupyter-eiger.cscs.ch).
+A [JupyterHub][ref-jupyter] service for Eiger is available at [https://jupyter-eiger.cscs.ch](https://jupyter-eiger.cscs.ch).
 
 ### FirecREST
 
diff --git a/docs/index.md b/docs/index.md
@@ -110,8 +110,6 @@ If you cannot find the information that you need in the documentation, help is a
 
     [:octicons-arrow-right-24: CI/CD for external projects](services/cicd.md)
 
-    [:octicons-arrow-right-24: JupyterLab](services/jupyterlab.md)
-
 
 -   :fontawesome-solid-hammer: __Software__
 
diff --git a/docs/services/index.md b/docs/services/index.md
@@ -12,11 +12,5 @@
     FirecREST is a RESTful API for programmatically accessing High-Performance Computing resources.
 
     [:octicons-arrow-right-24: FirecREST][ref-firecrest]
-
--   :simple-jupyter: __JupyterLab__
-
-    JupyterLab is a feature-rich notebook authoring application and editing environment.
-
-    [:octicons-arrow-right-24: JupyterLab][ref-jlab]
 </div>
 
diff --git a/docs/services/jupyterlab.md b/docs/services/jupyterlab.md
diff --git a/docs/software/prgenv/julia.md b/docs/software/prgenv/julia.md
@@ -53,7 +53,7 @@ Start the image and activate the Julia[up] HPC setup by loading the following vi
         uenv start julia/25.5:v1 --view=juliaup,modules
         ```
 
-There is also a view `jupyter` available, which is required for [using Julia in JupyterHub][using-julia-in-jupyterhub].
+There is also a view `jupyter` available, which is required for [using Julia in JupyterHub][using-julia-in-jupyter].
 
 !!! info "Automatic installation of Juliaup and Julia"
     The installation of `juliaup` and the latest `julia` version happens automatically the first time when `juliaup` is called:
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -41,6 +41,7 @@ nav:
     - 'Multi Factor Authentication (MFA)': access/mfa.md
     - 'Web Services': access/web.md
     - 'SSH': access/ssh.md
+    - 'JupyterLab': access/jupyterlab.md
     - 'VSCode': access/vscode.md
   - 'Software':
     - software/index.md
@@ -97,7 +98,6 @@ nav:
     - services/index.md
     - 'FirecREST': services/firecrest.md
     - 'CI/CD': services/cicd.md
-    - 'JupyterLab': services/jupyterlab.md
   - 'Running Jobs':
     - running/index.md
     - 'Slurm': running/slurm.md
