Skip to content
Snippets Groups Projects
Verified Commit b5379f5b authored by Alexander Dunkel's avatar Alexander Dunkel
Browse files

docs: improve readme

parent deddee10
No related branches found
No related tags found
No related merge requests found
Pipeline #171783 passed
......@@ -9,10 +9,6 @@ Mobile Cartography Jupyter Lab Workshop.
------
> :warning: Unfortunately, the ZIH is in the midst of migration from `Taurus` system to `Barnard`. You
> can run the workshop in both systems, but the startup is a little bit different between the two. We
> do not know whether or how long Taurus will be available in 2024, so please try to use this only as a fallback.
## Preparations
1. If working from remote: Make sure to connect to TUD network using [a VPN connection][cisco-zih] (Cisco VPN or OpenVPN), otherwise you will not be able to use any of ZIH HPC Services
......@@ -42,24 +38,8 @@ Afterwards, once the notebook has opened:
## Manual startup
3. [Login to HPC][login-zih-link]
- You'll be requested to login using your TUD Account
4. Select `Barnard - 2 core, 3G, 4 hours` or `Romeo - 2 core, 3G, 4 hours`
5. **Click Start** to spawn a Jupyter Lab instance on the TUD ZIH Jupyter Hub.
6. Clone the workshop files
- Once JupyterHub started, open a new empty Python Notebook with click on the following icon:
![Startup Jupyter Hub](resources/python_jup.webp)
- .. and copy &paste the following command in the first cell:
```bash
!cd /home/$USER && \
git clone https://gitlab.hrz.tu-chemnitz.de/tud-ifk/jupyter_python_datascience.git
```
- run with <kbd>SHIFT+Enter</kbd>
![Startup Jupyter Hub](resources/clone.webp)
- this will download the workshop material to your local user folder (explorer on the left side)
- in the explorer on the left, open the file `jupyter_python_datascience/notebooks/01_raw_intro.ipynb`
![Startup Jupyter Hub](resources/notebook_jup.webp)
- and start following the instructions
See [00_manual.md](resources/faq/00_manual.md) with a description to start Jupyter Hub manually,
without the spawn link.
## FAQ
......@@ -81,7 +61,7 @@ Please click on the links below to see possible routes to solve these issues.
4. [04_topic_classification.html](https://kartographie.geo.tu-dresden.de/ad/jupyter_python_datascience/04_topic_classification.html)
[login-zih-link]: https://jupyterhub.hpc.tu-dresden.de/hub/
[spawn-zih-link]: https://jupyterhub.hpc.tu-dresden.de/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgitlab.hrz.tu-chemnitz.de%2Ftud-ifk%2Fjupyter_python_datascience.git&branch=main&urlpath=lab%2Ftree%2Fjupyter_python_datascience.git%2Fnotebooks%2F01_raw_intro.ipynb#/~(cluster~'barnard~project~'p_lv_mobicart_2425~runtime~'2*3a30*3a00~cpuspertask~'2~mempercpu~'4096)
[spawn-zih-link2]: https://jupyterhub.hpc.tu-dresden.de/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgitlab.hrz.tu-chemnitz.de%2Ftud-ifk%2Fjupyter_python_datascience.git&branch=main&urlpath=lab%2Ftree%2Fjupyter_python_datascience.git%2Fnotebooks%2F01_raw_intro.ipynb#/~(cluster~'romeo~project~'p_lv_mobicart_2425~runtime~'2*3a30*3a00~cpuspertask~'2~mempercpu~'2583)
[spawn-zih-link]: https://jupyterhub.hpc.tu-dresden.de/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgitlab.hrz.tu-chemnitz.de%2Ftud-ifk%2Fjupyter_python_datascience.git&branch=main&urlpath=lab%2Ftree%2Fjupyter_python_datascience.git%2Fnotebooks%2F01_raw_intro.ipynb#/~(cluster~'barnard~nodes~'2~project~'p_lv_mobicart_2425~runtime~'2*3a30*3a00~cpuspertask~'2~ntasks~'2~mempercpu~'4096)
[spawn-zih-link2]: https://jupyterhub.hpc.tu-dresden.de/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgitlab.hrz.tu-chemnitz.de%2Ftud-ifk%2Fjupyter_python_datascience.git&branch=main&urlpath=lab%2Ftree%2Fjupyter_python_datascience.git%2Fnotebooks%2F01_raw_intro.ipynb#/~(cluster~'romeo~nodes~'2~project~'p_lv_mobicart_2425~runtime~'2*3a30*3a00~cpuspertask~'2~ntasks~'2~mempercpu~'2583)
[static-gl-url]: https://gitlab.hrz.tu-chemnitz.de/tud-ifk/jupyter_python_datascience
[cisco-zih]: https://tu-dresden.de/zih/dienste/service-katalog/arbeitsumgebung/zugang_datennetz/vpn?set_language=de
## Manual startup
3. [Login to HPC][login-zih-link]
- You'll be requested to login using your TUD Account
4. Select `Barnard - 2 core, 3G, 4 hours` or `Romeo - 2 core, 3G, 4 hours` and `p_lv_mobicart_2425` as the project name.
5. **Click Start** to spawn a Jupyter Lab instance on the TUD ZIH Jupyter Hub.
6. Clone the workshop files
- Once JupyterHub started, open a new empty Python Notebook with click on the following icon:
![Startup Jupyter Hub](resources/python_jup.webp)
- .. and copy &paste the following command in the first cell:
```bash
!cd /home/$USER && \
git clone https://gitlab.hrz.tu-chemnitz.de/tud-ifk/jupyter_python_datascience.git
```
- run with <kbd>SHIFT+Enter</kbd>
![Startup Jupyter Hub](resources/clone.webp)
- this will download the workshop material to your local user folder (explorer on the left side)
- in the explorer on the left, open the file `jupyter_python_datascience/notebooks/01_raw_intro.ipynb`
![Startup Jupyter Hub](resources/notebook_jup.webp)
- and start following the instructions
[login-zih-link]: https://jupyterhub.hpc.tu-dresden.de/hub/
\ No newline at end of file
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