Skip to content

Commit 0c33500

Browse files
author
Joe Hamman
committed
update to top level readme file
1 parent 98f0ffc commit 0c33500

File tree

1 file changed

+33
-5
lines changed

1 file changed

+33
-5
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,43 @@
11
VICpy
22
=====
33

4-
A pre/post processing toolbox for the VIC model (https://github.com/UW-Hydro/VIC)
4+
A pre/post processing toolbox for the [VIC model](https://github.com/UW-Hydro/VIC)
55

66
Truely a work in progress...
77

8-
This is a library of python scripts to go along with the pre/post
8+
This is a library of python scripts to go along with the pre/post
99
processing of VIC model forcings/parameters/outputs.
1010

11-
Right now this is just a collection of a few scripts but as the toolbox grows,
12-
a more formal structure may be put together.
11+
Right now this is just a collection of a few scripts but as the toolbox grows,
12+
a more formal structure may be put together.
1313

14-
Questions? Sure, Joe Hamman - [email protected]
14+
Most of the tools contained here are run from the command line and use a combination of command line arguments and configuration files. For tool specific usage try raising the help flag, -h (e.g. vic2netcdf.py -h).
15+
16+
-----
17+
18+
### vic2netcdf.py
19+
This tool converts binary or ASCII VIC output to a netCDF format. Options and settings are input via configuration file (e.g. VIC2nc_example.cfg).
20+
21+
Usage: `vic2netcdf.py some_config_file.cfg`
22+
23+
-----
24+
25+
### netcdf2vic.py
26+
This tool converts netCDF meteorological forcings to VIC binary or ASCII format. Options and settings are input via configuration file (e.g. example_netcdf2vic.cfg).
27+
28+
Usage: `netcdf2vic.py some_config_file.cfg`
29+
30+
-----
31+
32+
### grid_params.py
33+
This tool grids VIC soil, snow, and vegetation parameter files and stores them in a single netCDF file. This allows for easy viewing of parameters using tools like [ncview](http://meteora.ucsd.edu/~pierce/ncview_home_page.html). This tool take a list of command line arguments:
34+
35+
Usage:
36+
For soil only: `grid_params.py --soil_file=global_soil_param_new -o outfile.nc`
37+
38+
For soil and veg: `grid_params.py -s global_soil_param_new -o outfile.nc -v global_lai_0.25deg.txt`
39+
40+
-----
41+
42+
Questions? Sure, Joe Hamman - jhamman at hydro.washington.edu
1543

0 commit comments

Comments
 (0)