Variables#

The variables catalog defines every quantity a plans database can store. Each dataset in a database (a spec) points to one variable by its name, which fixes the units of the actual values and the domain used to flag suspect values on insert. The catalog ships with the package and seeds the variables table when a database is created. This page is built from the same file, so it always matches the installed version.

Variables are grouped by discipline and, within it, by theme. The domain uses the interval notation of plans.databases: [ and ] include the bound, ( and ) exclude it, an empty bound is unbounded, and U separates the bounds and joins intervals, so [0U) reads as zero or more. Categorical results, such as positive and negative tests, are stored as integer codes whose meaning is explained by the spec.

Climatology#

Code	Name	Alias	Symbol	Units	Type	Domain	Theme	Category
`CLM000`	surface air relative humidity	`RHAS`	\(\phi\)	`-`	`real`	`[0U1]`	Climatology	ratio
`CLM001`	surface air temperature	`TAS`	\(T\)	`degC`	`real`	`(U)`	Climatology	level
`CLM002`	standard surface air temperature	`TASS`	\(T\)	`K`	`real`	`[0U)`	Climatology	level
`CLM003`	dew point temperature	`TDP`	\(T_{\text{d}}\)	`degC`	`real`	`(U)`	Climatology	level
`CLM004`	land surface temperature	`LST`	\(T_{\text{land}}\)	`K`	`real`	`[0U)`	Climatology	level
`CLM005`	scalar wind speed	`WSS`	\(W\)	`m/s`	`real`	`[0U)`	Climatology	flow
`CLM006`	scalar wind gust speed	`WGS`	\(W_{G}\)	`m/s`	`real`	`[0U)`	Climatology	flow
`CLM007`	wind speed direction	`WSD`	\(W_{\theta}\)	`deg`	`real`	`[0U360]`	Climatology	level
`CLM008`	surface atmospheric pressure	`APS`	\(P_{\text{atm}}\)	`kPa`	`real`	`[0U)`	Climatology	level
`CLM009`	sunshine duration	`TSUN`	\(t_{\text{sun}}\)	`h`	`real`	`[0U)`	Climatology	level
`CLM011`	piché evaporation	`EVP`	\(E_{\text{Piché}}\)	`mm/(dt)`	`real`	`[0U)`	Climatology	flow
`CLM012`	solar radiation	`SR`	\(R_s\)	`kJ/m^2`	`real`	`[0U)`	Climatology	level
`CLM013`	solar irradiance	`SI`	\(R_s\)	`W/m^2`	`real`	`[0U)`	Climatology	flow
`CLM100`	precipitation	`PPT`	\(P\)	`mm/(dt)`	`real`	`[0U)`	Climatology	flow
`CLM101`	potential evapotranspiration	`PET`	\(E_{\text{p}}\)	`mm/(dt)`	`real`	`[0U)`	Climatology	flow

Geospatial#

Code	Name	Alias	Symbol	Units	Type	Domain	Theme	Category
`RSE001`	blue reflectance	`B`	\(B\)	`-`	`real`	`[0U1]`	Reflectance Bands	ratio
`RSE002`	green reflectance	`G`	\(G\)	`-`	`real`	`[0U1]`	Reflectance Bands	ratio
`RSE003`	red reflectance	`R`	\(R\)	`-`	`real`	`[0U1]`	Reflectance Bands	ratio
`RSE004`	near-infrared reflectance	`NIR`	\(NIR\)	`-`	`real`	`[0U1]`	Reflectance Bands	ratio
`RSE005`	red-edge reflectance	`RE`	\(RE\)	`-`	`real`	`[0U1]`	Reflectance Bands	ratio
`RSE006`	shortwave infrared reflectance	`SIR`	\(SIR\)	`-`	`real`	`[0U1]`	Reflectance Bands	ratio
`RSE007`	thermal infrared brightness temperature	`TIR`	\(T_B\)	`K`	`real`	`[200U360]`	Reflectance Bands	level
`RSE100`	x-band radar backscatter	`X-SAR`	\(\sigma^0_X\)	`dB`	`real`	`(U)`	Reflectance Bands	level
`RSE101`	c-band radar backscatter	`CSAR`	\(\sigma^0_C\)	`dB`	`real`	`(U)`	Reflectance Bands	level
`RSE102`	l-band radar backscatter	`LSAR`	\(\sigma^0_L\)	`dB`	`real`	`(U)`	Reflectance Bands	level
`RSE103`	p-band radar backscatter	`PSAR`	\(\sigma^0_P\)	`dB`	`real`	`(U)`	Reflectance Bands	level
`RSV001`	simple ratio vegetation index	`SRVI`	\(SR\)	`-`	`real`	`[0U)`	Spectral Vegetation Indices	ratio
`RSV002`	normalized difference vegetation index	`NDVI`	\(NDVI\)	`-`	`real`	`[-1U1]`	Spectral Vegetation Indices	ratio
`RSV003`	soil-adjusted vegetation index	`SAVI`	\(SAVI\)	`-`	`real`	`[-1U1]`	Spectral Vegetation Indices	ratio
`RSV004`	modified soil-adjusted vegetation index	`MSAVI`	\(MSAVI\)	`-`	`real`	`[-1U1]`	Spectral Vegetation Indices	ratio
`RSV005`	enhanced vegetation index	`EVI`	\(EVI\)	`-`	`real`	`[-1U1]`	Spectral Vegetation Indices	ratio
`RSV006`	red-edge normalized difference vegetation index	`NDRE`	\(NDRE\)	`-`	`real`	`[-1U1]`	Spectral Vegetation Indices	ratio
`RSV007`	chlorophyll index red-edge	`CIre`	\(CI_{re}\)	`-`	`real`	`[0U)`	Spectral Vegetation Indices	ratio
`RSV009`	normalized difference water vegetation index	`NDWI-V`	\(NDWI_V\)	`-`	`real`	`[-1U1]`	Spectral Vegetation Indices	ratio
`RSV010`	vegetation health index	`VHI`	\(VHI\)	`-`	`real`	`[0U100]`	Spectral Vegetation Indices	ratio
`RSV011`	temperature condition index	`TCI`	\(TCI\)	`-`	`real`	`[0U100]`	Spectral Vegetation Indices	ratio
`RSV012`	vegetation condition index	`VCI`	\(VCI\)	`-`	`real`	`[0U100]`	Spectral Vegetation Indices	ratio
`RSW001`	normalized difference water body index	`NDWI`	\(NDWI\)	`-`	`real`	`[-1U1]`	Spectral Water Indices	ratio
`RSW002`	normalized difference water body index modified	`MNDWI`	\(MNDWI\)	`-`	`real`	`[-1U1]`	Spectral Water Indices	ratio

Hydrology#

Code	Name	Alias	Symbol	Units	Type	Domain	Theme	Category
`HYD100`	rainfall	`RAIN`	\(P\)	`mm/(dt)`	`real`	`[0U)`	Hydrology	flow
`HYD200`	water level	`H`	\(h\)	`cm`	`real`	`(U)`	Hydrology	level
`HYD201`	rating curve coefficient	`HA`	\(a\)	`m^{3}/s`	`real`	`[0U)`	Hydrology	parameter
`HYD202`	rating curve exponent	`HB`	\(b\)	`-`	`real`	`[0U)`	Hydrology	parameter
`HYD203`	zero-flow stage	`H0`	\(h_0\)	`cm`	`real`	`(U)`	Hydrology	parameter
`HYD210`	streamflow	`F`	\(Q\)	`m^{3}/(dt)`	`real`	`(U)`	Hydrology	flow
`HYD211`	standard streamflow	`FS`	\(Q\)	`m^{3}/s`	`real`	`(U)`	Hydrology	flow
`HYD212`	drainage area	`A`	\(A_d\)	`km^{2}`	`real`	`[0U)`	Hydrology	boundary
`HYD213`	specific streamflow	`Q`	\(Q\)	`mm/(dt)`	`real`	`(U)`	Hydrology	flow

Water Quality#

Code	Name	Alias	Symbol	Units	Type	Domain	Theme	Category
`WQB001`	pseudomonas monteilii	`pmon`	\(P. mon.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB002`	enterobacter hormaechei	`ehor`	\(E. hor.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB003`	pseudomonas putida	`pput`	\(P. put.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB004`	stenotrophomonas maltophilia	`smal`	\(S. mal.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB005`	siccibacter turicensis	`stur`	\(S. tur.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB006`	empedobacter falsenii	`efal`	\(E. fal.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB007`	pseudomonas protegens	`ppro`	\(P. pro.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB008`	antibiogram results for amikacin	`antibio_akc`	\(AKC\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB009`	antibiogram results for gentamicin	`antibio_gmc`	\(GMC\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB010`	antibiogram results for tigecycline	`antibio_tgc`	\(TGC\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB011`	antibiogram results for sulfamethoxazole-trimethoprim	`antibio_sxt`	\(SXT\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB012`	antibiogram results for ciprofloxacin	`antibio_cip`	\(CIP\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB013`	antibiogram results for meropenem	`antibio_mem`	\(MEM\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB014`	antibiogram results for amoxicillin-clavulanic acid	`antibio_amc`	\(AMC\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB015`	antibiogram results for piperacillin-tazobactam	`antibio_ptz`	\(PTZ\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB016`	antibiogram results for cefepime	`antibio_cep`	\(CEP\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB017`	antibiogram results for cefotaxime	`antibio_ctx`	\(CTX\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB018`	antibiogram results for ceftazidime	`antibio_caz`	\(CAZ\)	`-`	`integer`	`[1U3]`	Microbiology	level
`WQB019`	carbapenemase testing for blakpc	`carbap_blaKPC`	\(blaKPC\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB020`	carbapenemase testing for blandm	`carbap_blaNDM`	\(blaNDM\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB021`	carbapenemase testing for blaimp	`carbap_blaIMP`	\(blaIMP\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB022`	carbapenemase testing for blavim	`carbap_blaVIM`	\(blaVIM\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB023`	carbapenemase testing for blages	`carbap_blaGES`	\(blaGES\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB024`	carbapenemase testing for blaoxa-48	`carbap_blaOXA-48`	\(blaOXA-48\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB025`	total coliforms	`tcoli`	\(T. coli.\)	`MPN/100 mL`	`real`	`[0U)`	Microbiology	level
`WQB026`	escherichia coli	`ecoli`	\(E. coli.\)	`MPN/100 mL`	`real`	`[0U)`	Microbiology	level
`WQB027`	norovirus gi	`noro1`	\(Noro 1\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB028`	norovirus gii	`noro2`	\(Noro 2\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB029`	sars-cov-2	`sarscov2`	\(SARS-CoV-2\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB030`	hepatitis a	`hav`	\(HAV\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB031`	hepatitis e	`hev`	\(HEV\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB032`	daphnia magna	`daphnia`	\(D. magna\)	`-`	`integer`	`(U)`	Microbiology	level
`WQB033`	pseudomonas koreensis	`pkor`	\(P. kor.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQB034`	klebsiella pneumoniae	`kpneu`	\(K. pneu.\)	`-`	`integer`	`[0U1]`	Microbiology	level
`WQE001`	yield of phytoplankton	`yielda`	\(Yield_A\)	`RFU`	`real`	`[0U)`	Ecology	level
`WQE002`	yield of cyanobacteria	`yieldc`	\(Yield_C\)	`RFU`	`real`	`[0U)`	Ecology	level
`WQG001`	swimmability	`swim`	\(Swimm.\)	`-`	`integer`	`(U)`	Management	level
`WQG002`	number of parameters framed as class 1	`classe1_n`	\(Class 1\)	`count`	`integer`	`[0U)`	Management	level
`WQG003`	number of parameters framed as class 2	`classe2_n`	\(Class 2\)	`count`	`integer`	`[0U)`	Management	level
`WQG004`	number of parameters framed as class 3	`classe3_n`	\(Class 3\)	`count`	`integer`	`[0U)`	Management	level
`WQG005`	number of parameters framed as class 4	`classe34_n`	\(Class 3-4\)	`count`	`integer`	`[0U)`	Management	level
`WQM001`	silver	`ag`	\(Ag\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM002`	aluminum	`al`	\(Al\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM003`	arsenic	`as`	\(As\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM004`	boron	`b`	\(B\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM005`	barium	`ba`	\(Ba\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM006`	bismuth	`bi`	\(Bi\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM007`	calcium (metals)	`ca_met`	\(Ca\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM008`	cobalt	`co`	\(Co\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM009`	chromium	`cr`	\(Cr\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM010`	copper	`cu`	\(Cu\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM011`	iron	`fe`	\(Fe\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM012`	mercury	`hg`	\(Hg\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM013`	indium	`in`	\(In\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM014`	potassium (metals)	`k_met`	\(K\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM015`	lithium (metals)	`li_met`	\(Li\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM016`	magnesium (metals)	`mg_met`	\(Mg\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM017`	manganese	`mn`	\(Mn\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM018`	sodium (metals)	`na_met`	\(Na\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM019`	nickel	`ni`	\(Ni\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM020`	lead	`pb`	\(Pb\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM021`	tin	`sn`	\(Sn\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM022`	strontium	`sr`	\(Sr\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQM023`	zinc	`zn`	\(Zn\)	`mg/L`	`real`	`[0U)`	Metals	level
`WQP001`	ph	`ph`	\(pH\)	`-`	`real`	`[0U14]`	Physical-Chemistry	level
`WQP002`	electrical conductivity	`ec`	\(EC\)	`uS/cm`	`real`	`[0U)`	Physical-Chemistry	level
`WQP003`	turbidity	`turbidity`	\(Turbidity\)	`NTU`	`real`	`[0U)`	Physical-Chemistry	level
`WQP004`	apparent color	`colora`	\(App. Color\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP005`	true color	`colort`	\(True Color\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP006`	settleable solids	`ss`	\(SS\)	`mL/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP007`	total suspended solids	`tss`	\(TSS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP008`	fixed suspended solids	`fss`	\(FSS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP009`	volatile suspended solids	`vss`	\(VSS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP010`	total solids	`ts`	\(TS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP011`	total fixed solids	`tfs`	\(TFS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP012`	total volatile solids	`tvs`	\(TVS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP013`	total dissolved solids	`tds`	\(TDS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP014`	dissolved fixed solids	`dfs`	\(DFS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP015`	dissolved volatile solids	`dvs`	\(DVS\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP016`	total phosphorus	`tp`	\(TP\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP017`	dissolved carbon	`dc`	\(DC\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP018`	dissolved organic carbon	`doc`	\(DOC\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP019`	dissolved inorganic carbon	`dic`	\(DIC\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP020`	chemical oxygen demand	`cod`	\(COD\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP021`	fluoride	`fluoride`	\(F^-\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP022`	chloride	`chloride`	\(Cl^-\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP023`	nitrite	`no2`	\(NO_2\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP024`	nitrate	`no3`	\(NO_3\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP025`	phosphate	`po4`	\(PO_4\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP026`	sulfate	`so4`	\(SO_4\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP027`	lithium (physical-chemistry)	`li_pch`	\(Li\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP028`	sodium (physical-chemistry)	`na_pch`	\(Na\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP029`	ammonia	`nh3`	\(NH_3\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP030`	ammonium	`nh4`	\(NH_4\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP031`	potassium (physical-chemistry)	`k_pch`	\(K\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP032`	magnesium (physical-chemistry)	`mg_pch`	\(Mg\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level
`WQP033`	calcium (physical-chemistry)	`ca_pch`	\(Ca\)	`mg/L`	`real`	`[0U)`	Physical-Chemistry	level

Water Resources#

Code	Name	Alias	Symbol	Units	Type	Domain	Theme	Category
`WRD001`	standardized precipitation index	`SPI`	\(SPI\)	`-`	`real`	`(U)`	Drought Indices	ratio
`WRD002`	aggregate drought index	`ADI`	\(ADI\)	`-`	`real`	`(U)`	Drought Indices	ratio
`WRD003`	standardized streamflow index	`SSFI`	\(SSFI\)	`-`	`real`	`(U)`	Drought Indices	ratio
`WRD004`	standardized runoff index	`SRI`	\(SRI\)	`-`	`real`	`(U)`	Drought Indices	ratio
`WRD005`	standardized precipitation evapotranspiration index	`SPEI`	\(SPEI\)	`-`	`real`	`(U)`	Drought Indices	ratio
`WRD006`	composite drought index	`CDI`	\(CDI\)	`-`	`real`	`[0U)`	Drought Indices	ratio
`WRD007`	soil water deficit index	`SWDI`	\(SWDI\)	`-`	`real`	`(U10]`	Drought Indices	ratio
`WRD008`	evaporative stress index	`ESI`	\(ESI\)	`-`	`real`	`(U)`	Drought Indices	ratio