Skip to content

earth-system-radiation/pyRTE-RRTMGP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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

Technical documentation for pyRTE-RRTMGP including installation instructions is available on Read the Docs.

User documentation including explanations, tutorials, and examples is available on Github

Project Status

The project is currently under active development. See CONTRIBUTING.md for information on how to contribute.

Note: The Python API is not entirely stable and is subject to change.

Installing pyRTE-RRTMGP

Installing with Mamba (recommended)

Conda Version Conda Platforms

pyRTE-RRTMGP is available as a conda package for Linux (x86_64) and MacOS. You can install it from the conda-forge channel or, better, use mamba:

mamba install 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 not supported by the conda package and alternatives to installing with conda, see the installation instructions in the documentation and the Contributor Guide.