Merge pull request #74 from UW-Hydro/feature/sample_datasets

add rasm and pnw sample configurations using git lfs

Author: Joe Hamman

.gitattributes

@@ -0,0 +1,2 @@
+*.nc filter=lfs diff=lfs merge=lfs -text
+*.csv filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -21,6 +21,7 @@ rvic.egg-info
 # Configuration Files #
 #######################
 *cfg
+samples/cases/*
 
 # Packages #
 ############

config/rvic_convert_example.cfg

@@ -19,13 +19,10 @@ VERBOSE:True
 #-- ====================================== --#
 
 #--case run directory (char)  --#
-CASE_DIR : /path/to/%(CASEID)s/
-
-#--RVIC tag (char)  --#
-RVIC_TAG : 1.0beta
+CASE_DIR : ./samples/cases/%(CASEID)s/
 
 #--case description (char)  --#
-CASEID : testing
+CASEID : sample_rasm_convolution
 
 #--case description (char)  --#
 CASESTR : a simple test run
@@ -39,7 +36,7 @@ CALENDAR : noleap
 RUN_TYPE : drystart
 
 #--Run start date (yyyy-mm-dd-hh). Only used for startup and drystart runs (char)  --#
-RUN_STARTDATE : 1989-01-01-01
+RUN_STARTDATE : 1979-09-01-00
 
 #-- ====================================== --#
 
@@ -106,7 +103,7 @@ RVICHIST_OUTTYPE: grid, array
 RVICHIST_NCFORM: NETCDF4_CLASSIC, NETCDF4_CLASSIC
 
 #-- Output parameter file compression options --#
-# Descriptions of these options can be found in 
+# Descriptions of these options can be found in
 RVICHIST_NETCDF_ZLIB: False
 RVICHIST_NETCDF_COMPLEVEL: 4
 RVICHIST_NETCDF_SIGFIGS: None
@@ -119,7 +116,7 @@ RVICHIST_UNITS: m3/s, m3/s
 
 [DOMAIN]
 #--rof domain file (char) -->
-FILE_NAME: /path/to/domain.lnd.nc
+FILE_NAME: ./samples/domains/domain.lnd.wr50a_ar9v4.100920.nc
 LONGITUDE_VAR: xc
 LATITUDE_VAR: yc
 AREA_VAR: area
@@ -136,24 +133,24 @@ FILE_NAME: None
 
 [PARAM_FILE]
 #--rvic parameter file file (char) -->
-FILE_NAME:/path/to/rvic.prm.nc
+FILE_NAME: ./samples/cases/sample_rasm_parameters/params/sample_rasm_parameters.rvic.prm.wr50a.20151024.nc
 
 #-- ====================================== --#
 [INPUT_FORCINGS]
-DATL_PATH:/path/to/
+DATL_PATH: ./samples/forcings/
 
 # prfix.$YYYY[-$MM-[$DD[-$HH]]].nc
-DATL_FILE: inputs.lnd.h.$YYYY-$MM.nc
+DATL_FILE: rasm_sample_runoff.nc
 
 #--variable names (char) -->
 TIME_VAR: time
-LATITUDE_VAR: lat
-DATL_LIQ_FLDS: l2x_Flrl_rofliq
+LATITUDE_VAR: yc
+DATL_LIQ_FLDS: Runoff, Baseflow
 
 #--start date, date formate YYYY[-MM[-DD]] (char) -->
-START:1989-01
+START:
 
 #--end date, date formate YYYY[-MM[-DD]] (char) -->
-END:1989-12
+END:
 
 #-- ====================================== --#

config/rvic_convolution_example.cfg renamed to samples/configs/rvic.convolution.rasm.cfg

@@ -0,0 +1,133 @@
+#-- ========================================================================== --#
+#--                                                                            --#
+#--       This RVIC namelist contains options and paths for the                --#
+#--       development of the RVIC parameter file.                              --#
+#--                                                                            --#
+#--                                                                            --#
+#-- ========================================================================== --#
+
+# Note:  namelist is parsed by the python ConfigParser module.  %(Interploation) is
+#        supported inside [sections] only.
+
+[OPTIONS]
+#-- ====================================== --#
+#--Level to log output at (char) --#
+# valid values: DEBUG, INFO, WARNING, ERROR, CRITICAL
+LOG_LEVEL:DEBUG
+
+#--Print output to console in addition to the log file (bool) --#
+# valid values: True, False
+VERBOSE:True
+
+#--Delete temporary files, only used if REMAP=True (bool) --#
+# valid values: True, False
+CLEAN: False
+
+#--case description (char)  --#
+CASEID: sample_pnw_parameters
+
+#--routing domain grid shortname (char)  --#
+GRIDID: pnw
+
+#--case run directory (char)  --#
+CASE_DIR: ./samples/cases/%(CASEID)s
+
+#--Directory to use for temporary read/write operations (char)  --#
+TEMP_DIR:%(CASE_DIR)s/temp/
+
+#--Remap Unit Hydrographs from [ROUTING] grid to [DOMAIN] grid (bool)  --#
+# valid values: True, False
+REMAP:False
+
+#--Aggregate all [POUR_POINTS] inside each [DOMAIN] grid cell (bool)  --#
+# This should only be used when routing to coastal grid cells for CESM
+AGGREGATE:False
+
+#--Size of pad to add to aggregated files prior to remapping (int) --#
+AGG_PAD:25
+
+#-- Output parameter file format (char) --#
+# Valid Values: NETCDF3_CLASSIC, NETCDF3_64BIT, NETCDF4_CLASSIC, and NETCDF4
+# For use with CESM, NETCDF3_CLASSIC is recommended.
+NETCDF_FORMAT:NETCDF3_CLASSIC
+
+#-- Output parameter file compression options --#
+# Descriptions of these options can be found in
+NETCDF_ZLIB: False
+NETCDF_COMPLEVEL: 4
+NETCDF_SIGFIGS: None
+
+#-- Length of unit hydrograph subset in days (int) --#
+SUBSET_DAYS:10
+
+#-- Constrain the final unit hydrographs sum to be less than or equal to the domain fractions --#
+# True when routing to coastal grid cells, else False
+CONSTRAIN_FRACTIONS: False
+
+SEARCH_FOR_CHANNEL: True
+
+#-- ====================================== --#
+
+[POUR_POINTS]
+#-- ====================================== --#
+#-- Path to Pour Points File (char) --#
+# A comma separated file of outlets to route to [lons, lats] - one coordinate pair per line (order not important)
+# May optionally include a column [names] - which will (if not aggregating) be included in param file
+FILE_NAME: ./samples/pour_points/columbia_sample_pour_points.csv
+
+#-- ====================================== --#
+
+[UH_BOX]
+#-- ====================================== --#
+#-- Path to UH Box File (char) --#
+# This defines the unit hydrograph to rout flow to the edge of each grid cell.
+# A comma separated file of [time in seconds, unit hydrograph ordinate] - one timestep per line
+# The timestep should be 1hr (3600 sec) or less.
+FILE_NAME: ./samples/uh_box/UH_Columbia_hourly.csv
+
+#-- Number of Header lines to ignore in [UH_BOX]FILE_NAME (INT) --#
+HEADER_LINES = 1
+#-- ====================================== --#
+
+[ROUTING]
+#-- ====================================== --#
+#-- Path to routing inputs netcdf (char) --#
+FILE_NAME: ./samples/flow_directions/pnw.RVIC.input_20140218.nc
+
+#-- netCDF Variable Names --#
+LONGITUDE_VAR: lon
+LATITUDE_VAR: lat
+FLOW_DISTANCE_VAR: Flow_Distance
+FLOW_DIRECTION_VAR: Flow_Direction
+BASIN_ID_VAR: Basin_ID
+SOURCE_AREA_VAR: Source_Area
+
+#-- Velocity and diffusion  --#
+# The velocity and diffusion parameters may either be specified as variables in
+# the routing netcdf (char) or as a single value (float or int)
+VELOCITY: 1
+DIFFUSION: 2000
+
+#-- Output Interval  --#
+# Timestep of output unit hydrographs.  Must be a multiple of the timestep in the UH_BOX
+OUTPUT_INTERVAL:86400
+
+#-- Maximum time for runoff to reach outlet (days)  --#
+BASIN_FLOWDAYS:50
+
+#-- Maximum time for runoff to pass through a grid cell (days)  --#
+CELL_FLOWDAYS:2
+#-- ====================================== --#
+
+[DOMAIN]
+#-- ====================================== --#
+#-- Path to cesm complient domain file (char) --#
+FILE_NAME: ./samples/domains/domain.lnd.bpa304.20140311.nc
+
+#-- netCDF Variable Names --#
+LONGITUDE_VAR: lon
+LATITUDE_VAR: lat
+LAND_MASK_VAR: mask
+FRACTION_VAR: frac
+AREA_VAR: area
+#-- ====================================== --#