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.
In order to facilitate future compatibility with multiple platforms,
Cyclus is built using
CMake. A full list of the Cyclus package
dependencies is shown below:
||2.7 or 3.3+|
Instructions on how to install those dependencies on the major platforms can be found here.
git clone https://github.com/cyclus/cyclus . git fetch git checkout master
Before going further with the installation procedure be sure you have installed all the required dependencies listed above. We have provided detailed instructions for installing dependencies for the major supported systems.
Run the install script:
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
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
echo "export PYTHONPATH=\"\$HOME/.local/lib/python`python -c 'import sys; \ print(".".join(map(str, sys.version_info[:2])))'`/site-packages:\$PYTHONPATH\"" >> ~/.bashrc source ~/.bashrc
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 Custom Installation.
git clone https://github.com/cyclus/cycamore . git fetch git checkout master
Before going further with the installation procedure, be sure you have installed Cyclus.