Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cyclus/cyclus

The Cyclus Nuclear Fuel Cycle Simulator
https://github.com/cyclus/cyclus

Last synced: about 2 months ago
JSON representation

The Cyclus Nuclear Fuel Cycle Simulator

Awesome Lists containing this project

README 

        
Cyclus

------

.. image:: https://coveralls.io/repos/github/cyclus/cyclus/badge.svg

  :target: https://coveralls.io/github/cyclus/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           |

+====================+====================+====================+====================+

| ``main``           | |cyclus_main|      | |cycamore_main|    | |cymetric_main|    |

+--------------------+--------------------+--------------------+--------------------+



.. |cyclus_main| image:: https://github.com/cyclus/cyclus/actions/workflows/publish_latest.yml/badge.svg

.. |cycamore_main| image:: https://github.com/cyclus/cycamore/actions/workflows/publish_latest.yml/badge.svg

.. |cymetric_main| image:: https://github.com/cyclus/cymetric/actions/workflows/publish_latest.yml/badge.svg



###########

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 `_.



.. contents:: Table of Contents



************

Dependencies

************



In order to facilitate future compatibility with multiple platforms,

Cyclus is built using ``CMake``. For detailed instructions on Cyclus dependencies (including minimum version requirements), 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 22.04 LTS):



- Download and install Miniconda for Linux



.. code-block:: bash



  mkdir -p ~/miniconda3

  wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh -O ~/miniconda3/miniconda.sh

  bash ~/miniconda3/miniconda.sh -b -u -p ~/miniconda3

  rm -rf ~/miniconda3/miniconda.sh



- Execute the following commands to initialize Miniconda:



.. code-block:: bash



  ~/miniconda3/bin/conda init bash

  source ~/.bashrc



- Create a new environment and install the Cyclus package



.. code-block:: bash



  conda config --add channels conda-forge

  conda create -n cyclus

  conda activate cyclus

  conda install -y cyclus



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:



.. code-block:: bash



    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/``):

  ``python3 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:



.. code-block:: bash



    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 ``main`` branch,



#. Implement your modification of the Cyclus source code,



#. Submit a Pull request into ``Cyclus/main`` branch,



#. Wait for reviews/merge (the proposer of a pull request cannot be the Merger).



You may also want to read our `Contribution Guidelines `_.



.. _`Cyclus Homepage`: http://fuelcycle.org/

.. _`Cyclus User Guide`: http://fuelcycle.org/user/index.html

.. _`Cyclus repo`: https://github.com/cyclus/cyclus

.. _`Cycamore Repo`: https://github.com/cyclus/cycamore

.. _`INSTALL`: INSTALL.rst

.. _`CONTRIBUTING`: CONTRIBUTING.rst