Cthulhu.VALD

Functions

check(atom, ion, VALD_data_dir)

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

determine_linelist(VALD_data_dir)

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

create_pf_VALD(VALD_data_dir)

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

filter_pf(molecule, ionization_state, ...)

Read in specific atomic partition function from a pre-provided file that contains all atomic partition functions. Then

process_VALD_file(species, ionization_state, VALD_data_dir)

Used on developers' end to transform a raw VALD line list into the format

summon_VALD(molecule, ionization_state, VALD_data_dir)

Retrieve the desired line list from VALD.

load_line_list(input_directory, molecule)

Needs documentation

Module Contents

Cthulhu.VALD.check(atom, ion, VALD_data_dir)

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

Parameters:

  • atom (String) – Atomic name.

  • ion (int) – Ionization state of atom. Neutral state corresponds to ion = 1.

Return type:

None.

Cthulhu.VALD.determine_linelist(VALD_data_dir)

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

Parameters:

VALD_data_dir (String) – Local directory where the pre-supplied VALD line lists are stored.

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).

Cthulhu.VALD.create_pf_VALD(VALD_data_dir)

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

Return type:

None.

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

Parameters:

  • molecule (String) – Atomic name.

  • ionization_state (int) – Ionization state of atom (neutral state is 1).

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

  • VALD_data_dir (String) – Local directory where all the pre-provided VALD line lists, and the file with all the atomic partition functions, is stored.

Return type:

None.

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

Parameters:

  • species (String) – Nae fo atom.

  • ionization_state (int) – Ionization state of atom (neutral state is 1).

  • VALD_data_dir (String) – Local directory where the pre-provided VALD line lists are stored.

Return type:

None.

Cthulhu.VALD.summon_VALD(molecule, ionization_state, VALD_data_dir)

Retrieve the desired line list from VALD.

Parameters:

  • molecule (String) – Atomic name.

  • ionization_state (String) – Ionization state of atom (neutral state is 1).

  • VALD_data_dir (String) – Local directory where the pre-provided VALD line lists are stored.

Return type:

None.

Cthulhu.VALD.load_line_list(input_directory, molecule)

Needs documentation

Parameters:

  • input_directory (String) – Local directory where the line list is stored.

  • molecule (String) – Atomic name.

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.