Developer Docs

This guide will get you started as an ARMI developer. It will teach you how to develop within the ARMI ecosystem and also guide you through some of the structure of the ARMI code.

The intended audience for this section is reactor design engineers and computer scientists who want to integrate ARMI into their workflow and/or enhance ARMI for the community.

---

• 1. Framework Architecture
  • 1.1. The Reactor Model
  • 1.2. Operators
  • 1.3. Plugins
• 2. Making ARMI-based Apps
  • 2.1. ARMI Plugins
  • 2.2. ARMI-Based Applications
• 3. Entry Points
• 4. Documenting ARMI
  • 4.1. Building the documentation
  • 4.2. Documentation for ARMI plugins
  • 4.3. Updating the Gallery
  • 4.4. Using Jupyter notebooks
• 5. Profiling ARMI
• 6. Reports in ARMI
  • 6.1. The Hook: getReportContents()
  • 6.2. What is ReportContent?
  • 6.3. Sections
  • 6.4. Tables
  • 6.5. Images
  • 6.6. TimeSeries
  • 6.7. Html Elements
  • 6.8. Summary
• 7. Tooling and Infrastructure
  • 7.1. Good Commit Messages
  • 7.2. Packaging and dependency management
  • 7.3. Releasing a New Version of ARMI
  • 7.4. Module-Level Logging