UFS DA Diagnostics Toolkit

A modular, extensible diagnostics framework for UFS FV3-JEDI DA experiments.

Contents

Getting Started

• Installation
  • Prerequisites
  • Creating a Conda Environment
  • Installing the Diagnostics Toolkit
  • Building Documentation
• Quickstart
  • Spectra Diagnostics
  • Increment Maps
  • Observation Diagnostics
  • Log Diagnostics
  • Running on Hercules
• CADRE 2026 EPIC Session Instructions
  • The Control Case
  • Logging Into Hercules
  • Clone the CADRE-DA-training Repository
  • Day 1: Running the CADRE 2026 Control Experiment & Diagnostics
  • Key Aspects to Verify Day 1 Experiment Outputs
  • Optional Single-Obs Experiments
  • Day 2: Background Error Experiments (Hybrid Weight, NICAS)
  • Day 3: Observation Experiments (Thinning, Obs Error)
  • Notes
• CADRE DA Diagnostic Images
  • Day 1 Plots
  • Day 2 Plots
  • Day 3 Plots
• Diagnostics Overview
• Spectral Diagnostics
  • Overview
  • 2‑D Fourier Transform
  • Power Spectrum
  • Isotropic Spectrum
  • Parseval Consistency
  • Background vs Increment Spectra (Control Experiment)
  • Spectral Ratio (EXP vs CTRL)
  • NICAS Length‑Scale Experiment
  • Static Background Covariance Weight Experiment
• Observation Statistics
  • Formulation
  • Extended ATMS Statistics
• Chi‑Square Consistency Check
  • Interpretation
  • Practical Computation in JEDI
  • Channel‑Wise Normalized RMS²
  • Reference
  • Weather Events Diagnostics

Usage

• Using Spectra Diagnostics
  • Analysis Increment Spectra (CTRL vs EXP)
  • Background vs Increment Spectra
  • Example Figure
  • NICAS Length‑Scale Example
  • YAML Example
  • Outputs
• Using Increment Diagnostics
  • Running the CLI Tool
  • Example Figures
  • YAML Configuration
  • Amplification Options
  • Outputs
• Observation Diagnostics Overview
  • Subsystem Components
  • Workflow
  • Related Tools
• Using Observation Diagnostics
  • Running the CLI Tool
  • Example Figure
  • YAML Configuration
  • Outputs
• Using Log Diagnostics
  • Running the CLI Tool
  • Chi‑Squared Consistency Check
  • Outputs
  • Example Report (Excerpt)
• Using Plotting Tools
  • Scalar Histogram Example
  • Vector Histogram Example
  • Spectra Plot Example
  • ATMS Extended Statistics Example
  • Scan‑Position Bias Example
• Single-Observation Extraction
  • Overview
  • Configuration
  • Running the Tool
  • Python API
  • Output Structure
  • Example Use Cases
• Weather Events Diagnostics
  • Running the Tool
  • Inputs
  • Outputs
  • API Reference

API Reference

• Diagnostics API Overview
  • Architecture
• Spectral Diagnostics API
  • Modules
  • Function Summary
  • Detailed API
• Increment Diagnostics API
  • Modules
  • Function Summary
  • Detailed API
• Observation Diagnostics Driver API
  • Modules
  • Function Summary
  • Detailed API
• JEDI Log Diagnostics API
  • Modules
  • Function Summary
  • Detailed API
• Plotting Subsystem API
  • Modules
  • Function Summary
• Weather Events Diagnostics API
  • High‑Level Workflow
  • Functions
  • Command‑Line Interface

Appendices

• Appendix A — System Access and HPC Login
• Appendix B — Slurm Basics
• Appendix C — Hercules Filesystem and Environment Modules
• NOAA AWS Parallel Cluster — CADRE 2026 Workshop Instructions
• Appendix X: Innovation-Space Diagnostics with ufsda-obs-br-check

Developer Guide

• Developer Guide