Skip to content

Commit 90a75b2

Browse files
committed
refactoring for round 2
1 parent 4a969d3 commit 90a75b2

File tree

2 files changed

+87
-54
lines changed

2 files changed

+87
-54
lines changed

docs/software-deployment/index.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,37 @@
1-
# Software Deployment
1+
# Alps environments
22

3-
!!! todo
4-
section on uenv and container engine
3+
Once you have logged into a [cluster][ref-alps-clusters] on Alps, you will want to set up your environment and find the software and tools provided by CSCS.
4+
This part of the documentation will give guidance on how to set up your shell, and how to access software in uenv and container environments.
55

6-
!!! todo
7-
section on building your own software
6+
<div class="grid cards" markdown>
7+
8+
- :fontawesome-solid-layer-group: __Set up your login environment__
9+
10+
A good spot to start is to read our guide on configuring your shell.
11+
12+
[:octicons-arrow-right-24: Using the terminal][ref-platform-hpcp]
13+
14+
</div>
15+
16+
<div class="grid cards" markdown>
17+
18+
- :fontawesome-solid-layer-group: __Setting up your development and simulation environments__
19+
20+
CSCS provides two ways to acess software, and create the environment used to develop and run.
21+
22+
Scientitic HPC workloads are a good fit for uenv -- a tool developed by CSCS to deliver scientific software stacks on Alps.
23+
24+
[:octicons-arrow-right-24: uenv][ref-uenv]
25+
26+
The container engine runtime is recommended for machine learning workflows.
27+
It can also be a very good choice for Python environments installed using pip, uv and conda.
28+
29+
[:octicons-arrow-right-24: container engine][ref-container-engine]
30+
31+
</div>
32+
33+
34+
!!! todo "links to programming environments"
35+
Provide links to programming environements, software and Frameworks (which are in a different top level section).
36+
37+
This helps with discoverability.

mkdocs.yml

Lines changed: 52 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -31,36 +31,16 @@ nav:
3131
- 'Climate and Weather Platform':
3232
- platforms/cwp/index.md
3333
- 'Santis': clusters/santis.md
34-
- 'Accounts and Projects':
35-
- accounts/index.md
36-
- 'Account and Resources Management Tool': accounts/ump.md
37-
- 'Project and Resources Management Tool': accounts/waldur.md
38-
- 'Creating a new account': accounts/account-create.md
3934
- 'Connecting to Alps':
4035
- access/index.md
4136
- 'Multi Factor Authentication (MFA)': access/mfa.md
4237
- 'Web Services': access/web.md
4338
- 'SSH': access/ssh.md
4439
- 'JupyterLab': access/jupyterlab.md
4540
- 'VSCode': access/vscode.md
46-
- 'Running Jobs':
47-
- running/index.md
48-
- 'Slurm': running/slurm.md
49-
- 'Job report': running/jobreport.md
50-
- 'Known issues': running/known-issues.md
51-
- 'Machine Learning':
52-
- ml/index.md
53-
- 'PyTorch': software/ml/pytorch.md
54-
- 'Tutorials':
55-
- ml/tutorials/index.md
56-
- 'LLM Inference': ml/tutorials/llm-inference.md
57-
- 'LLM Fine-tuning': ml/tutorials/llm-fine-tuning.md
58-
- 'LLM Pre-training': ml/tutorials/llm-nanotron-training.md
59-
- 'Data management': ml/data.md
60-
- 'Tuning and optimization': ml/tuning.md
61-
- 'Inference Workflows': ml/inference.md
62-
- 'Software Deployment':
41+
- 'Environments':
6342
- software-deployment/index.md
43+
- 'Using the terminal': guides/terminal.md
6444
- 'uenv':
6545
- software/uenv/index.md
6646
- 'Configuration': software/uenv/configure.md
@@ -73,31 +53,20 @@ nav:
7353
- 'Resource and hooks': software/container-engine/resource-hook.md
7454
- 'EDF reference': software/container-engine/edf.md
7555
- 'Known issues': software/container-engine/known-issue.md
76-
- 'Building software':
77-
- build-install/index.md
78-
- 'uenv': build-install/uenv.md
79-
- 'Containers (podman)': build-install/containers.md
80-
- 'Community codes':
81-
- build-install/applications/index.md
82-
- 'Matlab': build-install/applications/matlab.md
83-
- 'WRF': build-install/applications/wrf.md
84-
- 'Software':
85-
- software/index.md
86-
- 'Scientific Applications':
87-
- software/sciapps/index.md
88-
- 'CP2K': software/sciapps/cp2k.md
89-
- 'GROMACS': software/sciapps/gromacs.md
90-
- 'LAMMPS': software/sciapps/lammps.md
91-
- 'NAMD': software/sciapps/namd.md
92-
- 'Quantum ESPRESSO': software/sciapps/quantumespresso.md
93-
- 'VASP': software/sciapps/vasp.md
56+
- 'Building and Installing Software':
57+
- build-install/index.md
9458
- 'Programming Environments':
9559
- software/prgenv/index.md
9660
- 'prgenv-gnu': software/prgenv/prgenv-gnu.md
9761
- 'prgenv-nvfortran': software/prgenv/prgenv-nvfortran.md
9862
- 'linalg': software/prgenv/linalg.md
9963
- 'julia': software/prgenv/julia.md
10064
- 'Cray modules (CPE)': software/prgenv/cpe.md
65+
- 'How to build software':
66+
- 'uenv': build-install/uenv.md
67+
- 'Packaging and Deployment':
68+
- 'Creating uenv': software/uenv/build.md
69+
- 'Creating Containers with podman': build-install/containers.md
10170
- 'Communication Libraries':
10271
- software/communication/index.md
10372
- 'Cray MPICH': software/communication/cray-mpich.md
@@ -106,18 +75,48 @@ nav:
10675
- 'NCCL': software/communication/nccl.md
10776
- 'RCCL': software/communication/rccl.md
10877
- 'libfabric': software/communication/libfabric.md
109-
- 'Debugging and Performance Analysis':
110-
- software/devtools/index.md
111-
- 'Using NVIDIA Nsight': software/devtools/nvidia-nsight.md
112-
- 'Using Linaro Forge':
113-
- software/devtools/linaro-uenv.md
114-
- 'Linaro performance analysis tool': software/devtools/linaro-map.md
115-
- 'Linaro debugger': software/devtools/linaro-ddt.md
116-
- 'Using Score-P/Scalasca': software/devtools/vihps.md
78+
- 'Software and Frameworks':
79+
- software/index.md
80+
- 'Scientific Applications':
81+
- software/sciapps/index.md
82+
- 'CP2K': software/sciapps/cp2k.md
83+
- 'GROMACS': software/sciapps/gromacs.md
84+
- 'LAMMPS': software/sciapps/lammps.md
85+
- 'NAMD': software/sciapps/namd.md
86+
- 'Quantum ESPRESSO': software/sciapps/quantumespresso.md
87+
- 'VASP': software/sciapps/vasp.md
88+
- 'Machine Learning':
89+
- ml/index.md
90+
- 'PyTorch': software/ml/pytorch.md
91+
- 'Tutorials':
92+
- ml/tutorials/index.md
93+
- 'LLM Inference': ml/tutorials/llm-inference.md
94+
- 'LLM Fine-tuning': ml/tutorials/llm-fine-tuning.md
95+
- 'LLM Pre-training': ml/tutorials/llm-nanotron-training.md
96+
- 'Data management': ml/data.md
97+
- 'Tuning and optimization': ml/tuning.md
98+
- 'Inference Workflows': ml/inference.md
99+
- 'Community codes':
100+
- build-install/applications/index.md
101+
- 'Matlab': build-install/applications/matlab.md
102+
- 'WRF': build-install/applications/wrf.md
117103
- 'Scientific Visualization':
118104
- software/sciviz/index.md
119105
- 'ParaView': software/sciviz/paraview.md
120106
- 'Unsupported Software': software/unsupported.md
107+
- 'Debugging and Performance Analysis':
108+
- software/devtools/index.md
109+
- 'Using NVIDIA Nsight': software/devtools/nvidia-nsight.md
110+
- 'Using Linaro Forge':
111+
- software/devtools/linaro-uenv.md
112+
- 'Linaro performance analysis tool': software/devtools/linaro-map.md
113+
- 'Linaro debugger': software/devtools/linaro-ddt.md
114+
- 'Using Score-P/Scalasca': software/devtools/vihps.md
115+
- 'Running Jobs':
116+
- running/index.md
117+
- 'Slurm': running/slurm.md
118+
- 'Job report': running/jobreport.md
119+
- 'Known issues': running/known-issues.md
121120
- 'Services':
122121
- services/index.md
123122
- 'FirecREST': services/firecrest.md
@@ -133,11 +132,15 @@ nav:
133132
- 'Data Transfer': storage/transfer.md
134133
- 'Long Term Storage': storage/longterm.md
135134
- 'Object Storage': storage/object.md
135+
- 'Accounts and Projects':
136+
- accounts/index.md
137+
- 'Account and Resources Management Tool': accounts/ump.md
138+
- 'Project and Resources Management Tool': accounts/waldur.md
139+
- 'Creating a new account': accounts/account-create.md
136140
- 'Guides':
137141
- guides/index.md
138142
- 'Internet Access on Alps': guides/internet-access.md
139143
- 'Storage': guides/storage.md
140-
- 'Using the terminal': guides/terminal.md
141144
- 'Gordon Bell 2025': guides/gb25.md
142145
- 'Policies':
143146
- policies/index.md

0 commit comments

Comments
 (0)