README.md 2.01 KB
Newer Older
Azat Khuziyakhmetov's avatar
Azat Khuziyakhmetov committed
1
2
# pdf-report

p.rmeuer's avatar
p.rmeuer committed
3
4
### PDF report

p.rmeuer's avatar
p.rmeuer committed
5
6
Program to create a PDF-Report from data supplied for a job run on an HPC-system

p.rmeuer's avatar
p.rmeuer committed
7
### Dependencies:
p.rmeuer's avatar
p.rmeuer committed
8
9
10
11
12

pdfreport.py was developed on an Ubuntu16.04-System and has the following
dependencies:

Python (>= 3.5)
p.rmeuer's avatar
p.rmeuer committed
13

p.rmeuer's avatar
p.rmeuer committed
14
numpy(>= 1.15.4)
p.rmeuer's avatar
p.rmeuer committed
15

p.rmeuer's avatar
p.rmeuer committed
16
matplotlib (>= 3.0.2)
p.rmeuer's avatar
p.rmeuer committed
17

p.rmeuer's avatar
p.rmeuer committed
18
pandas (>= 0.23.4)
p.rmeuer's avatar
p.rmeuer committed
19

p.rmeuer's avatar
p.rmeuer committed
20
reportlab (>= 3.3.0)
p.rmeuer's avatar
p.rmeuer committed
21

root's avatar
root committed
22
svglib (== 0.9.0)
p.rmeuer's avatar
p.rmeuer committed
23

p.rmeuer's avatar
p.rmeuer committed
24
25
26

 ### Installation notes:

p.rmeuer's avatar
p.rmeuer committed
27
28
 After installation of all dependencies, pdfreport.py can be called with the
 line command:
p.rmeuer's avatar
p.rmeuer committed
29

p.rmeuer's avatar
p.rmeuer committed
30
 python3 \<pdf-report-home\>/pdfgen/pfit_pdfreport.py \<name-of-json-file\> \<tmp-output-dir\> \<pdf-report-dir\>
p.rmeuer's avatar
p.rmeuer committed
31
32

 where
p.rmeuer's avatar
p.rmeuer committed
33
34
 
 \<pdf-report-home\> is the directory of this file
p.rmeuer's avatar
p.rmeuer committed
35

p.rmeuer's avatar
p.rmeuer committed
36
 \<name-of-json-file\> is the path to the json input file containing the job-ID-data
p.rmeuer's avatar
p.rmeuer committed
37
 (see docs/spec-input)
p.rmeuer's avatar
p.rmeuer committed
38

p.rmeuer's avatar
p.rmeuer committed
39
 \<tmp-output-dir\> is the directory for temperary ouput files
p.rmeuer's avatar
p.rmeuer committed
40

p.rmeuer's avatar
p.rmeuer committed
41
 \<pdf-report-dir\> is the directory for the output pdf-report
p.rmeuer's avatar
p.rmeuer committed
42

p.rmeuer's avatar
p.rmeuer committed
43
44
45
46
A configuration file can be created to customize some of the graphs. If it
exists, it will be used. Otherwise default values will be used. It must have
the following path:

p.rmeuer's avatar
p.rmeuer committed
47
\<pdf-report-home\>/conf/pdfreport.conf
p.rmeuer's avatar
p.rmeuer committed
48

p.rmeuer's avatar
p.rmeuer committed
49

p.rmeuer's avatar
p.rmeuer committed
50
 ### Test:
p.rmeuer's avatar
p.rmeuer committed
51
52
53
54
55
 
 Create a directory for temporary output files and for output PDF report.
 In this example, the PDF report will be place in the local directory
 
 mkdir ./tmp
p.rmeuer's avatar
p.rmeuer committed
56

p.rmeuer's avatar
p.rmeuer committed
57
 python3 \<pdf-report-home\>/pdfgen/pfit_pdfreport.py \<pdf-report-home\>/testdata/test-ib_1352076.json ./tmp ./
p.rmeuer's avatar
p.rmeuer committed
58

p.rmeuer's avatar
p.rmeuer committed
59
60
 ### Current defined data and structure

p.rmeuer's avatar
p.rmeuer committed
61
62
 See docs/spec-input. Missing data may either remain undefined in the json file or defined with value Null. 
 Json data type Null converts to data type None in python.
p.rmeuer's avatar
p.rmeuer committed
63

p.rmeuer's avatar
p.rmeuer committed
64
 ### Extending pdfgen/pfit_pdfreport.py to include data not mentioned in docs/spec-input
p.rmeuer's avatar
p.rmeuer committed
65
66
67

 All timeseries data will be plotted, if they are included properly in the  
 nodes.dynamic section in docs/spec-input, for example, similar to `node_load`.
p.rmeuer's avatar
p.rmeuer committed
68
 For more details on displaying other data, see comments in pdfreport.py and
p.rmeuer's avatar
p.rmeuer committed
69
70
 follow instructions for modifying the file conf/pdfreport.conf.

p.rmeuer's avatar
p.rmeuer committed
71
72
73
74
 ### Author:

 Rosemarie Meuer, University of Rostock

p.rmeuer's avatar
p.rmeuer committed
75
 ### Date: January 16, 2020