Skip to content

Commit 72a13b5

Browse files
schwicketiborsimko
authored andcommitted
docs: DELPHI CVMFS guide
Extract CVMFS-related documentation as a dedicated guide and fix some bugs and typos in the DELPHI Getting Started guide.
1 parent b94d7c6 commit 72a13b5

File tree

3 files changed

+75
-34
lines changed

3 files changed

+75
-34
lines changed

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

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This quick start guide is meant as a guide for the very first steps to get going
66
* [Documentation](#documentation)
77
* [Examples](#examples)
88

9-
# <a name="overview"> Overview
9+
# <a name="overview"> Overview</a>
1010

1111
The DELPHI stack consists of the following modules:
1212

@@ -23,44 +23,16 @@ DELPHI data access rules are available [here](/record/417), or from [the DELPHI
2323

2424
Please read these before accessing the DELPHI software and data.
2525

26-
# <a name="access"> Accessing the software stack
26+
# <a name="access"> Accessing the software stack</a>
2727
There are two possible ways to access the software stack.
2828

2929
## Docker
30-
A docker container is available which ships with all the modules installed. Please take a look [here](docs/delpi-guide-docker)
30+
A docker container is available which ships with all the modules installed. Please take a look [here](docs/delphi-guide-docker).
3131

3232
## CVMFS
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.
33+
Binaries are also available from CVMFS, for a variety of different Linux flavors. Please take a look [here](docs/delphi-guide-cvmfs).
3434

35-
This method is convenient if you are running a desktop or a virtual machine with one of the supported Linux flavors on it.
36-
37-
### Requirements
38-
You will need to have:
39-
40-
* /cvmfs/delphi.cern.ch mounted. Documentation can be found at https://cvmfs.readthedocs.io/en/stable/
41-
* /eos/opendata/delphi mounted. Documentation can be found at
42-
* A list of additional packages installed, see https://gitlab.cern.ch/delphi/deployment for more information:
43-
* general: tcsh xfonts-100dpi xfonts-75dpi libxfont2
44-
* compilers: cmake gcc g++ gfortran
45-
* library packages: libx11 libglu1-mesa xutils libmotif r-base xutils libxbae libxaw7 libssl libglew libdlm
46-
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.
48-
49-
### Initialising the environment
50-
For C-Shell (csh, tcsh ), do
51-
```
52-
source /cvmfs/delphi.cern.ch/setup.csh
53-
```
54-
55-
For Bourne shell (sh, bash, zsh, ...), type
56-
```
57-
. /cvmfs/delphi.cern.ch/setup.sh
58-
```
59-
If using the container, please use `/etc/profile.d/delphi.sh` or `/etc/profile.d/delphi.csh` instead.
60-
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`.
62-
63-
# <a name="documentation"> Documentation
35+
# <a name="documentation"> Documentation</a>
6436
DELPHI manuals and notes are available from [https://cds.cern.ch/](http://cds.cern.ch/search?c=DELPHI&sc=1)
6537

6638
Here is a selection for getting started:
@@ -79,10 +51,11 @@ The DELPHI stack is mostly written in Fortran, with some bits written in C. Only
7951

8052
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!
8153

82-
# <a name="examples"> Examples
54+
# <a name="examples"> Examples</a>
8355
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.
8456

8557
In the following, we will
58+
8659
* Create some Monte Carlo events and run simulation, reconstruction and DST production on them
8760
* First, we will show how to do so interactively
8861
* Then, how to do this on the batch farm at CERN
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-cvmfs.md",
5+
"format": "md"
6+
},
7+
"experiment": [
8+
"DELPHI"
9+
],
10+
"short_description": {
11+
"content": "This guide explains you how to run the DELPHI software from CVMFS, if available. Various flavours of the Linux operating systems are supported. This is an alternative to the encapsulated container image which in some cases may be easier and more performant."
12+
},
13+
"slug": "delphi-guide-cvmfs",
14+
"tags": [
15+
"Getting Started"
16+
],
17+
"title": "Running the DELPHI software stack from CVMFS",
18+
"type": {
19+
"primary": "Documentation",
20+
"secondary": [
21+
"Guide"
22+
]
23+
}
24+
}
25+
]
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## Introduction
2+
The DELPHI software is also availabe on CVMFS. Many decent Linux flavors are supported, however, there are no generic binaries available for Windows and MacOS.
3+
If you run on Windows, you can use the Windows for Linux subsystem, using one of the supported systems, for example Ubuntu 22. It is possible to install both CVMFS
4+
and EOS, allowing for direct access to the data.
5+
6+
This method is convenient if you are running a desktop or a virtual machine with one of the supported Linux flavors on it.
7+
8+
Running the stack locally from CVMFS has some advantages, in particular if the EOS storage system is available on the same host:
9+
10+
* No need to copy the data locally and expose them to the container.
11+
* Software development can be done locally, without the risk to loose your work if the container is accidentially destroyed.
12+
* Easy access to hardware accellerated graphics when running on the local desktop. This is only relevant for the event display though.
13+
* No need for podman or docker.
14+
15+
## Requirements
16+
You will need to have:
17+
18+
* /cvmfs/delphi.cern.ch mounted. Documentation can be found at https://cvmfs.readthedocs.io/en/stable/
19+
* /eos/opendata/delphi mounted. More information about EOS can be found at https://github.com/cern-eos/eos
20+
* A list of additional packages installed, see https://gitlab.cern.ch/delphi/deployment for more information:
21+
* general: tcsh xfonts-100dpi xfonts-75dpi libxfont2
22+
* compilers: cmake gcc g++ gfortran
23+
* library packages: libx11 libglu1-mesa xutils libmotif r-base xutils libxbae libxaw7 libssl libglew libdlm
24+
25+
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.
26+
27+
## Initialising the environment
28+
For C-Shell (csh, tcsh ), do
29+
30+
```
31+
source /cvmfs/delphi.cern.ch/setup.csh
32+
```
33+
34+
For Bourne shell (sh, bash, zsh, ...), type
35+
```
36+
. /cvmfs/delphi.cern.ch/setup.sh
37+
```
38+
If using the container, please use `/etc/profile.d/delphi.sh` or `/etc/profile.d/delphi.csh` instead.
39+
40+
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
41+
data sets you want to use locally. It should point to `/eos/opendata/delphi`.
42+
43+

0 commit comments

Comments
 (0)