README.md 2.99 KB
Newer Older
Dirk Brömmel's avatar
Dirk Brömmel committed
1
[![pipeline status](https://repository.prace-ri.eu/git/latex-templates/prace-whitepaper/badges/master/pipeline.svg)](https://repository.prace-ri.eu/git/latex-templates/prace-whitepaper/-/commits/master) (compiling the example)
Dirk Brömmel's avatar
Dirk Brömmel committed
2

Dirk Brömmel's avatar
Dirk Brömmel committed
3
# LaTeX package for a PRACE whitepaper
Martti Louhivuori's avatar
Martti Louhivuori committed
4

Dirk Brömmel's avatar
Dirk Brömmel committed
5
(c) CSC - IT Center for Science Ltd.  
Dirk Brömmel's avatar
Dirk Brömmel committed
6
7
8
9
10
    original author: Martti Louhivuori (martti.louhivuori@csc.fi)  
(c) JSC/PRACE  
    Dirk Broemmel (prace-pmo@fz-juelich.de)

Please report any problems with this template to `prace-pmo@fz-juelich.de` or contribute directly to this repository.
Martti Louhivuori's avatar
Martti Louhivuori committed
11

Dirk Brömmel's avatar
Dirk Brömmel committed
12
The latest version of the required files is available as download: [PRACE-Whitepaper.tar.gz](https://repository.prace-ri.eu/git/latex-templates/prace-whitepaper/-/jobs/artifacts/master/raw/PRACE-Whitepaper.tar.gz?job=build-example).
Dirk Brömmel's avatar
Dirk Brömmel committed
13

Dirk Brömmel's avatar
Dirk Brömmel committed
14
## PURPOSE
Dirk Brömmel's avatar
Dirk Brömmel committed
15
Enable the writing of a PRACE project report in LaTeX with minimal typographical effort. Uses a pre-defined document class 'prace' that automatically sets the correct document style and layout as well as provides custom macros for the ease-of-use of the writer.
Martti Louhivuori's avatar
Martti Louhivuori committed
16

Dirk Brömmel's avatar
Dirk Brömmel committed
17
## FILES
Dirk Brömmel's avatar
Dirk Brömmel committed
18
`prace.cls`      : LaTeX document class  
Dirk Brömmel's avatar
Dirk Brömmel committed
19
20
`template.tex`   : PRACE whitepaper template  
`prace-logo.[pdf|eps|png]` : logo of PRACE (used by prace.cls)  
Dirk Brömmel's avatar
Dirk Brömmel committed
21
 
Dirk Brömmel's avatar
Dirk Brömmel committed
22
The `example` directory contains a full example:  
Dirk Brömmel's avatar
Dirk Brömmel committed
23
`example.tex` : example of a filled-in template  
Dirk Brömmel's avatar
Dirk Brömmel committed
24
25
26
27
28
29
`example.pdf` : example PRACE whitepaper  
`example.[eps|png]` : figure used in the example whitepaper  

## REQUIREMENTS
Some LaTeX packages are assumed to be present for this class to work: `mathptmx` (for the correct font), `siunitx` (for properly formatted numbers+units), and `fancyhdr` (which should be updated at some point).  
The current version of the template is meant for use with `latex` or `pdflatex`, a modern dialect may follow in the future.
Dirk Brömmel's avatar
Dirk Brömmel committed
30
31
32
33
34

## QUICK HOW-TO
1) copy `template.tex` to `yourname_yourproject.tex`
2) fill in all the required information in `yourname_yourproject.tex` using your favorite text editor
3) convert `.tex` to `.pdf`, e.g. `pdflatex yourname_yourproject`
Martti Louhivuori's avatar
Martti Louhivuori committed
35
36
4) send the resulting PDF to PRACE

Dirk Brömmel's avatar
Dirk Brömmel committed
37
38
## MACROS
```tex
Martti Louhivuori's avatar
Martti Louhivuori committed
39
\author[<affiliation>]{<name of the author>}
Dirk Brömmel's avatar
Dirk Brömmel committed
40
41
```
Defines the name and affiliation(s) of an author. The affiliation(s) should be given as a comma-separated list of integers corresponding to the order of \affiliation definitions.
Martti Louhivuori's avatar
Martti Louhivuori committed
42

Dirk Brömmel's avatar
Dirk Brömmel committed
43
```tex
Martti Louhivuori's avatar
Martti Louhivuori committed
44
\corresponding
Dirk Brömmel's avatar
Dirk Brömmel committed
45
46
```
Flags the following \author definition as the corresponding author.
Martti Louhivuori's avatar
Martti Louhivuori committed
47

Dirk Brömmel's avatar
Dirk Brömmel committed
48
```tex
Martti Louhivuori's avatar
Martti Louhivuori committed
49
\affiliation{<name and address>}
Dirk Brömmel's avatar
Dirk Brömmel committed
50
51
```
Defines the name and address of an affiliation. The syntax should be 'Name, Street, Postcode and City, Country'.
Martti Louhivuori's avatar
Martti Louhivuori committed
52

Dirk Brömmel's avatar
Dirk Brömmel committed
53
```tex
Martti Louhivuori's avatar
Martti Louhivuori committed
54
\email{<e-mail address>}
Dirk Brömmel's avatar
Dirk Brömmel committed
55
56
```
Defines the e-mail address of the corresponding author.
Martti Louhivuori's avatar
Martti Louhivuori committed
57

Dirk Brömmel's avatar
Dirk Brömmel committed
58
All these macros should be used in the pre-amble of the document, so that all the required information is defined before calling `\maketitle`. In the main body of the document you can use default LaTeX commands for sections, figures etc., but you should refer to the comments in the `template.tex` for further information regarding the required structure, syntax and nomenclature in a PRACE whitepaper.
Martti Louhivuori's avatar
Martti Louhivuori committed
59