Skip to content

Commit f0b3fa8

Browse files
author
Francesco Pagnamenta
committed
firecrest ui doc
1 parent 3f0bdb9 commit f0b3fa8

File tree

3 files changed

+58
-0
lines changed

3 files changed

+58
-0
lines changed

docs/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ If you cannot find the information that you need in the documentation, help is a
108108

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

111+
[:octicons-arrow-right-24: FirecREST UI](services/firecrest-ui.md)
112+
111113
[:octicons-arrow-right-24: CI/CD for external projects](services/cicd.md)
112114

113115
[:octicons-arrow-right-24: JupyterLab](services/jupyterlab.md)

docs/services/firecrest-ui.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
[](){#ref-firecrest}
2+
# FirecREST UI
3+
4+
FirecREST UI is a web application designed to provide essential functionalities for interacting with [FirecREST API v2 backend](https://docs.cscs.ch/services/firecrest/).
5+
6+
## Features
7+
8+
- A modern web interface built on FirecREST API functionalities.
9+
- A dashboard offering an overview of configured clusters and their statuses.
10+
- A dedicated view for creating and monitoring jobs.
11+
- A file navigator with basic file management functionalities, including upload and download features.
12+
13+
A description of the views and functionalities can be found [here](https://eth-cscs.github.io/firecrest-ui/documentation/).
14+
15+
## FirecREST supported version
16+
17+
Starting early 2025, CSCS has introduced a new version of the API: [FirecREST version 2](https://eth-cscs.github.io/firecrest-v2).
18+
19+
The FirecREST UI is available and runs on the FirecREST API v2 backend (v1 not supported).
20+
21+
## FirecREST UI Deployment on Alps
22+
23+
FirecREST UI is currently available on two [Alps platforms][ref-alps-platforms].
24+
25+
<table>
26+
<tr>
27+
<th>Platform</th>
28+
<th>UI URL</th>
29+
<th>Clusters</th>
30+
</tr>
31+
<tr>
32+
<td>HPC Platform</td>
33+
<td>https://my.hpcp.cscs.ch/</td>
34+
<td><a href="../../clusters/daint">Daint</a>, <a href="../../clusters/eiger">Eiger</a></td>
35+
</tr>
36+
<tr>
37+
<td>ML Platform</td>
38+
<td>https://my.mlp.cscs.ch/</td>
39+
<td><a href="../../clusters/bristen">Bristen</a>, <a href="../../clusters/clariden">Clariden</a></td>
40+
</tr>
41+
</table>
42+
43+
44+
## Further Information
45+
46+
* [FirecREST Official Docs](https://eth-cscs.github.io/firecrest-ui/)
47+
* [FirecREST UI for HPC Platform](https://my.hpcp.cscs.ch)
48+
* [FirecREST UI for ML Platform](https://my.mlp.cscs.ch)
49+
* [FirecREST OpenAPI Specification](https://eth-cscs.github.io/firecrest-v2/openapi)
50+
* [FirecREST Official Docs](https://eth-cscs.github.io/firecrest-v2)
51+
* [Documentation of pyFirecREST](https://pyfirecrest.readthedocs.io/)
52+
* [FirecREST repository](https://github.com/eth-cscs/firecrest-v2)
53+
* [What are JSON Web Tokens](https://jwt.io/introduction)
54+
* [Python Requests](https://requests.readthedocs.io/en/master/user/quickstart)
55+
* [Python Async API Calls](https://docs.aiohttp.org/en/stable/)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ nav:
9696
- 'Services':
9797
- services/index.md
9898
- 'FirecREST': services/firecrest.md
99+
- 'FirecREST UI': services/firecrest-ui.md
99100
- 'CI/CD': services/cicd.md
100101
- 'JupyterLab': services/jupyterlab.md
101102
- 'Running Jobs':

0 commit comments

Comments
 (0)