install_from_git

Installing |Cyclus| Using the GitHub Repository

Installing Cyclus is a two step process. First get and compile the |Cyclus| core, then get and compile the Cyclus Additional Modules (Cycamore), which provides nuclear fuel cycle facilities such the reactor, fuel fabrication facility, storage, etc.

• Dependencies
• Install Cyclus
  • Get the Source Code from the Git Repo
  • Compiling Cyclus
• Install Cycamore
  • Get the Source Code from the Git Repo
  • Compiling Cycamore
• Run the Unit Tests

Dependencies

Instructions on how to install those dependencies on the major platforms can be found :doc:`here <DEPENDENCIES>`.

Install Cyclus

Get the Source Code from the Git Repo

git clone https://github.com/cyclus/cyclus .
git fetch
git checkout master

Compiling Cyclus

If you were successful then Cyclus has been installed and you can skip down to Installing Cycamore!

Alternative instructions are also available for doing a :doc:`Custom Installation <install_custom>`.

Install Cycamore

Get the Source Code from the Git Repo

git clone https://github.com/cyclus/cycamore .
git fetch
git checkout master

Compiling Cycamore

Run the Unit Tests