diff --git a/README.md b/README.md new file mode 100644 index 0000000..7158f9c --- /dev/null +++ b/README.md @@ -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 + +repository. diff --git a/README.rst b/README.rst deleted file mode 100644 index 38250e1..0000000 --- a/README.rst +++ /dev/null @@ -1,65 +0,0 @@ -BMI for Python -============== - -Python bindings for the CSDMS `Basic Model Interface `_. - -.. image:: https://zenodo.org/badge/179283861.svg - :target: https://zenodo.org/badge/latestdoi/179283861 - :alt: DOI - -.. image:: https://github.com/csdms/bmi-python/actions/workflows/test.yml/badge.svg - :target: https://github.com/csdms/bmi-python/actions/workflows/test.yml - :alt: Build Status - -.. image:: https://anaconda.org/conda-forge/bmipy/badges/version.svg - :target: https://anaconda.org/conda-forge/bmipy - :alt: Anaconda-Server Badge - -.. image:: https://anaconda.org/conda-forge/bmipy/badges/platforms.svg - :target: https://anaconda.org/conda-forge/bmipy - :alt: Anaconda-Server Badge - -.. image:: https://anaconda.org/conda-forge/bmipy/badges/downloads.svg - :target: https://anaconda.org/conda-forge/bmipy - :alt: Anaconda-Server Badge - -Install -------- - -Install *bmipy* with *pip*, - -.. code-block:: bash - - $ pip install bmipy - -If you're using Anaconda, you can also install *bmipy* -with conda from the *conda-forge* channel, - -.. code-block:: bash - - $ conda install bmipy -c conda-forge - -To build and install *bmipy* from source, - -.. code-block:: bash - - $ git clone https://github.com/csdms/bmi-python - $ cd bmi-python - $ pip install . - -Usage ------ - -.. code-block:: 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. diff --git a/pyproject.toml b/pyproject.toml index 5a5b267..84c7c5c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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