Skip to content

earth-system-radiation/pyRTE-RRTMGP

Repository files navigation

CI passing Mypy Documentation Status DOI

pyRTE-RRTMGP

This is the repository for the pyRTE-RRTMGP project.

This project provides a Python interface to the RTE+RRTMGP Fortran software package. RTE+RRTMGP package is a set of libraries for for computing radiative fluxes in planetary atmospheres.

Documentation

Documentation for pyRTE-RRTMGP is available on Read the Docs.

Project Status

The project is currently under active development. We hope to have a stable first usable release by Apr 2025.

See CONTRIBUTING.md for information on how to contribute to this effort

Note: The code in this repository is a work in progress. The Python API is not yet stable and is subject to change.

Installing pyRTE-RRTMGP

Installing with Conda (recommended)

Conda Version Conda Platforms

pyRTE-RRTMGP is available as a conda package for Linux (x86_64). You can install it from the conda-forge channel:

conda install -c conda-forge pyrte_rrtmgp

This will install the package in your current conda environment. If you want to install the package in a different environment, activate your environment before running the conda install command above.

After installing the package, you can import it in your Python code:

import pyrte_rrtmgp

To verify your installation, you can run a set of tests with the following command:

pyrte_rrtmgp run_tests

For platforms other than Linux for x64 processors and alternatives to installing with conda, see the installation instructions in the documentation and the Contributor Guide.