wavy.satellite_readers
======================

.. py:module:: wavy.satellite_readers

.. autoapi-nested-parse::

   The main task of this module is to read satellite altimetry
   files for further use.



Attributes
----------

.. autoapisummary::

   wavy.satellite_readers.satellite_dict
   wavy.satellite_readers.variable_info


Functions
---------

.. autoapisummary::

   wavy.satellite_readers.read_wavy_ncfiles
   wavy.satellite_readers.read_local_ncfiles
   wavy.satellite_readers.read_remote_ncfiles_aggregated
   wavy.satellite_readers.read_local_20Hz_files
   wavy.satellite_readers.read_local_ncfiles_swim


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

.. py:data:: satellite_dict

.. py:data:: variable_info

.. py:function:: read_wavy_ncfiles(**kwargs)

   Wrapping function to read wavy netcdf files.

   param:
       pathlst - list of paths to be parsed
       sd - start date (datetime object)
       ed - start date (datetime object)
       twin - time window (temporal constraint) in minutes

   return:
       dictionary of variables for the satellite_class object


.. py:function:: read_local_ncfiles(**kwargs)

   Wrapping function to read satellite netcdf files.


.. py:function:: read_remote_ncfiles_aggregated(**kwargs)

   Wrapping function to read remote opendap satellite netcdf files
   that use credentials


.. py:function:: read_local_20Hz_files(**kwargs)

   Wrapping function to read satellite netcdf files.

   param:
       pathlst - list of paths to be parsed
       product - product as specified in satellite_cfg.yaml
       varalias
       sd - start date (datetime object)
       ed - start date (datetime object)
       twin - time window (temporal constraint) in minutes

   return:
       dictionary of variables for the satellite_class object


.. py:function:: read_local_ncfiles_swim(**kwargs)

   Wrapping function to read swim netcdf files.

   param:
       pathlst - list of paths to be parsed
       product - product as specified in satellite_cfg.yaml
       varalias
       sd - start date (datetime object)
       ed - start date (datetime object)
       twin - time window (temporal constraint) in minutes

   return:
       dictionary of variables for the satellite_class object