diff --git a/README.md b/README.md index c4f95e6300c9f0949cec1ff4c83f2e1d0d47dff9..1e14b0ede7361a50d5a7f02ac5327ed2bf9b8fdd 100644 --- a/README.md +++ b/README.md @@ -1,93 +1,111 @@ -# training-2024.04-jupyter4hpc - - - -## Getting started - -To make it easy for you to get started with GitLab, here's a list of recommended next steps. - -Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! - -## Add your files - -- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files -- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: - -``` -cd existing_repo -git remote add origin https://gitlab.jsc.fz-juelich.de/jupyter4jsc/training-2024.04-jupyter4hpc.git -git branch -M main -git push -uf origin main -``` - -## Integrate with your tools - -- [ ] [Set up project integrations](https://gitlab.jsc.fz-juelich.de/jupyter4jsc/training-2024.04-jupyter4hpc/-/settings/integrations) - -## Collaborate with your team - -- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) -- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) -- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) -- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) -- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) - -## Test and Deploy - -Use the built-in continuous integration in GitLab. - -- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) -- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) -- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) -- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) -- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) - -*** - -# Editing this README - -When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. - -## Suggestions for a good README - -Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. - -## Name -Choose a self-explaining name for your project. - -## Description -Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. - -## Badges -On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. - -## Visuals -Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. - -## Installation -Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. - -## Usage -Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. - -## Support -Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. - -## Roadmap -If you have ideas for releases in the future, it is a good idea to list them in the README. - -## Contributing -State if you are open to contributions and what your requirements are for accepting them. - -For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. - -You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. - -## Authors and acknowledgment -Show your appreciation to those who have contributed to the project. - -## License -For open source projects, say how it is licensed. - -## Project status -If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. +Training Course 2024, Interactive High-Performance Computing with JupyterLab +================ + +### Document Updates: +- 08.04.24, 09:00 : initial commit + +### General Information: +- [Event Webpage](https://indico3-jsc.fz-juelich.de/event/161/) +- [JSC Webpage](https://www.fz-juelich.de/en/ias/jsc/news/events/training-courses/2024/interactive-hpc) + +Interactive exploration and analysis of large amounts of data from scientific simulations, in-situ visualization and application control are convincing scenarios for explorative sciences. Based on the open source software Jupyter or JupyterLab, a way has been available for some time now that combines interactive with reproducible computing while at the same time meeting the challenges of support for the wide range of different software workflows. + +Even on supercomputers, the method enables the creation of documents that combine live code with narrative text, mathematical equations, visualizations, interactive controls, and other extensive output. However, a number of challenges must be mastered in order to make existing workflows ready for interactive high-performance computing. With so many possibilities, it's easy to lose sight of the big picture. This course provides a detailed introduction to interactive high-performance computing. + +### Main Data: +date +: 23-24 April 2024 + 9:00 - 13:00 (CET) + +instructor: +: Jens Henrik Göbbert, j.goebbert@fz-juelich.de + +contents level: +: Beginner's contents: 20 % + Intermediate contents: 80 % + +venue +: Online, Zoom + (not available yet) + +prerequisites: +: Experience in Python + +workshop materials +: GitLab repository: https://gitlab.jsc.fz-juelich.de/jupyter4jsc/training-2024.04-jupyter4hpc + Shared notes: https://gitlab.jsc.fz-juelich.de/hedgedoc/3y3ppo_2Rq2ieO59LrBotg + +recordings +: day 1 : (not available yet) + day 2 : (not available yet) + +### Agenda: +| | Title | +|:-------------:|:-------------------------------------------------| +| **Tuesday, 23th** | **Introduction to JupyterLab** | +| 9:00 - 10:30 | Welcome & Introduction | +| | Register & Login | +| | JupyterLab UI Tour | +| | JupyterLab First Steps | +| 10:30 - 11:00 | Break | +| 11:00 - 13:00 | Jupyter Kernels | +| | Custom Jupyter Kernels | +| | Extras | +| **Wednesday, 24th** | **Building on JupyterLab** | +| 9:00 - 10:30 | Welcome & Login | +| | JupyterLab Extensions | +| | JupyterLab Server Proxy | +| 10:30 - 11:00 | Break | +| | Parallel Programming with JupyterLab | +| | JupyterHub - under the hood | +| | My own JupyterLab | +| | Feedback & Good Bye | + + +## Getting Access + - [ ] **Register** at https://judoor.fz-juelich.de - [**Video-Howto (1:10)**](https://drive.google.com/file/d/1-DfiNBP4Gta0av4lQmubkXIXzr2FW4a-/view) + - Click on "Register" + - Enter your email address + - Click on "Send confirmation mail..." + - Open the confirmation email in your email program + - Click the confirmation link + + - [ ] **Join** the training project + - [ ] by following this link: + - **https://judoor.fz-juelich.de/projects/join/(not available yet)** + - [ ] **or** by choosing this general approach - [**Video-Howto (1:06)**](https://drive.google.com/file/d/1XdQSdML_jqGqvr_2WXqzlE-G6hiuYE2_/view) + - Login to https://judoor.fz-juelich.de + - Scroll to section "Projects" + - Hit the link "Join a project" + - Enter the Project id: + - "**(no available yet)**" for this training course + - Click on "Join project" + + - [ ] **Please be patient** + - **This takes as long as the PI needs to respond!** + - The PI has to accept your join-request first + - After acceptance + - project will be listed in section "Projects" + - systems will be listed in section "Systems" + +- [ ] **Sign usage agreement** - [**Video-Howto (1:13)**](https://drive.google.com/file/d/1mEN1GmWyGFp75uMIi4d6Tpek2NC_X8eY/view) + - Login to https://judoor.fz-juelich.de + - Scroll to section "Systems" + - Click on "You need to _sign the usage agreement_ to access this system" + - Sign the usage agreement + +- [ ] **Please be patient** + - **This may take up to 10 minutes!** + - Your HPC accounts will now be created on the desired systems. + - Shortly after your HPC accounts are prepared you will see + - "jupyter-jsc" in the section "Connected Services" + +- [ ] **Login** at https://jupyter-jsc.fz-juelich.de - [**Video-Howto (1:34)**](https://drive.google.com/file/d/1S8_DaZRjBUOv7S3xT_KO8WFf44BqlR0O/view) + - Click on "Login" + - Login with your new **JSC account** + - If this is your first login + - click on "Register" + - agree to the terms of service + - click the link in the confirmation mail + +- [ ] **CONGRATULATIONS - YOU ARE READY FOR THE TRAINING COURSE** \ No newline at end of file