pyValEIA.io.write
=================

.. py:module:: pyValEIA.io.write

.. autoapi-nested-parse::

   Functions to write standard output files.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   pyValEIA.io.write.build_daily_stats_filename
   pyValEIA.io.write.write_daily_stats


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

.. py:function:: build_daily_stats_filename(stime, model, obs, file_dir, **kwargs)

   
   Build the filename and directory for daily EIA stat files.


   :Parameters:

       **stime** : datetime
           day of desired file

       **model** : str
           Case-sensitive name of model requested (e.g., 'NIMO', 'PyIRI').

       **obs** : str
           Name of data set requested (e.g., 'SWARM', 'MADRIGAL')

       **file_dir** : str
           File directory

       **kwargs** : dict
           Optional kwargs by data type.  Includes 'mad_lon', which expects
           longitudes of either -90 deg E or 60 deg E for Madrigal data.



   :Returns:

       **date_dir** : str
           Directory path in which file should exist (e.g., 'file_dir/yyyy')

       **fname** : str
           Filename without directory











   ..
       !! processed by numpydoc !!

.. py:function:: write_daily_stats(stat_data, stime, model, obs, file_dir, **kwargs)

   
   Write the daily statistics file for model-data comparisons.


   :Parameters:

       **stat_data** : pd.DataFrame
           DataFrame that includes all EIA statistics for the obs type

       **stime** : datetime
           day of desired file

       **model** : str
           Case-sensitive name of model requested (e.g., 'NIMO', 'PyIRI').

       **obs** : str
           Name of data set requested (e.g., 'SWARM', 'MADRIGAL')

       **file_dir** : str
           File directory, if it does not exist it will use the current directory

       **kwargs** : dict
           Optional kwargs by data type.  Includes 'mad_lon', which expects
           longitudes of either -90 deg E or 60 deg E for Madrigal data.














   ..
       !! processed by numpydoc !!