docs: DELPHI Getting started guide table of contents

Author: schwicke

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

@@ -2,9 +2,24 @@
 This quick start guide is meant as a guide for the very first steps to get going with DELPHI software and data access.
 
 * [Overview and requirements](#overview)
+    * [Before you start](#before)
 * [Accessing the software stack](#access)
+    * [Docker](#docker)
+    * [CVMFS](#cvmfs)
 * [Documentation](#documentation)
+    * [Source code](#sources)
+    * [Compilers](#compilers)
+    * [Getting help](#help)
 * [Examples](#examples)
+    * [About simulation](#simulation)
+    * [Creating MonteCarlo interactively](#simulinter)
+        * [Using internal generators](#internalgen)
+        * [Using external generators](#externalgen)
+    * [Running an analysis job on the result](#anajobinter)
+    * [Using nicknames](#nicknames)
+    * [Raw data access](#rawdata)
+    * [Event visualisation](#delgra)
+    * [More examples](#more)
 
 # <a name="overview"> Overview</a>
 
@@ -15,7 +30,7 @@ The DELPHI stack consists of the following modules:
 * Event reconstruction from raw data, using the DELPHI event server.
 * The graphical DELPHI Event display, also referred to as [delgra](/record/80503).
 
-## Before you start ...
+## <a name="before"> Before you start ... </a>
 
 Please read and accept the data access rules.
 
@@ -26,11 +41,11 @@ Please read these before accessing the DELPHI software and data.
 # <a name="access"> Accessing the software stack</a>
 There are two possible ways to access the software stack.
 
-## Docker
-A docker container is available which ships with all the modules installed. Please take a look [here](docs/delphi-guide-docker).
+## <a name="docker"> Docker</a>
+A docker container is available which ships with all the modules installed. Please take a look [here](/docs/delphi-guide-docker).
 
-## CVMFS
-Binaries are also available from CVMFS, for a variety of different Linux flavors. Please take a look [here](docs/delphi-guide-cvmfs).
+## <a name="cvmfs"> CVMFS</a>
+Binaries are also available from CVMFS, for a variety of different Linux flavors. Please take a look [here](/docs/delphi-guide-cvmfs).
 
 # <a name="documentation"> Documentation</a>
 DELPHI manuals and notes are available from [https://cds.cern.ch/](http://cds.cern.ch/search?c=DELPHI&sc=1)
@@ -41,17 +56,17 @@ Here is a selection for getting started:
 * [Event display](/record/80503)
 * [DST contents](/record/80504)
 
-## Source code
+## <a name="sources">Source code</a>
 The sources are available on https://gitlab.cern.ch/delphi. Some modules still requires CERN authentication. The plan is to release the software in the near future.
 
-## Compilers
+## <a name="compilers">Compilers</a>
 The DELPHI stack is mostly written in Fortran, with some bits written in C. Only gfortran and GNU gcc are supported. We use the gfortran version which comes with the supported operating system.
 
-## Getting help
+## <a name="help">Getting help</a>
 
 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!
 
-# <a name="examples"> Examples</a>
+# <a name="examples">Examples</a>
 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.
 
 In the following, we will
@@ -61,15 +76,15 @@ In the following, we will
     * Then, how to do this on the batch farm at CERN
 * Show how to read the result from an analysis job
 
-## About simulation
+## <a name="simulation"> About simulation</a>
 Simulation is reconstruction code is supported for all the years 1992 and later. The code differs a bit for each of the years.
 
  * The DELPHI simulation code comes with a few build-in generators. Typically, generators are run externally though.
  * The script *runsim* is used to do the detector simulation, reconstruction and short DST creation steps. Use -gext to process an external file from some generator.
 
-## Creating Monte Carlo samples interactively
+## <a name="simulinter"> Creating Monte Carlo samples interactively</a>
 
-### Using internal generators
+### <a name="internalgen">Using internal generators</a>
 For creating a few events with a build-in generator run
 ```
 runsim -VERSION va0u -LABO CERN -NRUN 1000 -EBEAM 45.625 -igen qqps -NEVMAX 10
@@ -93,7 +108,7 @@ Created files:
 
 In principle, analysis code can be run as well on the full DST output, however, this requires that a bunch of modules and fixes have to be rerun on top of the data, before they can be used.
 
-### Using external generators
+### <a name="externalgen">Using external generators</a>
 In this case the generator is run externally and the output is written to a file in a specific format. This can then
 be passed through the detector simulation with
 ```
@@ -103,7 +118,7 @@ Old executables for generators can be found in /cvmfs/delphi.cern.ch/mc-producti
 
 A source code example of DELPHI tuned Pythia can be found in the example tree.
 
-## Running an analysis job on the result
+## <a name="anajobinter">Running an analysis job on the result</a>
 The following script can be run interactively or submitted to a batch farm with DELPHI setup
 
 ```
@@ -162,7 +177,7 @@ This simple script will:
 * create a data input fiel which would read **simana.xsdst** from the local folder where the executable will be started
 * run the job
 
-## Using nicknames
+## <a name="nicknames">Using nicknames</a>
 DELPHI data is organised in data sets which are identified via a nickname. When using opendata, each nickname comes with a corresponding DOI which you can quote.
 
 To analyse data, use the nicknames which you can find at http://delphiwww.cern.ch/offline/data/castor/html.
@@ -173,7 +188,7 @@ FAT = short94_c2
 ```
 to read 94 C2 data. It will automatically resolve the data files and loop over all of them.
 
-## Raw data access
+## <a name="rawdata">Raw data access</a>
 The DELPHI event server can be used to pick and reprocss individual events from raw data.
 It supports different modes:
 
@@ -196,12 +211,12 @@ where the first one is the full DST output, and the second the short dst one.
 
 Note: Running the event server requires access to the DELPHI raw data sets.
 
-## Event visualisation
+## <a name="delgra">Event visualisation</a>
 After setting up the DELPHI environment you can start the DELPHI event display with
 ```
 rungra
 ```
 Note that the event display can read only reconstructed data, not raw data. Both full and short DST work.
 
-## More examples
+## <a name="more">More examples</a>
 More examples can be found at https://gitlab.cern.ch/delphi/examples.