om_get_rundata: Get OM Model Data

In HARPgroup/hydro-tools: Data processing and accessors for VAHydro

Get OM Model Data

Description

Retrieve model results (run data) from the VA Hydro server for a particular model and run ID (scenario ID).

Usage

om_get_rundata(
  elid,
  runid,
  site = "http://deq2.bse.vt.edu",
  cached = FALSE,
  hydrowarmup = TRUE,
  cleanup = FALSE
)

Arguments

elid	integer OM element connection ID e.g. the original OM model ID
runid	integer run id representing the scenario. Ask the modeling team for scenario IDs if you are unsure otherwise see the WSPA Shiny Dashboard for more information
site	URL of OM server, typically established in WSPA config files
cached	boolean - if TRUE will use recently stored local copy
hydrowarmup	boolean - if TRUE will trim beginning of model time frame to account for potential model warm up as water routes downstream from the headwaters and operational rules engage
cleanup	Logical. Should the function delete the log file create for the cached argument? If this is TRUE, the .log files will be deleted after download from OM server

Details

A wrapper of hydrotools::fn_get_runfile(). This function returns the results in a zoo (see zoo::zoo()) that has the timestamp as the index. See hydrotools::fn_get_runfile() for more details.

Value

data.frame of model results

Examples

#om_get_rundata(72446, 600, site=omsite)

HARPgroup/hydro-tools documentation built on July 4, 2025, 11:05 a.m.