Valence / README.md
penguinnator's picture
Duplicate from domattioli/Valence
e8f97a6
|
Raw
History Blame Contribute Delete
3.3 kB
---
license: mit
pretty_name: ADMESH Domains
size_categories:
- n<1K
tags:
- adcirc
- mesh
- coastal
- simulation
- geoscience
---
# ADMESH Domains
A registry of ADCIRC-compatible coastal-simulation mesh domains, organized as
**Domains** (geographic regions or logical groups) containing one or more
**Meshes** (specific realizations).
- **Release**: `data-2026-06-09-c2c5373`
- **Schema version**: `0.3`
- **Domains**: 17
- **Meshes**: 44
- **Total size**: 90.8 MB
- **Source**: https://github.com/domattioli/ADMESH-Domains
## Geographic coverage
![Bounding boxes of geographic domains](bbox_map.png)
Bounding boxes shown for Domains whose coordinates are in lat/lon (decimal degrees). Synthetic, projected, and arbitrary-coordinate Domains are listed in the tables below but not plotted.
## Quickstart
Install the Python package and load a mesh from this dataset:
```bash
pip install admesh-domains[hf]
```
```python
from admesh_domains import get_mesh
mesh = get_mesh("WNAT/hagen@v1")
local_path = mesh.load() # downloads + caches via huggingface_hub
print(local_path) # /Users/.../huggingface/hub/.../WNAT_Hagen.14
```
You can also use the HF CLI directly:
```bash
hf download domattioli/ADMESH-Domains --type dataset
```
Or load the Parquet sidecar to query without Python:
```python
import pyarrow.parquet as pq
from huggingface_hub import hf_hub_download
p = hf_hub_download(
repo_id="domattioli/ADMESH-Domains",
filename="manifest.parquet",
repo_type="dataset",
)
table = pq.read_table(p)
print(table.to_pandas().head())
```
## Real-world domains (12)
| Domain | Region | Meshes | Description |
|---|---|---|---|
| `BaranjaHill` | Europe | 2 | Baranja Hill |
| `ChesapeakeBay` | North America | 1 | Chesapeake Bay |
| `DelawareBay` | North America | 2 | Delaware Bay |
| `GreatLakes` | North America | 1 | Great Lakes |
| `Italy` | Mediterranean | 1 | Italy coastal region |
| `LakeErie` | North America | 2 | Lake Erie |
| `LakeMichigan` | North America | 1 | Lake Michigan |
| `WNAT` | Atlantic Ocean | 4 | Western North Atlantic |
| `EasternPacific` | Pacific Ocean | 1 | Eastern Pacific (ENPAC) |
| `EnglishChannel` | Europe | 0 | English Channel |
| `SanFranciscoBay` | North America | 1 | San Francisco Bay |
| `STOFS2DGlobal` | Global | 0 | STOFS-2D-Global |
## Synthetic / test domains (5)
| Domain | Meshes | Description |
|---|---|---|
| `MiscTests` | 8 | Miscellaneous test meshes |
| `Rectangles` | 4 | Rectangular reference meshes |
| `Shapes` | 7 | Simple geometric shapes |
| `StructuredGrids` | 4 | Structured grid meshes |
| `TestCases` | 5 | Numbered test cases |
## File layout
```
manifest.parquet # flat one-row-per-mesh sidecar
README.md # this file
meshes/<domain>/<filename> # original ADCIRC .14 / .2dm files
```
## License
MIT (matches the upstream repo).
## Citation
If you use this registry in research, please cite:
```bibtex
@misc{admesh_domains,
author = {Mattioli, Dominik},
title = {ADMESH Domains: A Registry of ADCIRC-Compatible Mesh Domains},
year = {2026},
publisher = {Hugging Face},
url = {https://huggingface.co/datasets/domattioli/ADMESH-Domains},
note = {Version data-2026-06-09-c2c5373},
}
```