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. Parallel Code in ARMI
  • 5.1. MPI communication crash course
  • 5.2. MPI Communication within ARMI
• 6. Profiling ARMI
• 7. Reports in ARMI
  • 7.1. The Hook: getReportContents()
  • 7.2. What is ReportContent?
  • 7.3. Sections
  • 7.4. Tables
  • 7.5. Images
  • 7.6. TimeSeries
  • 7.7. HTML Elements
  • 7.8. Summary
• 8. Standards and Practices for Coding
  • 8.1. Code formatting with Black
  • 8.2. Remove commented-out code
  • 8.3. Avoid hard-coding run parameters
  • 8.4. Avoid the global keyword
  • 8.5. Naming conventions
  • 8.6. Prefer shorter methods
  • 8.7. Avoid repeating code
  • 8.8. Public methods should have docstrings
  • 8.9. Unit tests
  • 8.10. Import statements
  • 8.11. Don’t create naked exceptions.
  • 8.12. Data model
  • 8.13. Input files
  • 8.14. Address the ruff warnings
  • 8.15. General do’s and don’ts
• 9. Tooling and Infrastructure
  • 9.1. Good Commit Messages
  • 9.2. Good Pull Requests
  • 9.3. Packaging and dependency management
  • 9.4. Releasing a New Version of ARMI
  • 9.5. Module-Level Logging