loadRSM: loadRSM

In troyhill/RSM: Post-processing tools for Regional Simulation Model output

loadRSM

Description

pulls stage data from an RSM output netCDF file

Usage

loadRSM(
  ncdf_address,
  variable = "ComputedHead",
  subtractTopo = TRUE,
  divideByArea = FALSE
)

Arguments

ncdf_address	address of the netCDF file
variable	name of variable to extract from the netCDF
subtractTopo	should topography be subtracted? i.e., should water depths ('subtractTopo = TRUE'; units = feet relative to soil surface) or stages ('subtractTopo = FALSE'; units = feet NGVD29) be returned?
divideByArea	should quantity be divided by cell area? Useful for volumetric quantities: rainfall/ET. Note that this assumes congruent units in both quantities, e.g., rainfall (ft3) / area (ft2) = rainfall (ft)

Value

a list with class 'rsm' containing three elements: (1) a vector of dates in the time series, (2) data matrix (not explicitly geospatial data), (3) a cell map that links data to cells in the RSM mesh, and (4) the name of the variable extracted from the netCDF file (a metadata attribute used by other functions)

See Also

[RSM::getDEM()]

Examples

## Not run: 
addr <- "G:/data/models/COP/ALTQ/globalmonitors.nc"
altq <- loadRSM(ncdf_address = addr, 
                variable     = 'ComputedHead', 
                subtractTopo = TRUE)

## End(Not run)

troyhill/RSM documentation built on Aug. 23, 2022, 2:40 p.m.