opendrift.readers.reader_timeseries
===================================

.. py:module:: opendrift.readers.reader_timeseries


Classes
-------

.. autoapisummary::

   opendrift.readers.reader_timeseries.Reader


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

.. py:class:: Reader(parameter_value_map)

   Bases: :py:obj:`opendrift.readers.basereader.BaseReader`, :py:obj:`opendrift.readers.basereader.ContinuousReader`


   Reader providing the nearest value in time from a given time series.

   init with a map {'time':, time array, 'variable_name': value, ...}
   If there is the key lon or lat in the map, it will be stored as
   self.lon and self.lat but not as a timeserie.


   .. py:attribute:: times

      Setting this to `True` overrides temporal and spatial bounds checks.
      Also useful for readers that are constant and do not have a temporal
      dimension.



   .. py:attribute:: _parameter_value_map


   .. py:attribute:: variables


   .. py:attribute:: proj4
      :value: '+proj=latlong'



   .. py:attribute:: xmin
      :value: -180



   .. py:attribute:: xmax
      :value: 180



   .. py:attribute:: ymin
      :value: -90



   .. py:attribute:: ymax
      :value: 90



   .. py:attribute:: start_time


   .. py:attribute:: end_time


   .. py:attribute:: time_step


   .. py:attribute:: name
      :value: 'reader_timeseries'



   .. py:method:: get_variables(requestedVariables, time=None, x=None, y=None, z=None)

      Obtain and return values of the requested variables at all positions
      (x, y, z) closest to given time.

      Returns:

          Dictionary with arrays of length len(x) with values at exact positions x, y and z.