API Reference

Radiation

Longwave and shortwave radiation components.

RRTMGLongwave The Rapid Radiative Transfer Model (RRTMG).
RRTMGShortwave The Rapid Radiative Transfer Model (RRTMG).
GrayLongwaveRadiation
Frierson06LongwaveOpticalDepth

Cork radiation

Non-grey correlated-k (CORK) scheme.

CorkLongwaveRadiation
CorkShortwaveRadiation

Convection & condensation

EmanuelConvection The Emanuel convection scheme from [Emanuel and Zivkovic-Rothman]_
DryConvectiveAdjustment A conservative scheme to keep the temperature profile close to the
GridScaleCondensation Calculate condensation due to supersaturation of water.

Surface & ice

SlabSurface Calculate the surface energy balance.
IceSheet Deprecated monolithic 1-d snow-ice energy balance model.
BucketHydrology Manages surface energy and moisture balance

Solar & insolation

BergerSolarInsolation Determines solar insolation using spectral solutions for orbital
Instellation Calculates the zenith angle and star-planet correction
HeldSuarez

Idealised & test physics

SimplePhysics Interface to the simple physics package.
DcmipInitialConditions Climt interface to the DCMIP initial conditions.

State & grid utilities

get_default_state Retrieves a reasonable initial state for the set of components given.
get_grid Args:
mass_to_volume_mixing_ratio g/g or g/kg to mole/mole
get_interface_values Calculate interface values given mid-level values.

Constants

list_available_constants Prints all the constants currently registered with sympl.
set_constants_from_dict Modify/Add constants in the library.
load_atmospheric_properties Load an atmospheric profile and set sympl constants accordingly.
reset_atmospheric_properties Restore constants to the state before the last load_atmospheric_properties call.