Skip to content
Snippets Groups Projects
Commit 0560a7e3 authored by Sylvester Joosten's avatar Sylvester Joosten
Browse files

updated readme

parent be3a12ab
Branches
No related tags found
No related merge requests found
...@@ -17,24 +17,24 @@ Note: the following instructions are given assuming you are using `bash` as your ...@@ -17,24 +17,24 @@ Note: the following instructions are given assuming you are using `bash` as your
```bash ```bash
export PREFIX="/path/to/your/prefix"; mkdir -p $PREFIX export PREFIX="/path/to/your/prefix"; mkdir -p $PREFIX
``` ```
## Install all necessary dependencies ## Set the repository
Ensure you have `cmake`, ROOT, a modern c++ compiler (gcc4.8+ or clang3.5+) and `gfortran` installed
### nanocernlib
You will need to install a the necessary cernlib routines through the `nanocernlib` library.
```bash ```bash
mkdir -p ${PREFIX}/src && cd ${PREFIX}/src export REPO="<enter the git repository here>"
git clone https://gitlab.com/tmdmc/nanocernlib.git
mkdir -p nanocernlib/BUILD && cd nanocernlib/BUILD
cmake .. -DCMAKE_INSTALL_PREFIX=${PREFIX} -DCMAKE_PREFIX_PATH=${PREFIX}
make -j4
make install
``` ```
## Install all necessary dependencies
Ensure you have
- `cmake`
- ROOT
- the Boost C++ libraries
- a modern c++ compiler (gcc4.8+ or clang3.5+)
- `gfortran`
## Build and install pythia6m ## Build and install pythia6m
Once you have all dependencies installed, you are ready to build pythia6m Once you have all dependencies installed, you are ready to build pythia6m
```bash ```bash
mkdir -p ${PREFIX}/src && cd ${PREFIX}/src mkdir -p ${PREFIX}/src && cd ${PREFIX}/src
git clone https://gitlab.com/tmdmc/pythia6m.git git clone ${REPO}
mkdir -p pythia6m/BUILD && cd pythia6m/BUILD mkdir -p pythia6m/BUILD && cd pythia6m/BUILD
cmake .. -DCMAKE_INSTALL_PREFIX=${PREFIX} -DCMAKE_PREFIX_PATH=${PREFIX} cmake .. -DCMAKE_INSTALL_PREFIX=${PREFIX} -DCMAKE_PREFIX_PATH=${PREFIX}
make -j4 make -j4
...@@ -57,11 +57,16 @@ You can view the command line options by running ...@@ -57,11 +57,16 @@ You can view the command line options by running
pythia6m -h pythia6m -h
``` ```
It requires the following arguments: It requires the following arguments:
- `--conf`: a configuration file, see `$PREFIX/src/pythia6m/program/example-config.json` for an example. - `--conf`: a configuration file, see `$PREFIX/share/pythia6m/example-config.json` for an example.
- `--run`: a run number. This is also used as the random seed for this run - `--run`: a run number. This is also used as the random seed for this run
- `--events`: the number of events to be generated - `--events`: the number of events to be generated
- `--out`: the output directory. This is where the output files will be placed - `--out`: the output directory. This is where the output files will be placed
## Advanced
Instead of running the main executable, you can make your own program in C++ using program/pythia6m.cc as example.
If you do this, you can use `cmake` to directly link to the pythia librariers.
Alternatively, you could also modify the main program directly (located in the program/pythia6m.cc source file). This latter option is only recommended for quick studies.
## Output ## Output
The generated events are written to a ROOT TTree. The following variables are written to the tree for each of the generated events: The generated events are written to a ROOT TTree. The following variables are written to the tree for each of the generated events:
```c++ ```c++
...@@ -102,4 +107,4 @@ double y; // Generated y ...@@ -102,4 +107,4 @@ double y; // Generated y
double W2; // Generated W2 double W2; // Generated W2
int32_t scat_index; // the C-index of the scattered (NOT THE FORTRAN INDEX) int32_t scat_index; // the C-index of the scattered (NOT THE FORTRAN INDEX)
// of the scattered lepton // of the scattered lepton
``` ```
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment