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 https://github.com/permamodel/bmi-ilamb
$ cd bmi-ilamb
$ python setup.py 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 ( ilamb.cfg and bmi_ilamb.yaml, respectively) are given in the data directory of this repository.

In a Python session, execute:

from bmi_lamb import BmiIlamb

m = BmiIlamb()
m.initialize('/path/to/bmi_ilamb.yaml')
m.update()  # calls the ilamb-run script
m.finalize()

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