Installing Cyclus with Binaries

Cyclus supports two binary installation options:

  1. Conda (Linux and Mac OSX)

  2. Debian package manager (Linux only)

Conda is a cross-platform, user-space package manager aimed at simplifying the installation of open source software. The Cyclus project uses Conda to distribute pre-built Cyclus and Cycamore binaries.

The Debian package manager simplifies the installation of open-source software. It contains all of the files required to use specific software, as well as variety of relevant information: maintainer, description, version, dependencies (other software or libraries required to use it). The Cyclus team provides pre-built Cyclus and Cycamore Debian packages to simplify installation for the user. These packages are available for LTS Ubuntu version 20.04 and 22.04 (though they may also work on other Linux systems).

Conda

  1. If you don’t have Conda, start by installing the Python 3.x version of Anaconda (or miniconda for a more lightweight choice) to prepare it for Cyclus.

  2. Once you have conda installed, installing Cyclus and Cycamore is straightforward. If you are having issues with certificate verification you may install using the second set of commands to fix these issues.

    $ conda install -c conda-forge cycamore
    
    $ conda config --set ssl_verify false
    $ conda install -c conda-forge cycamore
    

To ensure the proper installation of Cyclus and Cycamore, you can run the Cyclus and Cycamore unit tests, they should report that all tests have passed (or been disabled):

$ cyclus_unit_tests
$ cycamore_unit_tests

Debian Package Manager

This installation procedure assumes that you are using Ubuntu (LTS) 20.04 or 22.04. This method has only been tested on those Ubuntu versions. This installation procedure also assumes that you have root access to you computer.

  1. Install Cyclus dependencies:

    $ sudo apt-get install libtcmalloc-minimal4 libboost-filesystem-dev libboost-program-options-dev libboost-serialization-dev libhdf5-dev libxml++2.6-dev coinor-libcbc-dev
    

    WARNING: This dependency list is ONLY correct for the debian binary installation, additional dependencies are required to install from source. If you need/want more information about dependency installation please read the dependency installation documentation.

  2. Download the latest version Cyclus Core Debian installation package (previous versions located here):

    Ubuntu 20.04

    Standard install

    Ubuntu 22.04

    Standard install

  3. Install the package by running:

    $ sudo dpkg -i cyclus-x.x.x-Linux.deb
    

At this point Cyclus should be successfully installed on your system and you are ready to install Cycamore.

  1. Download the latest Cycamore Debian installation package here. Previous/different versions are also available.

  2. Install the package by running:

    $ sudo dpkg -i cycamore-x.x.x-Linux.deb
    
  3. To ensure the proper installation of Cyclus and Cycamore, you can run the Cyclus and Cycamore unit tests, they should report that all tests have passed (or been disabled):

    $ cyclus_unit_tests
    $ cycamore_unit_tests
    

Happy simulating!