Difference between revisions of "Document RGLM tools"
From Age of Water
(Added PropertyValue: Expertise = physical limnology) |
|||
| Line 1: | Line 1: | ||
[[Category:Task]] | [[Category:Task]] | ||
| − | |||
= Overview = | = Overview = | ||
| − | + | GLEON and CIDA (center for data analytics) at the USGS have developed two software packages written in the R statistical language to interact with GLM | |
| + | *GLM: lake model | ||
| + | *GLMr: package designed to support scripted interactions with [[GLM_Software]]. | ||
| + | *glmtools: tools to reproducible model results, adjust parameter files, and plot visualizations | ||
| + | |||
| + | == Why R? == | ||
| + | *Performace: stable, light and fast | ||
| + | *Support network | ||
| + | **documentation, community, developers | ||
| + | *Reproducibility | ||
| + | **anyone anywhere can reproduce results | ||
| + | **enables dissemination - this presentation is a .Rmd file! | ||
| + | *Versatility: unified solution to almost any numerical problem, graphical capabilities | ||
| + | *Testing: integrated “R package” testing limits bugs | ||
| + | |||
| + | == Package Downloads == | ||
| + | Download R packages from GRAN (Geological Survey R Archive Network) | ||
| + | *[http://owi.usgs.gov/R/gran.html GRAN] | ||
| + | |||
| + | == glmtools Functions (as of v0.2.5.2) == | ||
| + | Maintainer: Jordan S Read <br> | ||
| + | Authors: Jordan S Read, Luke A Winslow<br> | ||
| + | {| {{table}} | ||
| + | | align="center" style="background:#f0f0f0;"|'''Function''' | ||
| + | | align="center" style="background:#f0f0f0;"|'''Title''' | ||
| + | |- | ||
| + | | compare_to_field||compare metric for GLM vs field observations | ||
| + | |- | ||
| + | | get_evaporation||get evaporation from GLM simulation | ||
| + | |- | ||
| + | | get_hypsography||retrieve hypsography information | ||
| + | |- | ||
| + | | get_ice||get ice depth from GLM simulation | ||
| + | |- | ||
| + | | get_nml_value||gets a nml value according to an arg_name | ||
| + | |- | ||
| + | | get_surface_height||get surface height from GLM simulation | ||
| + | |- | ||
| + | | get_temp||get water temperatures from a GLM simulation | ||
| + | |- | ||
| + | | get_wind||get wind speed from GLM simulation | ||
| + | |- | ||
| + | | model_diagnostics||run diagnostics on model results | ||
| + | |- | ||
| + | | plot_temp||plot water temperatures from a GLM simulation | ||
| + | |- | ||
| + | | read_field_obs||read in field data into a data.frame | ||
| + | |- | ||
| + | | read_nml||read in a GLM simulation *.nml file | ||
| + | |- | ||
| + | | resample_sim||get subset of time from a generic timeseries data.frame | ||
| + | |- | ||
| + | | resample_to_field||match GLM water temperatures with field observations | ||
| + | |- | ||
| + | | set_nml||sets values in nml object | ||
| + | |- | ||
| + | | sim_metrics||get possible metrics for comparing GLM outputs to field | ||
| + | |- | ||
| + | | summarize_sim||creates GLM simulation summary outputs | ||
| + | |- | ||
| + | | validate_sim||run diagnostics on model results vs observations | ||
| + | |- | ||
| + | | write_nml||write GLM *.nml for a GLM simulation | ||
| + | |} | ||
<!-- Add any wiki Text above this Line --> | <!-- Add any wiki Text above this Line --> | ||
Revision as of 18:16, 23 April 2015
Overview
GLEON and CIDA (center for data analytics) at the USGS have developed two software packages written in the R statistical language to interact with GLM
- GLM: lake model
- GLMr: package designed to support scripted interactions with GLM_Software.
- glmtools: tools to reproducible model results, adjust parameter files, and plot visualizations
Why R?
- Performace: stable, light and fast
- Support network
- documentation, community, developers
- Reproducibility
- anyone anywhere can reproduce results
- enables dissemination - this presentation is a .Rmd file!
- Versatility: unified solution to almost any numerical problem, graphical capabilities
- Testing: integrated “R package” testing limits bugs
Package Downloads
Download R packages from GRAN (Geological Survey R Archive Network)
glmtools Functions (as of v0.2.5.2)
Maintainer: Jordan S Read
Authors: Jordan S Read, Luke A Winslow
| Function | Title |
| compare_to_field | compare metric for GLM vs field observations |
| get_evaporation | get evaporation from GLM simulation |
| get_hypsography | retrieve hypsography information |
| get_ice | get ice depth from GLM simulation |
| get_nml_value | gets a nml value according to an arg_name |
| get_surface_height | get surface height from GLM simulation |
| get_temp | get water temperatures from a GLM simulation |
| get_wind | get wind speed from GLM simulation |
| model_diagnostics | run diagnostics on model results |
| plot_temp | plot water temperatures from a GLM simulation |
| read_field_obs | read in field data into a data.frame |
| read_nml | read in a GLM simulation *.nml file |
| resample_sim | get subset of time from a generic timeseries data.frame |
| resample_to_field | match GLM water temperatures with field observations |
| set_nml | sets values in nml object |
| sim_metrics | get possible metrics for comparing GLM outputs to field |
| summarize_sim | creates GLM simulation summary outputs |
| validate_sim | run diagnostics on model results vs observations |
| write_nml | write GLM *.nml for a GLM simulation |
