wavy.insitu_module
==================

.. py:module:: wavy.insitu_module

.. autoapi-nested-parse::

   This module encompasses classes and methods to read and process wave
   field related data from stations. I try to mostly follow the PEP
   convention for python code style. Constructive comments on style and
   effecient programming are most welcome!



Attributes
----------

.. autoapisummary::

   wavy.insitu_module.variable_def


Classes
-------

.. autoapisummary::

   wavy.insitu_module.insitu_class
   wavy.insitu_module.poi_class


Functions
---------

.. autoapisummary::

   wavy.insitu_module.check_date


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

.. py:data:: variable_def

.. py:function:: check_date(filelst, date)

   Checks if str in lst according to desired date (sd, ed)

   return: idx for file


.. py:class:: insitu_class(**kwargs)

   Bases: :py:obj:`wavy.quicklookmod.quicklook_class_sat`, :py:obj:`wavy.filter_module.filter_class`


   Class to handle insitu based time series.


   .. py:attribute:: twin


   .. py:attribute:: sd


   .. py:attribute:: ed


   .. py:attribute:: nID


   .. py:attribute:: name


   .. py:attribute:: varalias


   .. py:attribute:: units


   .. py:attribute:: stdvarname


   .. py:attribute:: distlim


   .. py:attribute:: filter


   .. py:attribute:: region


   .. py:attribute:: cfg


   .. py:method:: download(path=None, nproc=1, **kwargs)


   .. py:method:: _create_pathlst(**kwargs)


   .. py:method:: list_input_files(show=False, **kwargs)


   .. py:method:: _get_files(dict_for_sub=None, path=None, wavy_path=None, **kwargs)

      Function to retrieve list of files/paths for available
      locally stored data. This list is used for other functions
      to query and parsing.

      param:
          sd - start date (datetime object)
          ed - end date (datetime object)
          nID - nID as of model_cfg.yaml
          dict_for_sub - dictionary for substitution in templates
          path - a path if defined

      return:
          pathtotals - list of paths



   .. py:method:: _get_insitu_ts(**kwargs)

      Main function to obtain data from insitu locations.
      reads files, apply region and temporal filter

      return: adjusted dictionary according to spatial and
              temporal constraints



   .. py:method:: _enforce_longitude_format(ds)
      :staticmethod:



   .. py:method:: _enforce_meteorologic_convention(**kwargs)


   .. py:method:: _change_varname_to_aliases(**kwargs)


   .. py:method:: _change_stdvarname_to_cfname()


   .. py:method:: _return_extension(fstr: str)
      :staticmethod:



   .. py:method:: populate(**kwargs)


   .. py:method:: get_item_parent(item, attr)


   .. py:method:: get_item_child(item)


.. py:class:: poi_class(poi: dict, **kwargs)

   Bases: :py:obj:`wavy.quicklookmod.quicklook_class_sat`, :py:obj:`wavy.filter_module.filter_class`


   Class to handle poi based time series.


   .. py:attribute:: nID


   .. py:attribute:: varalias


   .. py:attribute:: sd


   .. py:attribute:: ed


   .. py:attribute:: stdvarname


   .. py:attribute:: units


   .. py:attribute:: twin


   .. py:attribute:: distlim


   .. py:attribute:: filter


   .. py:attribute:: region


   .. py:attribute:: name


   .. py:attribute:: vars


   .. py:method:: _build_xr_ds(poi)


   .. py:method:: crop_to_period(**kwargs)

      Function to crop the variable dictionary to a given period