README.rst

BMI for Python

Python bindings for the CSDMS Basic Model Interface.

Install

Install bmipy with pip,

$ pip install bmipy

If you're using Anaconda, you can also install bmipy with conda from the conda-forge channel,

$ conda install bmipy -c conda-forge

To build and install bmipy from source,

$ git clone https://github.com/csdms/bmi-python
$ cd bmi-python
$ pip install .

Usage

from bmipy import Bmi


class MyBmi(Bmi):

    def initialize(self, config_file):
        # Your implementation goes here

A complete sample implementation is given in the https://github.com/csdms/bmi-example-python repository.