Skip to content

Latest commit

 

History

History
58 lines (39 loc) · 2.4 KB

installation-guide.md

File metadata and controls

58 lines (39 loc) · 2.4 KB
Raw

Installing SI

The default installation location for SI is /usr/local/lib/si. SI can be installed using raw cmake, cpack (cmakes package mechanism), or as a conan.io package provided from conan center.

Installing using cmake

To install using cmake, clone the repository and execute the following commands from within the cloned folder.

mkdir build && cd build
cmake ..
cmake --build . --config Release --target install -- -j $(nproc)

Consider running the build/install command with setting the install prefix, if you do not want to install SI system wide

-DCMAKE_INSTALL_PREFIX:PATH=${HOME}/SI-install

The folder test/installation-tests contains standalone sample programs to check for successful installation.

Installing using cpack

To install using cpack, clone the repository and execute the following commands from within the cloned folder.

mkdir build && cd build
cmake ..
cmake --build . --config Release --target package -- -j $(nproc)

This creates gzipped archives containing all files as well as an installation script SI-<version>-<platform>.sh.

cd build
mkdir ${HOME}/SI-install
./SI-1.0.1-Linux.sh --prefix=$HOME/SI-install --skip-license --exclude-subdir

Installation using conan.io

SI is available at conan-center. As per convention of ConanCenter the package name is si (lower case).

Use the following in your conanfile.txt

[requires]
si/[>1.0 <2.0]@SI/stable

SI/stable are release builds and are considered usable. Use SI/unstable to get the latest development builds. See the official conan documentation on how to integrate the package into your cmake project.

Using as a subdirectory (not installing at all)

Although not the preferred way, SI can be included in any cmake project by putting it into a directory and including it with add_subdirectory(). Depending on the project setup this means that SI should not be installed on its own. Setting the option SI_INSTALL_LIBRARY=OFF will prevent SI from installing any files although the preferred method is using add_subdirectory(path/to/SI ${PROJECT_BINARY_DIR}/SI-build EXCLUDE_FROM_ALL).

If using as a subdirectory with EXCLUDE_FROM_ALL the SI testing has to be disabled by setting SI_BUILD_TESTING=OFF in cmake.