Skip to content

Commit

Permalink
convert readme to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
mcflugen committed Jan 6, 2024
1 parent d53fc67 commit d01fb5e
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 67 deletions.
53 changes: 53 additions & 0 deletions README.md
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.
65 changes: 0 additions & 65 deletions README.rst

This file was deleted.

9 changes: 7 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,17 @@ requires = [
build-backend = "setuptools.build_meta"

[tool.setuptools.dynamic.readme]
file = "README.rst"
content-type = "text/x-rst"
file = "README.md"
content-type = "text/markdown"

[tool.setuptools.dynamic.version]
attr = "bmipy._version.__version__"

[tool.setuptools.packages.find]
where = [
"src",
]

[tool.mypy]
check_untyped_defs = true
disallow_any_generics = true
Expand Down

0 comments on commit d01fb5e

Please sign in to comment.