Welcome to bluemira’s documentation!

The documentation is divided into the following sections:

• Getting started, where you can learn more about the code and how to install it

• Bluemira Modules, where you can learn more about the individual modules

• Developer Documentation, where you can find the API reference, and more developer-focused documentation

Getting started

• Introduction
• Installation
• Conventions
• Examples

Bluemira Modules

• Base
• Balance of Plant
• Interfaces to external codes
• 2-D fixed and free boundary equilibrium solvers
• Fuel cycle model
• Geometry module
• Mesh modules
• Magnetostatics
• Materials
• Optimisation
• Radiation transport solvers
• Structural module
• Utilities

Developer Documentation

• Configuring SSH keys
• Logging customisation
• Generating ParameterFrames
• Module API Reference
• Release Workflow
• FAQs