Skip to content

Commit 1ebb036

Browse files
schwicketiborsimko
authored andcommitted
docs: DELPHI event display guide
Reshuffle the DELPHI guide on using Docker to extract event display documentation into a separate guide.
1 parent 54a9318 commit 1ebb036

File tree

4 files changed

+82
-20
lines changed

4 files changed

+82
-20
lines changed

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,10 +213,14 @@ Note: Running the event server requires access to the DELPHI raw data sets.
213213

214214
## <a name="delgra">Event visualisation</a>
215215
After setting up the DELPHI environment you can start the DELPHI event display with
216+
216217
```
218+
cd
217219
rungra
218220
```
219-
Note that the event display can read only reconstructed data, not raw data. Both full and short DST work.
221+
222+
For convenience, copy the files you want to scan to ~/graexe/data.
223+
Please take a look at the [DELGRA guide](delphi-guide-delgra) on how to proceed.
220224

221225
## <a name="more">More examples</a>
222226
More examples can be found at https://gitlab.cern.ch/delphi/examples.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[
2+
{
3+
"body": {
4+
"content": "delphi-guide-delgra.md",
5+
"format": "md"
6+
},
7+
"experiment": [
8+
"DELPHI"
9+
],
10+
"short_description": {
11+
"content": "This guide explains you how to start up the DELPHI event display, called DELGRA. For further information on the usage, please refer to the manual."
12+
},
13+
"slug": "delphi-guide-delgra",
14+
"tags": [
15+
"Getting Started"
16+
],
17+
"title": "Running the DELPHI event display",
18+
"type": {
19+
"primary": "Documentation",
20+
"secondary": [
21+
"Guide"
22+
]
23+
}
24+
}
25+
]
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## Introduction
2+
The DELPHI event display, also known as 'DELGRA', is used to visualise reconstructed events. This document gives a brief introduction
3+
on how to start up the display.
4+
5+
Important note: The event display only works on reconstructed data, not on raw data.
6+
7+
## Directory structure
8+
DELGRA expects to see a folder called graexe in your home directory, with 4 subfolders in it. These are called `data`, `hcopy`, `macro`, `run`.
9+
In case it does not find the graexe folder, it will try to create them. They have the following meaning
10+
11+
* graexe/data: Default folder for reconstructed date files which are to be scanned.
12+
* graexe/hcopy: DELGRA allows to print the current view into a file. This is where the output of these screenshots will go.
13+
* graexe/macro: Folder for macros.
14+
* graexe/run: This folder contains log files from running the program. Consult it in case the program does not work correctly or crashed.
15+
16+
## Starting the event display
17+
18+
Start the event display from a shell from your home directory:
19+
20+
```
21+
cd
22+
rungra
23+
```
24+
25+
It should start up showing an hour glass, and a welcome box, like this:
26+
27+
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_1.png" width="60%"></center></p>
28+
29+
After pressing on OK in the welcome box, the program will bring up the file dialog where you can select the folder and the file to be read in:
30+
31+
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_2.png" width="60%"></center></p>
32+
33+
Change into the ~/graexe/data folder and select a suitable file.
34+
In the screenshot here, there is a file called `simana.sdst`. This is a short DST file of simulated data, so can be selected for viewing.
35+
Select it and press `Ok` in that dialog.
36+
37+
Next, the event display will ask for the `event number` in this `run` to be read:
38+
39+
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_3.png" width="60%"></center></p>
40+
41+
Just press OK or return to start reading the first event.
42+
43+
You will see the first event, can rotate it, zoom in, and analyze it, or you can skip to the next event, going through them one by one. Here's a screen shot of event number 5, viewed at a slightly different angle:
44+
45+
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_4.png" width="60%"></center></p>
46+
47+
Note that due to possibly different random number seeds, the sequence may look different for you.
48+
49+
## Event display manual
50+
51+
The event display manual can be found [here](/record/80503)

cernopendata/modules/fixtures/data/docs/delphi-guide-docker/delphi-guide-docker.md

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -77,22 +77,4 @@ cd
7777
rungra
7878
```
7979

80-
It should start up showing an hour glass, and a welcome box, like this:
81-
82-
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_1.png" width="60%"></center></p>
83-
84-
After pressing on OK in the welcome box, the program will bring up the file dialog where you can select the folder and the file to be read in:
85-
86-
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_2.png" width="60%"></center></p>
87-
88-
Switch to ~/graexe/data and select the simana.sdst file which we just copied there, and press Ok in that dialog. Next, it will ask for the number of event in this run to be read:
89-
90-
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_3.png" width="60%"></center></p>
91-
92-
Just press OK to start reading the first event from the run, or press return.
93-
94-
You will see the first event, can rotate it, zoom in, and analyze it, or you can skip to the next event, going through them one by one. Here's a screen shot of event number 5, viewed at a slightly different angle:
95-
96-
<p><center><img src="/static/docs/delphi-guide-docker/delgra_startup_4.png" width="60%"></center></p>
97-
98-
Note that due to possibly different random number seeds, the sequence may look different for you.
80+
Please take a look at the [DELGRA guide](delphi-guide-delgra) on how to proceed.

0 commit comments

Comments
 (0)