Skip to content
Snippets Groups Projects
Commit f22a1c06 authored by Jan Frenzel's avatar Jan Frenzel
Browse files

Corrected link texts and typos in jupyterhub.md and

jupyterhub_for_teaching.md.
parent bdeacbb0
No related branches found
No related tags found
3 merge requests!446docs: Add Jupyter Teaching Example,!423Automated merge from preview to main,!420Reduce the number of forbidden pattern matches further
# JupyterHub
With our JupyterHub service we offer you a quick and easy way to work with Jupyter notebooks on ZIH
systems. This page covers starting and stopping JuperterHub sessions, error handling and customizing
systems. This page covers starting and stopping JupyterHub sessions, error handling and customizing
the environment.
We also provide a comprehensive documentation on how to use
......@@ -101,7 +101,7 @@ running the code. We currently offer one for Python, C++, MATLAB and R.
## Stop a Session
It is good practise to stop your session once your work is done. This releases resources for other
It is good practice to stop your session once your work is done. This releases resources for other
users and your quota is less charged. If you just log out or close the window, your server continues
running and **will not stop** until the Slurm job runtime hits the limit (usually 8 hours).
......@@ -148,8 +148,8 @@ Useful pages for valid batch system parameters:
If the connection to your notebook server unexpectedly breaks, you will get this error message.
Sometimes your notebook server might hit a batch system or hardware limit and gets killed. Then
usually the logfile of the corresponding batch job might contain useful information. These logfiles
are located in your `home` directory and have the name `jupyter-session-<jobid>.log`.
usually the log file of the corresponding batch job might contain useful information. These log
files are located in your `home` directory and have the name `jupyter-session-<jobid>.log`.
## Advanced Tips
......@@ -310,4 +310,4 @@ You can switch kernels of existing notebooks in the kernel menu:
You have now the option to preload modules from the [module system](../software/modules.md).
Select multiple modules that will be preloaded before your notebook server starts. The list of
available modules depends on the module environment you want to start the session in (`scs5` or
`ml`). The right module environment will be chosen by your selected partition.
`ml`). The right module environment will be chosen by your selected partition.
# JupyterHub for Teaching
On this page we want to introduce to you some useful features if you
want to use JupyterHub for teaching.
On this page, we want to introduce to you some useful features if you want to use JupyterHub for
teaching.
!!! note
......@@ -9,23 +9,21 @@ want to use JupyterHub for teaching.
Please be aware of the following notes:
- ZIH systems operate at a lower availability level than your usual Enterprise Cloud VM. There
can always be downtimes, e.g. of the filesystems or the batch system.
- ZIH systems operate at a lower availability level than your usual Enterprise Cloud VM. There can
always be downtimes, e.g. of the filesystems or the batch system.
- Scheduled downtimes are announced by email. Please plan your courses accordingly.
- Access to HPC resources is handled through projects. See your course as a project. Projects need
to be registered beforehand (more info on the page [Access](../application/overview.md)).
- Don't forget to [add your users](../application/project_management.md#manage-project-members-dis-enable)
(eg. students or tutors) to your project.
(e.g. students or tutors) to your project.
- It might be a good idea to [request a reservation](../jobs_and_resources/overview.md#exclusive-reservation-of-hardware)
of part of the compute resources for your project/course to
avoid unnecessary waiting times in the batch system queue.
of part of the compute resources for your project/course to avoid unnecessary waiting times in
the batch system queue.
## Clone a Repository With a Link
This feature bases on
[nbgitpuller](https://github.com/jupyterhub/nbgitpuller).
Documentation can be found at
[this page](https://jupyterhub.github.io/nbgitpuller/).
This feature bases on [nbgitpuller](https://github.com/jupyterhub/nbgitpuller). Further information
can be found in the [external documentation about nbgitpuller](https://jupyterhub.github.io/nbgitpuller/).
This extension for Jupyter notebooks can clone every public git repository into the users work
directory. It's offering a quick way to distribute notebooks and other material to your students.
......@@ -50,14 +48,14 @@ The following parameters are available:
|---|---|
|`repo` | path to git repository|
|`branch` | branch in the repository to pull from default: `master`|
|`urlpath` | URL to redirect the user to a certain file [more info](https://jupyterhub.github.io/nbgitpuller/topic/url-options.html#urlpath)|
|`urlpath` | URL to redirect the user to a certain file, [more info about parameter urlpath](https://jupyterhub.github.io/nbgitpuller/topic/url-options.html#urlpath)|
|`depth` | clone only a certain amount of latest commits not recommended|
This [link
generator](https://jupyterhub.github.io/nbgitpuller/link?hub=https://taurus.hrsk.tu-dresden.de/jupyter/)
might help creating those links
## Spawner Options Passthrough with URL Parameters
## Spawn Options Pass-through with URL Parameters
The spawn form now offers a quick start mode by passing URL parameters.
......
......@@ -65,6 +65,8 @@ DockerHub
dockerized
dotfile
dotfiles
downtime
downtimes
EasyBuild
ecryptfs
engl
......@@ -142,6 +144,7 @@ Itanium
jobqueue
jpg
jss
jupyter
Jupyter
JupyterHub
JupyterLab
......@@ -194,6 +197,7 @@ multithreaded
Multithreading
NAMD
natively
nbgitpuller
nbsp
NCCL
Neptun
......@@ -260,6 +264,8 @@ pytorch
PyTorch
Quantum
queue
quickstart
Quickstart
randint
reachability
README
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment