-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
60 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# BMI for Python | ||
|
||
Python bindings for the CSDMS [Basic Model Interface](https://bmi.readthedocs.io). | ||
|
||
![[DOI][doi-link]][doi-badge] | ||
![[Build Status][build-link]][build-badge] | ||
![[Build Status][anaconda-link]][anaconda-badge] | ||
|
||
[anaconda-badge]: https://anaconda.org/conda-forge/bmipy/badges/version.svg | ||
[anaconda-link]: https://anaconda.org/conda-forge/bmipy | ||
[build-badge]: https://github.com/csdms/bmi-python/actions/workflows/test.yml/badge.svg | ||
[build-link]: https://github.com/csdms/bmi-python/actions/workflows/test.yml | ||
[doi-badge]: https://zenodo.org/badge/179283861.svg | ||
[doi-link]: https://zenodo.org/badge/latestdoi/179283861 | ||
|
||
## Install | ||
|
||
Install *bmipy* with *pip*, | ||
|
||
```bash | ||
pip install bmipy | ||
``` | ||
|
||
If you're using Anaconda, you can also install *bmipy* | ||
with conda from the *conda-forge* channel, | ||
|
||
```bash | ||
conda install bmipy -c conda-forge | ||
``` | ||
|
||
To build and install *bmipy* from source, | ||
|
||
```bash | ||
git clone https://github.com/csdms/bmi-python | ||
cd bmi-python | ||
pip install . | ||
``` | ||
|
||
## Usage | ||
|
||
```python | ||
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. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters