You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: INSTALL.md
+33-33Lines changed: 33 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# INSTALLATION
1
+
# INSTALLATION
2
2
3
3
Eventdisplay is a C++ based library and designed to run in typical Linux environments. It has not been tested on MacOS (use Docker containers in this instance).
4
4
@@ -8,19 +8,19 @@ Eventdisplay is a C++ based library and designed to run in typical Linux environ
8
8
9
9
CERN's [ROOT](https://root.cern.ch/) library for I/O, histogramming, and statistical applications:
10
10
11
-
- ROOT versions >= 6.28
12
-
- the first-stage tool `evndisp` requires ROOT compiled with mysql for access to the VERITAS database. Pre-compiled version of ROOT (downloaded from [here](https://root.cern/install/)) have mysql installed. If building from source, ensure the mysql dependencies are installed and compiler flags are added (see [root installation page](https://root.cern/install/build_from_source/)). All other stages of Eventdisplay do not required mysql - meaning e.g., the conda-based installation of Eventdisplay is fine.
13
-
- paths for ROOT should be set through e.g.,
11
+
* ROOT versions >= 6.28
12
+
* the first-stage tool `evndisp` requires ROOT compiled with mysql for access to the VERITAS database. Pre-compiled version of ROOT (downloaded from [here](https://root.cern/install/)) have mysql installed. If building from source, ensure the mysql dependencies are installed and compiler flags are added (see [root installation page](https://root.cern/install/build_from_source/)). All other stages of Eventdisplay do not required mysql - meaning e.g., the conda-based installation of Eventdisplay is fine.
13
+
* paths for ROOT should be set through e.g.,
14
14
15
-
```
15
+
```console
16
16
export ROOTSYS=<Path to ROOT installation>/root/
17
17
cd $ROOTSYS
18
18
source ./bin/thisroot.sh
19
19
```
20
20
21
-
- test your ROOT installation using the `root-config` tool, which should be accessible from any directory (through the `PATH` variable) if the system is setup correctly:
21
+
Test your ROOT installation using the `root-config` tool, which should be accessible from any directory (through the `PATH` variable) if the system is setup correctly:
22
22
23
-
```
23
+
```console
24
24
root-config --version
25
25
root-config --has-mysql
26
26
```
@@ -31,7 +31,7 @@ root-config --has-mysql
31
31
32
32
Download and install using this script in the $EVNDISPSYS directory:
33
33
34
-
```
34
+
```console
35
35
./install_sofa.sh
36
36
```
37
37
@@ -41,9 +41,9 @@ Set the following environmental variable: `SOFASYS=$EVNDISPSYS/sofa`
41
41
42
42
The first-stage tool `evndisp` requires the [VBF](https://github.com/VERITAS-Observatory/VBF) (VERITAS bank format) library to read VERITAS raw data files.
43
43
44
-
- use VBF version VBF >= 0.3.4
45
-
-https://github.com/VERITAS-Observatory/VBF/releases/tag/0.3.4-1-c%2B%2B17 for newer Linux systems C++17 support
46
-
-https://github.com/VERITAS-Observatory/VBF/releases/tag/0.3.4-1 for all other systems
44
+
* use VBF version VBF >= 0.3.4
45
+
*https://github.com/VERITAS-Observatory/VBF/releases/tag/0.3.4-1-c%2B%2B17 for newer Linux systems C++17 support
46
+
*https://github.com/VERITAS-Observatory/VBF/releases/tag/0.3.4-1 for all other systems
47
47
48
48
Simple installation instructions are found in `VBF/README`. To install in a local directory instead of the first installation command in VBF/README use `$ /.configure --prefix=<local directory>` and change the environment variable `VBFSYS` to `<local directory>`.
49
49
@@ -67,21 +67,21 @@ Eventdisplay can be used efficiently with the correct environmental variables se
67
67
68
68
### Compiling and Linking
69
69
70
-
ROOTSYS : (required) ROOT installation; add $ROOTSYS/lib to $LD_LIBRARY_PATH and $ROOTSYS/bin to $PATH
70
+
`ROOTSYS` : (required) ROOT installation; add $ROOTSYS/lib to $LD_LIBRARY_PATH and $ROOTSYS/bin to $PATH
71
71
72
-
SOFASYS: (required) Astronomy library from Sofa
72
+
`SOFASYS`: (required) Astronomy library from Sofa
73
73
74
-
VBSYS : (optional) VBF libraries (for `evndisp` analysis only); add $VBFSYS/bin to $PATH and $VBFSYS/lib to $LD_LIBRARY_PATH
74
+
`VBFSYS` : (optional) VBF libraries (for `evndisp` analysis only); add $VBFSYS/bin to $PATH and $VBFSYS/lib to $LD_LIBRARY_PATH
75
75
76
-
FITSSYS : (optional, not needed in most cases) FITS libraries
76
+
`FITSSYS` : (optional, not needed in most cases) FITS libraries
77
77
78
-
GSLSYS : (optional, not needed in most cases) GSL libraries
78
+
`GSLSYS` : (optional, not needed in most cases) GSL libraries
79
79
80
80
### Analysis
81
81
82
-
EVNDISPSYS : Eventdisplay code directory (scripts expect binaries in $EVNDISPSYS/bin and libraries in $EVNDISPSYS/lib). Add $EVNDISPSYS/obj to LD_LIBRARY_PATH.
82
+
`EVNDISPSYS` : Eventdisplay code directory (scripts expect binaries in `$EVNDISPSYS/bin` and libraries in `$EVNDISPSYS/lib`). Add `$EVNDISPSYS/obj` to `LD_LIBRARY_PATH`.
83
83
84
-
EVNDISPSCRIPTS: Eventdisplay scripts directory
84
+
`EVNDISPSCRIPTS`: Eventdisplay scripts directory (see [Eventdisplay_AnalysisScripts_VTS](https://github.com/VERITAS-Observatory/Eventdisplay_AnalysisScripts_VTS)).
85
85
86
86
### Data directories
87
87
@@ -90,57 +90,57 @@ Assume a computing environment, where several users are analysis the same raw da
90
90
directories ($VERITAS_USER_DATA_DIR).
91
91
Note that $VERITAS_DATA_DIR and $VERITAS_USER_DATA_DIR can point to the same directory.
92
92
93
-
- VERITAS_EVNDISP_AUX_DIR: directory with all auxiliary data like calibration files, lookup tables, effective areas, etc
94
-
- VERITAS_DATA_DIR : directory containing the raw telescope data or input simulation files
95
-
- VERITAS_USER_DATA_DIR : user data directory: containing output files from this analysis package
96
-
- VERITAS_USER_LOG_DIR : user log file directory: log files and temporary scripts are written to this directory
93
+
* VERITAS_EVNDISP_AUX_DIR: directory with all auxiliary data like calibration files, lookup tables, effective areas, etc
94
+
* VERITAS_DATA_DIR : directory containing the raw telescope data or input simulation files
95
+
* VERITAS_USER_DATA_DIR : user data directory: containing output files from this analysis package
96
+
* VERITAS_USER_LOG_DIR : user log file directory: log files and temporary scripts are written to this directory
97
97
98
98
To set the variables for VERITAS:
99
99
100
-
```
100
+
```console
101
101
./setObservatory.sh VERITAS
102
102
```
103
103
104
-
# Compiling
104
+
##Compiling
105
105
106
106
Check your systems configuration:
107
107
108
-
```
108
+
```console
109
109
make config
110
110
```
111
111
112
112
Compare the output with the requirements on software and environmental variable settings described above.
113
113
114
114
In the main Eventdisplay directory ($EVNDISPSYS is pointing to this directory), compile all Eventdisplay binaries with
115
115
116
-
```
116
+
```console
117
117
source ./setObservatory.sh VTS
118
118
make VTS
119
119
```
120
120
121
121
If you are working on a computing with several cores, this can be accelerated by e.g. compiling with four cores in parallel:
122
122
123
-
```
123
+
```console
124
124
source ./setObservatory.sh VTS
125
125
make -j 12 VTS
126
126
```
127
127
128
128
To compile a single component of the software only, e.g.:
129
129
130
-
```
130
+
```console
131
131
source ./setObservatory.sh VTS
132
132
make slib
133
133
```
134
134
135
135
Use `make clean` to remove any files produced in earlier compilation runs.
136
136
137
-
# Troubleshooting
137
+
##Troubleshooting
138
138
139
-
- many compilation issues are related to incorrect settings of the environmental variables, especially `ROOTSYS` and `VBFSYS`.
140
-
- ask via ELOG, slack, or GitHub issues for persistent issues
141
-
- check your installation, it should look something like this (with different directories):
139
+
* many compilation issues are related to incorrect settings of the environmental variables, especially `ROOTSYS` and `VBFSYS`.
140
+
* ask via ELOG, slack, or GitHub issues for persistent issues
141
+
* check your installation, it should look something like this (with different directories):
0 commit comments