Reference/API

Contents

Reference/API#

shone.opacity Package#

Functions#

`download_atom`(atom, charge[, line_list, ...])	Download atomic opacity data from DACE [Rd8c7416adfcb-1] [Rd8c7416adfcb-2].
`download_molecule`([isotopologue, ...])	Download molecular opacity data from DACE [R552ea83fc591-1] [R552ea83fc591-2].
`generate_synthetic_opacity`([filename])	Construct a netCDF file containing a synthetic opacity grid.
`rayleigh_cross_section_H2`(wavelength)	Rayleigh scattering cross-section of H2.
`rayleigh_cross_section_He`(wavelength)	Rayleigh scattering cross-section of He.

Classes#

Opacity([path, grid])

Load and interpolate from a pre-computed opacity grid.

shone.chemistry.fastchem Module#

Functions#

`build_fastchem_grid`([temperature, pressure, ...])	Pre-compute a grid of equilibrium chemistry solutions from FastChem.
`get_fastchem_interpolator`([path])	Return a jitted FastChem abundance interpolator.
`fastchem_species_table`()	Return an astropy table with names, symbols, weights and indices for each species in a generic instance of FastChem.
`number_density`(temperature, pressure)	Number density of all atmospheric species.
`mass_density`(temperature, pressure, vmr, weights)
`mean_molecular_weight`(temperature, pressure, ...)	Mean molecular weight [AMU] at each pressure and temperature for an ideal gas.

Classes#

FastchemWrapper(temperature, pressure[, ...])

Wrapper around pyfastchem.

shone.chemistry.translate Module#

Functions#

`isotopologue_to_species`(isotopologue)	Convert isotopologue name to common species name.
`isotopologue_to_mass`(isotopologue)	Find the total atomic mass for `isotopologue`.
`species_name_to_fastchem_name`(species[, ...])	Convert generic species name, like "H2O" or "ClAlF2", to Hill notation for FastChem, like "H2O1" or "Al1Cl1F2".
`species_name_to_common_isotopologue_name`(species)	Convert generic species name, like "H2O", to isotopologue name like "1H2-16O".

shone.transmission Package#

Functions#

`transmission_radius`(wavelength, temperature, ...)	Compute the radius spectrum for planet observed in transmission.
`transmission_radius_isothermal_isobaric`(...)	Compute the radius spectrum for planet observed in transmission with an isothermal atmosphere.

shone.spectrum Module#

Functions#

bin_spectrum(output_wavelength, ...)

Bin a spectrum from one wavelength grid to another.