Supported Files¶
Last Updated: July 30, 2014
Not all files are supported by GsshaPy. A summary of the files that are supported and the file class handler that reads the file is provided in the following table.
Input Files Supported¶
The following table lists the input files that are supported by the current version of GsshaPy. The files are listed with the appropriate project file card and file class handler. Some files do not have a specified file extension. These are indicated with an ellipses ( … ).
Project File Card | File Extension | Handler |
---|---|---|
#PROJECTION_FILE | pro | ProjectionFile |
MAPPING_TABLE | cmt | MapTableFile |
PRECIP_FILE | gag | PrecipitationFile |
CHANNEL_INPUT | cif | ChannelInputFile |
STREAM_CELL | gst | GridStreamFile |
IN_THETA_LOCATION | ith | OutputLocationFile |
IN_HYD_LOCATION | ihl | OutputLocationFile |
IN_SED_LOC | isl | OutputLocationFile |
IN_GWFLUX_LOCATION | igf | OutputLocationFile |
HMET_WES | … | HmetFile |
NWSRFS_ELEV_SNOW | … | NwsrfsFile |
HMET_OROG_GAGES | … | OrthographicGageFile |
STORM_SEWER | spn | StormPipeNetworkFile |
GRID_PIPE | gpi | GridPipeFile |
OVERLAND_DEPTH_LOCATION | odi | OutputLocationFile |
OVERLAND_WSE_LOCATION | owi | OutputLocationFile |
OUT_WELL_LOCATION | igw | OutputLocationFile |
REPLACE_PARAMS | … | ReplaceParamFile |
REPLACE_VALS | … | ReplaceValFile |
ELEVATION | ele | RasterMapFile |
WATERSHED_MASK | msk | RasterMapFile |
ROUGHNESS | ovn | RasterMapFile |
RETEN_DEPTH | … | RasterMapFile |
READ_OV_HOTSTART | … | RasterMapFile |
STORAGE_CAPACITY | … | RasterMapFile |
INTERCEPTION_COEFF | … | RasterMapFile |
CONDUCTIVITY | … | RasterMapFile |
CAPILLARY | … | RasterMapFile |
POROSITY | … | RasterMapFile |
MOISTURE | … | RasterMapFile |
PORE_INDEX | … | RasterMapFile |
RESIDUAL_SAT | … | RasterMapFile |
FIELD_CAPACITY | … | RasterMapFile |
SOIL_TYPE_MAP | … | RasterMapFile |
WATER_TABLE | wte | RasterMapFile |
READ_SM_HOTSTART | … | RasterMapFile |
ALBEDO | alb | RasterMapFile |
WILTING_POINT | wtp | RasterMapFile |
TCOEFF | tcf | RasterMapFile |
VHEIGHT | vht | RasterMapFile |
CANOPY | cpy | RasterMapFile |
INIT_SWE_DEPTH | … | RasterMapFile |
AQUIFER_BOTTOM | aqe | RasterMapFile |
GW_BOUNDFILE | bnd | RasterMapFile |
GW_POROSITY_MAP | por | RasterMapFile |
GW_HYCOND_MAP | hyd | RasterMapFile |
EMBANKMENT | dik | RasterMapFile |
DIKE_MASK | dik | RasterMapFile |
CONTAM_MAP | … | RasterMapFile |
INDEX_MAP* | idx | IndexMapFile |
Note
*Index maps are listed in the mapping table file with the INDEX_MAP card.
Output Files Supported¶
The following table lists the output files that are supported by the current version of GsshaPy. The files are listed with the appropriate project file card and file class handler. Some files do not have a specified file extension. These are indicated with an ellipses ( … ).
Project File Card | File Extension | Handler |
---|---|---|
OUTLET_HYDRO | otl | TimeSeriesFile |
OUT_THETA_LOCATION | oth | TimeSeriesFile |
OUT_HYD_LOCATION | ohl | TimeSeriesFile |
OUT_DEP_LOCATION | odl | TimeSeriesFile |
OUT_SED_LOC | osl | TimeSeriesFile |
CHAN_DEPTH | cdp | LinkNodeDatasetFile |
CHAN_STAGE | cds | LinkNodeDatasetFile |
CHAN_DISCHARGE | vdq | LinkNodeDatasetFile |
CHAN_VELOCITY | cdv | LinkNodeDatasetFile |
OUT_GWFULX_LOCATION | ogf | TimeSeriesFile |
OUTLET_SED_FLUX | osf | TimeSeriesFile |
OUTLET_SED_TSS | oss | TimeSeriesFile |
OUT_TSS_LOC | tss | TimeSeriesFile |
MAX_SED_FLUX | … | LinkNodeDatasetFile |
OUT_CON_LOCATION | ocl | TimeSeriesFile |
OUT_MASS_LOCATION | oml | TimeSeriesFile |
SUPERLINK_JUNC_FLOW | … | TimeSeriesFile |
SUPERLINK_NODE_FLOW | … | TimeSeriesFile |
OVERLAND_DEPTHS | odo | TimeSeriesFile |
OVERLAND_WSE | owo | TimeSeriesFile |
GW_OUTPUT | … | WMSDatasetFile |
DISCHARGE | … | WMSDatasetFile |
INF_DEPTH | … | WMSDatasetFile |
SURF_MOIS | … | WMSDatasetFile |
RATE_OF_INFIL | … | WMSDatasetFile |
DIS_RAIN | … | WMSDatasetFile |
GW_OUTPUT | … | WMSDatasetFile |
GW_RECHARGE_CUM | … | WMSDatasetFile |
GW_RECHARGE_INC | … | WMSDatasetFile |
DEPTH | dep | WMSDatasetFile |
SNOW_SWE_FILE | swe | WMSDatasetFile |
Note
WMS Dataset Files can only be read in if the map type was set to 1 during the model run.
Partial Support¶
Many files are not fully supported by GsshaPy, meaning that they are not abstracted into several objects to make working
with them easy. However, many of these files are partially supported via the gsshapy.orm.GenericFile
object.
This file works by reading the entire contents of the file into a single text field in the database. The files that are
supported by this class are listed in the following table. Some files do not have a specified file extension. These are indicated with
an ellipses ( … ).
Project Card | File Extension |
---|---|
ST_MAPPING_TABLE | smt |
SECTION_TABLE | … |
SOIL_LAYER_INPUT_FILE | … |
EXPLIC_HOTSTART | … |
READ_CHAN_HOTSTART | … |
CHAN_POINT_INPUT | … |
HMET_SURFAWAYS | … |
HMET_SAMSON | … |
HMET_ASCII | … |
GW_FLUXBOUNDTABLE | flx |
SUPERLINK_JUNC_LOCATION | … |
SUPERLINK_NODE_LOCATION | … |
SUMMARY | sum |
EXPLIC_BACKWATER | … |
WRITE_CHAN_HOTSTART | … |
LAKE_OUTPUT | lel |
GW_WELL_LEVEL | owl |
ADJUST_ELEV | ele |
NET_SED_VOLUME | … |
VOL_SED_SUSP | … |
OPTIMIZE | opt |