Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/access/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,32 @@ This documentation guides users through the process of accessing CSCS systems an

!!! note ""
Before accessing CSCS, you need to have an account at CSCS, and be part of a project that has been allocated resources.
More information on how to get an account is available in [accounts and projects][account-management].
More information on how to get an account is available in [accounts and projects][ref-account-management].

<div class="grid cards" markdown>

- :fontawesome-solid-layer-group: __Multi Factor Authentification__

Before signing in to CSCS' web portals or using SSH, all users have to set up multi factor authentification (MFA)

[:octicons-arrow-right-24: MFA][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)

[:octicons-arrow-right-24: Accessing CSCS web services][access-web]
[:octicons-arrow-right-24: Accessing CSCS web services][ref-access-web]

- :fontawesome-solid-layer-group: __SSH Access__

Logging into Clusters on Alps

[:octicons-arrow-right-24: SSH][access-ssh]
[:octicons-arrow-right-24: SSH][ref-ssh]

- :fontawesome-solid-layer-group: __VSCode__

How to connect VSCode IDE on your laptop with Alps

[:octicons-arrow-right-24: SSH][access-vscode]
[:octicons-arrow-right-24: SSH][ref-access-vscode]

</div>
8 changes: 4 additions & 4 deletions docs/access/mfa.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[](){#mfa}
[](){#ref-mfa}
# Multi Factor Authentification

To access CSCS services and systems users are required to authenticate using multi-factor authentication (MFA).
Expand All @@ -10,7 +10,7 @@ An OTP is a six-digit number which changes every 30 seconds.
OTPs are generated using a tool installed on a device other than the one used to access CSCS services and infrastructure.
We recommend to use a smartphone with an application such as Google Authenticator to obtain the OTPs.

[](){#mfa-setup}
[](){#ref-mfa-setup}
## Getting Started

When you first log in to any of the CSCS web applications such as UMP, Jupyter, etc., you will be asked to register your device.
Expand All @@ -36,7 +36,7 @@ You can download Google Authenticator for your phone:
* :fontawesome-brands-android: Android: on the [Google Play Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2).
* :fontawesome-brands-apple: iOS: on the [Apple Store](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2).

[](){#mfa-configure-otp}
[](){#ref-mfa-configure-otp}
### Configure the Authenticator

Before starting, ensure that the following pre-requisites are satisfied
Expand Down Expand Up @@ -78,7 +78,7 @@ In case users lose access to their mobile device/Authenticator OTP, users can re
2. From the login screen, click the "Reset OTP" link below the "LOG IN" button
3. Enter your username and password.
4. On successful validation of user credentials, users will receive an email with a reset credentials link like the one below, click on the link in the email
5. The steps are the same as for the first time you [configured the authenticator][mfa-configure-otp].
5. The steps are the same as for the first time you [configured the authenticator][ref-mfa-configure-otp].

!!! warning
When replacing your smartphone remember to sync the authenticator app before resetting the old smartphone.
Expand Down
12 changes: 6 additions & 6 deletions docs/access/ssh.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
[](){#access-ssh}
[](){#ref-ssh}
# Using SSH

Before accessing CSCS clusters using SSH, first ensure that you have [created a user account][account-management] that is part of a project that has access to the cluster, and have [multi factor authentification][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 authentification][ref-mfa] configured.

[](){#sshservice}
[](){#ref-ssh-service}
## Generating Keys with SSHService

It is not possible to authenticate with a username/password and user-created SSH keys.
Expand Down Expand Up @@ -103,7 +103,7 @@ ssh -i ~/.ssh/cscs-key ela.cscs.ch
To log into a target system at CSCS, you need to perform some additional setup to handle forwarding of SSH keys generated using the SSHService.
There are two alternatives detailed below.

[](){#ssh-ssh-config}
[](){#ref-ssh-config}
### Adding Ela as a jump host in SSH Configuration

This approach configures Ela as a jump host and creates aliases for the systems that you want to access in `~/.ssh/config` on your laptop or PC.
Expand Down Expand Up @@ -148,12 +148,12 @@ After saving this file, one can directly log into `daint.alps.cscs.ch` from your
ssh daint
```

[](){#ssh-ssh-agent}
[](){#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.

Each time a new key is generated using the [SSHService][sshservice], add the key to the SSH agent:
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
```
Expand Down
4 changes: 2 additions & 2 deletions docs/access/vscode.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[](){#access-vscode}
[](){#ref-access-vscode}
# Connecting with VSCode

[Visual Studio Code](https://code.visualstudio.com/) provides flexible support for remote development.
Expand Down Expand Up @@ -107,7 +107,7 @@ Once the tunnel is configured, you can access it from VSCode.

!!! warning
If you plan to do any intensive work: repeated compilation of large projects or running python code in Jupyter, please see the guide to running on a compute node below.
Running intensive workloads on login nodes, which are shared resources between all users, is against CSCS [fair usage][policies-fair-use] of Shared Resources policy.
Running intensive workloads on login nodes, which are shared resources between all users, is against CSCS [fair usage][ref-policies-fair-use] of Shared Resources policy.

### Using with containers

Expand Down
6 changes: 3 additions & 3 deletions docs/access/web.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[](){#access-web}
[](){#ref-access-web}
# Accessing CSCS Web Portals

Most services at CSCS are connected to the CSCS Single Sign-On gate.
This gives users the comfort of not having to sign in multiple times in each individual service connected to this gate and increases security.
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

[](){#web-mfa}
[](){#ref-web-mfa}
## Using MFA to acccess web-based services

After having completed the setup of [MFA][mfa], you will be asked to enter your login/password and the OTP to access all 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.

Enter username and password.

Expand Down
8 changes: 4 additions & 4 deletions docs/accounts/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[](){#account-management}
[](){#ref-account-management}
# Getting and Managing Accounts

Users at CSCS have one account that can be used to access all services and systems at CSCS.
Expand All @@ -22,11 +22,11 @@ PIs can then invite members of their groups to join their project.

The tool used to manage projects and accounts depends on the platform on which the project was granted:

* The [HPC Platform][hpcp] and [Climate and Weather Platform][cwp] use the [account and resources management tool][ump] at [account.cscs.ch](https://account.cscs.ch)
* The [Machine Learning Platform][mlp] uses the [project and resources management tool][waldur] at [portal.cscs.ch](https://portal.cscs.ch).
* The [HPC Platform][ref-platform-hpcp] and [Climate and Weather Platform][ref-platform-cwp] use the [account and resources management tool][ref-account-ump] at [account.cscs.ch](https://account.cscs.ch)
* The [Machine Learning Platform][ref-platform-mlp] uses the [project and resources management tool][ref-account-waldur] at [portal.cscs.ch](https://portal.cscs.ch).

!!! note
The [portal.cscs.ch][waldur] site will be used to manage all projects in the future.
The [portal.cscs.ch][ref-account-waldur] site will be used to manage all projects in the future.

## Signing up for a new account

Expand Down
2 changes: 1 addition & 1 deletion docs/accounts/ump.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[](){#ump}
[](){#ref-account-ump}
# Account and Resources Management Tool

The Swiss National Supercomputing Centre (CSCS) offers a web-based tool for users to manage their accounts and projects at [account.cscs.ch](https://account.cscs.ch).
Expand Down
6 changes: 3 additions & 3 deletions docs/accounts/waldur.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[](){#waldur}
[](){#ref-account-waldur}
# The Project and Resources Management Tool

CSCS Account Managers, PIs and deputy PIs can invite users to the respective projects following the below steps on CSCS's new project management portal.

!!! info
The new user project management portal is currently only used by the [Machine Learning Platform][mlp]
All other platforms use the old [user management portal](ump.md)
The new user project management portal is currently only used by the [Machine Learning Platform][ref-platform-mlp]
All other platforms use the old [user management portal][ref-account-ump]

## log in to the portal

Expand Down
12 changes: 6 additions & 6 deletions docs/alps/hardware.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[](){#alps-hardware}
[](){#ref-alps-hardware}
# Alps Hardware

Alps is a HPE Cray EX3000 system, a liquid cooled blade-based, high-density system.
Expand Down Expand Up @@ -47,27 +47,27 @@ There are currently four node types in Alps, with another becoming available in
| AMD MI250x | 12 | 24 | 24 | 96 |
| AMD MI300A | 64 | 128 | 512 | 512 |

[](){#gh200-node}
[](){#ref-alps-gh200-node}
### NVIDIA GH200 GPU Nodes

Perry Peak

[](){#zen2-node}
[](){#ref-alps-zen2-node}
### AMD Rome CPU Nodes

EX425

[](){#a100-node}
[](){#ref-alps-a100-node}
### NVIDIA A100 GPU Nodes

Grizzly Peak

[](){#mi200-node}
[](){#ref-alps-mi200-node}
### AMD MI250x GPU Nodes

Bard Peak

[](){#mi300-node}
[](){#ref-alps-mi300-node}
### AMD MI300A GPU Nodes

Parry Peak
Expand Down
5 changes: 3 additions & 2 deletions docs/alps/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[](){#ref-alps}
# Alps Infrastructure

Alps is a general-purpose compute and data Research Infrastructure (RI) open to the broad community of researchers in Switzerland and the rest of the world.
Expand All @@ -14,13 +15,13 @@ Additionally, network segregation ensures secure and isolated communication, wit

- :fontawesome-solid-signs-post: __Platforms__

[:octicons-arrow-right-24: Alps Platforms][platforms]
[:octicons-arrow-right-24: Alps Platforms][ref-alps-platforms]

- :fontawesome-solid-signs-post: __Clusters__

The resources on Alps are partitioned and configured into versatile software defined clusters (vClusters).

[:octicons-arrow-right-24: Alps vClusters][clusters]
[:octicons-arrow-right-24: Alps vClusters][ref-alps-clusters]

- :fontawesome-solid-signs-post: __Hardware__

Expand Down
12 changes: 6 additions & 6 deletions docs/alps/platforms.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
[](){#platforms}
[](){#ref-alps-platforms}
# Platforms on Alps

A platform represents a set of scientific services along with compute and data resources hosted on the Alps research infrastructure, provided to a specific scientific community.
Each platform addresses particular research needs and domains, such as climate and weather modeling, machine learning, or high-performance computing applications.
A platform can consist of one or multiple [clusters][clusters], and its services can be managed either by CSCS or by the scientific community itself, including access control, usage policies, and support.
A platform can consist of one or multiple [clusters][ref-alps-clusters], and its services can be managed either by CSCS or by the scientific community itself, including access control, usage policies, and support.

<div class="grid cards" markdown>

- :fontawesome-solid-mountain: __Machine Learning Platform__

The Machine Learning Platform (MLp) hosts ML and AI researchers.
The Machine Learning Platform (MLP) hosts ML and AI researchers.

[:octicons-arrow-right-24: MLp][mlp]
[:octicons-arrow-right-24: MLP][ref-platform-mlp]

- :fontawesome-solid-mountain: __HPC Platform__

!!! todo

[:octicons-arrow-right-24: HPCp][hpcp]
[:octicons-arrow-right-24: HPCP][ref-platform-hpcp]

- :fontawesome-solid-mountain: __Climate and Weather Platform__

!!! todo

[:octicons-arrow-right-24: CWp][cwp]
[:octicons-arrow-right-24: CWP][ref-platform-cwp]

</div>
1 change: 1 addition & 0 deletions docs/alps/storage.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[](){#ref-alps-storage}
# Alps Storage

!!! todo
Expand Down
22 changes: 15 additions & 7 deletions docs/alps/vclusters.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
[](){#clusters}
[](){#ref-alps-clusters}
# Alps Clusters

A vCluster (versatile software-defined cluster) is a logical partition of the supercomputing resources where platform services are deployed. It serves as a dedicated environment supporting a specific platform. The composition of resources and services for each vCluster is defined in a configuration file used by an automated pipeline for deployment. Once deployed by CSCS, the vCluster becomes immutable.

## Clusters on Alps

Clusters on Alps are provided as part of different [platforms][platforms].
Clusters on Alps are provided as part of different [platforms][ref-alps-platforms].

<div class="grid cards" markdown>
- :fontawesome-solid-mountain: __Machine Learning Platform__

Clariden is the main Grace-Hopper cluster

[:octicons-arrow-right-24: Clariden][clariden]
[:octicons-arrow-right-24: Clariden][ref-cluster-clariden]

Bristen is a small system with a100 nodes, used for **todo**

[:octicons-arrow-right-24: Bristen][bristen]
[:octicons-arrow-right-24: Bristen][ref-cluster-bristen]
</div>

<div class="grid cards" markdown>
- :fontawesome-solid-mountain: __HPC Platform__ { .col-span-12 }
- :fontawesome-solid-mountain: __HPC Platform__

!!! todo
Daint is the main Grace-Hopper cluster for GPU workloads

[:octicons-arrow-right-24: Daint][ref-cluster-daint]

Eiger is a large AMD-CPU cluster for CPU workloads

[:octicons-arrow-right-24: Eiger][ref-cluster-eiger]
</div>

<div class="grid cards" markdown>
- :fontawesome-solid-mountain: __Climate and Weather Platform__

!!! todo
Santis is a Grace-Hopper cluster for climate and weather simulation

[:octicons-arrow-right-24: Santis][ref-cluster-santis]
</div>


2 changes: 1 addition & 1 deletion docs/build-install/uenv.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Uenv are user environments that provide scientific applications, libraries and t

For more documentation on how to find, download and use uenv in your workflow, see the [env tool documentation](../tools/uenv.md).

[](){#building-uenv-spack}
[](){#ref-building-uenv-spack}
## Building software using Spack

Each uenv is tightly coupled with [Spack] and can be used as an upstream [Spack] instance, because
Expand Down
16 changes: 8 additions & 8 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,19 @@ Start here to get access to CSCS services and Alps

The first step is to get an account and a project

[:octicons-arrow-right-24: Accounts and Projects][account-management]
[:octicons-arrow-right-24: Accounts and Projects][ref-account-management]

- :fontawesome-solid-key: __Logging In__

Once you have an account, you can set up multi factor authentification

[:octicons-arrow-right-24: Setting up MFA][mfa]
[:octicons-arrow-right-24: Setting up MFA][ref-mfa]

Then access CSCS services

[:octicons-arrow-right-24: Accessing CSCS Web Services][access-web]
[:octicons-arrow-right-24: Accessing CSCS Web Services][ref-access-web]

[:octicons-arrow-right-24: Using SSH][access-ssh]
[:octicons-arrow-right-24: Using SSH][ref-ssh]

</div>

Expand All @@ -32,15 +32,15 @@ The Alps Research infrastructure hosts multiple platforms and clusters targeting

Once you have a project at CSCS, start here to find your platform:

[:octicons-arrow-right-24: Platforms overview][platforms]
[:octicons-arrow-right-24: Platforms overview][ref-alps-platforms]

Go straight to the documentation for the platform that hosts your project:

[:octicons-arrow-right-24: HPC Platform][hpcp]
[:octicons-arrow-right-24: HPC Platform][ref-platform-hpcp]

[:octicons-arrow-right-24: Machine Learning Platform][mlp]
[:octicons-arrow-right-24: Machine Learning Platform][ref-platform-mlp]

[:octicons-arrow-right-24: Climate and Weather Platform][cwp]
[:octicons-arrow-right-24: Climate and Weather Platform][ref-platform-cwp]

- :fontawesome-solid-mountain-sun: __Alps__

Expand Down
4 changes: 2 additions & 2 deletions docs/platforms/cwp/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[](){#cwp}
[](){#ref-platform-cwp}
# Climate and Weather Platform

!!! todo
follow the template of the [MLp][mlp]
follow the template of the [MLp][ref-platform-mlp]
Loading