Skip to content

Latest commit

 

History

History
214 lines (139 loc) · 6.7 KB

INSTALL.rst

File metadata and controls

214 lines (139 loc) · 6.7 KB
Raw

Cyclus Installation Guide

Cyclus uses the CMake cross-platform build-generator. To simplify the usage of cmake to build Cyclus from source, a python script is provided with the source.

Table of Contents

Dependencies

A full list of the Cyclus package dependencies is listed here.

Installation

Before going further with the installation procedure be sure you have installed all the required dependencies. We have provided detailed instructions for installing those dependencies for the major supported systems.

Default Installation

Run the install script:

python3 install.py

If you successfully followed the instruction above, the cyclus binary has been generated and placed in the ~/.local/ in your home directory. You need to add ~/.local/bin to the front of your $PATH:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

On MacOSX you also need to add ~/.local/lib/pythonX.Y/site-packages to your $PYTHONPATH:

echo "export PYTHONPATH=\"\$HOME/.local/lib/python`python3 -c 'import sys; \
print(".".join(map(str, sys.version_info[:2])))'`/site-packages:\$PYTHONPATH\"" >> ~/.bashrc
source ~/.bashrc

Custom Cyclus Installation

The installation using the install script can be customized using the following flags:

-h, --help show the help message and exit
--build-dir BUILD_DIR where to place the build directory
--uninstall uninstall
--allow-milps build with COIN solvers
--no-update do not update the hash in version.cc
--clean-build attempt to remove the build directory before building
-j THREADS, --threads THREADS the number of threads to use in the make step
--prefix PREFIX the relative path to the installation directory
--config-only only configure the package, do not build or install
--build-only only build the package, do not install
--test run tests after building
--coin-root COIN_ROOT the relative path to the Coin-OR libraries directory
--boost-root BOOST_ROOT the relative path to the Boost libraries directory
--hdf5-root HDF5_ROOT the path to the HDF5 libraries directory
--cmake-prefix-path CMAKE_PREFIX_PATH the cmake prefix path for use with FIND_PACKAGE, FIND_PATH, FIND_PROGRAM, or FIND_LIBRARY macros
--build-type BUILD_TYPE change the CMAKE_BUILD_TYPE
--data-model-version sets the data model version number
--code_coverage Enable code coverage analysis using gcov/lcov
--fast Will try to compile from assembly, if possible (default). This is faster than compiling from source.
--slow Will NOT try to compile from assembly, if possible. This is slower as it must compile from source.
-D VAR set environment variable(s).

For example, if you have installed coin-Cbc from source or otherwise have it installed in a non-standard location, you should make use of the coin_root installation flag. The otherwise identical process would look like:

.../cyclus$  python3 install.py --coin-root=path/to/coin

CMake Cyclus Installation

If you are CMake aficionado you can also install Cyclus without using the install.py python script and use cmake directly, which should look like:

mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=~/.local/
make
make install

As usual you can customize your cmake installation using the proper cmake flag. All cmake variables can be listed using: cmake -LAH. The main variables used are:

COIN_ROOT_DIR set Coin-OT library directory
BOOST_ROOT set Boost libraries directory
HDF5_ROOT set HDF5 root directory
HDF5_LIBRARIES set HDF5 libraries path
HDF5_LIBRARY_DIRS set HDF5 library directory
HDF5_INCLUDE_DIRS set HDF5 include directory

All variables can be set using -DMY_VARIABLE=MY_VARIABLES_VALUE.

Note on Building Cyclus with Conda

If your python libraries are installed using Conda, install cyclus dependencies through conda-forge.

conda config --add channels conda-forge
conda install cyclus --only-deps

Running Tests

Installing Cyclus will also install a test driver (i.e., an executable of all of our tests). We strongly recommend after a fresh install of Cyclus, or after any modification on the source code, to rerun those tests in order to insure the proper functioning of Cyclus. You can run the tests yourself via:

$ cyclus_unit_tests