Library Reference

This presents information on the Bright API. The api module is the central place for accessing all of Bright’s features:

from bright.api import *

This command implicitly imports all of the underlying extension modules. While bright is primarily a collection of fuel cycle components (subclasses of FCComp), there are a couple of package-level functions and attributes that must be set for Bright to run successfully. These are explained here. Meanwhile, because of their potential for complexity, each fuel cycle component is given its own page.

Components

All fuel cycle objects inherit from a common FCComp class. This takes care of all of the bookkeeping, input, and output for all component instances. Below is a diagram of the how all of the comonents inheret from the top-level FCComp object. Generally, a bright user will only need to call the bottom-level classes directly.

• FCComp Class
• Enrichment Parameters
• Enrichment
• Fuel Fabrication Class
• Fluence Point Class
• Reactor Parameters
• Reactor1G Class
• Light Water Reactor1G Class
• Fast Reactor1G Class
• ReactorMG Class
• Origen ReactorMG Class
• Reprocess Class
• Storage Class

Other APIs

The following parts of Bright aid in the construction of the fuel cycle or help provide an API for generating code.

• Bright Configuration
  • Configuration Object
  • Helper Functions
  • Helper Data
• API Generation
  • Type System
  • Automatic Descriptions
  • Cython Generation
  • API Generation CLI
  • Utilities