Cthulhu.HITRAN
==============

.. py:module:: Cthulhu.HITRAN


Functions
---------

.. autoapisummary::

   Cthulhu.HITRAN.create_id_dict
   Cthulhu.HITRAN.check
   Cthulhu.HITRAN.determine_linelist
   Cthulhu.HITRAN.replace_iso_name
   Cthulhu.HITRAN.create_pf
   Cthulhu.HITRAN.create_air_broad
   Cthulhu.HITRAN.summon_HITRAN


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

.. py:function:: create_id_dict()

   Create a dictionary that maps molecules to their HITRAN molecule ID number found here: https://hitran.org/lbl/

   :returns: **molecule_dict** -- Dictionary mapping a given molecule to its HITRAN ID number.
   :rtype: dict


.. py:function:: check(molecule, isotope)

   Checks if the parameters passed into the summon() function by the user are valid to use with the HITRAN database

   :param molecule: Name of molecule (e.g. H2O).
   :type molecule: String
   :param isotope: Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).
   :type isotope: int

   :rtype: None.


.. py:function:: determine_linelist()

   Determines the molecule and isotopologue that would like to be accessed based on user input

   :returns: * **molecule_ID** (*int*) -- Molecular ID number of the desired molecule (based on HITRAN conventions found at https://hitran.org/lbl/# ).
             * **isotopologue_ID** (*int*) -- Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).


.. py:function:: replace_iso_name(iso_name)

   Replace the isotopologue name generated by HITRAN/HITEMP to match the isotopologue name convention
   used by ExoMol.

   :param iso_name: Name of the isotopologue that is to be replaced.
   :type iso_name: String

   :returns: **iso_name** -- A differently formatted version of the isotopologue name passed in. Matches ExoMol format.
   :rtype: String


.. py:function:: create_pf(mol_ID, iso_ID, folder, T_min=70, T_max=3001, step=1.0)

   Create partition function file using the partitionSum() function already in hapi

   :param mol_ID: Molecule ID number of the given molecule, as given by the first column in HITRAN here: https://hitran.org/lbl/.
   :type mol_ID: int
   :param iso_ID: Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).
   :type iso_ID: int
   :param folder: Local directory where the partition function file is to be stored.
   :type folder: String
   :param T_min: Minimum temperature (K) for which the partition function is computed by hapy.py. The default is 70.
   :type T_min: int, optional
   :param T_max: Maximum temperature (K) for which the partition function is computed by hapy.py. The default is 3001.
   :type T_max: int, optional
   :param step: Increment for temperature between T_min and T_max. The default is 1.0.
   :type step: float, optional

   :rtype: None.


.. py:function:: create_air_broad(input_dir)

   Create an air broadening file using the downloaded line list

   :param input_dir: Local directory where the broadening file is to be stored.
   :type input_dir: String

   :rtype: None.


.. py:function:: summon_HITRAN(molecule, isotopologue)

   Main function, uses calls to other functions to perform the line list download.

   :param molecule: Molecular ID number of species as specifed on HITRAN database.
   :type molecule: int
   :param isotopologue: Isotopologue ID number of species as specifed on HITRAN database.
   :type isotopologue: int

   :rtype: None.