API Documentation

Main User Interface for simulations in Visible mode

Main User Interface for simulations in Thermal mode

Utility class

change_option(fi, fo, option, val)[source]

Returns the values for option in an input file.

Usage:

values = get_vals(input_filename,optionname)

Input:: filename uvspec input file optionname name of uvspec option
Output:: values list of option values

Author: Arve Kylling Date: 2011-05-23

get_vals(fn, option)[source]

Returns the values for option in an input file.

Usage:

values = get_vals(input_filename,optionname)

Input:: filename uvspec input file optionname name of uvspec option
Output:: values list of option values

Author: Arve Kylling Date: 2011-05-23

remove_option(fi, fo, option)[source]

Removes option from input file fi, new input file in fo.

Usage:

values = get_vals(input_filename,new_input_filename,optionname)

Input:: input_filename uvspec input file new_input_filename new uvspec input file optionname name of uvspec option

Author: Arve Kylling Date: 2012-02-23

Analytical tools

The following function allow to check libradtran simulation

Created on Tue May 22 20:19:44 2018 Author: Sylvie Dagoret-Campagne Affliiation : LAL/IN2P3/CNRS

AeroOptDepth(wavelength, alpha)[source]

Provide Vertical Aerosols optical depth

Parameters:

wavelength (float in unit nm) – wavelength
tau_aerosols_500 (float) – VAOD at 500 nm
alpha_ang (float) – Angstrom exponent, must be positive.

Returns:

aerosol optical depth

Return type:

float

AtomeDensity_adiabatic(altitude, T=0)[source]

atome Density for Dry Air ( double altitude)

Provide the atome density at the altitude. Attention, ici on considère de l’air sec.

Parameters:

altitude (float in unit meter) – altitude
T (float in unit degree Kelvin) – Temperature. If T=0, use average altitude profile

Returns:

density

Return type:

float in atom / m^3

AtomeDensity_isothermal(altitude)[source]

atome Density for Dry Air ( double altitude)

Provide the atome density at the altitude. Attention, ici on considère de l’air sec.

Parameters:: altitude – input altitude
Type:: float in unit meters
Returns:: density
Return type:: float in unit atom/ m^3

MassDensity_adiabatic(altitude, T=0)[source]

Mass density Density for Dry Air in kg per m^3 Provide the density at the altitude. For dry air.

Parameters:

altitude (flotat in unit meter) – altitude
T (float in degree K.) – Temperature. If T=0, use average altitude profile

Returns:

density

Return type:

float in unit kg/m^3

MassDensity_adiabatic_humid(altitude, Hr, T=0)[source]

Mass density Density for Dry Air in kg per m^3 Provide the density at the corresponding altitude.

Parameters:

altitude (float in unit meter) – altitude
Hr (float) – relative humidity
T (float in unit degree Kelvin.) – Temperature. If T=0, use average altitude profile

Returns:

density

Return type:

float in unit kg/m^3

MassDensity_isothermal(altitude)[source]

Mass density Density for Dry Air in kg per m^3 Provide the density at the altitude. For dry air.

Parameters:: altitude (float in unit meters.) – input altitude in meters
Returns:: density
Return type:: float in unit kg/m^3

Pressure_adiabatic(altitude)[source]

Pressure at the altitude for an adiabatic atmosphere.

Parameters:: altitude (float in unit meters) – input altitude
Returns:: pressure
Return type:: float in unit Pa SI

Pressure_isothermal(altitude)[source]

Pressure at the altitude for an isothermal atmosphere. For dry air.

Parameters:: altitude (float in meters) – input altitude
Returns:: pressure
Return type:: float in unit Pa SI

RayOptDepth2_adiabatic(wavelength, altitude=2750, costh=1)[source]

Function RayOptDepth2(wavelength, altitude, costh) Provide Rayleigh optical depth for an adiabatic atmosphere

Parameters:

wavelength (float in unit nm) – wavelength
altitude (float in unit meter) – input altitude
costh (float) – cosimus of zenith angle

Returns:

the optical depth no unit, for Rayleigh scattering

Return type:

float

WORSE !

RayOptDepth2_isothermal(wavelength, altitude=2750, costh=1)[source]

Function RayOptDepth2(wavelength, altitude, costh) Provide Rayleigh optical depth for an isothermal atmosphere.

Parameters:

wavelength (float in unit nm) – wavelength
altitude (float in unit meter) – input altitude
costh (float) – cosimus of zenith angle

Returns:

the optical depth no unit, for Rayleigh scattering

Return type:

float

RayOptDepthXD(wavelength, xdepth)[source]

Function RayOptDepthXD(wavelength, xdepth) Provide Rayleigh optical depth

Parameters:

wavelength (float in nm) – wavelength
xdepth (float in unit g/cm2) – atmospheric depth

Returns:

optical depth no unit, for Rayleigh

Return type:

float

RayOptDepth_adiabatic(wavelength, altitude=2750, costh=1)[source]

Function RayOptDepth(double wavelength, double altitude, double costh) Provide Rayleigh optical depth in an adiabatic atmosphere.

Parameters:

wavelength (float in unit nm) – wavelength
altitude (float in unit meter) – input altitude
costh (float) – cosimus of zenith angle

Returns:

the optical depth no unit, for Rayleigh

Return type:

float

RayOptDepth_isothermal(wavelength, altitude=2750, costh=1)[source]

Function RayOptDepth(double wavelength, double altitude, double costh) Provide Rayleigh optical depth for an isothermal atmosphere

Parameters:

wavelength (float in unit nm) – wavelength
altitude (float in unit meter) – input altitude
costh (float) – cosimus of zenith angle

Returns:

the optical depth no unit, for Rayleigh scattering

Return type:

float

Temperature_adiabatic(h)[source]

Temperature vs altitude

Parameters:: h (float in meters) – altitude
Returns:: temperature
Return type:: float in unit degree Kelvin

XDepth_adiabatic(altitude, costh=1)[source]

Function : XDepth(altitude,costh) Provide the column depth in gr / cm^2 equivalent of airmass in physical units for an adiabatic atmosphere.

Parameters:

altitude (float in unit meter) – input altitude
costh (float) – cosimus of zenith angle

Returns:

XDepth column depth

Return type:

float in unit gr per cm squared

XDepth_isothermal(altitude, costh=1)[source]

Function : XDepth(altitude,costh) Provide the column depth in gr / cm^2 equivalent of airmass in physical units for an isothermal atmosphere.

Parameters:

altitude (float in unit meter) – input altitude
costh (float) – cosimus of zenith angle

Returns:

XDepth column depth

Return type:

float in unit gr per cm squared

PyExtinction tools

Additionnal analytical tools imported from the external package PyExtinction

AtmosphericExtinction (module)

createTable(arrays, names, units=None, formats=None, keywords=(), extname=None)[source]

Create a FITS-table from a set of arrays.

Parameters:

arrays – list of input arrays (ncols,)
names – list of column names (ncols,)
units – list of column units (ncols,) (‘none’ by default)
formats – list of column formats (ncols,) (‘1E’ by default)
keywords – list of keys (key,val[,comment]) to add to table header
extname – name of the binary table extension

Returns:

table HDU

readOzoneTemplate(ozoneName, lbda, colLbda='LAMBDA', colTrans='OZONE', ext=1)[source]

Read ozone transmission template, interpolate over wavelengthes, and convert to extinction [mag/airmass].

Parameters:

ozoneName – input FITS table, with columns colLbda (wavelength in AA) and colTrans (fractional transmission), and key ‘REFO3COL’ specifing the reference ozone column density [DU]
lbda – output wavelengthes [AA]
colLbda – name of the wavelength (in AA) column
colTrans – name of the ozone transmission column
ext – extension in which to look for wavelength and transmission columns

Returns:

ozone extinction [mag/airmass], refO3col