lstid_processing.model.io
=========================

.. py:module:: lstid_processing.model.io

.. autoapi-nested-parse::

   Process standard SAMI3 output files.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   lstid_processing.model.io.create_concat_files
   lstid_processing.model.io.load_concat_file
   lstid_processing.model.io.download_nrl_files


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

.. py:function:: create_concat_files(sami3_dir, output_dir, run_name, date_list=None, samp_period=300, min_period=1800, max_period=7200, nl_inds=None, nf_inds=None, key_inds=None)

   
   Create concatonated files from SAMI3 output f1, f2, f3 files.


   :Parameters:

       **sami3_dir** : str
           Directory where the SAMI3 f1, f2, and f3 files exist

       **output_dir** : str
           Directory to which the concatonated files will be output

       **run_name** : str
           Run name to use to distinguish the output files

       **date_list** : list-like or NoneType
           List containing string specifying the YYYYDDD to concatonate. If None,
           will use ['2014084', '2014085']. (default=None)

       **samp_period** : int
           Sample period for model data in seconds (default=300)

       **min_period** : int
           Minimum period for relative variations in seconds (default=1800)

       **max_period** : int
           Maximum period for relative variations in seconds (default=7200)

       **nl_inds** : list-like or NoneType
           List of nl indices at which variations will be computed, if None
           uses [26, 26] (default=None)

       **nf_inds** : list-like or NoneType
           List of nl indices at which variations will be computed, if None
           uses [44, 58] (default=None)

       **key_inds** : list-like or NoneType
           Key to assign to the nl/nf index pairs, if None uses ['c', 'd']
           (default=None)



   :Returns:

       **sami** : xr.Dataset
           Concatonated dataset with relative and maxima included








   .. rubric:: Notes

   Adds variations at the 26 March 2014 DMSP and C/NOFS conjugate locations.



   ..
       !! processed by numpydoc !!

.. py:function:: load_concat_file(filename)

   
   Load a concatonated file SAMI3 file into an xarray Dataset.


   :Parameters:

       **filename** : str
           Filename with full path.



   :Returns:

       **sami** : xr.Dataset
           An xarray Dataset with model data and fixed times











   ..
       !! processed by numpydoc !!

.. py:function:: download_nrl_files(outdir, filename=None, nrl_site='https://map.nrl.navy.mil/map/pub/nrl/lstids/')

   
   Download SAMI3 files from the public NRL directory.


   :Parameters:

       **outdir** : str
           Directory to which data will be saved

       **filename** : str or NoneType
           Desired file to download or None to get all of them (default=None)

       **nrl_site** : str
           URL hosting the SAMI3 files
           (default='https://map.nrl.navy.mil/map/pub/nrl/lstids')



   :Returns:

       **model_names** : list
           List of model run names with their destination directory




   :Raises:

       ValueError
           If `outdir` does not exist.







   ..
       !! processed by numpydoc !!