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

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
## PURPOSE
Dirk Brömmel's avatar
Dirk Brömmel committed
13
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
14

Dirk Brömmel's avatar
Dirk Brömmel committed
15
## FILES
Dirk Brömmel's avatar
Dirk Brömmel committed
16
`prace.cls`      : LaTeX document class  
Dirk Brömmel's avatar
Dirk Brömmel committed
17
18
`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
19
20
21
 
The `example` directory contains a full example:
`example.tex` : example of a filled-in template  
Dirk Brömmel's avatar
Dirk Brömmel committed
22
23
24
25
26
27
`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
28
29
30
31
32

## 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
33
34
4) send the resulting PDF to PRACE

Dirk Brömmel's avatar
Dirk Brömmel committed
35
36
## MACROS
```tex
Martti Louhivuori's avatar
Martti Louhivuori committed
37
\author[<affiliation>]{<name of the author>}
Dirk Brömmel's avatar
Dirk Brömmel committed
38
39
```
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
40

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

Dirk Brömmel's avatar
Dirk Brömmel committed
46
```tex
Martti Louhivuori's avatar
Martti Louhivuori committed
47
\affiliation{<name and address>}
Dirk Brömmel's avatar
Dirk Brömmel committed
48
49
```
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
50

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

Dirk Brömmel's avatar
Dirk Brömmel committed
56
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
57