Skip to content
Snippets Groups Projects
Commit fb23e7a5 authored by LocNgu's avatar LocNgu
Browse files

Fix links and markdown in JupyterHubForTeaching.md

parent 8cec4e16
No related branches found
No related tags found
3 merge requests!322Merge preview into main,!319Merge preview into main,!132Fix links and markdown in JupyterHubForTeaching.md
Hide whitespace changes
Inline Side-by-side
doc.zih.tu-dresden.de/docs/software/JupyterHubForTeaching.md
+ 41
− 62
View file @ fb23e7a5
......@@ -3,28 +3,25 @@
On this page we want to introduce to you some useful features if you
want to use JupyterHub for teaching.
<span class="twiki-macro RED"></span> **PLEASE UNDERSTAND:** <span
class="twiki-macro ENDCOLOR"></span> JupyterHub uses compute resources
<span style="color:red">**PLEASE UNDERSTAND:** </span> JupyterHub uses compute resources
from the HPC system Taurus. Please be aware of the following notes:
- The HPC system operates at a lower availability level than your
usual Enterprise Cloud VM. There can always be downtimes, e.g. of
the file systems 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](Compendium.Access)).
- Don't forget to [add your
users](ProjectManagement#manage_project_members_40dis_45_47enable_41)
(eg. students or tutors) to your project.
- It might be a good idea to [request a
reservation](Slurm#Reservations) of part of the compute resources
- The HPC system operates at a lower availability level than your
usual Enterprise Cloud VM. There can always be downtimes, e.g. of
the file systems 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/Access.md)).
- Don't forget to **TODO ANCHOR**(add your
users)(ProjectManagement#manage_project_members_40dis_45_47enable_41)
(eg. students or tutors) to your project.
- It might be a good idea to **TODO ANCHOR**(request a
reservation)(Slurm#Reservations) 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
......@@ -35,7 +32,7 @@ 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.
\<a href="%ATTACHURL%/gitpull_progress.png">\<img alt="Git pull progress
**TODO ADD IMAGE** \<a href="%ATTACHURL%/gitpull_progress.png">\<img alt="Git pull progress
screen" width="475"
src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/gitpull_progress.png>"
style="border: 1px solid #888;" title="Git pull progress screen"/>\</a>
......@@ -43,47 +40,25 @@ style="border: 1px solid #888;" title="Git pull progress screen"/>\</a>
A sharable link for this feature looks like this:
<https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https://github.com/jdwittenauer/ipython-notebooks&urlpath=/tree/ipython-notebooks/notebooks/language/Intro.ipynb>
\<a href="%ATTACHURL%/url-git-pull.png?t=1604588695">\<img alt="URL with
**TODO ADD IMAGE**\<a href="%ATTACHURL%/url-git-pull.png?t=1604588695">\<img alt="URL with
git-pull parameters" width="100%" style="max-width: 2717px"
src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-git-pull.png?t=1604588695>"
style="border: 1px solid #888;" title="URL with git-pull
parameters"/>\</a>
\<span
style`"font-size: 1em;">This example would clone the repository </span> [[https://github.com/jdwittenauer/ipython-notebooks][github.com/jdwittenauer/ipython-notebooks]]<span style="font-size: 1em;"> and afterwards open the </span> =Intro.ipynb`
\<span style="font-size: 1em;"> notebook in the given path.\</span>
This example would clone the repository
[https://github.com/jdwittenauer/ipython-notebooks](https://github.com/jdwittenauer/ipython-notebooks)
and afterwards open the **Intro.ipynb** notebook in the given path.
The following parameters are available:
<table>
<thead>
<tr class="header">
<th style="text-align: left;">parameter</th>
<th style="text-align: left;">info</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: left;">repo</td>
<td style="text-align: left;">path to git repository</td>
</tr>
<tr class="even">
<td style="text-align: left;">branch</td>
<td style="text-align: left;">branch in the repository to pull from<br />
default: <code>master</code></td>
</tr>
<tr class="odd">
<td style="text-align: left;">urlpath</td>
<td style="text-align: left;">URL to redirect the user to a certain file<br />
<a href="https://jupyterhub.github.io/nbgitpuller/topic/url-options.html#urlpath">more info</a></td>
</tr>
<tr class="even">
<td style="text-align: left;">depth</td>
<td style="text-align: left;">clone only a certain amount of latest commits<br />
not recommended</td>
</tr>
</tbody>
</table>
|parameter | info |
|---|---|
|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)|
|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/)
......@@ -96,17 +71,19 @@ parameters.
An example: The following link would create a jupyter notebook session
on the `interactive` partition with the `test` environment being loaded:
https://taurus.hrsk.tu-dresden.de/jupyter/hub/spawn#/~(partition~'interactive~environment~'test)
```
https://taurus.hrsk.tu-dresden.de/jupyter/hub/spawn#/~(partition~'interactive~environment~'test)
```
/ \<a href="%ATTACHURL%/url-quick-start.png?t=1604586059">\<img alt="URL
**TODO ADD IMG** \<a href="%ATTACHURL%/url-quick-start.png?t=1604586059">\<img alt="URL
with quickstart parameters" width="100%" style="max-width: 800px"
src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-quick-start.png?t=1604586059>"
style="border: 1px solid #888;" title="URL with quickstart
parameters"/>\</a>
\<span style="font-size: 1em;">Every parameter of the advanced form can
Every parameter of the advanced form can
be set with this parameter. If the parameter is not mentioned, the
default value will be loaded.\</span>
default value will be loaded.
| parameter | default value |
|:----------------|:-----------------------------------------|
......@@ -132,9 +109,11 @@ want. The address bar contains the encoded parameters starting with
You can combine both features in a single link:
https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https://github.com/jdwittenauer/ipython-notebooks&urlpath=/tree/ipython-notebooks/notebooks/language/Intro.ipynb#/~(partition~'interactive~environment~'test)
```
https://taurus.hrsk.tu-dresden.de/jupyter/hub/user-redirect/git-pull?repo=https://github.com/jdwittenauer/ipython-notebooks&urlpath=/tree/ipython-notebooks/notebooks/language/Intro.ipynb#/~(partition~'interactive~environment~'test)
```
/ \<a
**TODO ADD IMAGE**\<a
href="%ATTACHURL%/url-git-pull-and-quick-start.png?t=1604588695">\<img
alt="URL with git-pull and quickstart parameters" width="100%"
style="max-width: 3332px"
......@@ -148,14 +127,14 @@ With the following link you will be redirected to a certain file in your
home directory. The file needs to exist, otherwise a 404 error will be
thrown.
<https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb>
\<a href="%ATTACHURL%/url-user-redirect.png">\<img alt="URL with
[https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb](https://taurus.hrsk.tu-dresden.de/jupyter/user-redirect/notebooks/demo.ipynb)
**TODO ADD IMAGE** \<a href="%ATTACHURL%/url-user-redirect.png">\<img alt="URL with
git-pull and quickstart parameters" width="100%" style="max-width:
700px"
src="<https://doc.zih.tu-dresden.de/hpc-wiki/pub/Compendium/JupyterHubForTeaching/url-user-redirect.png?t=1604587961>"
style="border: 1px solid #888;" title="URL with git-pull and quickstart
parameters"/>\</a>
\<span
style`"font-size: 1em;">This link would redirect to </span> =https://taurus.hrsk.tu-dresden.de/jupyter/user/{login}/notebooks/demo.ipynb`
\<span style="font-size: 1em;">.\</span>
This link would redirect to
`https://taurus.hrsk.tu-dresden.de/jupyter/user/{login}/notebooks/demo.ipynb` .
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
Nutzungsbedingungen | Datenschutzerklärung | Barrierefreiheitserklärung