Skip to content

Commit 82198cf

Browse files
Merge branch 'main' into lammps_docs_v2
2 parents 1235f33 + b38dea7 commit 82198cf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2701
-255
lines changed

.github/CODEOWNERS

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
* @bcumming @msimberg @RMeli
22
docs/services/firecrest @jpdorsch @ekouts
3-
docs/software/communication @msimberg
3+
docs/software/communication @Madeeks @msimberg
44
docs/software/devtools/linaro @jgphpc
55
docs/software/prgenv/linalg.md @finkandreas @msimberg
66
docs/software/sciapps/cp2k.md @abussy @RMeli
7-
docs/software/sciapps/lammps.md @nickjbrowning
7+
docs/software/sciapps/lammps.md @nickjbrowning
8+
docs/software/sciapps/gromacs.md @kanduri
9+
docs/software/ml @boeschf

.github/actions/spelling/allow.txt

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
ACLs
2+
ACR
3+
AMD
4+
AWS
5+
Alpstein
6+
Balfrin
7+
Broyden
8+
CFLAGS
9+
CHARMM
10+
CHF
11+
COSMA
12+
CPE
13+
cpe
14+
CPMD
15+
CSCS
16+
CWP
17+
CXI
18+
capstor
19+
Ceph
20+
Containerfile
21+
DNS
22+
EDF
23+
EDFs
24+
EDFs
25+
EMPA
26+
ETHZ
27+
Ehrenfest
28+
Errigal
29+
FFT
30+
Fock
31+
GAPW
32+
GCC
33+
GGA
34+
GPFS
35+
GPG
36+
GPU
37+
GPUs
38+
GPW
39+
GROMACS
40+
GTL
41+
Gaussian
42+
Google
43+
HDD
44+
HPC
45+
HPCP
46+
HPE
47+
HSN
48+
Hartree
49+
iopsstor
50+
Jax
51+
Jira
52+
Keycloak
53+
LAMMPS
54+
LDA
55+
LOCALID
56+
LUMI
57+
Libc
58+
Linaro
59+
Linux
60+
MFA
61+
MLP
62+
MNDO
63+
MPICH
64+
MPS
65+
MeteoSwiss
66+
NAMD
67+
NICs
68+
NVIDIA
69+
NVMe
70+
OTP
71+
OTPs
72+
PASC
73+
PBE
74+
PDUs
75+
PID
76+
PMPI
77+
POSIX
78+
Parrinello
79+
Piz
80+
Plesset
81+
Pulay
82+
RCCL
83+
RDMA
84+
ROCm
85+
RPA
86+
Roboto
87+
Roothaan
88+
SSHService
89+
STMV
90+
Scopi
91+
TOTP
92+
UANs
93+
UserLab
94+
VASP
95+
Waldur
96+
Wannier
97+
XDG
98+
aarch
99+
aarch64
100+
acl
101+
biomolecular
102+
bristen
103+
bytecode
104+
clariden
105+
concretise
106+
concretizer
107+
containerised
108+
customised
109+
diagonalisation
110+
eiger
111+
filesystems
112+
groundstate
113+
inodes
114+
lexer
115+
libfabric
116+
multitenancy
117+
podman
118+
prioritised
119+
prgenv
120+
proactively
121+
quickstart
122+
santis
123+
sbatch
124+
screenshot
125+
slurm
126+
smartphone
127+
squashfs
128+
srun
129+
ssh
130+
stackinator
131+
stakeholders
132+
subfolders
133+
subtable
134+
subtables
135+
supercomputing
136+
superlu
137+
sysadmin
138+
tcl
139+
tcsh
140+
testuser
141+
timeframe
142+
timelimit
143+
tmpfs
144+
todi
145+
toolbar
146+
toolset
147+
torchaudio
148+
torchvision
149+
treesitter
150+
trilinos
151+
uarch
152+
uenv
153+
uenvs
154+
uids
155+
vCluster
156+
vClusters
157+
venv
158+
versioned
159+
versioning
160+
webhooks
161+
webinar
162+
webpage
163+
website
164+
wikipedia
165+
workaround
166+
workflows
167+
xattr
168+
xattrs
169+
youtube
170+
zstd
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# generic ignore spelling block
2+
<!--begin no spell check-->
3+
<!--end no spell check-->
4+
5+
# ignore code blocks
6+
```
7+
```

.github/actions/spelling/only.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs/.*\.md$
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Recognized as "Firec" and "REST" with the regular rules, so in patterns.txt
2+
# instead of allow.txt
3+
FirecREST
4+
RESTful
5+
6+
# markdown figure
7+
^!\[.*\]\(.*\)$
8+
9+
# Most obvious URLs
10+
https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_\+.~#?&//=]*)
11+
12+
# Markdown references (definition and use)
13+
^\[\]\(\){#[a-z-]+}$
14+
\]\(#[a-z-]+\)
15+
\]\[[a-z-]+\]
16+
17+
# Inline code
18+
\`[^\`]+\`

.github/workflows/spelling.yaml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: Check Spelling
2+
3+
on:
4+
pull_request:
5+
6+
jobs:
7+
spelling:
8+
name: Check Spelling
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
- name: Check spelling
13+
id: spelling
14+
# The given commit contains preliminary, unreleased, support for ignoring
15+
# whole blocks (multi-line) from spell checking. See
16+
# https://github.com/check-spelling/check-spelling/commit/46c981b7c96b3777aff4fd711fc9a8f126121b04
17+
# for more details.
18+
uses: check-spelling/check-spelling@46c981b7c96b3777aff4fd711fc9a8f126121b04
19+
with:
20+
check_file_names: 1
21+
post_comment: 0
22+
use_magic_file: 1
23+
warnings: bad-regex,binary-file,deprecated-feature,large-file,limited-references,no-newline-at-eof,noisy-file,non-alpha-in-dictionary,token-is-substring,unexpected-line-ending,whitespace-in-dictionary,minified-file,unsupported-configuration,no-files-to-check
24+
use_sarif: 1
25+
extra_dictionary_limit: 20
26+
extra_dictionaries:
27+
cspell:software-terms/dict/softwareTerms.txt
28+
cspell:bash/dict/bash-words.txt
29+
cspell:companies/dict/companies.txt
30+
cspell:filetypes/filetypes.txt

docs/accounts/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ To get an account you must be invited by a member of CSCS project adminstration
99
CSCS issues calls for proposals that are announced via the CSCS website and e-mails.
1010
More information about upcoming calls is available on [the CSCS web site](https://www.cscs.ch/user-lab/allocation-schemes).
1111

12-
New PIs who have sucessfully applied for a preparatory project will receive an invitation from CSCS to get an account at CSCS.
12+
New PIs who have successfully applied for a preparatory project will receive an invitation from CSCS to get an account at CSCS.
1313
PIs can then invite members of their groups to join their project.
1414

1515
!!! info

docs/alps/clusters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Clusters on Alps are provided as part of different [platforms][ref-alps-platform
1414

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

17-
Bristen is a small system with a100 nodes, used for **todo**
17+
Bristen is a small system with A100 nodes used for data processing, development, x86 workloads and ML inference services.
1818

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

docs/alps/hardware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This approach to cooling provides greater efficiency for the rack-level cooling,
2828
information about the network.
2929

3030
* Details about SlingShot 11.
31-
* how many NICS per node
31+
* how many NICs per node
3232
* raw feeds and speeds
3333
* Some OSU benchmark results.
3434
* GPU-aware communication

docs/alps/storage.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
# Alps Storage
33

44
Alps has different storage attached, each with characteristics suited to different workloads and use cases.
5-
HPC storage is manged in a separate cluster of nodes that host servers that manage the storage and the physical storage drives.
5+
HPC storage is managed in a separate cluster of nodes that host servers that manage the storage and the physical storage drives.
66
These separate clusters are on the same Slingshot 11 network as the Alps.
77

8-
| | Capstor | IOPStor | Vast |
8+
| | Capstor | Iopsstor | Vast |
99
|--------------|------------------------|------------------------|---------------------|
1010
| Model | HPE ClusterStor E1000D | HPE ClusterStor E1000F | Vast |
1111
| Type | Lustre | Lustre | NFS |
1212
| Capacity | 129 PB raw GridRAID | 7.2 PB raw RAID 10 | 1 PB |
13-
| Number of Drives | 8,480 16 TB HDD | 240 * 30 TB NVME SSD | N/A |
13+
| Number of Drives | 8,480 16 TB HDD | 240 * 30 TB NVMe SSD | N/A |
1414
| Read Speed | 1.19 TB/s | 782 GB/s | 38 GB/s |
1515
| Write Speed | 1.09 TB/s | 393 GB/s | 11 GB/s |
1616
| IOPs | 1.5M | 8.6M read, 24M write | 200k read, 768k write |
@@ -22,19 +22,19 @@ These separate clusters are on the same Slingshot 11 network as the Alps.
2222
Capstor is the largest file system, for storing large amounts of input and output data.
2323
It is used to provide SCRATCH and STORE for different clusters - the precise details are platform-specific.
2424

25-
[](){#ref-alps-iopstor}
26-
## iopstor
25+
[](){#ref-alps-iopsstor}
26+
## iopsstor
2727

2828
!!! todo
29-
small text explaining what iopstor is designed to be used for.
29+
small text explaining what iopsstor is designed to be used for.
3030

3131
[](){#ref-alps-vast}
3232
## vast
3333

3434
The Vast storage is smaller capacity system that is designed for use as home folders.
3535

3636
!!! todo
37-
small text explaining what iopstor is designed to be used for.
37+
small text explaining what iopsstor is designed to be used for.
3838

3939
The mounts, and how they are used for SCRATCH, STORE, PROJECT, HOME would be in the [storage docs][ref-storage-fs]
4040

0 commit comments

Comments
 (0)