Cthulhu.VALD
============

.. py:module:: Cthulhu.VALD


Functions
---------

.. autoapisummary::

   Cthulhu.VALD.check
   Cthulhu.VALD.determine_linelist
   Cthulhu.VALD.create_pf_VALD
   Cthulhu.VALD.filter_pf
   Cthulhu.VALD.process_VALD_file
   Cthulhu.VALD.summon_VALD
   Cthulhu.VALD.load_line_list


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

.. py:function:: check(atom, ion, VALD_data_dir)

   Check if VALD has a line list for the specified atom and ionization state

   :param atom: Atomic name.
   :type atom: String
   :param ion: Ionization state of atom. Neutral state corresponds to ion = 1.
   :type ion: int

   :rtype: None.


.. py:function:: determine_linelist(VALD_data_dir)

   Use user prompts to determine which VALD line list to download.

   :param VALD_data_dir: Local directory where the pre-supplied VALD line lists are stored.
   :type VALD_data_dir: String

   :returns: * **molecule** (*String*) -- Name of atom for which the line list is to be downloaded.
             * **ionization_state** (*int*) -- Ionization state of atom (neutral state is 1).


.. py:function:: create_pf_VALD(VALD_data_dir)

   Used on developers' end to create the partition function file which is included in the GitHub package


   :rtype: None.


.. py:function:: filter_pf(molecule, ionization_state, line_list_folder, VALD_data_dir)

   Read in specific atomic partition function from a pre-provided file that contains all atomic partition functions. Then
   reformat the partition function into a more tractable form.

   :param molecule: Atomic name.
   :type molecule: String
   :param ionization_state: Ionization state of atom (neutral state is 1).
   :type ionization_state: int
   :param line_list_folder: Local directory where the partition function is to be stored.
   :type line_list_folder: String
   :param VALD_data_dir: Local directory where all the pre-provided VALD line lists, and the file with all the atomic partition functions, is stored.
   :type VALD_data_dir: String

   :rtype: None.


.. py:function:: process_VALD_file(species, ionization_state, VALD_data_dir)

   Used on developers' end to transform a raw VALD line list into the format
   used by EXCALIBUR.

   :param species: Nae fo atom.
   :type species: String
   :param ionization_state: Ionization state of atom (neutral state is 1).
   :type ionization_state: int
   :param VALD_data_dir: Local directory where the pre-provided VALD line lists are stored.
   :type VALD_data_dir: String

   :rtype: None.


.. py:function:: summon_VALD(molecule, ionization_state, VALD_data_dir)

   Retrieve the desired line list from VALD.

   :param molecule: Atomic name.
   :type molecule: String
   :param ionization_state: Ionization state of atom (neutral state is 1).
   :type ionization_state: String
   :param VALD_data_dir: Local directory where the pre-provided VALD line lists are stored.
   :type VALD_data_dir: String

   :rtype: None.


.. py:function:: load_line_list(input_directory, molecule)

   Needs documentation

   :param input_directory: Local directory where the line list is stored.
   :type input_directory: String
   :param molecule: Atomic name.
   :type molecule: String

   :returns: * **nu_0** (*TYPE*) -- DESCRIPTION.
             * **gf** (*TYPE*) -- DESCRIPTION.
             * **E_low** (*TYPE*) -- DESCRIPTION.
             * **E_up** (*TYPE*) -- DESCRIPTION.
             * **J_low** (*TYPE*) -- DESCRIPTION.
             * **l_low** (*TYPE*) -- DESCRIPTION.
             * **l_up** (*TYPE*) -- DESCRIPTION.
             * **Gamma_nat** (*TYPE*) -- DESCRIPTION.
             * **Gamma_vdw** (*TYPE*) -- DESCRIPTION.
             * **alkali** (*TYPE*) -- DESCRIPTION.