AuroraScienceHub.Integrations.NoaaClient 1.4.0

AuroraScienceHub.Integrations.NoaaClient

NOAA space weather data integration for RTSW and KP-index feeds.

Overview

Provides HTTP clients for NOAA Space Weather Prediction Center data: real-time solar wind (RTSW) magnetometer and plasma measurements, plus geomagnetic Kp-index nowcast and forecasts.

Installation

dotnet add package AuroraScienceHub.Integrations.NoaaClient

Configuration

{
  "Noaa": {
    "ServerUrl": "https://services.swpc.noaa.gov",
    "UseProxy": false
  },
  "Proxy": {
    "Address": "http://proxy.example.com:8080",
    "UserName": "",
    "Password": ""
  }
}

• Noaa:ServerUrl — NOAA SWPC base URL (required).
• Noaa:UseProxy — when true, client requests are routed through the proxy configured in the Proxy section. Default: false.
• Proxy:Address — proxy server URI (required when UseProxy is enabled; startup fails with InvalidOperationException if missing).
• Proxy:UserName / Proxy:Password — optional proxy credentials. When omitted, default credentials are used.

Register clients in DI:

builder.Services.AddNoaaClients(builder.Configuration);

RTSW Client

Primary client for 1-minute magnetometer and solar wind plasma data:

var magnetometerData = await rtswClient.GetMagnetometerDataAsync(cancellationToken);
var solarWindData = await rtswClient.GetSolarWindPlasmaDataAsync(cancellationToken);

Response models map the NOAA rtsw_mag_1m.json and rtsw_wind_1m.json schema, including Active, Source, GSE/GSM field components, and quality flags.

Filter by Active == true for the NOAA-selected primary feed, or by Source when a specific instrument row is required.

KP-Index Client

var nowcast = await kpIndexClient.GetKpIndexNowcastAsync(cancellationToken);
var forecast3Day = await kpIndexClient.GetKpIndex3DayForecastAsync(cancellationToken);
var forecast27Day = await kpIndexClient.GetKpIndex27DayForecastAsync(cancellationToken);

WSA-ENLIL Client

Generates MP4 (H.264) animations from WSA-ENLIL solar wind forecast model frames provided by NOAA SWPC.

Prerequisites: FFmpeg must be installed on the system. See FFmpeg Installation for platform-specific instructions.

// Download and encode WSA-ENLIL animation frames as MP4 video
await using var stream = await wsaEnlilClient.GetEnlilAnimationAsync(
    maxWidth: 480,
    cancellationToken: cancellationToken);

// Save to file
await using var fileStream = File.Create("enlil_animation.mp4");
await stream.CopyToAsync(fileStream);

• maxWidth — maximum output width in pixels; frames are scaled proportionally (default: 480)
• Return value — MemoryStream containing the complete MP4 video; caller is responsible for disposal
• Frame rate: 20 fps (50 ms per frame)
• Encoder: H.264 (libx264), CRF 23, pixel format yuv420p

Deprecated API

IAceClient is obsolete and scheduled for removal (#3). Use IRtswClient for magnetometer and solar wind plasma data.

Links

• Repository: https://github.com/Aurora-Science-Hub/Integrations
• Changelog: https://github.com/Aurora-Science-Hub/Integrations/blob/main/CHANGELOG.md