brian-rose / climlab-emanuel-convection

climlab-emanuel-convection

Brian Rose, University at Albany

About

This is a stand-alone Python wrapper for the Emanuel convection scheme.

The primary use-case is to serve as the under-the-hood moist convection driver for climlab, but it can be used as a stand-alone model if you are familiar with Fortran source code. This is a lightweight wrapper that emulates the Fortran interface as closely as possible. The original convect43c code is bundled here, courtesy of Kerry Emanuel.

Installation

Pre-built binaries for many platforms are available from conda-forge.

To install in the current environment:

conda install climlab-emanuel-convection --channel conda-forge

or create a self-contained environment:

conda create --name my_env python=3.11 climlab-emanuel-convection --channel conda-forge
conda activate my_env

See below for instructions on how to build from source.

Example usage

You can import the Fortran driver into a Python session with

from climlab_emanuel_convection import emanuel_convection

Please see the directory climlab_emanuel_convection/tests/ directory in this repository for working examples that set up all the necessary input arrays and call the driver.

Building from source

Build environment

Here are instructions to create a build environment (including Fortran compiler) with conda/mamba

Starting from the root of the climlab-sbm-convection repo (example for Apple M1 machine, see ./ci/ for other environment files):

mamba env create --file ./ci/requirements-macos-arm64.yml
conda activate convect_build_env

Or, to specify the Python version, you can do

mamba create --name convect_build_env python=3.11 --channel conda-forge
mamba env update --file ./ci/requirements-macos-arm64.yml
conda activate convect_build_env

Building and installing into the Python environment

From the root of the repository, do this:

python -m pip install . --no-deps -vv

Running tests

To run tests, do this from any directory other than the climlab-emanuel-convection repo:

pytest -v --pyargs climlab_emanuel_convection

Version history

• Version 0.3 (released August 2024) modernizes the build infrastructure (now using meson) and successfully builds on Python 3.12. No changes to the Python wrapper.
• Version 0.2 is the first public release (April 2022). The Python wrapper code has been extracted from climlab v0.7.13.