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
- 2. Making ARMI-based Apps
- 3. Entry Points
- 4. Documenting ARMI
- 5. Parallel Code in ARMI
- 6. Profiling ARMI
- 7. Reports in ARMI
- 8. First Time Contributors Guide
- 9. Standards and Practices for Coding
- 9.1. Code formatting with Black
- 9.2. Address the ruff warnings
- 9.3. Remove commented-out code
- 9.4. Avoid hard-coding run parameters
- 9.5. Avoid the global keyword
- 9.6. Naming conventions
- 9.7. Prefer shorter methods
- 9.8. Avoid repeating code
- 9.9. Public methods should have docstrings
- 9.10. Unit tests
- 9.11. Import statements
- 9.12. Don’t create naked exceptions.
- 9.13. Data model
- 9.14. Input files
- 9.15. General do’s and don’ts
- 10. Tooling and Infrastructure