Reference/API

This is the API documentation for frei.

frei Package

Functions

absorb(opacities, temperatures, pressures, ...)

Compute emission spectrum.

binned_opacity(temperatures, pressures, ...)

Compute opacity for all available species, binned to wavelengths lam.

chemistry(temperatures, pressures, species)

Run pyfastchem to compute chemistry throughout an atmosphere.

dashboard(lam, F_2_up, ...)

Generate a dashboard plot.

dask_client([cluster_kwargs, client_kwargs])

Launch a local cluster, return the client.

download_atom(atom, charge, linelist)

Download atomic opacity data from DACE.

download_molecule(isotopologue, linelist)

Download molecular opacity data from DACE.

effective_temperature(grid, spec, dtaus, ...)

Compute effective temperature of an atmosphere given the outputs from emit.

emit(opacities, temperatures, pressures, ...)

Compute emission spectrum.

get_binned_phoenix_spectrum(T_eff, g, ...[, ...])

Return a binned PHOENIX spectrum with effective temperature T_eff.

kappa(opacities, temperature, pressure, lam)

Return the opacity at a given temperature and pressure.

load_example_opacity(grid[, seed, scale_factor])

Load "example" opacity xarray.

pressure_grid([n_layers, P_toa, P_boa])

Produce a pressure grid from bottom to top of atmosphere.

propagate_fluxes(lam, F_1_up, F_2_down, T_1, ...)

Compute fluxes up and down using the improved two-stream equations.

temperature_grid(pressures[, T_ref, P_ref, ...])

Produce a rough initial temperature grid for each pressure.

Classes

Grid(planet[, lam, pressures, ...])

Grid over temperatures, pressures and wavelengths.

Planet(a_rstar, m_bar, g, T_star, alpha)

Container for planetary system information

Class Inheritance Diagram

Inheritance diagram of frei.core.Grid, frei.core.Planet