-
Notifications
You must be signed in to change notification settings - Fork 41
HPC console documentation page #147
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
francescopagnamenta
wants to merge
13
commits into
eth-cscs:main
from
francescopagnamenta:fix/firecrest-ui-doc
Closed
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
f0b3fa8
firecrest ui doc
10c0337
ref-firecrest-ui fix
98208ce
firecrest-ui changes based on PR #147 feedbacks
f2ae72f
firecrest-ui fixed Santis label and removed a the Firecrest GH link (…
6b32db5
application renamed to HPC Console
f72a08d
Removed old firecrest ui file
804d6b3
Apply suggestion from @msimberg
jpdorsch 3799087
Apply suggestion from @msimberg
jpdorsch 7d3ceb2
Update docs/services/hpc-console.md
francescopagnamenta a5fdaa0
Update docs/services/hpc-console.md
francescopagnamenta 92eb716
Update docs/services/hpc-console.md
francescopagnamenta bf2002d
Update docs/services/hpc-console.md
francescopagnamenta 1e66a03
Update docs/services/hpc-console.md
francescopagnamenta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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]. | ||
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| It provides users with a modern web-based environment to interact with HPC resources such as clusters, job schedulers, and filesystems. | ||
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Features | ||
|
|
||
| - A modern web interface built on FirecREST API functionalities. | ||
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - A dashboard offering an overview of configured clusters and their statuses. | ||
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| - 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 | ||
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| - 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. | ||
francescopagnamenta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## 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. | ||
francescopagnamenta marked this conversation as resolved.
Show resolved
Hide resolved
francescopagnamenta marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## 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) | ||
francescopagnamenta marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.