6.8. Open-ADAS¶

Although a typical Open-ADAS data set is installed to the local atomic data repository using the populate() function, additional atomic data can be installed manually.

The following functions allow to parse the Open-ADAS files and install the rates of the atomic processes to the local atomic data repository.

6.8.1. Parse¶

cherab.openadas.parse.adf11.parse_adf11(element, adf_file_path)¶

Reads contents of open adas adf11 files

Parameters:

element – Element described by ADF file.
adf_file_path – Path to ADF11 file from ADAS root.

Returns:

temperature, density, rates as numpy array

cherab.openadas.parse.adf12.parse_adf12(donor_ion, donor_metastable, receiver_ion, receiver_charge, adf_file_path)¶

Opens and parses ADAS ADF12 data files.

Parameters:

donor_ion – The donor ion element described by the rate file.
donor_metastable – The donor ion metastable level.
receiver_ion – The receiver ion element described by the rate file.
receiver_charge – The receiver ion charge state described by the rate file.
adf_file_path – Path to ADF15 file from ADAS root.

Returns:

Dictionary containing rates.

cherab.openadas.parse.adf15.parse_adf15(element, charge, adf_file_path, header_format=None)¶

Opens and parses ADAS ADF15 data files.

Parameters:

element – Element described by ADF file.
charge – Charge state described by ADF file.
adf_file_path – Path to ADF15 file from ADAS root.

Returns:

Dictionary containing rates.

cherab.openadas.parse.adf21.parse_adf21(beam_species, target_ion, target_charge, adf_file_path)¶

Opens and parses ADAS ADF21 data files.

Parameters:

beam_species – Element object describing the beam species.
target_ion – Element object describing the target ion species.
target_charge – Ionisation level of the target species.
adf_file_path – Path to ADF15 file from ADAS root.

Returns:

Dictionary containing rates.

cherab.openadas.parse.adf22.parse_adf22bmp(beam_species, beam_metastable, target_ion, target_charge, adf_file_path)¶

Opens and parses ADAS ADF22 BMP data files.

Parameters:

beam_species – Element object describing the beam species.
beam_metastable – The metastable level of the beam species.
target_ion – Element object describing the target ion species.
target_charge – Charge state of the target species.
adf_file_path – Path to ADF15 file from ADAS root.

Returns:

Dictionary containing rates.

cherab.openadas.parse.adf22.parse_adf22bme(beam_species, target_ion, target_charge, transition, adf_file_path)¶

Opens and parses ADAS ADF22 BME data files.

Parameters:

beam_species – Element object describing the beam species.
target_ion – Element object describing the target ion species.
target_charge – Charge state of the target species.
transition – Atomic transition tuple (upper level, lower level).
adf_file_path – Path to ADF15 file from ADAS root.

Returns:

Dictionary containing rates.

6.8.2. Install¶

cherab.openadas.install.install_adf11acd(element, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the recombination rate defined in an ADF11 file to the repository.

Parameters:

element – The element described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf11ccd(donor_element, donor_charge, receiver_element, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the thermal charge exchange rate defined in an ADF11 file to the repository.

Parameters:

donor_element – Element donating the electron, for the case of ADF11 files it is neutral hydrogen.
donor_charge – Charge of the donor atom/ion.
receiver_element – Element receiving the electron.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf11plt(element, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the line radiated power rates defined in an ADF11 file to the repository.

Parameters:

element – The element described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf11prb(element, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the continuum radiated power rates defined in an ADF11 file to the repository.

Parameters:

element – The element described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf11prc(element, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the CX radiated power rates defined in an ADF11 file to the repository.

Parameters:

element – The element described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf11scd(element, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the ionisation rate defined in an ADF11 file to the repository.

Parameters:

element – The element described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf12(donor_ion, donor_metastable, receiver_ion, receiver_charge, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the rates in the ADF12 file to the repository.

Parameters:

donor_ion – The donor ion element described by the rate file.
donor_metastable – The donor ion metastable level.
receiver_ion – The receiver ion element described by the rate file.
receiver_charge – The receiver ion ionisation level described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf15(element, ionisation, file_path, download=False, repository_path=None, adas_path=None, header_format=None)¶

Adds the rates in the ADF15 file to the repository.

Parameters:

element – The element described by the rate file.
ionisation – The ionisation level described by the rate file.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf21(beam_species, target_ion, target_charge, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the beam stopping rate defined in an ADF21 file to the repository.

Parameters:

beam_species – Beam neutral atom (Element/Isotope).
target_ion – Target species (Element/Isotope).
target_charge – Charge of the target species.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf22bme(beam_species, target_ion, target_charge, transition, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the beam emission rate defined in an ADF22 BME file to the repository.

Parameters:

beam_species – Beam neutral atom (Element/Isotope).
target_ion – Target species (Element/Isotope).
target_charge – Charge of the target species.
transition – Tuple containing (initial level, final level).
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).

cherab.openadas.install.install_adf22bmp(beam_species, beam_metastable, target_ion, target_charge, file_path, download=False, repository_path=None, adas_path=None)¶

Adds the beam population rate defined in an ADF22 BMP file to the repository.

Parameters:

beam_species – Beam neutral atom (Element/Isotope).
beam_metastable – Metastable/excitation level of beam neutral atom.
target_ion – Target species (Element/Isotope).
target_charge – Charge of the target species.
file_path – Path relative to ADAS root.
download – Attempt to download file if not present (Default=True).
repository_path – Path to the repository in which to install the rates (optional).
adas_path – Path to ADAS files repository (optional).