Navigation

  • index
  • modules    
  • next    
  • previous    
  • Home »
  • Cyclus User Guide »
  • Cymetric »
  • Cymetric API

Cymetric API¶

The following modules make up the cymetric package. Note that most of the important stuff you can get directly from cymetric without needing to import the module. For example:

from cymetric import metric

Interface Modules:

  • cymetric.schemas - Schemas
  • cymetric.evaluator - Evaluators
  • cymetric.execution - Execution
  • cymetric.filters - Filters
  • cymetric.graphs - Graphs

Metrics Modules:

  • cymetric.metrics - Metrics
  • cymetric.root_metrics - Root Metrics
  • cymetric.cycamore_root_metrics - Cycamore Root Metrics
  • cymetric.brightlite_root_metrics - Bright-lite Root Metrics
  • cymetric.fco_metrics - Fuel Cycle Option Metrics

Helper Modules:

  • cymetric.main - Command Line Interface
  • cymetric.tools - Tools
  • cymetric.timeseries - Timeseries

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 User Guide »
  • Cymetric »
  • Cymetric API
© Copyright 2012-2025, University of Wisconsin Computational Nuclear Engineering Research Group. Last updated on Apr 21, 2025.