Skip to content

Latest commit

 

History

History
164 lines (108 loc) · 5.58 KB

INSTALL.md

File metadata and controls

164 lines (108 loc) · 5.58 KB
Raw

Installation

The installation process is based on CMake (version >3.9 required). To handle dependencies and for simple usage in other projects, the package manager conan (version >1.33 required) can be used additionally. If you are only interested to use PROPOSAL in python, you can install PROPOSAL using pip.

All different installation approaches are going to be explained in the following.

For more detailed information about the specific building tools, see the listed documentations:

Building using conan (recommended for C++ users)

For this installation approach, all dependencies will be fetched by conan, meaning that you don't have to install them by yourself. If you have not installed conan yet, you can do so, for example:

$ pip install "conan~=2.0"

Clone the repository and create a build directory

$ git clone https://github.com/tudo-astroparticlephysics/PROPOSAL.git
$ cd PROPOSAL

To prepare all dependencies, build PROPOSAL, and install PROPOSAL, simply use the command

$ conan install . --build=missing -o with_python=True	# other options

The following options can be passed to conan build:

Option. default Description
with_python False Build and install python interface.
with_testing False Build TestFiles for Python.
with_documentation False Build doxygen documentation of C++ code (WIP)

Next, call CMake, using the toolchain file created by conan:

$ cd build
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake

Now make and install PROPOSAL

$ cmake --build . -j4
$ cmake --install .

Per default, CMake installs PROPOSAL to /usr/local. To change this, specify the install directory when calling CMake, for example cmake .. -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake -DCMAKE_INSTALL_PREFIX=/path/to/dir.

Note: As an alternative, you may create a local conan package and use it in your project. See the conan documentation for more information.

Building using pip (recommended for Python users)

If you only want to use PROPOSAL in Python, the easiest way is to use pip:

$ pip install proposal

This will install the most recent version of PROPOSAL. See the pip documentation for more information.

Building using CMake (recommended for advanced users)

If you want to provide all dependencies by your own, you can skip conan and only use CMake. In this case, you need to provide the following dependencies for CMake:

Clone the repository and create a build directory

$ git clone https://github.com/tudo-astroparticlephysics/PROPOSAL.git
$ cd PROPOSAL && mkdir build && cd build

Use CMake and make to build and install PROPOSAL. We recommend building PROPOSAL in Release since performance will be better by several orders of magnitude:

$ cmake .. -DCMAKE_BUILD_TYPE=Release	# or other CMake options
$ make -j
# sudo make install

There are several CMake options you may pass:

Option. default Description
BUILD_PYTHON OFF Build and install python interface.
BUILD_TESTING OFF Build TestFiles for Python.
BUILD_DOCUMENTATION OFF Build doxygen documentation of C++ code (WIP)

Minimal working example

If you have installed PROPOSAL at a relocatable place, linking against it should be straight forward.

Create a simple Cmake file called CMakeLists.txt, which searches for the target PROPOSAL and link your executable against it.

CMAKE_MINIMUM_REQUIRED(VERSION 3.9)

PROJECT(PROPOSAL_test)

find_package(PROPOSAL REQUIRED)

add_executable(test test.cpp)
target_link_libraries(test PROPOSAL::PROPOSAL)

Run CMake and build the executable.

$ cmake -B build .
$ make -C build 
$ ./build/bin/test

Hopefully everything has been built correctly and your program will be executed. Otherwise, create an issue with the corresponding error code.

Enjoy!

FAQ:

This section provides help for common problems during installation.

I am experiencing linker errors when importing proposal in python or when trying to link PROPOSAL.

If you have installed PROPOSAL using conan, check your conan profile for the compiler.libcxx setting, for example with

$ cat .conan/profiles/default`

if you are using the default conan profile. This should be set to libstdc++11. If not, you can change this setting with

$ conan profile update settings.compiler.libcxx=libstdc++11 default

before installing for your default profile.