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.7.2. I/O 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.1.1. Planned Test Cases, Sequence, and Identification of Stages Required
      • 3.2.1.2. Requirements for Testing Logic Branches
      • 3.2.1.3. Requirements for Hardware Integration
      • 3.2.1.4. Criteria for Accepting the Software
      • 3.2.1.5. Necessary Inputs to Run Test Cases
      • 3.2.1.6. Required Ranges of Input Parameters for the Test Case(s)
      • 3.2.1.7. Expected Results for the Test Case(s)
      • 3.2.1.8. Acceptance Criteria for the Test Case(s)
    • 3.2.2. Test Record Criteria
      • 3.2.2.1. Software Tested, Including System Software Used and All Versions
      • 3.2.2.2. Compute Platform and Hardware Used
      • 3.2.2.3. Test Equipment and Calibrations
      • 3.2.2.4. Runtime Environment Including System Software, and Language-Specific Environments
      • 3.2.2.5. Date of Test
      • 3.2.2.6. Tester or Data Recorder
      • 3.2.2.7. Simulation Models Used
      • 3.2.2.8. Test Problems Identified During Test Planning
      • 3.2.2.9. All Input Data and Output Results and Applicability
      • 3.2.2.10. Action Taken in connection with Any Deviations Noted
      • 3.2.2.11. Person Evaluating Test Result
      • 3.2.2.12. Acceptability
  • 3.3. Test Traceability Matrix
  • 3.4. Test Results Report
    • 3.4.1. Testing Environment
      • 3.4.1.1. System Information
        • 3.4.1.1.1. Python Version and Packages
      • 3.4.1.2. Software Tested and Date
    • 3.4.2. Record of Test Cases
  • 3.5. Appendix A Pytest Verbose Output
• 4. Software Change Requests (SCR)
  • 4.1. SCR for ARMI 0.7.0
    • 4.1.1. SCR Listing
  • 4.2. Release Notes for ARMI 0.6
    • 4.2.1. ARMI v0.6.4
      • 4.2.1.1. Code Changes, Features
      • 4.2.1.2. Code Changes, Bugs and Fixes
      • 4.2.1.3. Code Changes, Maintenance, or Trivial
      • 4.2.1.4. Documentation-Only Changes
    • 4.2.2. ARMI v0.6.3
      • 4.2.2.1. Code Changes, Features
      • 4.2.2.2. Code Changes, Maintenance, or Trivial
      • 4.2.2.3. Documentation-Only Changes
    • 4.2.3. ARMI v0.6.2
      • 4.2.3.1. Code Changes, Features
      • 4.2.3.2. Code Changes, Bugs and Fixes
      • 4.2.3.3. Code Changes, Maintenance, or Trivial
      • 4.2.3.4. Documentation-Only Changes
    • 4.2.4. ARMI v0.6.1
      • 4.2.4.1. Code Changes, Features
      • 4.2.4.2. Code Changes, Bugs and Fixes
      • 4.2.4.3. Code Changes, Maintenance, or Trivial
      • 4.2.4.4. Documentation-Only Changes
    • 4.2.5. ARMI v0.6.0
      • 4.2.5.1. Code Changes, Features
      • 4.2.5.2. Code Changes, Bugs and Fixes
      • 4.2.5.3. Code Changes, Maintenance, or Trivial
      • 4.2.5.4. Documentation-Only Changes
  • 4.3. Release Notes for ARMI 0.5
    • 4.3.1. ARMI v0.5.1
      • 4.3.1.1. New Features
      • 4.3.1.2. API Changes
      • 4.3.1.3. Bug Fixes
      • 4.3.1.4. Quality Work
    • 4.3.2. ARMI v0.5.0
      • 4.3.2.1. New Features
      • 4.3.2.2. API Changes
      • 4.3.2.3. Bug Fixes
      • 4.3.2.4. Quality Work
  • 4.4. Release Notes for ARMI 0.4
    • 4.4.1. ARMI v0.4.0
      • 4.4.1.1. New Features
      • 4.4.1.2. API Changes
      • 4.4.1.3. Bug Fixes
      • 4.4.1.4. Quality Work
      • 4.4.1.5. Changes that Affect Requirements
  • 4.5. Release Notes for ARMI 0.3
    • 4.5.1. ARMI v0.3.0
      • 4.5.1.1. What’s new in ARMI?
      • 4.5.1.2. Bug Fixes
      • 4.5.1.3. Quality Work
  • 4.6. Release Notes for ARMI 0.2
    • 4.6.1. ARMI v0.2.9
      • 4.6.1.1. What’s new in ARMI
      • 4.6.1.2. Build changes
      • 4.6.1.3. Bug fixes
    • 4.6.2. ARMI v0.2.8
      • 4.6.2.1. What’s new in ARMI
      • 4.6.2.2. Bug fixes
    • 4.6.3. ARMI v0.2.7
      • 4.6.3.1. What’s new in ARMI
      • 4.6.3.2. Bug fixes
    • 4.6.4. ARMI v0.2.6
      • 4.6.4.1. What’s new in ARMI
      • 4.6.4.2. Bug fixes
    • 4.6.5. ARMI v0.2.5
      • 4.6.5.1. What’s new in ARMI
      • 4.6.5.2. Bug fixes
    • 4.6.6. ARMI v0.2.4
      • 4.6.6.1. What’s new in ARMI
      • 4.6.6.2. Bug fixes
    • 4.6.7. ARMI v0.2.3
      • 4.6.7.1. What’s new in ARMI
    • 4.6.8. ARMI v0.2.2
      • 4.6.8.1. Bug fixes
    • 4.6.9. ARMI v0.2.1
      • 4.6.9.1. What’s new in ARMI v0.2.1
      • 4.6.9.2. Bug fixes
    • 4.6.10. ARMI v0.2.0
      • 4.6.10.1. What’s new in ARMI v0.2.0
      • 4.6.10.2. Backwards incompatible changes
      • 4.6.10.3. Bug fixes
  • 4.7. Release Notes for ARMI 0.1
    • 4.7.1. ARMI v0.1.7
      • 4.7.1.1. API changes
      • 4.7.1.2. Bug fixes
    • 4.7.2. ARMI v0.1.6
      • 4.7.2.1. Deprecations
      • 4.7.2.2. Bugfixes
    • 4.7.3. ARMI v0.1.5
      • 4.7.3.1. User-facing enhancements
      • 4.7.3.2. Bugfixes
      • 4.7.3.3. Backend changes
    • 4.7.4. ARMI v0.1.4
      • 4.7.4.1. Bugfixes
    • 4.7.5. ARMI v0.1.3
      • 4.7.5.1. User-facing enhancements
      • 4.7.5.2. Bugfixes
      • 4.7.5.3. Backend changes
    • 4.7.6. ARMI v0.1.2
      • 4.7.6.1. Hotfixes
    • 4.7.7. ARMI v0.1.1
      • 4.7.7.1. User-facing enhancements
      • 4.7.7.2. Backend changes
    • 4.7.8. ARMI v0.1.0