Cthulhu.HITEMP

Functions

create_id_dict()

Recreate the table of molecular names and IDs that HITRAN uses for identification

check(molecule, isotope)

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

determine_linelist()

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

create_pf(mol_ID, iso_ID, folder[, T_min, T_max, step])

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

create_air_broad(input_dir)

Create an air broadening file using the downloaded line list.

summon_HITEMP(molecule, isotopologue)

Main function, uses calls to other functions to perform the download

Module Contents

Cthulhu.HITEMP.create_id_dict()

Recreate the table of molecular names and IDs that HITRAN uses for identification

Returns:

molecule_dict – Dictionary where the keys are HITRAN molecular names and the values are the respective HITRAN molecular IDs, as seen on https://hitran.org/lbl/.

Return type:

dict

Cthulhu.HITEMP.check(molecule, isotope)

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

Parameters:

  • molecule (String) – Molecule name (e.g. H2O).

  • isotope (int) – Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).

Returns:

molecule_id_number – Molecule ID number of the given molecule, as given by the first column in HITEMP here: https://hitran.org/hitemp/.

Return type:

int

Cthulhu.HITEMP.determine_linelist()

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

Returns:

  • molecule_ID (int) – Molecule ID number of the given molecule, as given by the first column in HITEMP here: https://hitran.org/hitemp/.

  • isotopologue_ID (int) – Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).

Cthulhu.HITEMP.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

Parameters:

  • mol_ID (int) – Molecule ID number of the given molecule, as given by the first column in HITEMP here: https://hitran.org/hitemp/.

  • iso_ID (int) – Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).

  • folder (String) – Local directory where the partition function file is to be stored.

  • T_min (int, optional) – Minimum temperature (K) for which the partition function is computed by hapy.py. The default is 70.

  • T_max (int, optional) – Maximum temperature (K) for which the partition function is computed by hapy.py. The default is 3001.

  • step (float, optional) – Increment for temperature between T_min and T_max. The default is 1.0.

Return type:

None.

Cthulhu.HITEMP.create_air_broad(input_dir)

Create an air broadening file using the downloaded line list.

Parameters:

input_dir (String) – Local directory where the broadening file is to be stored.

Return type:

None.

Cthulhu.HITEMP.summon_HITEMP(molecule, isotopologue)

Main function, uses calls to other functions to perform the download

Parameters:

  • molecule (int) – Molecule ID number of the given molecule, as given by the first column in HITEMP here: https://hitran.org/hitemp/.

  • isotopologue (int) – Isotopologue number of the molecule (1 = most common isotopologue, 2 = second most common, etc.).

Return type:

None.