README.md 3.64 KB
Newer Older
Simon Spannagel's avatar
Simon Spannagel committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
![](doc/logo_small.png)

# Corryvreckan
### The Maelstrom for Your Test Beam Data

[![build status](https://gitlab.cern.ch/simonspa/corryvreckan/badges/master/build.svg)](https://gitlab.cern.ch/simonspa/corryvreckan/commits/master)

## Dependencies
* [ROOT](https://root.cern.ch/building-root) (required, with the GenVector component)

## Installation
The CMake build system is used for compilation and installation. The install directory can be specified by adding `-DCMAKE_INSTALL_PREFIX=<prefix>` as argument to the CMake command below. Other configuration options are explained in the manual.

The dependencies need to be initialized for the build to succeed.

### Compilation
To compile and install a default installation of Corryvreckan, run the following commands

```
$ mkdir build && cd build/
$ cmake ..
$ make install
```

For more detailed installation instructions, please refer to the documentation below.

## Documentation
28
29
The PDF user manual is automatically compiled by the continuous integration and can be [downloaded here](https://gitlab.cern.ch/corryvreckan/corryvreckan/-/jobs/artifacts/master/raw/public/usermanual/corryvreckan-manual.pdf?job=cmp%3Ausermanual).

Simon Spannagel's avatar
Simon Spannagel committed
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
The latest PDF version of the User Manual can be created from source by executing
```
$ make pdf
```
After running the manual is available under `usermanual/corryvreckan-manual.pdf` in the build directory.

To build the HTML version of the latest Doxygen reference, run the following command
```
$ make reference
```
The main page of the reference can then be found at `reference/html/index.html` in the build folder.

## Development of Corryvreckan

Corryvreckan has been developed and is maintained by

* Morag Williams, University of Glasgow/CERN, @williamm
Simon Spannagel's avatar
Simon Spannagel committed
47
* Jens Kroeger, University of Heidelberg/CERN, @jekroege
Jens Kroeger's avatar
Jens Kroeger committed
48
* Daniel Hynds, NIKHEF, @dhynds
Simon Spannagel's avatar
Simon Spannagel committed
49
50
51
52
* Simon Spannagel, CERN, @simonspa

The following authors, in alphabetical order, have contributed to Corryvreckan:

53
* Matthew Daniel Buckland, University of Liverpool, @mbucklan
54
* Dominik Dannheim, CERN, @dannheim
55
* Katharina Dort, University of Giessen/CERN, @kdort
Alexander Ferk's avatar
Alexander Ferk committed
56
* Alexander Ferk, CERN, @aferk
Simon Spannagel's avatar
Simon Spannagel committed
57
* Adrian Fiergolski, CERN, @afiergol
Lennart Huth's avatar
Lennart Huth committed
58
* Lennart Huth, DESY, @lhuth
59
* Magnus Mager, CERN, @mmager
60
61
* Andreas Matthias Nürnberg, KIT, @nurnberg
* Florian Pitters, HEPHY Vienna, @fpipper
62
* Paul Schütze, DESY, @pschutze
63
* Tomas Vanat, CERN, @tvanat
Simon Spannagel's avatar
Simon Spannagel committed
64
65
66
67
68
69
70
71
72
73
74

## Contributing
All types of contributions, being it minor and major, are very welcome. Please refer to our [contribution guidelines](CONTRIBUTING.md) for a description on how to get started.

Before adding changes it is very much recommended to carefully read through the documentation in the User Manual first.

## Licenses
This software is distributed under the terms of the MIT license. A copy of this license can be found in [LICENSE.md](LICENSE.md).

The documentation is distributed under the terms of the CC-BY-4.0 license. This license can be found in [doc/COPYING.md](doc/COPYING.md).

75
76
This project strongly profits from the developments done for the [Allpix Squared project](https://cern.ch/allpix-squared) which is released under the MIT license. Especially the configuration class, the module instantiation logic and the file reader and writer modules have profited heavily by their corresponding framework components in Allpix Squared.

Simon Spannagel's avatar
Simon Spannagel committed
77
The LaTeX and Pandoc CMake modules used by Corryvreckan are licensed under the BSD 3-Clause License.
Simon Spannagel's avatar
Simon Spannagel committed
78
79

The General Broken Lines library for track fitting is distributed under the terms of the GNU General Public License verison 2. The license can be found [here](3rdparty/GeneralBrokenLines/COPYING.LIB), the original source code is available from [here](www.terascale.de/wiki/generalbrokenlines/).