vic-skill

"What do I need?"
|
+-- First time. What is VIC and how do I install it?
|   Read: reference/getting-started.md
|   (clone UW-Hydro/VIC, pick a driver, install C compiler / netCDF / MPI)
|
+-- I want to run a single basin or set of stations on a laptop
|   Read: reference/running-classic-driver.md
|   (vic_classic.exe, ASCII or binary global parameter file, soil, veg, forcing)
|
+-- I want to run a continental or global gridded simulation in parallel
|   Read: reference/running-image-driver.md
|   (vic_image.exe, NetCDF I/O, MPI, domain file, image parameter file)
|
+-- I need to know what physics VIC actually solves
|   Read: reference/physics-overview.md
|   (variable infiltration curve, ARNO baseflow, two-layer snow,
|    Cherkauer-Lettenmaier frozen soil, lakes, organic soil)
|
+-- I need to control or extend VIC output
|   Read: reference/output-and-postprocess.md
|   (history streams, OUTVAR, AGGFREQ, default fluxes, state files,
|    HowToAddNewOutputVars)
|
+-- I need to route VIC runoff into a streamflow hydrograph
|   Read: reference/routing-and-streamflow.md
|   (Lohmann offline, RVIC, image driver in-line routing, MOSART under CESM)
|
+-- I want to understand the source-code layout before editing
|   Read: reference/architecture.md
|   (vic_run physics core, drivers/{classic,image,cesm,python},
|    drivers/shared_all, extensions/rout_rvic)
|
+-- I want to submit a pull request to UW-Hydro/VIC
|   Read: reference/contributing-pr.md
|   (fork, develop branch, uncrustify, Travis CI, tests/run_tests.py)
|
+-- The model won't compile, won't run, or gives bad output
    Read: reference/debugging.md
    (parameter file format errors, NaN fluxes, water balance closure,
     frozen soil convergence, T iteration failures, TFALLBACK)

VIC/                                       <- UW-Hydro/VIC repository root
+-- ci/                                    <- Travis CI scripts and Dockerfile
+-- docs/                                  <- mkdocs source for vic.readthedocs.org
+-- samples/                               <- sample parameters + plotting notebooks
|   +-- get_sample_data.bash               <- pulls VIC_sample_data submodule
|   +-- vic_parameters.txt                 <- example constants file
|   +-- notebooks/
+-- tests/                                 <- run_tests.py, test_image_driver.py, etc.
|   +-- examples/                          <- Stehekin example global parameter files
|   +-- system/, science/, unit/, release/
+-- tools/                                 <- code_format/run_uncrustify.bash, ide/
+-- vic/
    +-- vic_run/                           <- physics core (driver-independent)
    |   +-- include/                       <- vic_def.h, vic_run.h, vic_log.h,
    |   |                                     vic_physical_constants.h
    |   +-- src/                           <- runoff.c, frozen_soil.c, snow_melt.c,
    |                                         calc_surf_energy_bal.c, lakes.eb.c,
    |                                         photosynth.c, ... (~60 files)
    +-- drivers/
    |   +-- classic/                       <- vic_classic.exe (ASCII / binary I/O)
    |   +-- image/                         <- vic_image.exe (NetCDF + MPI)
    |   +-- cesm/                          <- CESM/RASM coupling (Fortran bindings)
    |   +-- python/                        <- Python CFFI bindings (vic.lib)
    |   +-- shared_all/                    <- shared C source for every driver
    |   |   +-- src/put_data.c, vic_history.c, history_metadata.c, ...
    |   +-- shared_image/                  <- shared between image-like drivers
    +-- extensions/
        +-- rout_rvic/                     <- in-line RVIC routing (image driver)
        +-- rout_stub/                     <- no-op stub (default, no routing)

# 1. Get the code and the sample data
git clone https://github.com/UW-Hydro/VIC.git
cd VIC
./samples/get_sample_data.bash

# 2. Build the classic driver
cd vic/drivers/classic
make
ls vic_classic.exe        # should now exist

# 3. Run the sample basin (10 days)
cd ../../../tests/examples
mkdir -p out
../../vic/drivers/classic/vic_classic.exe \
    -g global_param.classic.STEHE.txt

# 4. Inspect the fluxes file
ls out/
head out/fluxes_*.txt

cd vic/drivers/image
make                              # requires netCDF4 and MPI
mpiexec -np 4 ./vic_image.exe \
    -g ../../../tests/examples/global_param.image.STEHE.feb.txt