:mod:`shyfem`
=============

.. py:module:: shyfem


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

Classes
~~~~~~~

.. autoapisummary::

   shyfem.Reader



.. data:: logger
   

   

.. py:class:: Reader(filename=None, name=None)

   Bases: :class:`opendrift.readers.basereader.BaseReader`, :class:`opendrift.readers.basereader.UnstructuredReader`

   A reader for unstructured SHYFEM (irregularily gridded) `CF compliant
   <https://cfconventions.org/>`_ netCDF files.

   http://www.ismar.cnr.it/shyfem

   Args:
       :param filename: A single netCDF file, or a pattern of files. The
                        netCDF file can also be an URL to an OPeNDAP server.
       :type filename: string, requiered.

       :param name: Name of reader
       :type name: string, optional

   .. seealso::

       py:mod:`opendrift.readers.basereader.unstructured`.

   Common constructor for all readers

   .. attribute:: variable_aliases
      

      

   .. attribute:: dataset
      

      

   .. method:: plot_mesh(self, corners=None)

      Plot the grid mesh. Does not automatically show the figure.


   .. method:: get_variables(self, requested_variables, 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(time) with values at exact positions x, y and z.


   .. method:: __nearest_level__(self, z)

      Find nearest index of z in levels.