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: cernopendata/modules/fixtures/data/docs/delphi-getting-started/delphi-getting-started.md
+20-17Lines changed: 20 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,12 @@
1
-
FIXME: Introduce table of contents
2
-
3
-
# Introduction
1
+
# Table of contents
4
2
This quick start guide is meant as a guide for the very first steps to get going with DELPHI software and data access.
5
3
6
-
## Overview
4
+
*[Overview and requirements](#overview)
5
+
*[Accessing the software stack](#access)
6
+
*[Documentation](#documentation)
7
+
*[Examples](#examples)
8
+
9
+
# <aname="overview"> Overview
7
10
8
11
The DELPHI stack consists of the following modules:
9
12
@@ -20,18 +23,18 @@ DELPHI data access rules are available [here](/record/417), or from [the DELPHI
20
23
21
24
Please read these before accessing the DELPHI software and data.
22
25
23
-
##Accessing the software stack
26
+
#<aname="access"> Accessing the software stack
24
27
There are two possible ways to access the software stack.
25
28
26
-
###Docker
29
+
## Docker
27
30
A docker container is available which ships with all the modules installed. Please take a look [here](docs/delpi-guide-docker)
28
31
29
-
###CVMFS
32
+
## CVMFS
30
33
Binaries are also available from CVMFS, for a variety of different Linux flavors. There are no native Windows or Apple ports available for the time being.
31
34
32
35
This method is convenient if you are running a desktop or a virtual machine with one of the supported Linux flavors on it.
33
36
34
-
####Requirements
37
+
### Requirements
35
38
You will need to have:
36
39
37
40
* /cvmfs/delphi.cern.ch mounted. Documentation can be found at https://cvmfs.readthedocs.io/en/stable/
@@ -43,7 +46,7 @@ You will need to have:
43
46
44
47
Please check the instructions at https://cvmfs.readthedocs.io/en/stable/cpt-quickstart.html and https://eoscta.docs.cern.ch/install/eos/ and https://eos-web.web.cern.ch/eos-web.
45
48
46
-
####Initialising the environment:
49
+
### Initialising the environment
47
50
For C-Shell (csh, tcsh ), do
48
51
```
49
52
source /cvmfs/delphi.cern.ch/setup.csh
@@ -53,11 +56,11 @@ For Bourne shell (sh, bash, zsh, ...), type
53
56
```
54
57
. /cvmfs/delphi.cern.ch/setup.sh
55
58
```
56
-
If using the container, please use ```/etc/profile.d/delphi.sh``` or ```/etc/profile.d/delphi.csh``` instead.
59
+
If using the container, please use `/etc/profile.d/delphi.sh` or `/etc/profile.d/delphi.csh` instead.
57
60
58
-
After sourcing the environment, make sure that the environment variable **DELPHI_DATA_ROOT** points to the tip of the data area. This is specifically important if you copied the data sets you want to use locally. The default is ```/eos/experiment/delphi/castor2015```.
61
+
After sourcing the environment, make sure that the environment variable **DELPHI_DATA_ROOT** points to the tip of the data area. This is specifically important if you copied the data sets you want to use locally. The default is `/eos/experiment/delphi/castor2015`.
59
62
60
-
##Documentation
63
+
#<aname="documentation"> Documentation
61
64
DELPHI manuals and notes are available from [https://cds.cern.ch/](http://cds.cern.ch/search?c=DELPHI&sc=1)
62
65
63
66
Here is a selection for getting started:
@@ -76,8 +79,8 @@ The DELPHI stack is mostly written in Fortran, with some bits written in C. Only
76
79
77
80
The collaboration main contact for data preservation is the mailing list [email protected]. Support can only be given on a best effort basis. Suggestions and feedback is of course welcome!
78
81
79
-
# Examples
80
-
Some basic examples of how to run the software stack and perform various tasks can be found in the ```/cvmfs/delphi.cern.ch/examples``` tree.
82
+
# <aname="examples"> Examples
83
+
Some basic examples of how to run the software stack and perform various tasks can be found in the `/cvmfs/delphi.cern.ch/examples` tree.
81
84
82
85
In the following, we will
83
86
* Create some Monte Carlo events and run simulation, reconstruction and DST production on them
@@ -197,7 +200,7 @@ FAT = short94_c2
197
200
```
198
201
to read 94 C2 data. It will automatically resolve the data files and loop over all of them.
199
202
200
-
# Raw data access
203
+
##Raw data access
201
204
The DELPHI event server can be used to pick and reprocss individual events from raw data.
202
205
It supports different modes:
203
206
@@ -220,12 +223,12 @@ where the first one is the full DST output, and the second the short dst one.
220
223
221
224
Note: Running the event server requires access to the DELPHI raw data sets.
222
225
223
-
## Event visualisation:
226
+
## Event visualisation
224
227
After setting up the DELPHI environment you can start the DELPHI event display with
225
228
```
226
229
rungra
227
230
```
228
231
Note that the event display can read only reconstructed data, not raw data. Both full and short DST work.
229
232
230
-
# More examples
233
+
##More examples
231
234
More examples can be found at https://gitlab.cern.ch/delphi/examples.
0 commit comments