API Reference

salsa Package

Synthetic Absorption Line Surveyor Application (SALSA) for extracting absorbers from sightlines in astrophysical hydrodynamics simulations.

Functions

construct_rays(ds_file, start_points, ...[, ...])

Construct rays given a set of starting points and end points.

generate_catalog(ds_file, n_rays, ...[, ...])

Generates a catalog of absorber properties from a given number of lightrays through a dataset.

generate_lrays(ds, center, n_rays, ...[, ...])

Generate a sample of trident lightrays that randomly, uniformly cover impact parameter.

random_sightlines(ds_file, center, ...[, ...])

randomly sample impact parameter to get random sightlines from a given galaxy center

Classes

AbsorberExtractor(ds_filename[, ion_name, ...])

Base class for extracting absorbers from a Trident lightray for a given ion species.

AbsorberPlotter(abs_ext[, ion_name, ftype, ...])

Create's plot to easily see where absorbers are found along the light ray both directly and through resulting spectra.

SPICEAbsorberExtractor(ds_filename[, ...])

Uses SPICE to extract absorbers from a Trident lightray for a given ion species.

salsa.utils Package

Utilities for SALSA

Functions

check_rays(ray_dir, n_rays, fields[, parallel])

Check if a directory already contains a given number of trident lrays and contains necessary fields

collect_files(directory[, file_ext, ...])

Finds and returns files in a given directory with given extension.

get_ray_num(file_path)

extract the ray's number from it's file name by removing 'ray' and '.h5' as well as preceding path

ion_p(ion_name)

convert ion species name from trident style to one that matches YT's (ie 'H I' --> 'H_p0')

ion_p_num(ion_name)

convert ion species name from trident style to one that matches YT's (ie 'H I' --> 'H_p0_number_density')