vic package

Submodules

vic.output module

Module containing output templates for VIC.

vic.output.template(varlist)

Returns string of VIC output template.

vic.output.variableGroup(args)

Returns new list of variables by expanding variable that corresponds to group name.

vic.state module

Module for the VIC model state functions

vic.state.readSnowbands(filename)

Read VIC elevation bands file.

vic.state.readStateFile(filename)

Reads VIC initial state file.

vic.state.readVariable(model, state, alat, alon, veg, bands, nlayer, varname)

Reads variable from VIC initial state.

vic.state.readVegetation(filename)

Reads VIC vegetation file.

vic.state.updateVariable(model, state, x, xa, alat, alon, agid, veg, bands, nlayer, varname)

Updates variable in VIC initial state.

vic.state.writeStateFile(filename, state, header)

Write state file after updating variable.

vic.vic module

Class definition for the VIC model interface

class vic.vic.VIC(path, dbname, resolution, startyear, startmonth, startday, endyear, endmonth, endday, name='', savestate='', nlayer=3)

createIndexTable(dataset)

Creates index table from raster row, column, and tile for each grid cell.

getForcings(options)

Get meteorological forcings from database.

getOutputStruct(globalfile)

Creates a dictionary with output variable-file pairs.

paramFromDB()

Retrieve file parameters from database.

readOutput(args)

Reads VIC output for selected variables.

run(vicexec)

Run VIC model.

save(saveto, args, initialize=True, skipsave=0)

Reads and saves selected output data variables into the database or a user-defined directory.

stateFile()

Retrieve state file path from database.

writeForcings(prec, tmax, tmin, wind, lai=None)

Write VIC meteorological forcing data files.

writeParamFile(nodes=3, time_step=24, save_state='', init_state=False, state_file='', save_state_to_db=False)

Write VIC global parameter file for current simulation.

writeSoilFile(shapefile)

Write soil parameter file for current simulation based on basin shapefile.

writeToDB(data, dates, tablename, initialize, ensemble=False, skipsave=0)

Writes output data into database.

Module contents

Definition for VIC package.