Skip to content
Snippets Groups Projects
README.md 1.56 KiB
Newer Older
Vincent Pollet's avatar
Vincent Pollet committed
![PLIBS_9 logo](doc/logo.png)
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
[![repository](https://img.shields.io/badge/code-repository-purple)](https://gitlab.cta-observatory.org/vincent.pollet/template_cpp)
[![documentation](https://img.shields.io/badge/documentation-main-blue)](http://template-cpp.gitlab-pages.cta-observatory.org/) 
[![pipeline status](https://gitlab.cta-observatory.org/vincent.pollet/template_cpp/badges/main/pipeline.svg)](https://gitlab.cta-observatory.org/vincent.pollet/template_cpp/-/pipelines)
[![coverage report](https://gitlab.cta-observatory.org/vincent.pollet/template_python/badges/main/coverage.svg)](http://template-cpp.gitlab-pages.cta-observatory.org/htmlcov)
Vincent Pollet's avatar
Vincent Pollet committed
### Installation
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
Start by cloning the repository:
```bash
	$ git clone https://gitlab.cta-observatory.org/vincent.pollet/template_cpp.git
	$ cd template_cpp
Vincent Pollet's avatar
Vincent Pollet committed
```

Vincent Pollet's avatar
Vincent Pollet committed
#### Default location
Install the library in your global environment:
```bash
	$ ./install.sh
```
Then **template_cpp** is installed in your $HOME/usr.
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
#### Install in conda environment
If a conda environment is activated when installing the software, it will be installed in the conda environment:
```bash
	$ conda activate your_env # or mamba activate or micromamba activate
	$ ./install.sh
```
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
#### Specify install path
If you prefer a customized install path you can do :
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
```bash
	$ ./install.sh /your/install/path
```
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
#### Specify compilation options
If you prefer a customized install path with custom compilation you can do :
Vincent Pollet's avatar
Vincent Pollet committed

Vincent Pollet's avatar
Vincent Pollet committed
```bash
	$ mkdir -p build
	$ cd build
	$ cmake .. -DCMAKE_INSTALL_PREFIX=/your/install/Path
	$ make -j `nproc`
	$ make install -j `nproc`
```