RTE+RRTMGP documentation

This is the documentation for RTE+RRTMGP, a set of codes for computing radiative fluxes in planetary atmospheres. RTE+RRTMGP is described in a paper in Journal of Advances in Modeling Earth Systems. The code itself can be sited as doi:10.5281/zenodo.3403172 or via the DOI attached to each release.

RRTMGP uses a k-distribution to provide an optical description (absorption and possibly Rayleigh optical depth) of the gaseous atmosphere, along with the relevant source functions, on a pre-determined spectral grid given temperatures, pressures, and gas concentration. The k-distribution currently distributed with this package is applicable to the Earth’s atmosphere under present-day, pre-industrial, and 4xCO2 conditions.

RTE computes fluxes given spectrally-resolved optical descriptions and source functions. The fluxes are normally summarized or reduced via a user extensible class.

Work in progress

Comprehensive documentation for RTE and RRTMGP is very much under development.

We are planning to follow the Diataxis framework and produce tutorials, how-to guides, explanations, and reference.

We are starting with the reference documentation, auto-generated from the code itself. This is provided separately for RTE and RRTMGP and for the user-facing classes and underlying computational kernels.

We welcome contributions to the documentation via pull requests to the documentation branch of the Github repository.

Posts

subscribe via RSS