eth-cscs · bcumming · Mar 26, 2025 · Mar 24, 2025
@@ -8,15 +8,15 @@ This documentation guides users through the process of accessing CSCS systems an
 
 <div class="grid cards" markdown>
 
--   :fontawesome-solid-layer-group: __Multi Factor Authentification__
+-   :fontawesome-solid-layer-group: __Multi Factor Authentication__
 
-    Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)
+    Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentication (MFA)
 
     [:octicons-arrow-right-24: MFA][ref-mfa]
 
 -   :fontawesome-solid-layer-group: __Web Services__
 
-    Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)
+    Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentication (MFA)
 
     [:octicons-arrow-right-24: Accessing CSCS web services][ref-access-web]
 

@@ -1,5 +1,5 @@
 [](){#ref-mfa}
-# Multi Factor Authentification
+# Multi Factor Authentication
 
 To access CSCS services and systems users are required to authenticate using multi-factor authentication (MFA).
 MFA is implemented as a two-factor authentication, where one factor is the login and password pair ("the thing you know") and the other factor is the device which generates one-time passwords (OTPs, "the thing you have").
@@ -18,7 +18,7 @@ When you first log in to any of the CSCS web applications such as UMP, Jupyter,
 Firstly, you will be asked to provide a code that you received by email.
 After this validation step, you will need to scan a QR code with your mobile phone using an application such as Google Authenticator.
 Lastly, you will need to enter the OTP from the authenticator application to complete the registration of your device.
-From then on, two-factor authrentication will be required to access CSCS services and systems.
+From then on, two-factor authentication will be required to access CSCS services and systems.
 A more detailed explanation of the registration process is provided in the next section.
 
 !!! warning
@@ -42,7 +42,7 @@ You can download Google Authenticator for your phone:
 Before starting, ensure that the following pre-requisites are satisfied
 
 1. You have an invitation email from CSCS for MFA enrollment
-    * a notification email will be sent atleast one week before we sent the invitation email.
+    * a notification email will be sent at least one week before we sent the invitation email.
 2. You have installed an OTP Authenticator app on your mobile device (see above).
 
 !!! note
@@ -61,7 +61,7 @@ Steps:
 1. Access any of the CSCS Web applications such as [`account.cscs.ch`](https://account.cscs.ch), Jupyter, etc., on a new browser session which will redirects you to the CSCS login page.
 2. Log in with your username and password.
 3. You will be asked to key in a code which CSCS Authentication system sent to you by email.
-   After successfaul validation of the code you will be redirected to the next page which present a QR code.
+   After successful validation of the code you will be redirected to the next page which present a QR code.
 4. Scan the QR code with the authenticator app that was installed on your mobile device.
    After scanning the QR code the authenticator app will start generating a new 6 digit OTP every 60 seconds.
 5. To complete the OTP registration process, please enter the 6 digit OTP from the authenticator app at the bottom of the the same QR code page. Optionally, you can input your device name where you imported the OTP seed by scanning the QR code

@@ -1,7 +1,7 @@
 [](){#ref-ssh}
 # Using SSH
 
-Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][ref-account-management] that is part of a project that has access to the cluster, and have [multi factor authentification][ref-mfa] configured.
+Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][ref-account-management] that is part of a project that has access to the cluster, and have [multi factor authentication][ref-mfa] configured.
 
 [](){#ref-ssh-service}
 ## Generating Keys with SSHService
@@ -53,14 +53,14 @@ The next step is to use either the bash or python scripts:
     pip install -r requirements.txt
     ```
 
-    Therafter, activate the venv before using the script:
+    Thereafter, activate the venv before using the script:
 
     ```bash
     source mfa/bin/activate
     python cscs-keygen.py
     ```
 
-For both approaches, follow the on screen instructions that require you to enter your username, password and the six-digit OTP from the authentifactor app on your phone.
+For both approaches, follow the on screen instructions that require you to enter your username, password and the six-digit OTP from the authenticator app on your phone.
 The script generates the key pair (`cscs-key` and `cscs-key-cert.pub`) in your `~/.ssh` path:
 
 ```bash
@@ -85,7 +85,7 @@ chmod 0600 ~/.ssh/cscs-key
 
 ### Adding a password to the key
 
-Once the key has been generated using either the CLI or web interface above, it is strongly reccomended that you add a password to the generated key using the [ssh-keygen](https://www.ssh.com/academy/ssh/keygen) tool.
+Once the key has been generated using either the CLI or web interface above, it is strongly recommended that you add a password to the generated key using the [ssh-keygen](https://www.ssh.com/academy/ssh/keygen) tool.
 
 ```
 ssh-keygen -f ~/.ssh/cscs-key -p
@@ -151,14 +151,14 @@ ssh daint
 [](){#ref-ssh-agent}
 ### Using SSH Agent
 
-Alternatively, the [SSH authentification agent](https://www.ssh.com/academy/ssh/add-command) can be configured to manage the keys.
+Alternatively, the [SSH authentication agent](https://www.ssh.com/academy/ssh/add-command) can be configured to manage the keys.
 
 Each time a new key is generated using the [SSHService][ref-ssh-service], add the key to the SSH agent:
 ```
 ssh-add -t 1d ~/.ssh/cscs-key
 ```
 
-??? warning "Could not open a connection to your authentification agent"
+??? warning "Could not open a connection to your authentication agent"
     If you see this error message, the ssh agent is not running.
     You can start it with the following command:
     ```
@@ -177,7 +177,7 @@ ssh daint.cscs.ch
 [](){#ref-ssh-faq}
 ## Frequently encountered issues
 
-??? warning "too many authentification failures"
+??? warning "too many authentication failures"
     You may have too many keys in your ssh agent.
     Remove the unused keys from the agent or flush them all with the following command:
     ```bash

@@ -6,7 +6,7 @@ This gives users the comfort of not having to sign in multiple times in each ind
 Furthermore, the Single Sign-On gate allow users to recover their forgotten passwords and authenticate using a third-party account. The login page looks like
 
 [](){#ref-web-mfa}
-## Using MFA to acccess web-based services
+## Using MFA to access web-based services
 
 After having completed the setup of [MFA][ref-mfa], you will be asked to enter your login/password and the OTP to access all web-based services.
 

@@ -2,7 +2,7 @@
 
 CSCS provides commonly used software and tools on Alps, however many use cases will require first installing software on a system before you can start working.
 
-Modern HPC applications and software stacks are often very complicated, and there is no one-size-fits-all method for building and installning them.
+Modern HPC applications and software stacks are often very complicated, and there is no one-size-fits-all method for building and installing them.
 
 ## Programming environments
 

@@ -6,7 +6,7 @@ For more documentation on how to find, download and use uenv in your workflow, s
 ## Building software using Spack
 
 Each uenv is tightly coupled with [Spack] and can be used as an upstream [Spack] instance, because
-the sofware in uenv is built with [Spack] using the [Stackinator] tool.
+the software in uenv is built with [Spack] using the [Stackinator] tool.
 
 CSCS provides `uenv-spack` - a tool that can be used to quickly install software using the software and configuration provided inside a uenv, similarly to how `module load` loads software packages.
 

@@ -42,10 +42,10 @@ Scratch is per user - each user gets separate scratch path and quota.
 !!! warning "scratch cleanup policy"
     Files that have not been accessed in 30 days are automatically deleted.
 
-    **Scratch is not intended for permanant storage**: transfer files back to the capstor project storage after job runs.
+    **Scratch is not intended for permanent storage**: transfer files back to the capstor project storage after job runs.
 
 !!! note
-    There is an additional scratch path mounted on [Capstor][ref-alps-capstor] at `/capstor/scratch/cscs/$USER`, however this is not reccomended for ML workloads for performance reasons.
+    There is an additional scratch path mounted on [Capstor][ref-alps-capstor] at `/capstor/scratch/cscs/$USER`, however this is not recommended for ML workloads for performance reasons.
 
 ### Project
 
@@ -127,7 +127,7 @@ See the SLURM documentation for instructions on how to run jobs on the [Grace-Ho
     | normal               | 1266       | 1-infinite | 1-00:00:00 | 812/371    |
     | xfer                 | 2          | 1          | 1-00:00:00 | 1/1        |
     ```
-    The last column shows the number of nodes that have been allocted in currently running jobs (`A`) and the number of jobs that are idle (`I`).
+    The last column shows the number of nodes that have been allocated in currently running jobs (`A`) and the number of jobs that are idle (`I`).
 
 ### FirecREST
 

@@ -19,7 +19,7 @@ Clone your fork repository on your PC/laptop:
 # ... make your edits ...
 # add and commit your changes
 > git add <files>
-> git commit -m 'update the ssh docs with alisases for all user lab vclusters'
+> git commit -m 'update the ssh docs with aliases for all user lab vclusters'
 > git push origin 'fix/ssh-alias'
 ```
 Then navigate to GitHub, and create a pull request.
@@ -163,7 +163,7 @@ See the good and bad examples below for an example of of what happens when a cha
 
     The diff in this case affects the original 3 lines, and creates a new one.
 
-This method defines a canonical represention of text, i.e. there is one and only one way to write a paragraph of text, which plays much better with git.
+This method defines a canonical representation of text, i.e. there is one and only one way to write a paragraph of text, which plays much better with git.
 
 * changes to the text are less likely to create merge conflicts
 * changing one line of text will not modify the surrounding lines (see example above)
@@ -173,7 +173,7 @@ This method defines a canonical represention of text, i.e. there is one and only
 
 The documentation does not have a FAQ section, because questions are best answered by the documentation, not in a separate section.
 Integrating information into the main documentation requires some care to identify where the information needs to go, and edit the documentation around it.
-Adding the information to a FAQ is easier, but the result is information about a topic distributed betwen the docs and FAQ questions, which ultimately makes the documentation harder to search.
+Adding the information to a FAQ is easier, but the result is information about a topic distributed between the docs and FAQ questions, which ultimately makes the documentation harder to search.
 
 FAQ content, such as lists of most frequently encountered error messages, is still very useful in many contexts.
 If you want to add such content, create a section at the bottom of a topic page, for example this section on the [SSH documentation page][ref-ssh-faq].

@@ -12,7 +12,7 @@ Workloads that do not play nicely with Lustre include:
 
 At first it can seem strange that a "high-performance" file system is significantly slower than a laptop drive for a "simple" task like compilation or loading Python modules, however Lustre is designed for high-bandwidth parallel file access from many nodes at the same time, with the attendant trade offs this implies.
 
-Meta data lookups on Lustre are expensive compared to your laptop, where the local file system is able to agressively cache meta data.
+Meta data lookups on Lustre are expensive compared to your laptop, where the local file system is able to aggressively cache meta data.
 
 ### Python virtual environments with uenv
 

@@ -53,7 +53,7 @@ The Alps Research infrastructure hosts multiple platforms and clusters targeting
 
 -   :fontawesome-solid-key: __Logging In__
 
-    Once you have an account, you can set up multi factor authentification
+    Once you have an account, you can set up multi factor authentication
 
     [:octicons-arrow-right-24: Setting up MFA][ref-mfa]
 

@@ -15,7 +15,7 @@
 Project administrators (PIs and deputy PIs) of projects on the MLp can to invite users to join their project, before they can use the project's resources on Alps.
 This is performed using the [project management tool][ref-account-waldur]
 
-Once invited to a project, you will receive an email, which you can need to create an account and configure [multi-factor authentification][ref-mfa] (MFA).
+Once invited to a project, you will receive an email, which you can need to create an account and configure [multi-factor authentication][ref-mfa] (MFA).
 
 ## vClusters
 

@@ -22,11 +22,11 @@ The User Lab Users must quote and acknowledge the use of Swiss Share of the LUMI
 
 > This work was supported by a grant from the Swiss National Supercomputing Centre (CSCS) on the Swiss share of the LUMI system under project ID ###
 
-Users with allocations under the  Swiss AI Intiative must quote and acknowledge the use of CSCS resources in all publications related to their projects on Alps as follows:
+Users with allocations under the  Swiss AI Initiative must quote and acknowledge the use of CSCS resources in all publications related to their projects on Alps as follows:
 
-> This work was supported as part of the “Swiss AI initiative”by a grant from the Swiss National Supercomputing Centre (CSCS) under project ID ### on Alps
+> This work was supported as part of the “Swiss AI initiative” by a grant from the Swiss National Supercomputing Centre (CSCS) under project ID ### on Alps
 
-User Lab Users should ackoweldge the PASC program in their publications as follows:
+User Lab Users should acknowledge the PASC program in their publications as follows:
 
 > This work was supported by the  Platform for Advanced Scientific Computing (PASC) project "name of the project"."
 

@@ -5,7 +5,7 @@ The right to access CSCS resources may be revoked to whoever breaches any of the
 
 These are the Terms & Conditions, which users need to follow in order to access CSCS computing resources.
 
-* Access to CSCS facilities is granted on an individual basis. An account is usable by the applicant only and only for the exlpicit purposes stated in the project application. CSCS does not allow sharing of accounts.
+* Access to CSCS facilities is granted on an individual basis. An account is usable by the applicant only and only for the explicit purposes stated in the project application. CSCS does not allow sharing of accounts.
 * The applicant is not permitted to give any other person (project member or otherwise), organization or representative of any organization access to CSCS facilities explicitly or implicitly, through negligence or carelessness. Revealing of passwords or identification protocols through verbal, written or electronic means is strictly prohibited. Any such activity is considered a breach of CSCS security, the contract between the applicant and CSCS at the moment the Account Application Form is submitted and approved, and the established contracts between CSCS and its computer vendors. Should such activity occur, the applicant will be immediately barred from all present and future use of CSCS facilities and is fully liable for all consequences arising from the infraction.
 * Any indication of usage or requests for runs which give rise to serious suspicion will be further investigated and escalated to the appropriate authorities if necessary.
 * Access to and use of data of other accounts on CSCS systems without prior consent from the principal investigator to which project the user account pertains is strictly prohibited. The terms and conditions for use of data from other accounts must be directly agreed to by the data owner.

@@ -7,7 +7,7 @@ SLURM is an open-source, highly scalable job scheduler that allocates computing
 ## Accounting
 
 !!! todo
-    document `--account`, `--constrant` and other generic flags.
+    document `--account`, `--constraint` and other generic flags.
 
 [](){#ref-slurm-partitions}
 ## Partitions

@@ -1,5 +1,5 @@
 [](){#ref-cicd}
-# Continous Integration / Continuous Deployment (CI/CD)
+# Continuous Integration / Continuous Deployment (CI/CD)
 
 [](){#ref-cicd-containerized-intro}
 ## Introduction containerized CI/CD

@@ -1,7 +1,7 @@
 [](){#ref-firecrest}
 # FirecREST
 
-FirecREST is a RESTful API for programatically accessing High-Performance Computing resources, developed at CSCS.
+FirecREST is a RESTful API for programmatically accessing High-Performance Computing resources, developed at CSCS.
 
 Users can make use of FirecREST to automate access to HPC, enabling [CI/CD pipelines](https://github.com/eth-cscs/firecrest/tree/master/examples/CI-pipeline), [workflow managers](https://github.com/eth-cscs/firecrest/tree/master/examples/airflow-operators), and other tools against HPC resources.
 
@@ -17,7 +17,7 @@ Users can make HTTP requests to perform the following operations:
 
 Starting early 2025, CSCS has introduced a new version of the API: [FirecREST version 2](https://eth-cscs.github.io/firecrest-v2).
 
-Version 2 is faster, easier to use, and more efficient in resource management than its predecesor, therefore, if you are new to FirecREST start directly using **version 2** (if available for your platform).
+Version 2 is faster, easier to use, and more efficient in resource management than its predecessor, therefore, if you are new to FirecREST start directly using **version 2** (if available for your platform).
 
 If you're using **version 1**, we recommend you to port your applications to use the new version.
 

@@ -1,4 +1,4 @@
-[](){#ref-sofware-prgenvs}
+[](){#ref-software-prgenvs}
 # Programming Environments
 
 !!! todo

@@ -8,7 +8,7 @@ Specifically, it is intended for building and running applications that **requir
 
 !!! note
     By default, use the `prgenv-gnu` toolchain for a generic environment for building GPU applications.
-    It provides CUDA and libraries with GPU support enabled for the Grace-Hopper nodes, the gnu compiler toolchain that it provides has better C and C++ standards complianace, and it also provides more libraries and tools than this `nvfortran` uenv.
+    It provides CUDA and libraries with GPU support enabled for the Grace-Hopper nodes, the gnu compiler toolchain that it provides has better C and C++ standards compliance, and it also provides more libraries and tools than this `nvfortran` uenv.
 
 ## Versioning
 
@@ -19,7 +19,7 @@ The naming scheme is `prgenv-nvfortran/<version>:v<i>`, where `<version>` matche
 
 The currently supported versions are:
 
-| `prgennv-nvhpc` | NVHPC |
+| `prgenv-nvhpc` | NVHPC |
 | --------------  | ----- |
 | 24.11 | 24.11 |
 
@@ -83,7 +83,7 @@ uenv image find prgenv-nvfortran/24.11:v1
     * `mpif90`
     * `mpifort`
 
-    And the following C/C++ wrapers are available:
+    And the following C/C++ wrappers are available:
 
     * `mpicc`
     * `mpicxx`