1
0
Fork 0
mirror of https://github.com/gwm17/catima.git synced 2024-11-23 02:38:51 -05:00
catima/docs/README.md
2019-10-22 20:59:21 +02:00

43 lines
1.7 KiB
Markdown

Installation
------------
CMake is used to build the library. For default build use:
```
> mkdir build
> cd build
> cmake ../
> make
```
after the compilation the libraries and headers must be either installed system-wide by make install or PATH and LD_LIBRARY_PATH must be adjusted to point to headers and library files.
The default install path can be change, ie: cmake -DCMAKE_INSTALL_PREFIX=/opt/catima
Alternative to the system-wide installation is to adjust library path and include paths.
This can be done sourcing the init.sh file, which is generated in the build directory:
```
source init.sh
```
cmake options
-------------
compile options, enable or disable with cmake:
> cmake ../ -D[OPTION]
available options:
* BUILD_SHARED_LIBS - if ON shared library is build, otherwise static
* PYTHON_MODULE - enable/disable building of the python bindigs, pybind11 is required to build the catima python module, default OFF
* APPS - build command line app, default ON
* TESTS - build tests, default OFF
* EXAMPLES - build examples, default OFF
* DOCS - prepare doxygen documentation (after cmake, __make docs__ needs to be executed)
* GENERATE_DATA - makes program to re-generate precalculated tables (ie precalculated LS coefficients), default:OFF
* THIN_TARGET_APPROXIMATION - compile the library with thin target approximation, default: ON
* GSL_INTEGRATION - use GSL integration functions, otherwise use built-in integrator, default: OFF
* GLOBAL - compile with GLOBAL code (source not included at the moment, needs to be manually added to __global__ directory, default:OFF)
* STORE_SPLINES - store splines in cache, if disabled datapoints are stored and splines are recreated, default ON
ie:
> cmake -DPYTHON_MODULE=ON -DEXAMPLES=ON ../