Skip to content

Latest commit

 

History

History
196 lines (126 loc) · 5 KB

INSTALL.rst

File metadata and controls

196 lines (126 loc) · 5 KB

Recycle Installation Guide

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

Recycle's only dependency is the Cyclus Core.

Package Minimum Version
Cyclus 1.4

There are a number of ways to install the Cyclus core:

Before going further with the installation procedure, be sure you have installed Cyclus.

Run the install script:

python install.py

If you successfully followed the instructions above, then the Recycle library has been generated and placed in .local/ in your home directory.

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

-h, --help show this help message and exit
--build_dir BUILD_DIR where to place the build directory
--uninstall uninstall
--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
--allow-milps Allows mixed integer linear programs by default
--dont-allow-milps Don't Allows mixed integer linear programs by default
--deps-root DEPS_ROOT, --deps_root DEPS_ROOT the path to the directory containing all dependencies
--coin-root COIN_ROOT, --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
--cyclus-root CYCLUS_ROOT, --cyclus_root CYCLUS_ROOT the relative path to Cyclus installation 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, --build_type BUILD_TYPE the CMAKE_BUILD_TYPE
-D VAR Set enviornment 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 coinRoot installation flag. The otherwise identical process would look like:

.../recycle$  python install.py --coin_root=path/to/coin

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

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

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 liraries 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.

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

$ recycle_unit_tests