USGS-R / mda.lakes

Wisconsin Lake Modeling Aggregation
2 stars 11 forks source link

mda.lakes

Model Data Assimilation - Lakes

Build status

By: Jordan Read, Luke Winslow, Gretchen Hansen

This code base is part of the modeling effort for Wisconsin Lakes. Please reference our paper on this work.

Functionality

Just musing here...

Want to encapsulate as much of the whole WiLMA running process in one file as possible. A single model run could look like this

library(WiLMA) 

#Setup and run model
run_glm_chained(site_id='805400', path='~/run_dir')
#the above function writes all relevant information for that lake to the directory
# this includes grabbing the driver file and generating the NML file.
# then runs the model

#There could be different functions that run the model in different ways
run_glm(site_id='805400', path='~/run_dir')
#this does a non-chained run

####Important: Why not have a separate "setup" function
# That is challenging. We don't know if the user wants to do a chained run
# so we may not setup the ice data (or it is wasted setup because it is not used)
# So the key thing at this stage is having functions that setup the workspace
# as they need them and run the model as they need them, leaving the NCDF files around
# for later analysis.

#### Hmmm, how do the below functions know the lakeID? 
##    standardized metadata file?
#Once the model is run, calculated some habitat metrics
habitat_metrics = calculate_habitat_chained(path='~/run_dir')
habitat_metrics_krose = calculate_habitat_chained_krose(path='~/run_dir')

#Maybe compare to validation data
cal_val = run_compare_validation(run_path='~/run_dir')
plot_cal_val(run_path='~/run_dir')

Disclaimer

This software is in the public domain because it contains materials that originally came from the U.S. Geological Survey, an agency of the United States Department of Interior. For more information, see the official USGS copyright policy

Although this software program has been used by the U.S. Geological Survey (USGS), no warranty, expressed or implied, is made by the USGS or the U.S. Government as to the accuracy and functioning of the program and related program material nor shall the fact of distribution constitute any such warranty, and no responsibility is assumed by the USGS in connection therewith.

This software is provided "AS IS."