Skip to main content


Project description

[![Build Status](](
[![Code Health](](
[![Coverage Status](](

# bmi-ilamb

A Basic Model Interface (BMI)
for version 2 (Python)
of the International Land Model Benchmarking Project (ILAMB)
benchmarking toolkit.

* The [journal article](
that describes BMI
* ILAMB [home page](
* ILAMB [source code repository](
* ILAMB [documentation](

## Installation

Clone and install **bmi-ilamb** into a Python distribution with

$ git clone
$ cd bmi-ilamb
$ python install

ILAMB itself must also be installed;
follow the [instructions](
in the ILAMB documentation
for downloading and installing ILAMB
into the same Python distribution as **bmi-ilamb**.

## Use

Two configuration files are needed:
one for ILAMB, the other for the BMI.
A description of the ILAMB configuration file can be found
in the ILAMB documentation.
The BMI configuration file contains values
that are passed to ILAMB's `ilamb-run` script.
Examples (
are given in the **data** directory
of this repository.

In a Python session, execute:

from bmi_lamb import BmiIlamb

m = BmiIlamb()
m.update() # calls the ilamb-run script

The path to the BMI configuration file can be relative or absolute.

The result:
$ ls -F
_build/ log

View the run log with:

$ cat log

Display ILAMB's graphical output with a web browser:

$ firefox _build/index.html

Project details

Release history Release notifications

This version


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bmi-ilamb, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size bmi-ilamb-0.1.1.tar.gz (13.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page