Documentation
Concise guides for using Valence and building against its APIs.
An open registry of ADCIRC mesh domains — every mesh carries its validation gates and provenance. New here? Start with What is Valence?
Start Here
What Valence is, and the fastest paths to using it.
- What is Valence? — A registry of ADCIRC mesh domains with validation gates and provenance.
- Quickstart — Install the package and load your first mesh in 5 minutes.
Concepts
The registry model, the trust and authority boundary, and shared vocabulary.
- Domains, Meshes & the Registry — The two-level model: identity-bearing Domains and their swappable Meshes.
- Trust, Provenance & Authority Boundaries — What is authoritative, what is advisory, and what is derived and illustrative.
- Capability Model & Limits — What Valence does today, and what is intentionally unsupported.
- Glossary — Canonical definitions for Domain, Mesh, Scope, Verdict, and related terms.
User Docs
Workflows and limits for discovering, comparing, and contributing meshes.
- Discovering & Comparing Meshes — Browse, filter, compare, and download meshes from the registry.
- Contributing Meshes — What a contributor submits, what Valence checks, and what maintainers decide.
- Region Proposals — How imported selection artifacts become ranked proposals and approved regions.
Maintainer Docs
Review queue, approval process, and mesh acquisition policy for maintainers.
- Review & Publication — The review queue, approval and rejection workflow, and mesh acquisition rules.
Developer Docs
API surfaces, schemas, and integration contracts for building with Valence.
- Python API — Registry queries, mesh loading, proposals, and deterministic package contracts.
- CLI Reference — The valence-domains command groups: registry, analysis, scope/attest, bundles/audit, proposals.
- Manifest Schema — How Domains, Meshes, identities, and visualization metadata fit together.
- Backend API — Contribution and lifecycle APIs, auth bridge, and OpenAPI entry points.
- Notebooks & Examples — Three offline, deterministic notebooks — registry discovery, evidence chain, and region proposals.