Skip to content

Commit 8535c5d

Browse files
bartnijssenbartnijssen
committed
Minor edits to documentation
1 parent 02226cb commit 8535c5d

File tree

10 files changed

+47
-183
lines changed

10 files changed

+47
-183
lines changed

‎docs/Development/Contributing.md‎

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,17 @@
11
# Contributing
22

3-
VIC is an open source research model. If you would like to see a new feature in VIC, open an issue on Github or find us on [Gitter](https://gitter.im/UW-Hydro/VIC).
3+
VIC is an open source research model. All development activity is coordinated via the [VIC github page](https://github.com/UW-Hydro/VIC), where you can also find all archived, current, beta, and development versions of the model.
44

55
## Features Under Development
66

77
There are currently a number of active development projects working on VIC. To see which features are slatted for future release, take a look at the issues in our [development milestones page on GitHub](https://github.com/UW-Hydro/VIC/milestones).
88

99
## Development and Collaboration
1010

11-
We welcome contributions from the hydrology community. Currently we have substantial collaborations on model development with the following groups:
12-
13-
* [Land Surface Hydrology Group, Dept. of Civil and Environmental Engineering, Princeton University](http://hydrology.princeton.edu/home.php)
14-
* [Keith Cherkauer's Lab, Dept. of Agricultural Engineering, Purdue University](https://www.agry.purdue.edu/hydrology/index.asp)
15-
* [Laura Bowling's Lab, Dept. of Agronomy, Purdue University](https://ag.purdue.edu/agry/directory/Pages/bowling.aspx)
16-
* [Jenny Adam's Lab, Dept. of Civil and Environmental Engineering, Washington State University](http://hydro.cee.wsu.edu/index.htm)
17-
* [Xu Liang's Lab, Dept. of Civil and Environmental Engineering, University of Pittsburg](http://www.engineering.pitt.edu/People/Faculty/Civil-Environmental/Primary/Liang,-Xu/)
18-
* [Earth System Science Group, Wageningen University](http://www.wageningenur.nl/en/expertise-services/Chair-groups/Environmental-Sciences/Earth-System-Science-Group.htm)
19-
20-
If you are a VIC user and have found a bug or have improved your private version of VIC in some way, please let us know by submitting an issue at the [UW-Hydro VIC GitHub Issues Page](https://github.com/UW-Hydro/VIC/issues).
11+
If you are a VIC user and have found a bug or have improved your private version of VIC in some way, please let us know by submitting an issue at the [UW-Hydro VIC GitHub Issues Page](https://github.com/UW-Hydro/VIC/issues). We also welcome discussion about larger updates and new features in VIC.
2112

2213
## Beta Testing
2314

24-
Do you consider yourself a pioneer? Are you eager to try new features of the VIC model before anyone else? Do you enjoy helping make the world a better place? If so, then volunteer to be a for the model.
15+
Do you consider yourself a pioneer? Are you eager to try new features of the VIC model before anyone else? Do you enjoy helping make the world a better place? If so, then volunteer to be a tester for the model.
2516

2617
We are actively developing VIC 5. A publicly available version of the development branch for this release is kept at the [UW-Hydro/VIC GitHub page](https://github.com/UW-Hydro/VIC). If you would like to try out the current development version, feel free to check out the [_develop_ branch](https://github.com/UW-Hydro/VIC/tree/develop).

‎docs/Development/CurrentVersion.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For more information about VIC 4.2 features and the differences VIC 4.2 has with
2929

3030
Existing model setup from VIC 4.1.2 will still run with VIC 4.2. The only exception to this may be when using an old state file to restart from a previous simulation
3131

32-
Most of the changes in VIC 4.2 are new features that are turned off by default. Therefore, similar, but not exact, results should be obtained by both VIC 4.1.2 and VIC 4.2.
32+
Most of the changes in VIC 4.2 are new features that are turned off by default. Therefore, similar, but not exactly the same, results should be obtained by both VIC 4.1.2 and VIC 4.2.
3333

3434
## Earlier Versions
3535

@@ -49,4 +49,4 @@ This is the routing model of [Lohmann, et al. (1996)](../Documentation/Reference
4949

5050
## How to Obtain the Code
5151

52-
For information on obtaining the routing model source code, [click here](../SourceCode/Code.md).
52+
The routing model source code can be obtained from its [GitHub repo](https://github.com/UW-Hydro/VIC_Routing).

‎docs/Development/ModelDevelopment.md‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,9 @@ Information about the VIC codebase:
1818
* [Differences with previous versions](VersionSummaries.md)
1919
* [Backwards-compatibility with previous versions](CompatOpt.md)
2020
* **[Previous Model Versions](ArchivedVersions.md)**
21-
* Overview of recent VIC model development
22-
* Brief descriptions of archived versions
23-
* How to obtain the code
24-
* **[Ongoing Development](OngoingDevelopment.md)**
25-
* Current development
26-
* Features under development
27-
* Issues under investigation
28-
* Collaboration
29-
* Beta Testing
30-
* How to obtain the code
21+
* **[Contributing](Contributing.md)**
22+
23+
All development activity is coordinated via the [VIC github page](https://github.com/UW-Hydro/VIC), where you can also find all archived, current, beta, and development versions of the model.
3124

3225
# Release Naming Convention
3326

‎docs/Development/OngoingDevelopment.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎docs/Development/open-source-philosophy.md‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,19 @@ Our rationale for moving the VIC model development to the open source community
66
- to encourage other researchers and developers to contribute to the VIC development, and
77
- to facilitate transparent development and use of the model
88

9-
## Official Support
9+
## Support
1010

11-
The VIC development community assumes the role of a limited scope of official support.
11+
There is **no official support** for the VIC model.
1212

13-
- Coordination of model development, bug fixes, and releases.
14-
- Distribution of model [documentation](http://vic.readthedocs.org) and [source code](https://github.com/UW-Hydro/VIC)
13+
While you are more than welcome to use VIC in your own research endeavors, the model code comes with _**no guarantees, expressed or implied, as to suitability, completeness, accuracy, and whatever other claim you would like to make**_. In addition, the model has no graphical user interface, nor does it include a large set of analysis tools, since most people want to use their own set of tools.
1514

16-
## Unsupported
15+
While we would like to hear about your particular application (especially a copy of any published paper), we cannot give you individual support in setting up and running the model. The VIC website includes reasonably complete instructions on how to run the model, as well as the opportunity to sign up for the VIC Users Email List.
1716

18-
Due to limited resources, there is not official support for some of the tasks related to using VIC. We expected that the user comes prepared with some understanding of the model and scientific computing. As such, these items are specifically not supported by the VIC development community:
17+
The [VIC listserve](https://mailman.u.washington.edu/mailman/listinfo/vic_users) should be used for questions about model setup and application. It is basically VIC users helping other VIC users.
18+
19+
All other exchanges about VIC source code are managed through the [VIC github page](https://github.com/UW-Hydro/VIC).
20+
21+
We expected that the user comes prepared with some understanding of the model and scientific computing. As such, these items are specifically not supported by the VIC development community:
1922

2023
- Building and running the VIC model on platforms other than LINUX, UNIX, and OSX.
2124
- Using LINUX, UNIX, or OSX operating systems.

‎docs/Overview/ModelOverview.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The VIC model ([Liang et al., 1994](../Documentation/References.md#primary-historical-reference)) is a large-scale, semi-distributed hydrologic model. As such, it shares several basic features with the other land surface models (LSMs) that are commonly coupled to global circulation models (GCMs):
66

7-
1. The land surface is modeled as a grid of large (>1km), flat, uniform cells
7+
1. The land surface is modeled as a grid of large (>>1km), flat, uniform cells
88
- Sub-grid heterogeneity (e.g. elevation, land cover) is handled via statistical distributions
99
1. Inputs are time series of daily or sub-daily meteorological drivers (e.g. precipitation, air temperature, wind speed)
1010
1. Land-atmosphere fluxes, and the water and energy balances at the land surface, are simulated at a daily or sub-daily time step
@@ -124,7 +124,7 @@ These apply to the case QUICK_FLUX = FALSE and FROZEN_SOIL = TRUE, i.e. the form
124124
- Linear (uniform) distribution of soil temperature around a mean
125125
- Allows some moisture movement in soil when the average temperature is below freezing
126126

127-
![VIC Spatial Frost Schematic Link](../img/VIC_spatial_frost.jpg)
127+
![VIC Spatial Frost Schematic Link](../img/VIC_spatial_frost.gif)
128128

129129
## Dynamic Lake/Wetland Model
130130

‎docs/SourceCode/Code.md‎

Lines changed: 1 addition & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,3 @@
11
# Code
22

3-
Note: The VIC model and the routing model have been developed for use on LINUX and UNIX platforms. To use VIC and/or the routing model on a Windows platform, we suggest downloading a free UNIX emulator such as [Cygwin](http://www.cygwin.com) and compiling/running these models within this emulator. Please do not ask us for help with installing or using Cygwin.
4-
5-
## VIC Model Source Code
6-
7-
The VIC model is written in C and typically compiled with the [GNU gcc](http://gcc.gnu.org/) compiler.
8-
9-
**Access:** The VIC model source code is archived in Git and is publicly available through [GitHub](https://github.com). To access the source code, visit [GitHub](https://github.com), create an account, and visit [github.com/UW-Hydro/VIC](https://github.com/UW-Hydro/VIC).
10-
11-
## Routing Model Source Code
12-
13-
The routing model is written in Fortran 77 and typically compiled with the [GNU g77](https://gcc.gnu.org/fortran/) compiler (not to be confused with GNU's gfortran compiler, which may also work but hasn't been tested here in our lab).
14-
15-
* [Route 1.0](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Source_Code/route_code_1.0.tgz)
16-
17-
## Preparing VIC Model Inputs
18-
19-
Follow these instructions if you don't want to use our parameters.
20-
21-
* Basin Delineation
22-
* Arc/Info Utility Basin Preparation Programs: [basin_prep.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/basin_prep.tgz)
23-
* Meteorological Data
24-
* Programs for gridding meteorological data from the National Climatic Data Center: [GRID_2000.TAR.gz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/GRID_2000.TAR.gz)
25-
* Programs for processing "Canada Daily Climate Data": [CANADA_MET.TAR.gz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/CANADA_MET.TAR.gz). Daily meteorological data for Canada is available on CDs from Environment Canada, entitled "Canada Daily Climate Data." This includes a README file describing the steps to downloading and processing the data for input to VIC.
26-
* Additional Processing MethodPrograms: [met_prep_other.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/met_prep_other.tgz)
27-
* Temporal Disaggregation of Precipitation Data
28-
* Tools for TemporalDisaggregation of Precipitation Data: [temporal_disagg_precip.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/temporal_disagg_precip.tgz)
29-
* Lookup tables for the continental U.S. (by season): [US_LOOKUP_TABLES.TAR.gz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/US_LOOKUP_TABLES.TAR.gz)
30-
* Parameter Files
31-
* Vegetation Parameter Preparation: [veg_param_prep.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/veg_param_prep.tgz)
32-
* Soil Parameter Preparation: [soil_param_prep.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/soil_param_prep.tgz)
33-
* Snowband Preparation: [snowband_prep.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/snowband_prep.tgz)
34-
* LDAS File Preparation: [LDAS_prep.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/LDAS_prep.tgz)
35-
36-
## Preparing Routing Model Inputs
37-
38-
* Routing Model Input Preparation: [rout_prep.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/rout_prep.tgz)
39-
* Jennifer Adam's Routing Model Preparation: [rout_prep_adam.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/rout_prep_adam.tgz)
40-
41-
## Post-processing
42-
43-
* Temporal Aggregation: [temporal_agg.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/temporal_agg.tgz)
44-
* Spatial Aggregation: [spatial_agg.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/spatial_agg.tgz)
45-
* Spatial Disaggregation: [spatial_disagg.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/spatial_disagg.tgz)
46-
* Tool for converting between standardVIC input/output and NetCDF: [flux2nc.py](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/flux2nc.py)
47-
48-
## Calibration
49-
50-
* Calibration Programs: [calibrate_other.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/calibrate_other.tgz) for method described on [Other Calibration Methods](../Documentation/CalibrateMethodOther.md) website.
51-
52-
## Plotting Scripts
53-
54-
* Splus (or R) scripts for comparing 2 VIC runs (at one grid cell): [R_plot_scripts.tgz](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Plotting_Scripts/R_plot_scripts.tgz)
55-
* C-shell/perl/gmt script for plotting hydrographs: [plot_flow_STEHE.scr](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Plotting_Scripts/plot_flow_STEHE.scr)
56-
57-
## Scripts For Converting File Formats Between VIC Versions
58-
59-
* Perl script for converting state files created by older versions of VIC to the format needed by the latest version of VIC: [convert_state_file.pl](ftp://ftp.hydro.washington.edu/pub/HYDRO/models/VIC/Utility_Programs/convert_state_file.pl)
3+
All development activity is coordinated via the [VIC github page](https://github.com/UW-Hydro/VIC), where you can also find all archived, current, beta, and development versions of the model.

‎docs/contact.md‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
# Primary Contacts
22

3-
4-
###[Bart Nijssen](http://www.ce.washington.edu/people/faculty/faculty.php?id=124)
5-
Bart is a Research Associate Professor in the Department of Civil and Environmental Engineering at the University of Washington where he leads the [Computational Hydrology Group](http://uw-hydro.github.io/). Bart manages the day-to-day development of the VIC model.
6-
7-
###[Dennis Lettenmaier](http://www.environment.ucla.edu/people/dennis-lettenmaier.php)
8-
Dennis is a Professor of Geography at UCLA. He supervised UW Land Land Surface Hydrology group and the development of the VIC model until November 2014.
9-
10-
#### How to get in touch with the VIC user and developer community
113
[![VIC Users Listserve](https://img.shields.io/badge/VIC%20Users%20Listserve-Active-blue.svg)](https://mailman.u.washington.edu/mailman/listinfo/vic_users) [![Join the chat at https://gitter.im/UW-Hydro/VIC](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/UW-Hydro/VIC?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub issues](https://img.shields.io/github/issues/UW-Hydro/VIC.svg?style=flat-square)](https://github.com/UW-Hydro/VIC/issues)
124

13-
Much of the development of VIC has been contributed or inspired by the various users who participate in this list serve (among them are Alan Hamlet, Andy Wood, Keith Cherkauer, Laura Bowling, Jenny Adam, and Ted Bohn, to name but a few). Often sending a question to the list serve is an effective way to learn about VIC.
5+
The [VIC listserve](https://mailman.u.washington.edu/mailman/listinfo/vic_users) should be used for questions about model setup and application. It is basically VIC users helping other VIC users.
6+
7+
All other exchanges about VIC source code are managed through the [VIC github page](https://github.com/UW-Hydro/VIC).

0 commit comments

Comments
 (0)