Skip to content

Commit e8700ee

Browse files
msimbergmsimberg
authored
Spellchecker CI action (#98)
1 parent 6eed060 commit e8700ee

File tree

21 files changed

+243
-34
lines changed

21 files changed

+243
-34
lines changed

‎.github/actions/spelling/allow.txt‎

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

‎.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$

‎.github/actions/spelling/patterns.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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-]+\]

‎.github/workflows/spelling.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
uses: check-spelling/[email protected]
15+
with:
16+
check_file_names: 1
17+
post_comment: 0
18+
use_magic_file: 1
19+
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
20+
use_sarif: 1
21+
extra_dictionary_limit: 20
22+
extra_dictionaries:
23+
cspell:software-terms/dict/softwareTerms.txt
24+
cspell:bash/dict/bash-words.txt
25+
cspell:companies/dict/companies.txt
26+
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/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

‎docs/build-install/uenv.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ uenv start prgenv-gnu/24.11:v1 --view=spack
7272

7373
??? warning "Upstream Spack version"
7474

75-
It is strongly recomended that your version of Spack and the version of Spack in the uenv match when building software on top of an uenv.
75+
It is strongly recommended that your version of Spack and the version of Spack in the uenv match when building software on top of an uenv.
7676

7777
!!! note "Advanced Spack users"
7878

@@ -131,7 +131,7 @@ The `uenv-spack` tool can be used to create a build directory with a template [S
131131

132132
1. Script to build the software stack.
133133
2. `git` clone of the required version of Spack.
134-
3. Spack onfiguration files for the software stack.
134+
3. Spack configuration files for the software stack.
135135
4. Information about the uenv that was used to run `uenv-spack`.
136136
5. Description of the software to build.
137137
6. Template [Spack environment file].

‎docs/clusters/bristen.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ See the SLURM documentation for instructions on how to run jobs on the [Grace-Ho
7474

7575
### FirecREST
7676

77-
Bristen can also be accessed using [FircREST][ref-firecrest] at the `https://api.cscs.ch/ml/firecrest/v1` API endpoint.
77+
Bristen can also be accessed using [FirecREST][ref-firecrest] at the `https://api.cscs.ch/ml/firecrest/v1` API endpoint.
7878

7979
### Scheduled Maintenance
8080

‎docs/clusters/clariden.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ See the SLURM documentation for instructions on how to run jobs on the [Grace-Ho
102102

103103
### FirecREST
104104

105-
Clariden can also be accessed using [FircREST][ref-firecrest] at the `https://api.cscs.ch/ml/firecrest/v1` API endpoint.
105+
Clariden can also be accessed using [FirecREST][ref-firecrest] at the `https://api.cscs.ch/ml/firecrest/v1` API endpoint.
106106

107107
## Maintenance and status
108108

0 commit comments

Comments
 (0)