gnome.environment.tide

Tide environment objects for OSSM or Shio tides.

Attributes

SHIO_YEARDATA_LIMITS

Classes

Tide

todo: baseclass called ScaleTimeseries (or something like that)

Module Contents

gnome.environment.tide.SHIO_YEARDATA_LIMITS
class gnome.environment.tide.Tide(filename, yeardata=os.path.join(os.path.dirname(gnome.__file__), 'data', 'yeardata'), scale_factor=None, **kwargs)

Bases: gnome.environment.environment.Environment

todo: baseclass called ScaleTimeseries (or something like that) ScaleCurrent Define the tide for a spill

Currently, this internally defines and uses the CyShioTime object, which is a cython wrapper around the C++ Shio object

Tide information can be obtained from a filename or set as a timeseries (timeseries is NOT TESTED YET)

It requires one of the following to initialize:

  1. ‘timeseries’ assumed to be in ‘uv’ format (NOT TESTED/IMPLEMENTED OR USED YET)

  2. a ‘filename’ containing a header that defines units amongst other meta data

Parameters:

  • timeseries (numpy.ndarray with dtype=datetime_value_1d) – numpy array containing tide data

  • units – units associated with the timeseries data. If ‘filename’ is given, then units are read in from the filename. unit conversion - NOT IMPLEMENTED YET

  • filename – path to a long wind filename from which to read wind data

  • yeardata='gnome/data/yeardata/' – path to yeardata used for Shio data.

filename
cy_obj
property yeardata
name

define as property in base class so all objects will have a name by default

scale_factor
property extrapolation_is_allowed
property data_start
property data_stop