diff --git a/docs/getting_started/login_snowy.md b/docs/getting_started/login_snowy.md index dba9545f7..d3757d2f6 100644 --- a/docs/getting_started/login_snowy.md +++ b/docs/getting_started/login_snowy.md @@ -2,19 +2,8 @@ Here we describe how to log in to [Snowy](../cluster_guides/snowy.md) -## Prerequisites - -To be allowed to use Snowy, one needs all of these: - -- [ ] An active research project -- [ ] An UPPMAX account -- [ ] An UPPMAX password - -- User account: visit the [UPPMAX page on user accounts](user_account.md) -- A local UPPMAX project: see [project](project.md). - Snowy is available as compute nodes only - -## Reach the Snowy compute nodes +One needs to be allowed to use Snowy. +[These prerequisites](rackham_usage_prerequisites.md) describes what is needed before one can use Snowy. To make Snowy do a calculation, one needs to log in to a Rackham login node, which is described [here](../getting_started/login_rackham.md). @@ -26,17 +15,16 @@ After logging in, one can ```mermaid - graph TB +graph LR - Node1 -- interactive --> SubGraph2Flow - Node1 -- sbatch --> SubGraph2Flow - subgraph "Snowy" - SubGraph2Flow(calculation nodes) - end + subgraph "Snowy" + snowy_calculation_node[Calculation nodes] + end - subgraph "Rackham" - Node1[Login] -- interactive --> Node2[calculation nodes] - Node1 -- sbatch --> Node2 - end + subgraph "Rackham" + login_node[Login node] + end + + login_node --> |interactive\nsbatch| snowy_calculation_node ``` diff --git a/docs/getting_started/snowy_usage_prerequisites.md b/docs/getting_started/snowy_usage_prerequisites.md new file mode 100644 index 000000000..a9b083740 --- /dev/null +++ b/docs/getting_started/snowy_usage_prerequisites.md @@ -0,0 +1,90 @@ +# Prerequisites for using Snowy + +To be allowed to [log in to Snowy](../getting_started/login_snowy.md), +one needs all of these: + +- [An active research project](#an-active-research-project) +- [An UPPMAX account](#an-uppmax-user-account) +- [An UPPMAX password](#an-uppmax-password) + +These prerequisites are discussed in detail below. + +## An active research project + +One [prerequisite for using Snowy](#prerequisites-for-using-snowy) +is that you need to be a member of an active SNIC +or SIMPLER research project (these can have many names such as `uppmax[number]`, +`snic[number]` or`naiss[number]`), +where `[number]` represent a number, for example `uppmax2021-2-1`, `snic2022-6-230` or `naiss2023-6-382`). + +???- question "Forgot your Snowy projects?" + + How to see you [research projects](project.md) is described at [research projects](project.md). + + Spoiler: go to [https://supr.naiss.se](https://supr.naiss.se) + +[SUPR](https://supr.naiss.se/) (the 'Swedish User and Project Repository') +is the website that allows one to request access to Snowy +and to get an overview of the requested resources. + +???- question "How does the SUPR website look like?" + + ![First SUPR page](./img/supr_first_page.png) + + > First SUPR page + + ![SUPR 2FA login](./img/supr_2fa.png) + + > SUPR 2FA login. Use the SUPR 2FA (i.e. **not** UPPMAX) + +After logging in, the [SUPR](https://supr.naiss.se/) +website will show all projects you are a member of, +under the 'Projects' tab. + +???- question "How does the 'Projects' tab of the SUPR website look like?" + + ![Example overview of SUPR projects](./img/supr_projects.png) + + > Example overview of SUPR projects + +To see if a project has access to Snowy, click on the +project and scroll to the 'Resources' section. In the 'Compute' subsection, +there is a table. Under 'Resource' it should state 'Snowy @ UPPMAX'. + +???- question "How does the 'Resources' page of an example project look like?" + + ![The 'Resources' page of an example project](./img/supr_project_naiss2024-22-49_resources.png) + + > The 'Resources' page of an example project. This project has two compute + > resources and two storage resources. + > A Snowy project would show the word 'Snowy' somewhere, + > so this is not a Snowy project. + +Note that the 'Accounts' tab can be useful to verify your username. + +???- question "How does the 'Accounts' tab help me find my username?" + + ![An example of a SUPR 'Accounts' tab](./img/supr_accounts.png) + + > An example of a SUPR 'Accounts' tab. + > The example user has username `richel-sens2023598`, + > which means his/her UPPMAX username is `richel` + +You can become a member of an active SNIC SENS by: + +- request membership to an existing project in SUPR +- create a project. See the UPPMAX page on + how to submit a project application [here](project_apply.md) + +## An UPPMAX user account + +Another [prerequisite for using Snowy](#prerequisites-for-using-snowy) +is that you must have a personal [UPPMAX user account](../getting_started/user_account.md). + +## An UPPMAX password + +Another [prerequisite for using Snowy](#prerequisites-for-using-snowy) +is that you need to know your UPPMAX password. +If you change it, it may take up to an hour before changes are reflected in Snowy. + +For advice on handling sensitive personal data correctly on Snowy, see our FAQ page.