:py:mod:`gnome.environment.tide`
================================

.. py:module:: gnome.environment.tide

.. autoapi-nested-parse::

   module contains objects that contain weather related data. For example,
   the Wind object defines the Wind conditions for the spill



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   gnome.environment.tide.Tide



Functions
~~~~~~~~~

.. autoapisummary::

   gnome.environment.tide._get_shio_yeardata_limits



Attributes
~~~~~~~~~~

.. autoapisummary::

   gnome.environment.tide.SHIO_YEARDATA_LIMITS


.. py:function:: _get_shio_yeardata_limits()


.. py:data:: SHIO_YEARDATA_LIMITS

   

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


   Bases: :py:obj:`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

   :param timeseries: numpy array containing tide data
   :type timeseries: numpy.ndarray with dtype=datetime_value_1d
   :param units: units associated with the timeseries data. If 'filename'
       is given, then units are read in from the filename.
       unit conversion - NOT IMPLEMENTED YET
   :type units=None:  (Optional) string, for example:
       'knot', 'meter per second', 'mile per hour' etc
   :param filename: path to a long wind filename from which to read
       wind data
   :param yeardata='gnome/data/yeardata/': path to yeardata used for Shio
       data.


   .. py:property:: extrapolation_is_allowed


   .. py:property:: data_start


   .. py:property:: data_stop


   .. py:property:: yeardata


   .. py:attribute:: _ref_as
      :value: 'tide'

      

   .. py:attribute:: _schema

      

   .. py:attribute:: scale_factor

      

   .. py:method:: _obj_to_create(filename)

      open file, read a few lines to determine if it is an ossm file
      or a shio file