diff --git a/docs/getting_started/rackham_usage_prerequisites.md b/docs/getting_started/rackham_usage_prerequisites.md new file mode 100644 index 000000000..0a9c1e223 --- /dev/null +++ b/docs/getting_started/rackham_usage_prerequisites.md @@ -0,0 +1,87 @@ +# Prerequisites for using Rackham + +To be allowed to [log in to Rackham](../getting_started/login_rackham.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 Rackham](#prerequisites-for-using-rackham) +is that you need to be a member of an active SNIC SENS +or SIMPLER research project (these are called `sens[number]` or `simp[number]`, +where `[number]` represent a number, for example `sens123456` or `simp123456`). + +???- question "Forgot your Rackham projects?" + + One easy way to see your Rackham projects is to use the + Rackham remote desktop login screen at . + + ![The Rackham remote desktop login screen](./img/rackham_remote_desktop_login_shows_sens_projects.png) + +[SUPR](https://supr.naiss.se/) (the 'Swedish User and Project Repository') +is the website that allows one to request access to Rackham +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 Rackham, click on the +project and scroll to the 'Resources' section. In the 'Compute' subsection, +there is a table. Under 'Resource' it should state 'Rackham @ UPPMAX'. + +???- question "How does the 'Resources' page of an example project look like?" + + ![The 'Resources' page of an example project.](./img/supr_project_sens2023598_resources.png) + + > The 'Resources' page of an example 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 Rackham](#prerequisites-for-using-rackham) +is that you must have a personal [UPPMAX user account](../getting_started/user_account.md). + +## An UPPMAX password + +Another [prerequisite for using Rackham](#prerequisites-for-using-rackham) +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 Rackham. + +For advice on handling sensitive personal data correctly on Rackham, see our FAQ page.