admesh-domains 0.2.4

ADCIRC mesh registry - domain management and validation for mesh data

ADMESH Domains

Source repository for the ADCIRC mesh domain registry: a curated catalog of coastal-simulation meshes with a Python loader, HuggingFace dataset mirror, and PR-based contribution workflow.

Where to go	What you'll find
📦 pypi.org/project/admesh-domains	The Python package
🤗 huggingface.co/datasets/domattioli/ADMESH-Domains	The mesh files + Parquet sidecar + auto-generated dataset card (start here if you just want data)
🧪 domattioli/ADMESH	The parent ADMESH library this registry complements

This repo is for contributors and maintainers of the registry — the data, schema, publisher pipeline, and CI live here. End users normally don't need to clone it; pip install admesh-domains[hf] is enough.

Quick install

# Read the bundled manifest only (no mesh downloads, ~50 KB install)
pip install admesh-domains

# Add Mesh.load() — fetches mesh files from the HF mirror on demand
pip install admesh-domains[hf]

The user-facing API (find_domains, find_meshes, get_mesh, Mesh.load) is documented on the HF dataset card.

Repo layout

admesh_domains/          Python package (schema, manifest loader, query API,
                         CLI, HF publisher, dataset-card template)
admesh_domains/data/     Bundled manifest.toml shipped in the wheel
registry_data/           Source-of-truth manifest + mesh files (.14, .2dm)
                         excluded from the wheel/sdist; mirrored to HF
specs/                   Spec-driven design docs (one folder per feature)
scripts/                 One-shot data tooling (mesh import, bbox extractor)
tests/                   pytest suite (mocked huggingface_hub)
.github/workflows/       release.yml (tag → PyPI + HF) + validate-pr.yml (CI)

Development

pip install -e ".[publish]" pytest
admesh-domains validate                 # check the bundled manifest parses
admesh-domains validate registry_data/manifest.toml   # ...and the dev one
pytest tests/                           # full suite
admesh-domains publish --tag v0.0.0-dryrun \
    --manifest registry_data/manifest.toml --dry-run --verbose

Every push and PR is validated by .github/workflows/validate-pr.yml (matrix across Python 3.9 / 3.11 / 3.12).

Releasing

Tag a strict-semver version (v[0-9]+.[0-9]+.[0-9]+), push it, walk away. The release.yml workflow handles twine upload to PyPI and a single atomic create_commit to the HF dataset, with sha256 dedup against the prior release. See specs/006-huggingface-publisher/quickstart.md for the full maintainer recipe.

# bump pyproject.toml + admesh_domains/__init__.py to e.g. 0.2.2
git tag v0.2.2 && git push origin v0.2.2

Contributing

Open an issue first if you're proposing a new domain, schema change, or behavior change. PRs welcome — the validator will run on every push.

Currently filed:

• #1 Natural-language → fort.14 generation
• #2 Interactive draw → fort.14 export
• #3 Domain auto-suggester for new mesh PRs

Specs

Active and shipped specs live under specs/. Each folder contains spec.md, plan.md, tasks.md, and supporting docs.

Spec	Status
005 — ADCIRC mesh registry (legacy from monorepo, see migration note)	Superseded
006 — HuggingFace dataset publisher	✅ Shipped in v0.2.0

License

MIT — see LICENSE.