Skip to content

hfx 0.3.0

Latest

Choose a tag to compare

@CooperBigFoot CooperBigFoot released this 12 Jun 21:41
· 1 commit to main since this release

HFX 0.3.0 — first curated release of the open HydroFabric Exchange format toolkit

HFX is the open HydroFabric Exchange format: a compiled, source-agnostic
on-disk contract for hydrographic fabrics (catchments, flow topology, and
optional D8 rasters) that any river-network dataset can be normalized into.
This release ships the toolkit that defines and enforces that contract — the
hfx-core and hfx-validator crates and the hfx CLI. shed is the
reference engine that consumes HFX datasets.

This toolkit release implements HFX spec 0.2.1 (frozen wire shape).

Curated releases begin here

0.3.0 is the first release under the curated-release policy described in
docs/VERSIONING.md.
It supersedes the per-commit-bump era, during which the workspace reached
version 0.2.64 across 87 v* tags. The crates.io snapshots from that era —
hfx-core 0.2.0 and hfx-validator 0.1.26 — are stale and target the legacy
0.1-era format; they should not be used against current datasets.

Highlights

Everything since the published crates.io snapshots:

  • HFX spec 0.2.1 with RFC 2119 normative hardening, a Version
    Compatibility section, and a dedicated spec changelog.
  • Manifest JSON schema and a conformance suite of valid/invalid fixtures
    exercising it.
  • hfx validator CLI, installed by the hfx-validator crate.
  • grit-v2 and merit-v2 reference adapters for compiling GRIT and
    MERIT-Basins fabrics into HFX.
  • examples/tiny reference dataset for quick-start and testing.
  • GitHub Actions CI plus issue and pull-request templates.
  • Governance docs: the two-track version policy (VERSIONING.md),
    CODE_OF_CONDUCT, and GOVERNANCE.

Lockstep versioning

hfx-core and hfx-validator both release as 0.3.0 and move in
lockstep: the validator pins hfx-core with an exact =0.3.0 dependency.

Links