Iwxxm.Net 1.0.0-rc.2

This is a prerelease version of Iwxxm.Net.
dotnet add package Iwxxm.Net --version 1.0.0-rc.2
                    
NuGet\Install-Package Iwxxm.Net -Version 1.0.0-rc.2
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Iwxxm.Net" Version="1.0.0-rc.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Iwxxm.Net" Version="1.0.0-rc.2" />
                    
Directory.Packages.props
<PackageReference Include="Iwxxm.Net" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Iwxxm.Net --version 1.0.0-rc.2
                    
#r "nuget: Iwxxm.Net, 1.0.0-rc.2"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Iwxxm.Net@1.0.0-rc.2
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Iwxxm.Net&version=1.0.0-rc.2&prerelease
                    
Install as a Cake Addin
#tool nuget:?package=Iwxxm.Net&version=1.0.0-rc.2&prerelease
                    
Install as a Cake Tool

Iwxxm.Net

ICAO/WMO IWXXM 2025-2 aeronautical meteorology for .NET: parse, validate, map and export METAR, SPECI, TAF, SIGMET, AIRMET, VAA, TCA, space-weather advisories, VONA, QVACI, WAFS SIGWX and SWIM/AMHS collective bulletins.

License: MIT Target frameworks .NET SDK

Iwxxm.Net reads the XML, checks it against the official WMO schemas and rules, and hands you a small, immutable, strongly typed domain model, or an RFC 7946 GeoJSON document. It has no third-party runtime dependencies and runs from .NET Framework 4.6.1 to .NET 10 (netstandard2.0 and netstandard2.1).

New here? Start with the Getting started guide: a progressive tour with runnable examples, diagrams, and worked examples that read jet streams and cumulonimbus clouds from an official WAFS chart.

What you get

  • Every IWXXM 2025-2 product, plus collect:MeteorologicalBulletin envelopes with partial results (one bad report does not discard the rest).
  • Honest data: nothing is invented. A missing value is null; speeds and lengths keep their reported unit (Speed, Length); vertical limits keep unit and reference (VerticalLimit: FL, MSL, SFC); WMO code lists become typed CodeListValue<T> that never drop an unknown code.
  • Failures are values: every operation returns a Result<T> with structured, stable error codes (IwxxmErrorCodes for the ones you branch on) and warnings; only argument mistakes throw.
  • Safe by default: no DTDs, no external resolution, size and character limits, no network or file-system access at runtime. All schemas, rules and code lists are embedded.
  • Native RFC 7946 GeoJSON export, with circles, polygon holes, antimeridian handling and measures written as reported.
  • Hexagonal architecture with a public Schematron port (Iwxxm.Net.Extensibility) to replace the business-rule engine (the other adapters are internal); the layer rules are enforced by tests.

Validation scope

Gate What runs by default Complete option
XSD The unmodified official WMO IWXXM 2025-2 schemas with their official imports (OGC GML 3.2.1, O&M 2.0, ISO 19139, AIXM 5.1.1, METCE, OPM, COLLECT, W3C), embedded byte for byte. -
Business rules Partial: an XSLT 1.0 subset of the official Schematron (11 of the 165 rule ids, some for a subset of their contexts), the membership of every codes.wmo.int reference in the 20 official WMO RDF code lists, and a few library-specific checks. A document accepted by default may still violate official rules that are not implemented. UseOfficialSchematron() from Iwxxm.Net.Validation.Saxon runs the unmodified iwxxm.sch (all 165 rules) with SaxonCS-HE.

iwxxm:SIGWXReport is a non-standard compact root specific to this library (it is declared by no official schema) and is validated against a separate, hand-written schema subset. The official root is iwxxm:WAFSSignificantWeatherForecast.

Supported report suite

Category Root XML element(s) IwxxmReportType Domain type
WAFS Significant Weather iwxxm:WAFSSignificantWeatherForecast, iwxxm:SIGWXReport (non-standard) SignificantWeather Sigwx
Aerodrome routine observation iwxxm:METAR Metar Metar (base AerodromeObservation)
Aerodrome special observation iwxxm:SPECI Speci Speci (base AerodromeObservation)
Terminal aerodrome forecast iwxxm:TAF Taf Taf
En-route SIGMET iwxxm:SIGMET Sigmet Sigmet
Volcanic ash SIGMET iwxxm:VolcanicAshSIGMET VolcanicAshSigmet Sigmet
Tropical cyclone SIGMET iwxxm:TropicalCycloneSIGMET TropicalCycloneSigmet Sigmet
Low-level AIRMET iwxxm:AIRMET Airmet Airmet
Volcano observatory notice iwxxm:VolcanoObservatoryNoticeForAviation VolcanoObservatoryNotice Vona
Quantitative volcanic ash iwxxm:QuantitativeVolcanicAshConcentrationInformation QuantitativeVolcanicAshConcentration Qvaci
Volcanic ash advisory iwxxm:VolcanicAshAdvisory VolcanicAshAdvisory Vaa
Tropical cyclone advisory iwxxm:TropicalCycloneAdvisory TropicalCycloneAdvisory Tca
Space weather advisory iwxxm:SpaceWeatherAdvisory SpaceWeatherAdvisory SpaceWx
SWIM / AMHS collective bulletin collect:MeteorologicalBulletin MeteorologicalBulletin MeteorologicalBulletin

Every parsed document derives from the closed abstract root IwxxmDocument: either an IwxxmReport (the eleven report aggregates above, with their own status, usage and translation metadata) or the MeteorologicalBulletin envelope. See section 4 of the guide.

Installation

Packages are published to GitHub Packages only for release tags vMAJOR.MINOR.PATCH[-PRERELEASE] (the tag is the package version) or a deliberate manual workflow run; pull requests and pushes to main build and test -ci.<run>.<attempt> prereleases that are never published.

Packages are published on NuGet.org (with .snupkg symbols and SourceLink) and mirrored on GitHub Packages.

Install directly from NuGet.org:

dotnet add package Iwxxm.Net --prerelease
dotnet add package Iwxxm.Net.Validation.Saxon --prerelease   # optional: the complete official Schematron

If your environment does not have nuget.org configured as a source, add it once:

dotnet nuget add source "https://api.nuget.org/v3/index.json" --name "nuget.org"
Package Targets Runtime dependencies
Iwxxm.Net netstandard2.0, netstandard2.1 none
Iwxxm.Net.Validation.Saxon net10.0 Iwxxm.Net, SaxonCS-HE 13.1.0 (MPL-2.0, with its own transitive dependencies)

Building from source needs the .NET 10 SDK (see global.json).

Quick start

using System;
using Iwxxm.Net;
using Iwxxm.Net.Reports;

Result<IwxxmDocument> result = IwxxmParser.ParseFile("samples/metar-A3-1.xml");

if (result.IsFailure)
{
    foreach (ValidationError error in result.Errors)
    {
        Console.Error.WriteLine(error);   // [Category:Severity] CODE [location]: message
    }
    return;
}

switch (result.Value)
{
    case Metar metar:
        Console.WriteLine($"METAR {metar.AerodromeDesignator} at {metar.ObservationTimeUtc:u}");
        Console.WriteLine($"  QNH {metar.QnhHpa} hPa, visibility {metar.PrevailingVisibilityMeters} m");
        Console.WriteLine($"  wind {metar.SurfaceWind?.MeanDirectionDegrees} deg at {metar.SurfaceWind?.MeanSpeed} ({metar.SurfaceWind?.MeanSpeed?.ToKnots():F1} kt)");
        break;

    case Taf taf:
        Console.WriteLine($"TAF {taf.AerodromeDesignator}: {taf.ChangeForecasts.Count} change groups");
        break;

    case Sigmet sigmet:
        Console.WriteLine($"{sigmet.ReportType} {sigmet.FirDesignator} #{sigmet.SequenceNumber}");
        break;

    default:
        Console.WriteLine($"{result.Value.ReportType}");
        break;
}
METAR YUDO at 2012-08-22 16:30:00Z
  QNH 1018 hPa, visibility 600 m
  wind 240 deg at 4 m/s (7.8 kt)

The wind arrived in metres per second and stays that way until you ask for knots. That habit, "keep what was reported", runs through the whole library; the guide explains it with real data.

Which entry point do I use?

  • Common case: IwxxmParser.Default, or the static IwxxmParser.Parse* helpers that wrap it (IwxxmGeoJsonExporter.Default likewise). Default limits, built-in rule subset. WAFS SIGWX and bulletins need no other entry point: IwxxmParser.ParseFileAs<Sigwx>(path) reads the official and the compact SIGWX root (IwxxmSigwxParser is an optional narrow facade over the same mapper).
  • Options or Schematron selection: IwxxmParserBuilder (WithOptions, UseSchematronValidator, WithoutSchematron, and UseOfficialSchematron() from Iwxxm.Net.Validation.Saxon), then Build().

The facade constructors are internal; ISchematronValidator and IwxxmDocumentContext are the only public extension points. Details in the guide.

To export GeoJSON, validate with the full official rule set, or tighten the security limits, see the guide's sections on GeoJSON, validation levels and options.

Documentation

Document What is in it
Getting started guide A didactic tour: pipeline, Result<T>, document types, validation, value objects, and worked SIGWX (jet streams, clouds), METAR/TAF and SIGMET examples.
Reference One example per product family, the composition root and ports, the complete error-code table (every stable code, checked against the source by a test), value-object catalogue and namespace map.
Documentation index The map of everything under docs/.
Contributing Pull request workflow, local setup, architecture rules, how to add a report family, golden-master tests.
Code of conduct Contributor Covenant v2.1 community standards and reporting guidelines.
Releasing Versioning, the tag procedure, package contents and the v1.0.0 publication checklist.
Third-party notices Licences and notices of the schemas, code lists, rules and packages that are redistributed or depended on.
Security policy Supported versions, how to report a vulnerability privately, scope and secure-usage guidance.
Changelog Release notes.
Demo console app A small net10.0 consumer (not part of the solution, CI or packages): parses any IWXXM file, prints its data, can export GeoJSON and can run the complete official Schematron (--official-schematron).

Public namespaces

Namespace Contents
Iwxxm.Net Facades (IwxxmParser, IwxxmGeoJsonExporter, and the optional SIGWX-only IwxxmSigwxParser), the composition root IwxxmParserBuilder, options, Result<T>, ValidationError, ErrorCategory, IwxxmErrorCodes
Iwxxm.Net.Reports The domain model: the closed document hierarchy and every value object
Iwxxm.Net.Extensibility ISchematronValidator and IwxxmDocumentContext, the extension point for custom business-rule engines
Iwxxm.Net.Validation.Saxon OfficialSchematronValidator (optional package)

Consumers never need a layer name in a using directive; Iwxxm.Net.Application.*, Iwxxm.Net.Infrastructure.* and Iwxxm20252.Generated are internal. The layer map is in the reference.

Build, test and package

The reference build is the container pipeline, which runs restore, build (warnings as errors), test (with coverage, including the IL-level architecture tests and the official Schematron tests) and pack (both .nupkg and .snupkg, with a guard that Iwxxm.Net declares no dependency):

podman build --target test -t iwxxm-net-test .        # or: docker build --target test .
podman build --target pack --build-arg PACKAGE_VERSION=1.0.0-rc.2 .

bash tools/run-local-ci.sh                            # full pipeline, artifacts in ./artifacts
BUILD_NUMBER=5 bash tools/run-local-ci.sh             # custom incremental build number
CONTAINER_ENGINE=podman bash tools/run-local-ci.sh    # use Podman instead of Docker

Without containers: dotnet build Iwxxm.Net.slnx -c Release and dotnet test Iwxxm.Net.slnx -c Release (details in CONTRIBUTING.md).

The local pipeline never publishes: the ci image only copies the artifacts to /out, and the script does not forward GITHUB_TOKEN. Packages are published by the GitHub Actions workflow. A deliberate local publish is an explicit opt-in that refuses to run unless every condition holds:

# Requires --publish, a dedicated key (GITHUB_TOKEN is ignored), an explicit version and a clean git tree
IWXXM_NUGET_PUBLISH_API_KEY=... PACKAGE_VERSION=1.2.3 bash tools/run-local-ci.sh --publish

Benchmarks (BenchmarkDotNet; indicative numbers in the performance notes):

dotnet run --project tests/Iwxxm.Net.Benchmarks/Iwxxm.Net.Benchmarks.csproj --configuration Release -- --filter "*"

The internal SIGWX transport model (Infrastructure/Generated/Iwxxm20252.Generated.cs) is maintained by hand; CONTRIBUTING.md explains the optional xscgen reference scaffold.

License and third-party notices

Licensed under the MIT License. The complete list of third-party material, with licences, copyright notices and open points, is in THIRD-PARTY-NOTICES.md; the file is also at the root of both NuGet packages.

  • The embedded official WMO IWXXM schemas, Schematron rules and code lists, and the imported OGC, ISO, EUROCONTROL and W3C schemas, are redistributed unmodified; their upstream ReadMe and release notes ship under schema-notices/ in the Iwxxm.Net package. Some of those upstream sources state no licence; the open points are listed in THIRD-PARTY-NOTICES.md.
  • Iwxxm.Net.Validation.Saxon vendors SchXslt 1.10.1 (Copyright (c) 2018-2021 David Maus, MIT License), shipped under licenses/SchXslt/ in the package.
  • Iwxxm.Net.Validation.Saxon depends on SaxonCS-HE 13.1.0 (Saxonica Ltd.). Its bundled LICENSE.txt states that SaxonCS-HE is distributed as an "executable form" of the open-source SaxonJ-HE product under the Mozilla Public License 2.0 (file-level copyleft that applies to Saxon's own files, not to code that merely uses it). No Saxonica licence key is required for the Home Edition features used here.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • .NETStandard 2.1

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Iwxxm.Net:

Package Downloads
Iwxxm.Net.Validation.Saxon

Optional Iwxxm.Net add-on that runs the complete, unmodified official WMO IWXXM 2025-2 Schematron (iwxxm.sch, queryBinding xslt2, all 165 rules) with SaxonCS-HE (MPL-2.0) and the vendored SchXslt 1.10.1 compiler (MIT). Code-list lookups resolve to the official WMO RDF files embedded in Iwxxm.Net; no network or file-system access at runtime. Register with IwxxmParserBuilder.UseOfficialSchematron().

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0-rc.2 48 11/18/2026
1.0.0-rc.1 53 11/17/2026

See CHANGELOG.md at https://github.com/0neTX/Iwxxm.Net/blob/main/CHANGELOG.md for the release notes of this version.