Louhi User's Guide, the 2nd Edition > Introduction > Notation used in this guide
Tehdyt toimenpiteet

Notation used in this guide

This section gives a summary of the fonts and other notational conventions used in this guide.

In this guide, the boldface font indicates a command, filename, hostname etc. when used within a paragraph of normal text. For example, names of the compute nodes can be seen from the file /etc/hosts on the front node.

To emphasize how to write a command line or to give an entire code example, the teletype font in a grey box is used. For example, use

ssh louhi.csc.fi

to log in the front node.

Generic arguments given to commands are indicated with an italic (teletype) font. For example,

rm file

The names of the generic arguments are descriptive of the actual argument they represent.

The optional parts of the commands are written inside brackets

more [options] [files]

Similarly, braces indicate that a selection is required. For example, the optimization level is given by the flag -O{0 | 1 | 2 | 3}.

Italic font can also used to introduce new terms within text. For example, MPI is a message-passing library.

External links look like the following: Universities can obtain a freeware version of SSH from the web site

http://www.ssh.fi

Internal links can be used to provide code example files that are functional either as such or with minimal applicable changes. The code examples given within the grey boxes aim also to be copy/pastable as such, unless specially commented that they are fragments instead of a stand-alone code.

Boldface is used additionally in descriptive lists for each item. For example, the most important parallel programming standards are:

OpenMP
Shared-memory parallel programming paradigm
MPI
Message-passing paradigm than can be used both in distributed and shared-memory systems