Skip to content

Commit 63c0720

Browse files
committed
Add install instructions
1 parent c9c213a commit 63c0720

1 file changed

Lines changed: 51 additions & 1 deletion

File tree

README.rst

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,54 @@
2020
bmi-example-python
2121
==================
2222

23-
An example BMI implementation written in Python
23+
An example of implementing the `Python bindings`_
24+
for the CSDMS `Basic Model Interface`_ (BMI).
25+
26+
Overview
27+
--------
28+
29+
This is an example of implementing a BMI for a simple model
30+
that solves the diffusion equation
31+
on a uniform rectangular plate
32+
with Dirichlet boundary conditions.
33+
The model and its BMI are written in Python 3.
34+
Tests of the BMI are provided.
35+
36+
This repository is organized with the following directories:
37+
38+
*heat*
39+
Holds the model and the BMI for the model
40+
41+
*tests*
42+
Tests that cover the BMI of the model
43+
44+
Build/Install
45+
-------------
46+
47+
This example can be built and installed on Linux, macOS, and Windows.
48+
49+
**Prerequisites:**
50+
51+
* Python 3
52+
* The Python BMI bindings. Follow the build and install directions
53+
given in the `README`_ in that repository. You can choose to install
54+
them from source, or through pip, or conda.
55+
56+
To build/install this example from source,
57+
using the current Python BMI version, run
58+
59+
.. code-block:: bash
60+
61+
$ make install
62+
63+
To run the tests,
64+
65+
.. code-block:: bash
66+
67+
$ pip install -r requirements.txt
68+
$ make test
69+
70+
71+
.. _Python bindings: https://github.com/csdms/bmi-python
72+
.. _Basic Model Interface: https://bmi-spec.readthedocs.io
73+
.. _README: https://github.com/csdms/bmi-python/blob/master/README.rst

0 commit comments

Comments
 (0)