get_hypsography: retrieve hypsography information

In USGS-R/glmtools: Tools for working with the General Lake Model (GLM)

retrieve hypsography information

Description

Retrieves hypsography information from glm_nml object or file.
Hypsography is the relationship between depth and area of a lake. 'Depth' is referenced from the lake surface and downward values are positive in meters. Areas are in square meters.

Usage

get_hypsography(glm_nml, file)

Arguments

glm_nml	a nml (a list) for GLM config
file	a string with the path to the GLM glm.nml file

Value

glm_bth a data.frame with depths and areas

Author(s)

Jordan S. Read

See Also

read_nml, get_nml_value

Examples

sim_folder <- run_example_sim(verbose = FALSE)
nml_file <- file.path(sim_folder, 'glm3.nml')
glm_nml <- read_nml(nml_file)
get_hypsography(glm_nml)
get_hypsography(file = nml_file)

USGS-R/glmtools documentation built on March 26, 2024, 5:43 p.m.