Cyclus

The Cyclus fuel cycle simulator is an agent-based and extensible framework for modeling the flow of material through future nuclear fuel cycles. For more information on the entire "ecosystem" please refer to the Cyclus website.

Cyclus Projects Status
Branch	Cyclus	Cycamore	Cymetric
master

Cyclus Core

The core of the Cyclus nuclear fuel cycle simulator from the University of Wisconsin-Madison is intended to be a simulation framework for the development of innovative fuel cycle simulations.

This README is intended primarily for those who intend to contribute to the development of the Cyclus Core. If you are interested Cyclus as a user or in developing Cyclus archetypes, you may want to consult Getting Started with Cyclus.

This README provides basic information about:

the dependencies required by Cyclus
installation of Cyclus from the command line
how to run Cyclus and the Cyclus unit tests

The Cyclus Core contains all the fundamental pieces of the Cyclus framework required to interface with the input file, write the output file, and manage material flow during the simulation via the Dynamic Resource Exchange. It does not contain any fuel cycle facility models. A set of nuclear facilities can be obtained by installing Cycamore, the Cyclus Additional Module. Cycamore is supported by the Cyclus Developer Team.

Third party modules can also be installed (or developed) with additional facilities. Please visit the Cyclus website for a list of contributed modules.

For general information about Cyclus, visit the Cyclus Homepage,
For detailed installation instructions, visit the INSTALLATION Guide,
To see user and developer documentation for this code, please visit the Users Guide,
If you would like to contribute to Cyclus, please check our Contribution Guidelines.

Table of Contents

Cyclus Core

Dependencies

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:

Package	Minimum Version
`CMake`	2.8
`boost`	1.46.1
`libxml2`	2
`libxml++`	2.36
`python`	2.7 or 3.3+
`sqlite3`	3.7.10
`HDF5`	1.8.4
`Coin-Cbc`	2.5

For detailed instructions on installing dependencies, see Installing Dependencies.

Quick Cyclus Installation

The quickest way to install Cyclus and its dependencies relies on using the conda-forge channel and the conda package manager within the Anaconda python environment. The following instructions guide you through that approach. To install Cyclus and its dependencies onto a clean Ubuntu machine (tested on 18.04 LTS):

Download the latest Anaconda installer for Linux at https://www.anaconda.com/distribution/#download-section
Move the .sh to your Home directory
In Terminal, execute the following commands:
bash Anaconda3-2019.03-Linux-x86_64.sh
echo 'export PATH="~/anaconda/bin:$PATH"' >> ~/.bashrc
source .bashrc
conda config --add channels conda-forge
conda install -y openssh gxx_linux-64 gcc_linux-64 cmake make docker-pycreds git xo python-json-logger python=3.6 glibmm glib=2.56 libxml2 libxmlpp libblas libcblas liblapack pkg-config coincbc=2.9 boost-cpp hdf5 sqlite pcre gettext bzip2 xz setuptools nose pytables pandas jinja2 cython==0.26 websockets pprintpp
Use sudo apt install to install and configure git
Clone the Cyclus repository by running git clone https://github.com/cyclus/cyclus.git
Navigate to the folder containing Cyclus
Run the command python install.py

For more detailed installation procedure, and/or custom installation please refer to the INSTALLATION guide.

Running Tests

Installing Cyclus will also install a test driver (i.e., an executable of all of our tests). You can run the tests yourself via:

$ cyclus_unit_tests

Installing Cycamore

As noted previously, the Cyclus Core will not allow you to run fuel cycle simulations as it does not include nuclear facilities. To run fuel cycle simulations, first download Cycamore (GitHub Cyamore Repository):

Clone the Cycamore Repo: git clone https://github.com/cyclus/cycamore.git,
Install in the same location you installed Cyclus (eg. in ~/.local/): python install.py from the cycamore folder.

Running Cyclus

You can find instructions for writing an input file for cyclus from Cyclus User Guide or use sample input files from Cycamore Repo. Assuming you have some file input.xml, you can run Cyclus via:

$ cyclus path/to/input.xml

For a more detailed explanation, check out the Cyclus User Guide.

Contributing

We happily welcome new developers into the Cyclus Developer Team. If you are willing to contribute into Cyclus, please follow this procedure:

Fork Cyclus repository,
Create a working branch on your fork from the develop branch,
Implement your modification of the Cyclus source code,
Submit a Pull request into Cyclus/develop branch,
Wait for reviews/merge (the proposer of a pull request cannot be the Merger).

You may also want to read our Contribution Guidelines.

opotowsky/cyclus