Precipitation File

File extension: gag

File Object

class gsshapy.orm.PrecipFile[source]

Bases: sqlalchemy.ext.declarative.api.Base, gsshapy.base.file_base.GsshaPyFileObjectBase

Object interface for the Precipitation Input File.

The contents of the precipitation file are abstracted into three types of objects including: PrecipEvent, PrecipValue, and PrecipGage. One precipitation file can consist of multiple events and each event can have several gages and a time series of values for each gage.

See: http://www.gsshawiki.com/Precipitation:Spatially_and_Temporally_Varied_Precipitation

tableName = 'gag_precipitation_files'

Database tablename

id

PK

fileExtension

STRING

precipEvents

RELATIONSHIP

projectFile

RELATIONSHIP

Supporting Objects

class gsshapy.orm.PrecipEvent(description, nrGag, nrPds)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single precipitation event.

tableName = 'gag_events'

Database tablename

id

PK

precipFileID

FK

values

RELATIONSHIP

gages

RELATIONSHIP

precipFile

RELATIONSHIP

description

STRING

nrGag

INTEGER

nrPds

INTEGER

class gsshapy.orm.PrecipValue(valueType, dateTime, value)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single time stamped precipitation value.

tableName = 'gag_values'

Database tablename

id

PK

eventID

FK

coordID

FK

event

RELATIONSHIP

gage

RELATIONSHIP

valueType

STRING

dateTime

DATETIME

value

FLOAT

class gsshapy.orm.PrecipGage(description, x, y)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing data for a single precipitation gage or location.

tableName = 'gag_coord'

Database tablename

id

PK

values

RELATIONSHIP

event

RELATIONSHIP

description

STRING

x

FLOAT

y

FLOAT