shyfem
======

.. py:module:: shyfem


Attributes
----------

.. autoapisummary::

   shyfem.logger


Classes
-------

.. autoapisummary::

   shyfem.Reader


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

.. py:data:: logger

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

   Bases: :py:obj:`opendrift.readers.basereader.BaseReader`, :py:obj:`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


   .. py:attribute:: variable_aliases


   .. py:attribute:: dataset
      :value: None



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



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


   .. py:attribute:: end_time


   .. py:attribute:: xmin


   .. py:attribute:: xmax


   .. py:attribute:: ymin


   .. py:attribute:: ymax


   .. py:attribute:: z


   .. py:attribute:: variable_mapping


   .. py:attribute:: variables
      :value: []



   .. py:attribute:: boundary


   .. py:attribute:: nodes_idx


   .. py:method:: plot_mesh(corners=None)

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



   .. py:method:: get_variables(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.



   .. py:method:: __nearest_level__(z)

      Find nearest index of z in levels.