|
| 1 | +# README.txt - Release Notes |
| 2 | +# |
| 3 | +# $Id$ |
| 4 | +#------------------------------------------------------------------------ |
| 5 | + |
| 6 | +August 15, 2000: VIC release 4.0.3 |
| 7 | + |
| 8 | +This release fixes a problem with the implementation of va_arg that |
| 9 | +causes run time errors on some systems. Previous releases of the code |
| 10 | +worked correctly on the LINUX and freeBSD systems where it was tested. |
| 11 | +However on some systems (including Sun Ultra-2s) character variables |
| 12 | +passed with va_arg are changed into integers so reading a character from |
| 13 | +the argument list does not produce the value sent to the routine. The |
| 14 | +character flags used by VIC to indicate if there is snow present and if |
| 15 | +the frozen soil algorithm has been activated have now been converted to |
| 16 | +integers, which should make the va_arg call work on all systems. |
| 17 | + |
| 18 | +Also fixed in this release was a check in dist_prec.c to see if it is |
| 19 | +still raining which actually used the memory address of the |
| 20 | +precipitation variable rather than the daily value in the check. |
| 21 | + |
| 22 | +MODIFIED FILES: |
| 23 | + read_atmos_data.c - Fixed input file time step check |
| 24 | + write_forcing_files.c - Added free statements for pointers |
| 25 | + calc_surf_energy_bal.c - Converted char flags to int |
| 26 | + dist_prec.c - Fixed logical statement error |
| 27 | + frozen_soil.c - Converted char flags to int |
| 28 | + func_surf_energy_bal.c - Converted char flags to int |
| 29 | + initialize_atmos.c - Added flag for output forcing |
| 30 | + vicNl.h - Converted char flags to int |
| 31 | + vicNl_def.h - Converted char flags to int |
| 32 | + |
| 33 | +July 19, 2000: VIC release 4.0.2 |
| 34 | + |
| 35 | +Two new pre-processor options have been added to VIC as well as minor |
| 36 | +modifications to two subroutines. |
| 37 | + |
| 38 | +If set to TRUE the NO_REWIND pre-processor option stops the VIC model from |
| 39 | +rewinding the soil and vegetation parameter input files for each new grid |
| 40 | +cell. This reduces run times but requires that all input files are in the |
| 41 | +same order as the soil parameter file. |
| 42 | + |
| 43 | +If set TRUE the OUTPUT_FORCE pre-processor option blocks off the main |
| 44 | +model and only reads the provided forcing files. Once VIC has estimated |
| 45 | +the missing forcing parameters the full forcing data set for the defined |
| 46 | +simulation period is output to a series of gridded forcing files. The |
| 47 | +gridded forcing files are written to the RESULTS directory defined in the |
| 48 | +global control file with the prefix "full_data_". The new files are in |
| 49 | +Binary or ASCII depending on the setting of BINARY_OUTPUT. |
| 50 | + |
| 51 | +The error messages in get_global_param.c have been modified so that the |
| 52 | +correct file is referenced when telling the user to change values found in |
| 53 | +the model source code. |
| 54 | + |
| 55 | +In read_soilparam.c, the soil parameters are defined only if the current |
| 56 | +grid cell is run, otherwise the line in the file is skipped and soil_con |
| 57 | +is retruned without new data values. |
| 58 | + |
| 59 | +May 30, 2000: VIC release 4.0.1 |
| 60 | + |
| 61 | +Increased use of the released VIC model code has lead to the |
| 62 | +discovery of a couple of minor bugs. This release fixes those bugs as |
| 63 | +well as introducing a improved precipitation correction algorithm based on |
| 64 | +Yang et al. 1998. Unless you have encountered these problems or are |
| 65 | +trying to correct precipitation undercatch due to wind, in the VIC |
| 66 | +model, your results will not be impacted by these fixes. |
| 67 | + |
| 68 | +MODIFIED FILES: |
| 69 | + correct_precip.c - changed to WMO correction equation for |
| 70 | + NWS 8" standard gauge. |
| 71 | + full_energy.c - modified to handle WMO correction. |
| 72 | + initialize_atmos.c - modified to handle WMO correction. |
| 73 | + fixed error in estimating minimum daily |
| 74 | + temperature from sub-daily temperatures. |
| 75 | + make_in_and_outfiles.c - removed line that opened the state file |
| 76 | + again for each new grid cell. |
| 77 | + open_state_file.c - modified comments. |
| 78 | + put_data.c - modified to handle WMO correction. |
| 79 | + snow_utility.c - cleaned source code. |
| 80 | + solve_snow.c - modified to handle WMO correction. |
| 81 | + surface_fluxes.c - modified to handle WMO correction. |
| 82 | + vicNl.h - modified to handle WMO correction. |
| 83 | + vicNl_def.h - modified to handle WMO correction. |
| 84 | + |
| 85 | +REFERENCE: |
| 86 | + |
| 87 | + Yang, D., B. E. Goodison, J. R. Metcalfe, V. S. Golubev, R. |
| 88 | + Bates, T. Pangburn, and C. L. Hanson, Accuracy of NWS 8" Standard |
| 89 | + Nonrecording Precipitation Gauge: Results and Application of WMO |
| 90 | + Intercomparison, J. Atmos. Oceanic Tech., 15, 54-68, 1998. |
| 91 | + |
| 92 | + |
| 93 | +Date: May 16, 2000 |
| 94 | + |
| 95 | +From: Keith Cherkauer |
| 96 | + |
| 97 | +Topic: Release of VIC 4.0.0 |
| 98 | + |
| 99 | +The code for VIC release 4.0.0 has undergone several months of tests (as |
| 100 | +VIC release 3.3.0 Beta) and has now been deemed ready for release to the |
| 101 | +general public. This document is designed to provide information |
| 102 | +concerning changes in the model between the last release version (3.2.1) |
| 103 | +and the current version. |
| 104 | + |
| 105 | +There is no formal users manual, information about how to use the current |
| 106 | +version can be found at |
| 107 | +http://www.hydro.washington.edu/Lettenmaier/Models/VIC/VIChome.html. |
| 108 | +Information about the basic model design can be found in Liang, et al. |
| 109 | +(1994), while the rewrite of the source code as well as the addition of |
| 110 | +cold season processes is described in Cherkauer and Lettenmaier (1999). |
| 111 | + |
| 112 | +The VIC macroscale hydrologic model was developed as a research tool. As |
| 113 | +such it is the users responsibility to verify that it is working correctly |
| 114 | +when applied to new situations. When using the VIC model reference should |
| 115 | +be made to Liang, et al. (1994) and Cherkauer and Lettenmaier (1999) as |
| 116 | +well as an acknowledgment that the code was received from the University |
| 117 | +of Washington. Other important papers relating to the development of the |
| 118 | +VIC model are included on the home page and in the source code. |
| 119 | + |
| 120 | +Possible bugs in the code should be reported to |
| 121 | +vicadmin@hydro.washington.edu. ALWAYS CHECK YOUR INPUT FILES! Most |
| 122 | +"bugs" are actually caused by trying to run the model with bad parameters |
| 123 | +or forcing data. The VIC model will run limited checks to find common |
| 124 | +major errors but in most cases it will attempt to run with the bad values. |
| 125 | +If after checking all of your input data you still believe you have found |
| 126 | +a bug in the model, send an e-mail including the complete output from the |
| 127 | +model as well as a description of the problem and the files necessary to |
| 128 | +run the model to recreate the code (if files are large please put a |
| 129 | +compressed tar file in |
| 130 | +ftp://ftp.ce.washington.edu/pub/HYDRO/vicadmin/TEMP). Outdated and |
| 131 | +modified versions of the code are the responsibility of the user to debug. |
| 132 | +Modifications made to the code, which may improve the general model |
| 133 | +performance, may be submitted to vicadmin@hydro.washington.edu for |
| 134 | +possible inclusion in future versions of the code. |
| 135 | + |
| 136 | +VIC release 4.0.0 represents a major change to the source code from |
| 137 | +version 3.2.1. It is strongly recommended that if you were using version |
| 138 | +3.2.1 or earlier versions that you update with a complete copy of the new |
| 139 | +code. |
| 140 | + |
| 141 | +Major changes from release version 3.2.1 to 4.0.0: |
| 142 | + |
| 143 | +- Radiation Estimation Update: The routines to estimate shortwave and |
| 144 | +longwave radiation as well as vapor pressure from daily minimum and |
| 145 | +maximum temperature and precipitation have been updated to correspond to |
| 146 | +the algorithm described by Thornton and Running (1999). These routines |
| 147 | +provide significantly improved radiation estimates especially in regions |
| 148 | +outside the continental United States. |
| 149 | + |
| 150 | +- Model Core Update: The core of the VIC model was rewritten so that all |
| 151 | +modes of the model (water balance, energy balance, etc.) make use of the |
| 152 | +same model code. This makes it easier to modify the model and have |
| 153 | +modifications apply to sll modes, it also allows the model to run with new |
| 154 | +combinations of algorithms (i.e. full energy balance mode with the finite |
| 155 | +difference ground heat flux solution). |
| 156 | + |
| 157 | +- Soil Moisture Transport Update: The frozen and thawed sub-layers added |
| 158 | +to the model for the original frozen soil algorithm have been removed. |
| 159 | +This makes the soil drainage routine cleaner and faster. Frozen soils now |
| 160 | +estimate full layer ice contents from the ice content at each soil thermal |
| 161 | +node. Without being confined by sub-layers, the frozen soil algorithm can |
| 162 | +now be applied to regions of permafrost. |
| 163 | + |
| 164 | +- Forcing File Control Added: Version 4.0.0 moves controls of the forcing |
| 165 | +file format and data types into the global control file. The model can |
| 166 | +now handle most ASCII column and short int Binary files without writing |
| 167 | +new subroutines and recompiling the source code. |
| 168 | + |
| 169 | +- Pre-processor Options Added: There are now more option flags in the |
| 170 | +source code headers to control which parts of the model are in fact |
| 171 | +compiled. This allows the model functionality to be adjusted without the |
| 172 | +addition of computationally intensive conditional switching statements. |
| 173 | + |
| 174 | +- Model State File: With the release of version 4.0.0 separate snow and |
| 175 | +soil initialization files have been combined into a single model state |
| 176 | +file. The state file can be created outside the model for starting |
| 177 | +simulations with prescribed initial conditions, or the model state can be |
| 178 | +saved by VIC at a specified date. Note that currently there will be small |
| 179 | +differences between a full and a warm started simulation because radiation |
| 180 | +and vapor pressure are estimated using forcing data from the simulation |
| 181 | +period, not from the full dataset included in the forcing file. It also |
| 182 | +does not store wet and dry fraction information, when running with |
| 183 | +distributed precipitation the model is restarted using average soil |
| 184 | +conditions. |
| 185 | + |
| 186 | +References: |
| 187 | + |
| 188 | +Liang, X., D. P. Lettenmaier, E. F. Wood, and S. J. Burges, A simple |
| 189 | +hydrologically based model of land surface water and energy fluxes for |
| 190 | +GSMs, J. Geophys. Res., 99(D7), 14,415-14,428, 1994. |
| 191 | + |
| 192 | +Cherkauer, K. A., and D. P. Lettenmaier, Hydrologic effects of frozen |
| 193 | +soils in the upper Mississippi River basin, J. Geophys. Res., 104(D16), |
| 194 | +19,599-19,610, 1999. |
| 195 | + |
| 196 | +Thornton, P.E. and S.W. Running, An improved algorithm for estimating |
| 197 | +incident daily solar radiation from measurements of temperature, humidity, |
| 198 | +and precipitation, Ag. For. Met., 93, 211-228, 1999. |
| 199 | + |
| 200 | +File List: |
| 201 | + |
| 202 | +CalcAerodynamic.c modify_Ksat.c |
| 203 | +Makefile mtclim42_vic.c |
| 204 | +SnowPackEnergyBalance.c mtclim42_vic.h |
| 205 | +StabilityCorrection.c mtclim42_wrapper.c |
| 206 | +alloc_atmos.c nrerror.c |
| 207 | +arno_evap.c open_debug.c |
| 208 | +calc_air_temperature.c open_file.c |
| 209 | +calc_cloud_cover_fraction.c open_state_file.c |
| 210 | +calc_longwave.c penman.c |
| 211 | +calc_rainonly.c prepare_full_energy.c |
| 212 | +calc_root_fraction.c put_data.c |
| 213 | +calc_surf_energy_bal.c read_arcinfo_ascii.c |
| 214 | +calc_veg_params.c read_atmos_data.c |
| 215 | +canopy_evap.c read_forcing_data.c |
| 216 | +check_files.c read_initial_model_state.c |
| 217 | +check_state_file.c read_snowband.c |
| 218 | +close_files.c read_soilparam.c |
| 219 | +cmd_proc.c read_soilparam_arc.c |
| 220 | +compress_files.c read_veglib.c |
| 221 | +compute_dz.c read_vegparam.c |
| 222 | +correct_precip.c redistribute_during_storm.c |
| 223 | +dist_prec.c root_brent.c |
| 224 | +estimate_T1.c runoff.c |
| 225 | +free_dist_prcp.c snow.h |
| 226 | +free_vegcon.c snow_intercept.c |
| 227 | +frozen_soil.c snow_melt.c |
| 228 | +full_energy.c snow_utility.c |
| 229 | +func_surf_energy_bal.c soil_conduction.c |
| 230 | +get_force_type.c soil_thermal_eqn.c |
| 231 | +get_global_param.c solve_snow.c |
| 232 | +global.h store_moisture_for_debug.c |
| 233 | +initialize_atmos.c surface_fluxes.c |
| 234 | +initialize_global.c svp.c |
| 235 | +initialize_model_state.c user_def.h |
| 236 | +initialize_new_storm.c vicNl.c |
| 237 | +initialize_snow.c vicNl.h |
| 238 | +initialize_soil.c vicNl_def.h |
| 239 | +initialize_veg.c vicerror.c |
| 240 | +make_cell_data.c write_atmosdata.c |
| 241 | +make_dist_prcp.c write_data.c |
| 242 | +make_dmy.c write_debug.c |
| 243 | +make_energy_bal.c write_layer.c |
| 244 | +make_in_and_outfiles.c write_model_state.c |
| 245 | +make_snow_data.c write_soilparam.c |
| 246 | +make_veg_var.c write_vegparam.c |
| 247 | +massrelease.c write_vegvar.c |
0 commit comments