Master catalog of all NWAA Data Companion models supported by this package, across all three families:
wu(Water Use): irrigation, public supply, thermoelectric.wqn(Water Quantity): atmospheric forcing, the hydrologic ensemble, and its NHM-PRMS and WRF-Hydro component models.iwa(Integrated Water Availability): water budget assessment.
Value
A tibble with columns:
- model_id
API model identifier (string).
- model_label
Human-readable model name.
- family
One of
"wu","wqn","iwa".- start_ym, end_ym
Earliest and latest available data, format
"YYYY-MM".- temporal
List-column of supported temporal resolutions: combinations of
"monthly","annualcy","annualwy".- variables
List-column of variable ID character vectors.
- variable_name
List-column of human-readable variable names.
- units
List-column of unit-suffix character vectors aligned to
variables.
Details
Each row describes one model: its identifier, label, family, the variable
IDs it produces, the units those variables are reported in (units appear
as a suffix on column names in API responses, e.g. irrwdtot_mgd),
the start and end of available data, and the temporal resolutions the
model is published at.
This catalog is the single source of truth used internally by request validation and date-range resolution.
Temporal resolutions
All models are published monthly and, in addition, expose calendar-year
annual (annualcy) and water-year annual (annualwy)
aggregations. For Water Use models the upstream READMEs explicitly
describe annual mean derivation from monthly values. For the Water
Quantity and Integrated Water Availability models the annual
aggregations are computed server-side by the NWAA data endpoint; live
probes confirmed every one of these models returns annual (year)
output for both annualcy and annualwy. The catalog
therefore lists all three resolutions for every model.
Units verification
Unit suffixes for all variables in this catalog have been verified against
actual API responses. The hydrologic ensemble model
(wqn-ensemble-conus-nwaa-v1) was originally inferred from one
README example (actet_mm/mo); a live probe in May 2026 confirmed
all six variables match the catalog suffixes. The actual unit suffix is
always returned as part of the column name in API responses, so users
never need to rely on the catalog for unit information at runtime.
Examples
nwaa_catalog()
#> # A tibble: 10 × 9
#> model_id model_label family start_ym end_ym temporal variables variable_name
#> <chr> <chr> <chr> <chr> <chr> <list> <list> <list>
#> 1 wu-irrig… Crop Irrig… wu 2000-01 2020-… <chr> <chr [1]> <chr [1]>
#> 2 wu-irrig… Crop Irrig… wu 2000-01 2020-… <chr> <chr [3]> <chr [3]>
#> 3 wu-publi… Public Sup… wu 2009-01 2020-… <chr> <chr [1]> <chr [1]>
#> 4 wu-publi… Public Sup… wu 2000-01 2020-… <chr> <chr [3]> <chr [3]>
#> 5 wu-therm… Thermoelec… wu 2008-01 2020-… <chr> <chr [7]> <chr [7]>
#> 6 wqn-conu… Atmospheri… wqn 1979-10 2021-… <chr> <chr [1]> <chr [1]>
#> 7 wqn-ense… Hydrologic… wqn 2009-10 2020-… <chr> <chr [6]> <chr [6]>
#> 8 wqn-nhmp… Hydrologic… wqn 1983-01 2021-… <chr> <chr [8]> <chr [8]>
#> 9 wqn-wrfh… Hydrologic… wqn 2009-10 2021-… <chr> <chr [8]> <chr [8]>
#> 10 iwa-asse… National W… iwa 2009-10 2020-… <chr> <chr [4]> <chr [4]>
#> # ℹ 1 more variable: units <list>
# All Water Use models
cat <- nwaa_catalog()
cat[cat$family == "wu", c("model_id", "model_label")]
#> # A tibble: 5 × 2
#> model_id model_label
#> <chr> <chr>
#> 1 wu-irrigation-cu Crop Irrigation Consumptive Water-Use Model
#> 2 wu-irrigation-wd Crop Irrigation Withdrawals Water-Use Model
#> 3 wu-public-supply-cu Public Supply Consumptive Water-Use Model
#> 4 wu-public-supply-wd Public Supply Withdrawals Water-Use Model
#> 5 wu-thermoelectric Thermoelectric Power Water-Use Model