Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.54 KB

README.md

File metadata and controls

36 lines (26 loc) · 1.54 KB

ROLLO (Reactor evOLutionary aLgorithm Optimizer)

PyPI version CI

ROLLO is an open-source Python package that applies evolutionary algorithm techniques to optimize nuclear reactor design. It essentially couples the DEAP (Distributed Evolutionary Algorithms in Python) <https://deap.readthedocs.io/en/master/>_ evolutionary algorithm driver with nuclear software. ROLLO is nuclear-software agnostic, and designed to easily couple to any software.

Documentation on the usage of ROLLO is hosted at: https://gwenchee.github.io/rollo/

Installation

python -m pip install rollo

The more detailed installation guide can be found here.

Running ROLLO

python -m rollo -i <input file> -c <checkpoint file> -v

Command line flags:

Flag Description Mandatory ?
-i name of input file Yes
-c name of checkpoint file No
-v verbose output (only include the flag) No

Details about running ROLLO can be found in the users guide here.

Citing

TODO: Add ROLLO paper when completed.

Troubleshooting

If you run into problems compiling, installing, or running ROLLO, please post to the discussion forum.