:py:mod:`exo_k.util.filenames`
==============================

.. py:module:: exo_k.util.filenames

.. autoapi-nested-parse::

   @author: jeremy leconte

   Library of useful functions for handling filenames



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

.. py:exception:: EndOfFile


   Bases: :py:obj:`Exception`

   Error for an end of file


   Initialize self.  See help(type(self)) for accurate signature.


.. py:function:: select_kwargs(kwargs, filter_keys_list = None)

   Function to select only some keyword arguments from a
   kwargs dict to pass to a function afterward.

   :param kwargs: Dictionary of keyword arguments and values.
   :param filter_keys_list: Names of the keys to select.

   :returns:

             filtered_kwargs:
                 A dictionary with only the selected keys (if they were
                 present in kwargs).

   .. rubric:: Examples

   >>> def func(allo=None):
   >>>     print(allo)
   >>>
   >>> def bad_global_func(**kwargs):
   >>>     print(kwargs)
   >>>     func(**kwargs)
   >>>
   >>> def good_global_func(**kwargs):
   >>>     print(kwargs)
   >>>     func(**select_kwargs(kwargs,['allo']))

   >>> bad_global_func(allo=3.,yeah=None)
   {'allo': 3.0, 'yeah': None}
   TypeError: func() got an unexpected keyword argument 'yeah'

   >>> good_global_func(allo=3.,yeah=None)
   {'allo': 3.0, 'yeah': None}
   3.0


.. py:function:: create_fname_grid_Kspectrum_LMDZ(Np, Nt, Nx=None, suffix='', nb_digit=3)

   Creates a grid of filenames consistent with Kspectrum/LMDZ
   from the number of pressure, temperatures (, and vmr) points (respectively) in the grid.

   :param Np: Number of Pressure and temperature points.
   :type Np: :class:`int`
   :param Nt: Number of Pressure and temperature points.
   :type Nt: :class:`int`
   :param Nx: Number of vmr points if there is a variable gas
   :type Nx: :class:`int`, *optional*
   :param suffix: String to add behind the 'k001'
   :type suffix: :class:`str`, *optional*
   :param nb_digit: Total number of digit including the zeros ('k001' is 3)
   :type nb_digit: :class:`int`, *optional*

   :returns:

             list of str
                 List of the files in the right order and formating to be
                 given to :func:`exo_k.ktable.Ktable.hires_to_ktable` or
                 :func:`exo_k.xtable.Xtable.hires_to_xtable`.

   .. rubric:: Examples

   >>> exo_k.create_fname_grid_Kspectrum_LMDZ(2,3)
   array([['k001', 'k002', 'k003'],
   ['k004', 'k005', 'k006']], dtype='<U4')

   >>> exo_k.create_fname_grid_Kspectrum_LMDZ(2,3,suffix='.h5')
   array([['k001.h5', 'k002.h5', 'k003.h5'],
   ['k004.h5', 'k005.h5', 'k006.h5']], dtype='<U7')


.. py:function:: convert_exo_transmit_to_hdf5(file_in, file_out, mol='unspecified')

   Converts exo_transmit like spectra to hdf5 format for speed and space.

   :param file_in: Initial exo_transmit filename.
   :type file_in: :class:`str`
   :param file_out: Name of the final hdf5 file to be created.
   :type file_out: :class:`str`


.. py:function:: _read_array(file, Nvalue, N_per_line=5, Nline=None, revert=False)

   Reads an array in a .dat filestream.
   Assumes that the arrays are arranged N_per_line values per line.

   :param file: File to be read.
   :type file: :class:`file stream`
   :param Nvalue: Number of values to be read.
   :type Nvalue: :class:`int`
   :param N_per_line: Number of values assumed per line.
   :type N_per_line: :class:`int`
   :param revert: Whether or not to revert the array (because some arrays are
                  in decreasing order).
   :type revert: :class:`boolean (optional)`
   :param Nline: Slightly speeds up the process if the user specifies
                 the number of lines that will need to be read.
   :type Nline: :class:`int (optional)`

   :returns:

             Array
                 A numpy array with the values.


.. py:function:: _read_exorem_k_array(file, Nline)

   Reads an array in a .dat filestream.
   Assumes that the arrays are arranged N_per_line values per line.

   :param file: File to be read.
   :type file: :class:`file stream`
   :param Nline: Number of values/lines to be read.
   :type Nline: :class:`int`

   :returns:

             Array
                 A numpy array with the values.


.. py:function:: convert_old_kspectrum_to_hdf5(file_in, file_out, skiprows=0)

   Deprecated.

   Converts kspectrum like spectra to hdf5 format for speed and space

   :param file_in: Initial kspectrum filename.
   :type file_in: :class:`str`
   :param file_out: Name of the final hdf5 file to be created.
   :type file_out: :class:`str`