Navigation

  • index
  • modules    
  • next    
  • previous    
  • Home »
  • Cyclus Python Interface

Cyclus Python Interface¶

This covers the Python bindings for Cyclus and related utilities.

High-level Python Interface¶

  • Agent Interface - Region, Institution, and Facility (cyclus.agents)
  • Simulation State (cyclus.simstate)
  • Agent Archetypes implemented in Python (cyclus.pyagents)

Low-level Python Wrappers¶

  • Cyclus Type System (cyclus.typesystem)
  • Cyclus Library Bindings (cyclus.lib)
  • Main Command Line Interface (cyclus.main)
  • Nuclide Naming Functions (cyclus.nucname)

Cyclus Server Interface¶

  • Cyclus Server (cyclus.server)
  • Asynchronous Actions (cyclus.actions)
  • Client Web Application (cyclus.webapp)

Python & C++ Interop Modules¶

  • Event Loop (cyclus.events)
  • In-memory Backend (cyclus.memback)

Helpers & Utilities¶

  • Cyclus Preprocessor (cyclus.cycpp)
  • Type System Code Generator (cyclus.gentypesystem)
  • JSON C++ (cyclus.jsoncpp)
  • System and Platform Specific Tools (cyclus.system)

Quick search

Useful Pages

    • Install Cyclus
    • User Guide
    • User Tutorial
    • Archetype Developer Guide
    • Archetype Developer C++ Tutorial
    • Archetype Developer Python Tutorial
    • Cyclus API Documentation
    • Cycamore API Documentation
    • Glossary
    • Join the Cyclus Users mailing list.
    • Join the Cyclus Developers mailing list.
    • Cyclus Developers Hangout Link

Get Cyclus


Current version: 1.6.0

Install:
$ conda install -c conda-forge cyclus cycamore
Get the Source:
    • Cyclus
    • Cycamore
    • Cymetric
    • Rickshaw

Acknowledgements

The Cyclus project has received support from:


In addition, some of the students working on Cyclus have received support from:


Navigation

  • index
  • modules    
  • next    
  • previous    
  • Home »
  • Cyclus Python Interface
© Copyright 2012-2025, University of Wisconsin Computational Nuclear Engineering Research Group. Last updated on Apr 21, 2025.