Developer’s Guide

Welcome to the OpenMC Developer’s Guide! This guide documents and explains the structure of the OpenMC source code and how to do various development tasks such as debugging.

• 1. Data Structures
  • 1.1. Particle
  • 1.2. Cell
  • 1.3. Surface
  • 1.4. Material
  • 1.5. Nuclide
  • 1.6. SAlphaBeta
  • 1.7. XsListing
  • 1.8. NuclideMicroXS
  • 1.9. MaterialMacroXS
• 2. Style Guide for OpenMC
  • 2.1. Fortran
    • 2.1.1. General Rules
    • 2.1.2. Procedures
    • 2.1.3. Variables
    • 2.1.4. Derived Types and Classes
    • 2.1.5. Indentation
    • 2.1.6. Whitespace in Expressions
  • 2.2. Python
• 3. Development Workflow
  • 3.1. Overview
  • 3.2. Code Review Criteria
  • 3.3. Contributing
  • 3.4. OpenMC Test Suite
    • 3.4.1. Adding tests to test suite
  • 3.5. Private Development
• 4. XML Input Parsing
  • 4.1. Working with the FoX Submodule
  • 4.2. Editing FoX on Personal Fork
• 5. Building Sphinx Documentation
  • 5.1. Building Documentation as a Webpage
  • 5.2. Building Documentation as a PDF