Time Series Files

File extensions: Variable (e.g.: ohl, ocl, otl)

File Object

class gsshapy.orm.TimeSeriesFile[source]

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

Object interface for Time Series Files.

This object stores information from several time series output files. There are two supporting objects that are used to store the contents of this file: TimeSeries and TimeSeriesValue.

See:

tableName = 'tim_time_series_files'

Database tablename

id

PK

projectFileID

FK

fileExtension

STRING

projectFile

RELATIONSHIP

timeSeries

RELATIONSHIP

as_dataframe()[source]

Return time series as pandas dataframe

Supporting Objects

class gsshapy.orm.TimeSeries(**kwargs)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object that stores data for a single time series in a time series file.

Time series files can contain several time series datasets. The values for the times series are stored in TimeSeriesValue objects.

tableName = 'tim_time_series'

Database tablename

id

PK

timeSeriesFileID

FK

timeSeriesFile

RELATIONSHIP

values

RELATIONSHIP

class gsshapy.orm.TimeSeriesValue(simTime, value)[source]

Bases: sqlalchemy.ext.declarative.api.Base

Object containing the data for a single time series value. Includes the time stamp and value.

tableName = 'tim_time_series_values'

Database tablename

id

PK

timeSeriesID

FK

timeSeries

RELATIONSHIP

simTime

FLOAT

value

FLOAT