Getting and Building Cyclus From Source


In the cyclus ecosystem, only versions whose micro or patch number (the third and last number) are zero are considered stable. Other releases where the version number is greater than zero are bugfix and maintainence releases and are considered unstable. For example, a release number of 1.42.0 is stable, while 1.42.3 is unstable.

The Cyclus Library Suite

The Cyclus ecosystem is composed of two projects:

  • Cyclus Core, comprising core kernel functionality
  • Cycamore, a physics and other domain module repository

Installation information is provided in the README of each repository, and the core must be installed before Cycamore. Accordingly, installation steps are as follows:

  1. Visit the Cyclus repo and follow the installation instructions on the main page (README.rst)
  2. Visit the Cycamore readme and follow the installation instructions on the main page (README.rst)

Supported Systems

Currently, two specific systems are supported:

  • Linux 64-bit (Ubuntu 12+ recommended)
  • MacOSX 8 64-bit

Unfamiliar with git and Github?

For the git uninitiated, one must perform the following steps to acquire Cyclus:

  1. Set Up git shows one how to set up SSH keys and git user info
  2. Fork the Cyclus repository, as shown in Fork A Repo

Note that each Cyclus repository has two branches:

  • master – the latest stable release of the library
  • develop – the latest working copy that passes all tests

The above branches are synchronized with each other, and should be used in tandem (i.e., use master (Cyclus) with master (Cycamore) or develop with develop only).

Help with git and GitHub

If you are unfamiliar with git, here are some resources:

If you are unfamiliar with GitHub, here are some resources:

  • Github Help
  • To have your changes integrated into the cyclus/cyclus project, you must submit a GitHub Pull Request. Visit Send pull requests to learn more.

Contact Us

If you have further comments or questions about the build process, please don’t hesitate to email or join the Cyclus users list, which will allow you to contact the community of users and developers of Cyclus.