pyRTE-RRTMGP technical documentation

pyRTE-RRTMGP provides a Python interface to the RTE+RRTMGP Fortran software package for computing radiative fluxes in planetary atmospheres. RTE+RRTMGP is described in a paper in Journal of Advances in Modeling Earth Systems.

pyRTE-RRTMGP uses pybind11 to create a Python interface to a subset of the RTE+RRTMGP functions available in Fortran.

This documentation focuses on installation and developemnt and provides the technical reference for the functions and classes. User-facing documentation including explanation and usage examples is available on Github.

Getting started:

• Installing pyRTE-RRTMGP
  • Installation with Conda (recommended)
• Basic Usage
  • RRTMGP and RTE
  • Defining and Solving Radiative Transfer Problems
• pyRTE-RRTMGP Tutorials
  • Setting up the Tutorial Notebooks

Reference:

• Python Interface
  • pyrte_rrtmgp.rte module
  • pyrte_rrtmgp.config module
  • pyrte_rrtmgp.cli module
  • pyrte_rrtmgp.rrtmgp module
  • pyrte_rrtmgp.rrtmgp.data_files module
• Low-Level Kernel Modules
  • pyrte_rrtmgp.kernels.rte module
  • pyrte_rrtmgp.kernels.rrtmgp module

Contributing:

• Contributing to pyRTE-RRTMGP
  • How to Report a Bug
  • How to Contribute a Patch That Fixes a Bug
  • How to Propose a New Feature
  • How to Contribute New Features
  • How to Contribute to the Documentation
  • How to Make a New Release (for project maintainers)
• Installing a Local Development Environment
  • How to install (for developers)
• Maintaining compatibility between pyRTE-RRTMGP and RTE-RRTMGP
  • Steps to Use the New Version of RTE-RRTMGP (New Source)
  • Testing Current Bindings with the New Source
  • Adding New Bindings