:py:mod:`opendrift.readers`
===========================

.. py:module:: opendrift.readers

.. autoapi-nested-parse::

   Readers
   =======

   Readers are responsible for providing Opendrift with data about the
   `enviornment` of the drifting particles or elements.

   All readers descend from :class:`.basereader.BaseReader`. A reader generally also descends from one of the few general classes of readers. When writing a new reader consider which one fits your input data best:

       * :class:`.basereader.continuous.ContinuousReader`
       * :class:`.basereader.structured.StructuredReader`
       * :class:`.basereader.unstructured.UnstructuredReader`

   The `ContinuousReader` is suited for data that can be defined at any point within the domain, or if the reader does its own interpolation internally. E.g. a :class:`synthetic eddy <.reader_ArtificialOceanEddy.Reader>`, or a :class:`constant <.reader_constant.Reader>`. The `StructuredReader` aids in interpolation when creating a reader of data on a :class:`regular grid <.reader_netCDF_CF_generic.Reader>`, while the `UnstructuredReader` provides the basics for :class:`irregularily gridded data <.reader_netCDF_CF_unstructured.Reader>` (e.g. finite volume models).

   .. seealso::

       See the reader-types or reader-implementations for more details.

       See :class:`.basereader.BaseReader` for how readers work internally.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   basereader/index.rst
   interpolation/index.rst
   operators/index.rst
   roppy/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   reader_ArtificialOceanEddy/index.rst
   reader_ROMS_native/index.rst
   reader_constant/index.rst
   reader_constant_2d/index.rst
   reader_copernicusmarine/index.rst
   reader_current_from_drifter/index.rst
   reader_current_from_track/index.rst
   reader_double_gyre/index.rst
   reader_failing/index.rst
   reader_global_landmask/index.rst
   reader_grib/index.rst
   reader_grib2/index.rst
   reader_lazy/index.rst
   reader_netCDF_CF_generic/index.rst
   reader_netCDF_CF_unstructured/index.rst
   reader_oscillating/index.rst
   reader_schism_native/index.rst
   reader_shape/index.rst
   reader_telemac_selafin/index.rst
   reader_timeseries/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   opendrift.readers.reader_from_url



Attributes
~~~~~~~~~~

.. autoapisummary::

   opendrift.readers.logger


.. py:data:: logger

   

.. py:function:: reader_from_url(url, timeout=10)

   Make readers from URLs or paths to datasets