forked from NAG-DevOps/speed-hpc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathspeed-manual.tex
228 lines (194 loc) · 6.82 KB
/
speed-manual.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
\documentclass{easychair}
%\documentclass[draft]{easychair}
% https://en.wikibooks.org/wiki/LaTeX/Source_Code_Listings
\usepackage{listings}
% For inline citations
\usepackage{bibentry}
\nobibliography*
% For multicolumn itemized lists
\usepackage{multicol}
% For newline, simply insert an empty line
\usepackage{parskip}
% Down to the level of the paragraph (4)
\setcounter{secnumdepth}{4}
\setcounter{tocdepth}{4}
% Folders with images
\makeatletter
\providecommand*{\input@path}{}
\g@addto@macro\input@path{{../src/}{src/}}% append
\g@addto@macro\input@path{{../doc/images/}{images/}}% append
\makeatother
\input{commands}
%% Document
% ------------------------------------------------------------------------------
\begin{document}
%% Front Matter
% ------------------------------------------------------------------------------
% Regular title as in the article class.
%
\title{Speed: The GCS ENCS Cluster}
% \titlerunning{} has to be set to either the main title or its shorter
% version for the running heads. Use {\sf} for highlighting your system
% name, application, or a tool.
\titlerunning{Speed: The GCS ENCS Cluster}
% Previously VI
%\date{Version 6.5}
%\date{\textbf{Version 6.6-dev-07}}
%\date{\textbf{Version 6.6} (final GE version)}
%\date{\textbf{Version 7.0-dev-01}}
%\date{\textbf{Version 7.0}}
%\date{\textbf{Version 7.1}}
%\date{\textbf{Version 7.2}}
\date{\textbf{Version 7.3}}
% Authors are joined by \and and their affiliations are on the
% subsequent lines separated by \\ just like the article class allows.
\author{
Serguei A. Mokhov
\and
Gillian A. Roper
\and
Carlos Alarcón Meza
\and
Farah Salhany
\and
Network, Security and HPC Group\footnote{The group acknowledges the initial manual version VI produced by Dr.~Scott Bunnell while with us
as well as Dr.~Tariq Daradkeh for his instructional support of the users and contribution of examples.}\\
\affiliation{Gina Cody School of Engineering and Computer Science}\\
\affiliation{Concordia University}\\
\affiliation{Montreal, Quebec, Canada}\\
\affiliation{\url{rt-ex-hpc~AT~encs.concordia.ca}}\\
}
% \authorrunning{} has to be set for the shorter version of the authors' names;
% otherwise a warning will be rendered in the running heads.
%
\authorrunning{Mokhov, Roper, Alarcón Meza, Salhany, NAG/HPC, GCS ENCS}
\indexedauthor{Mokhov, Serguei}
\indexedauthor{Roper, Gillian}
\indexedauthor{Alarcón Meza, Carlos}
\indexedauthor{Salhany, Farah}
\indexedauthor{NAG/HPC}
\maketitle
%%
% ------------------------------------------------------------------------------
% Abstract
% ------------------------------------------------------------------------------
\begin{abstract}
This document serves as a quick start guide to using the Gina Cody School of
Engineering and Computer Science (GCS ENCS) compute server farm, known as ``Speed.''
Managed by the HPC/NAG group of the Academic Information Technology Services (AITS) at GCS,
Concordia University, Montreal, Canada.
\end{abstract}
% ------------------------------------------------------------------------------
% Table of Contents
% ------------------------------------------------------------------------------
\tableofcontents
\clearpage
% ------------------------------------------------------------------------------
% 1 Introduction
% ------------------------------------------------------------------------------
\input{introduction/introduction-main.tex}
% Includes:
% 1.1 Citing US
% 1.2 Resources
% 1.3 Team
% 1.4 What Speed Consists of
% 1.5 What Speed Is Ideal For
% 1.6 What Speed Is Not
% 1.7 Available Software
% 1.8 Requesting Access
% ------------------------------------------------------------------------------
% 2 Job Management
% ------------------------------------------------------------------------------
\input{job-management/job-management-main.tex}
% Includes:
% 2.1 Getting Started
% 2.1.1 SSH Connections
% 2.1.2 Environment Set Up
% 2.2 Job Submission Basics
% 2.2.1 Directives
% 2.2.2 Working with Modules
% 2.2.3 User Scripting
% 2.3 Sample Job Script
% 2.4 Common Job Management Commands
% 2.5 Advanced sbatch Options
% 2.6 Array Jobs
% 2.7 Requesting Multiple Cores
% 2.8 Interactive Jobs
% 2.8.1 Command Line
% 2.8.2 Graphical Applications
% 2.8.3 Jupyter Notebooks
% 2.8.3.1 Jupyter Notebook in Singularity
% 2.8.3.2 Jupyter Notebook in Conda
% 2.8.3.3 Jupyter Notebook in Python Virtual Env
% 2.8.4 Visual Studio Code
% 2.9 Scheduler Environment Variables
% 2.10 SSH Keys for MPI
% 2.11 Creating Virtual Environments
% 2.11.1 Anaconda
% 2.11.2 Python
% 2.12 Sample Job Script: Fluent
% 2.13 Example Job Script: EfficientDet
% 2.14 Java Jobs
% 2.15 Scheduling on the GPU Node
% 2.15.1 P6 on Multi-GPU, Multi-Node
% 2.15.2 CUDA
% 2.15.3 Special Notes for Sending CUDA Jobs to the GPU Queue
% 2.15.4 OpenISS Examples
% 2.15.4.1 OpenISS and REID
% 2.15.4.2 OpenISS and YOLOv3
% 2.16 Singularity Containers
% ------------------------------------------------------------------------------
% 3 Conclusion
% ------------------------------------------------------------------------------
\input{conclusion/conclusion-main.tex}
% Includes:
% 3.1 Important Limitations
% 3.2 Tips/Tricks
% 3.3 Use Cases
% ------------------------------------------------------------------------------
% Appendix
% ------------------------------------------------------------------------------
\appendix
% A History
% -------------------------------------------------------------
\input{appendix/history.tex}
% Includes:
% A.1 Acknowledgments
% A.2 Migration from UGE to SLURM
% A.3 Phases
% B Frequently Asked Questions
% -------------------------------------------------------------
\input{appendix/faq.tex}
% TO DELETE
%\input{scheduler-faq}
% Includes:
% B.1 Where do I learn about Linux?
% B.2 How to bash shell on Speed?
% B.3 How to resolve “Disk quota exceeded” errors?
% B.4 How do I check my job's status?
% B.5 Why is my job pending when nodes are empty?
% C Sister Facilities
% -------------------------------------------------------------
\input{appendix/sister-facilities.tex}
% D Software List
% -------------------------------------------------------------
\input{software-list.tex}
% Includes:
% D.1 EL7
% D.2 EL9
% ------------------------------------------------------------------------------
% References
% ------------------------------------------------------------------------------
\nocite{aosa-book-vol1}
\label{sect:bib}
\bibliographystyle{plain}
%\bibliographystyle{IEEEtran}
%\bibliographystyle{alpha}
%\bibliographystyle{unsrt}
%\bibliographystyle{abbrv}
% Create a section for references otherwise it appears to be part of the "Sister Facilities" Appendix
\clearpage
\addcontentsline{toc}{section}{Annotated Bibliography}
\bibliography{speed-manual}
%------------------------------------------------------------------------------
\end{document}