Skip to content

Commit 6b64ae4

Browse files
committed
docs: expand DEPLHI getting started guide
1 parent 5ea8a6d commit 6b64ae4

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

cernopendata/modules/fixtures/data/docs/delphi-getting-started/delphi-getting-started.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
FIXME: Introduce table of contents
2-
3-
# Introduction
1+
# Table of contents
42
This quick start guide is meant as a guide for the very first steps to get going with DELPHI software and data access.
53

6-
## Overview
4+
* [Overview and requirements](#overview)
5+
* [Accessing the software stack](#access)
6+
* [Documentation](#documentation)
7+
* [Examples](#examples)
8+
9+
# <a name="overview"> Overview
710

811
The DELPHI stack consists of the following modules:
912

@@ -20,18 +23,18 @@ DELPHI data access rules are available [here](/record/417), or from [the DELPHI
2023

2124
Please read these before accessing the DELPHI software and data.
2225

23-
## Accessing the software stack
26+
# <a name="access"> Accessing the software stack
2427
There are two possible ways to access the software stack.
2528

26-
### Docker
29+
## Docker
2730
A docker container is available which ships with all the modules installed. Please take a look [here](docs/delpi-guide-docker)
2831

29-
### CVMFS
32+
## CVMFS
3033
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.
3134

3235
This method is convenient if you are running a desktop or a virtual machine with one of the supported Linux flavors on it.
3336

34-
#### Requirements
37+
### Requirements
3538
You will need to have:
3639

3740
* /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:
4346

4447
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.
4548

46-
#### Initialising the environment:
49+
### Initialising the environment
4750
For C-Shell (csh, tcsh ), do
4851
```
4952
source /cvmfs/delphi.cern.ch/setup.csh
@@ -53,11 +56,11 @@ For Bourne shell (sh, bash, zsh, ...), type
5356
```
5457
. /cvmfs/delphi.cern.ch/setup.sh
5558
```
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.
5760

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`.
5962

60-
## Documentation
63+
# <a name="documentation"> Documentation
6164
DELPHI manuals and notes are available from [https://cds.cern.ch/](http://cds.cern.ch/search?c=DELPHI&sc=1)
6265

6366
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
7679

7780
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!
7881

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+
# <a name="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.
8184

8285
In the following, we will
8386
* Create some Monte Carlo events and run simulation, reconstruction and DST production on them
@@ -197,7 +200,7 @@ FAT = short94_c2
197200
```
198201
to read 94 C2 data. It will automatically resolve the data files and loop over all of them.
199202

200-
# Raw data access
203+
## Raw data access
201204
The DELPHI event server can be used to pick and reprocss individual events from raw data.
202205
It supports different modes:
203206

@@ -220,12 +223,12 @@ where the first one is the full DST output, and the second the short dst one.
220223

221224
Note: Running the event server requires access to the DELPHI raw data sets.
222225

223-
## Event visualisation:
226+
## Event visualisation
224227
After setting up the DELPHI environment you can start the DELPHI event display with
225228
```
226229
rungra
227230
```
228231
Note that the event display can read only reconstructed data, not raw data. Both full and short DST work.
229232

230-
# More examples
233+
## More examples
231234
More examples can be found at https://gitlab.cern.ch/delphi/examples.

0 commit comments

Comments
 (0)