QA Documentation

This is the Quality Assurance (QA) documentation for the Advanced Reactor Modeling Interface (ARMI) framework. This document includes the Software Requirements Specification Document (SRSD), the Software Design and Implementation Document (SDID), and the Software Test Report (STR).

---

• 1. Software Requirements Specification Document (SRSD)
  • 1.1. Purpose
  • 1.2. Introduction
  • 1.3. Framework-Related Concepts
    • 1.3.1. Functional Requirements
  • 1.4. Bookkeeping Package
    • 1.4.1. Functional Requirements
    • 1.4.2. Software Attributes
    • 1.4.3. I/O Requirements
  • 1.5. Cases Package
    • 1.5.1. Functional Requirements
    • 1.5.2. I/O Requirements
  • 1.6. Command Line Interface Package
    • 1.6.1. Functional Requirements
    • 1.6.2. I/O Requirements
  • 1.7. Materials Package
    • 1.7.1. Functional Requirements
  • 1.8. Nuclide Directory Package
    • 1.8.1. Functional Requirements
  • 1.9. Nuclear Data I/O Package
    • 1.9.1. Functional Requirements
  • 1.10. Physics Package
    • 1.10.1. Functional Requirements
  • 1.11. Reactors Package
    • 1.11.1. Functional Requirements
    • 1.11.2. I/O Requirements
  • 1.12. RunLog Module
    • 1.12.1. Functional Requirements
    • 1.12.2. I/O Requirements
  • 1.13. Settings Package
    • 1.13.1. Functional Requirements
    • 1.13.2. I/O Requirements
  • 1.14. Utilities Package
    • 1.14.1. Functional Requirements
  • 1.15. Software Attributes
• 2. Software Design and Implementation Document (SDID)
  • 2.1. Purpose and Scope
    • 2.1.1. Procedural Compliance
    • 2.1.2. Software Environment
    • 2.1.3. Failure Mitigation
    • 2.1.4. Implementation of Computational Sequence
    • 2.1.5. Technical Adequacy
  • 2.2. Design and Implementation
    • 2.2.1. Implementation of Plugin System
    • 2.2.2. Implementation of Reactor Data Model
    • 2.2.3. Hardware/OS Compatibility
    • 2.2.4. Error/Input Handling
    • 2.2.5. Implementation Traceability Matrix
• 3. Software Test Report (STR)
  • 3.1. Purpose and Scope
  • 3.2. Default Test Criteria
    • 3.2.1. Testing Approach
    • 3.2.2. Test Record Criteria
  • 3.3. Test Traceability Matrix
  • 3.4. Test Results Report
    • 3.4.1. Testing Environment
    • 3.4.2. Record of Test Cases
  • 3.5. Appendix A Pytest Verbose Output
• 4. Software Change Requests (SCR)
  • 4.1. SCR Listing for ARMI version 0.6.0
    • 4.1.1. Code Changes, Features
    • 4.1.2. Code Changes, Bugs and Fixes
    • 4.1.3. Code Changes, Maintenance, or Trivial
    • 4.1.4. Documentation-Only Changes
  • 4.2. ARMI v0.4 Release Notes
    • 4.2.1. ARMI v0.4.0
  • 4.3. ARMI v0.3 Release Notes
    • 4.3.1. ARMI v0.3.0
  • 4.4. ARMI v0.2 Release Notes
    • 4.4.1. ARMI v0.2.9
    • 4.4.2. ARMI v0.2.8
    • 4.4.3. ARMI v0.2.7
    • 4.4.4. ARMI v0.2.6
    • 4.4.5. ARMI v0.2.5
    • 4.4.6. ARMI v0.2.4
    • 4.4.7. ARMI v0.2.3
    • 4.4.8. ARMI v0.2.2
    • 4.4.9. ARMI v0.2.1
    • 4.4.10. ARMI v0.2.0
  • 4.5. ARMI v0.1 Release Notes
    • 4.5.1. ARMI v0.1.7
    • 4.5.2. ARMI v0.1.6
    • 4.5.3. ARMI v0.1.5
    • 4.5.4. ARMI v0.1.4
    • 4.5.5. ARMI v0.1.3
    • 4.5.6. ARMI v0.1.2
    • 4.5.7. ARMI v0.1.1
    • 4.5.8. ARMI v0.1.0