Compiling from source

Note

It is not always necessary to install c2py, as it can be fetched by an application using it as a dependency during its own compilation process, cf CMake integration.

clair

Download the source code of the latest stable version by cloning the clair repository from GitHub:
```
$ git clone https://github.com/flatironinstitute/clair clair.src
```
[Optional] If you want a particular version, check it out, e.g. (use git tag to see the available versions):
```
$ git checkout v0.1
```

Call cmake, including any additional custom CMake options, see below:

$ cmake -B clair.build -S clair.src -DCMAKE_INSTALL_PREFIX=path_to_clair_install_dir

Compile the code, run the tests and install the application (here with 8 cores, change accordingly):
```
$ cd clair.build
$ make -j 8
$ ctest -j 8
$ make -j 8 install
```

c2py

To install c2py, follow the same procedure as for clair, replacing clair by c2py.

Warning

clair and c2py must use the same version.

Download the source code of the latest stable version by cloning the c2py repository from GitHub:
```
$ git clone https://github.com/flatironinstitute/c2py c2py.src
```
[Optional] If you want a particular version, check it out, e.g. (use git tag to see the available versions):
```
$ git checkout v0.1
```

Call cmake, including any additional custom CMake options, see below:

$ cmake -B c2py.build -S c2py.src -DCMAKE_INSTALL_PREFIX=path_to_c2py_install_dir

Compile the code, run the tests and install the application (here with 8 cores, change accordingly):
```
$ cd c2py.build
$ make -j 8
$ ctest -j 8
$ make -j 8 install
```

CMake options

The following CMake-options are available for clair:

cmake ...  -DOPTION1=value1 -DOPTION2=value2

Options	Syntax
Build the documentation	-DBuild_Documentation=ON

Set environment variables

To load the proper paths into your current shell environment use:

$ source path_to_clair_install_dir/share/clair/clairvars.sh
$ source path_to_c2py_install_dir/share/c2py/c2pyvars.sh