Skip to content
Closed
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ If you cannot find the information that you need in the documentation, help is a

[:octicons-arrow-right-24: FirecREST API](services/firecrest.md)

[:octicons-arrow-right-24: HPC Console](services/hpc-console.md)

[:octicons-arrow-right-24: CI/CD for external projects](services/cicd.md)

[:octicons-arrow-right-24: JupyterLab](services/jupyterlab.md)
Expand Down
53 changes: 53 additions & 0 deletions docs/services/hpc-console.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
[](){#hpc-console}
# HPC Console

HCP Console is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend][ref-firecrest].
It provides users with a modern web-based environment to interact with HPC resources such as clusters, job schedulers, and filesystems.

## Features

- A modern web interface built on FirecREST API functionalities.
- A dashboard offering an overview of configured clusters and their statuses.
- A dedicated view for creating and monitoring jobs.
- A file navigator with basic file management functionalities, including upload and download features.

A description of the views and functionalities can be found [here](https://eth-cscs.github.io/firecrest-ui/documentation/).

## Views overview

- Dashboard – shows cluster availability and basic system status.
- Jobs – allows creating, submitting, and monitoring jobs. Users can provide job name, script, and resource requirements.
- File Navigator – supports browsing directories, uploading, downloading, and deleting files. Editing files inline is not supported.

## Supported version

Starting early 2025, CSCS has introduced a new version of the API: [FirecREST version 2](https://eth-cscs.github.io/firecrest-v2).

This web interface is available and runs on the FirecREST API v2 backend, FirecREST API v1 is not supported.

## Alps platforms

HPC console is currently available on three [Alps platforms][ref-alps-platforms].

| Platform | URL | Clusters |
|----------------|----------------------|--------------------------------------------------------------------------|
| HPC Platform | [https://my.hpcp.cscs.ch/](https://my.hpcp.cscs.ch/) | [Daint][ref-cluster-daint], [Eiger][ref-cluster-eiger] |
| ML Platform | [https://my.mlp.cscs.ch/](https://my.mlp.cscs.ch/) | [Bristen][ref-clsuter-bristen], [Clariden][ref-cluster-clariden] |
| CW Platform | [https://my.cwp.cscs.ch/](https://my.cwp.cscs.ch/) | [Santis][ref-cluster-santis] |

## Access and prerequisites

- Access requires a valid CSCS account and authentication through the institutional login system.
- Supported browsers: recent versions of Chrome, Firefox, and Safari are recommended.
- Sessions automatically expire after a period of inactivity.

## Feedback

We welcome your feedback to help us improve HPC Console.
If you encounter issues or have suggestions, please [let us know][ref-get-in-touch].

## Further information

* [HPC Console doc](https://eth-cscs.github.io/firecrest-ui/home/)
* [Github Repo](https://github.com/eth-cscs/firecrest-ui)
* [FirecREST doc](https://eth-cscs.github.io/firecrest-v2)
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ nav:
- 'Services':
- services/index.md
- 'FirecREST': services/firecrest.md
- 'HPC Console': services/hpc-console.md
- 'CI/CD': services/cicd.md
- 'JupyterLab': services/jupyterlab.md
- 'Running Jobs':
Expand Down
Loading