Docs navigation

Start Here

What is Valence?

A registry of ADCIRC mesh domains with validation gates and provenance.

An open registry of ADCIRC mesh domains — every mesh carries its validation gates and provenance.

A two-level system

A Domain is an identity-bearing entity defined by one curated, hashable Domain Boundary. A Mesh is one realization of a Domain with its own resolution and contributor, addressed as WNAT/hagen@v1. See Domains, Meshes & the Registry for the full model.

System overview

Diagram: the frontend reads directly from the HuggingFace dataset domattioli/Valence for browsing; contribution writes go frontend to backend to Postgres and HuggingFace; the valence-domains package loads mesh bytes via Mesh.load(); registry_data/manifest.toml is the source of truth from which site data is derived.

Browsing reads go straight to the dataset; contribution writes pass through the backend for review before they reach Postgres and the dataset.

Change control and reproducibility

Meshes carry provenance and structural gates. Changes are reviewed artifacts, and derived previews are never the science. Candidate proposals are advisory. An approved region is the artifact that crosses the authority boundary and can be used for enforcement-grade scope verdicts. Visual previews are illustrative; source mesh bytes and manifest metadata remain authoritative.

What Valence is not

  • Not a public candidate-generation engine — candidate generation is owner-only and fails closed when the proprietary engine is absent
  • Not a simulation tool — Valence is a registry and change-control system
  • Not a ranking of scientific optimality — ranking orders candidates for review; it is not a claim of scientific optimality, simulation accuracy, or automatic selection
  • Not authoritative visual validation — Visual previews are illustrative; source mesh bytes and manifest metadata remain authoritative

Getting started

Explore the registry:
Use meshes — Read the Quickstart for a 5-minute Python walkthrough.
Contribute — See Contributing Meshes to add your mesh to the registry.
Build on it — Explore the Python API for registry queries and programmatic access.
Learn the model — Read Domains, Meshes & the Registry and Trust, Provenance & Authority Boundaries for the concepts behind the registry.