Developer’s Guide

Welcome to the OpenMOC Developer’s Guide! The Developer’s Guide is a must read for those planning to contribute new code features to the OpenMOC open source project. This guide documents and explains the structure and design of the OpenMOC source code. The Guide discusses how SWIG is used to couple compiled C/C++ source code into a Python interface. In addition, the Python build system and techniques for debugging OpenMOC are presented. The Guide concludes with an overview of the coding style and development workflow used by the OpenMOC development team.

• 1. Software Design
  • 1.1. Object-Oriented Design
  • 1.2. Python Modules
• 2. Simplified Wrapper Interface Generator (SWIG)
  • 2.1. SAXPY in SWIG Example
  • 2.2. NumPy Typemaps
  • 2.3. SWIG Typemaps
  • 2.4. Default Parameters
  • 2.5. Macros
  • 2.6. Typedefs
• 3. Python Build System
  • 3.1. Configuration File
  • 3.2. Setup File
  • 3.3. SWIG Interface Files
  • 3.4. Common Modifications
  • 3.5. Add a C/C++ Extension Module
• 4. Alternative C++ Build System
  • 4.1. Makefile
  • 4.2. Building a multi-purpose C++ executable
  • 4.3. Building individual C++ Input Files
  • 4.4. Compiler Options
• 5. Debugging OpenMOC
  • 5.1. The GNU Debugger (GDB)
  • 5.2. Debugging C/C++ Source Code
  • 5.3. Debugging Python Source Code
• 6. Style Guide for OpenMOC
  • 6.1. General Rules
  • 6.2. Source Code Syntax
  • 6.3. Code Comments
  • 6.4. Line Length
  • 6.5. Indentation
  • 6.6. Whitespace
• 7. Documentation
  • 7.1. Preliminary Configuration
  • 7.2. Writing New Documentation
  • 7.3. Version Control for New Documentation
• 8. Development Workflow
• 9. Continuous integration