opendrift.readers.reader_ArtificialOceanEddy
============================================

.. py:module:: opendrift.readers.reader_ArtificialOceanEddy


Classes
-------

.. autoapisummary::

   opendrift.readers.reader_ArtificialOceanEddy.Reader


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

.. py:class:: Reader(lon=2, lat=66, proj4='+proj=stere +lat_0=90 +lon_0=70 +lat_ts=60 ' + '+units=m +a=6.371e+06 +no_defs')

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


   Artificial reader, with cyclonic surface current around selected centre.

   Purpose is demonstration and testing (unittest).

   Common constructor for all readers


   .. py:attribute:: fileName
      :value: 'ArtificialOceanEddy'



   .. py:attribute:: name
      :value: 'ArtificialOceanEddy'



   .. py:attribute:: proj4
      :value: '+proj=stere +lat_0=90 +lon_0=70 +lat_ts=60 +units=m +a=6.371e+06 +no_defs'



   .. py:attribute:: proj


   .. py:attribute:: pixelsize
      :value: 10000



   .. py:attribute:: delta_x
      :value: 10000



   .. py:attribute:: delta_y
      :value: 10000



   .. py:attribute:: x0


   .. py:attribute:: y0


   .. py:attribute:: xmin


   .. py:attribute:: xmax


   .. py:attribute:: ymin


   .. py:attribute:: ymax


   .. py:attribute:: start_time
      :value: None



   .. py:attribute:: end_time
      :value: None



   .. py:attribute:: time_step
      :value: None



   .. py:attribute:: variables
      :value: ['x_sea_water_velocity', 'y_sea_water_velocity']



   .. 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.