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. Style Guide for OpenMC
  • 1.1. Fortran
    • 1.1.1. Miscellaneous
    • 1.1.2. Naming
    • 1.1.3. Procedures
    • 1.1.4. Variables
    • 1.1.5. Shared/Module Variables
    • 1.1.6. Indentation
    • 1.1.7. Whitespace in Expressions
  • 1.2. C++
    • 1.2.1. Miscellaneous
    • 1.2.2. Naming
    • 1.2.3. Curly braces
  • 1.3. Python
• 2. Development Workflow
  • 2.1. Overview
  • 2.2. Code Review Criteria
  • 2.3. Contributing
  • 2.4. OpenMC Test Suite
    • 2.4.1. Adding tests to test suite
  • 2.5. Private Development
• 3. Making User Input Changes
• 4. Building Sphinx Documentation
  • 4.1. Building Documentation as a Webpage
  • 4.2. Building Documentation as a PDF