README.md 2.04 KB
Newer Older
Pierre Aubert's avatar
Pierre Aubert committed
1 2
![PLIBS_9 logo](doc/logo.png)

3 4 5
----
[![pipeline status](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator/badges/master/pipeline.svg)](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator/-/commits/master)
[![coverage report](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator/badges/master/coverage.svg)](https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator/-/commits/master)
Pierre Aubert's avatar
Pierre Aubert committed
6

7 8
# Code

Pierre Aubert's avatar
Pierre Aubert committed
9
https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator
Pierre Aubert's avatar
Pierre Aubert committed
10

11 12
# Documentation

Pierre Aubert's avatar
Pierre Aubert committed
13
https://cta-lapp.pages.in2p3.fr//PHOENIX_LIBS/PhoenixFileGenerator/
Pierre Aubert's avatar
Pierre Aubert committed
14

15
# Requirements
Pierre Aubert's avatar
Pierre Aubert committed
16

17
- c++ compiler (tested with gcc 5,6,7,8,9,10 and clang 9,10)
Pierre Aubert's avatar
Pierre Aubert committed
18 19 20
- cmake > 3
- make

21 22 23 24
# Installation for Users

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator.git
Pierre Aubert's avatar
Pierre Aubert committed
25 26
	$ cd PhoenixFileGenerator
	$ ./install.sh
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
```

Then **PhoenixFileGenerator** is installed in your $HOME/usr.


If you prefer a customized install path you can do :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator.git
	$ cd PhoenixFileGenerator
	$ ./install.sh /your/install/path
```

If you prefer a customized install path with custom compilation you can do :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator.git
	$ cd PhoenixFileGenerator
	$ mkdir -p build
	$ cd build
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/your/install/Path
	$ make -j `nproc`
	$ make install -j `nproc`
```

The **nproc** gives the number of cores of the computer. If you want a build on one core you can just type :

```sh
	$ make
	$ make install
```


# Update PhoenixFileGenerator

If you want to update the software :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator.git
	$ cd PhoenixFileGenerator
	$ ./update.sh
```

If you want to update the software with a custom install path :

```sh
	$ git clone https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixFileGenerator.git
	$ cd PhoenixFileGenerator
	$ ./update.sh /your/install/path
```
Pierre Aubert's avatar
Pierre Aubert committed
77