bmipy

Name	bmipy JSON
Version	2.0.1 JSON
	download
home_page
Summary	Basic Model Interface for Python
upload_time	2023-10-25 01:52:51
maintainer
docs_url	None
author
requires_python	>=3.9
license	MIT
keywords	bmi basic model interface
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            BMI for Python
==============

Python bindings for the CSDMS `Basic Model Interface <https://bmi.readthedocs.io>`_.

.. 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.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "bmipy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "BMI,Basic Model Interface",
    "author": "",
    "author_email": "Eric Hutton <huttone@colorado.edu>",
    "download_url": "https://files.pythonhosted.org/packages/de/22/4af81bc6c8546b3a1e2cd69bebb8f41644bdd1306361d8c32799a1115ad7/bmipy-2.0.1.tar.gz",
    "platform": null,
    "description": "BMI for Python\n==============\n\nPython bindings for the CSDMS `Basic Model Interface <https://bmi.readthedocs.io>`_.\n\n.. image:: https://zenodo.org/badge/179283861.svg\n    :target: https://zenodo.org/badge/latestdoi/179283861\n    :alt: DOI\n\n.. image:: https://github.com/csdms/bmi-python/actions/workflows/test.yml/badge.svg\n    :target: https://github.com/csdms/bmi-python/actions/workflows/test.yml\n    :alt: Build Status\n\n.. image:: https://anaconda.org/conda-forge/bmipy/badges/version.svg\n    :target: https://anaconda.org/conda-forge/bmipy\n    :alt: Anaconda-Server Badge\n\n.. image:: https://anaconda.org/conda-forge/bmipy/badges/platforms.svg\n    :target: https://anaconda.org/conda-forge/bmipy\n    :alt: Anaconda-Server Badge\n\n.. image:: https://anaconda.org/conda-forge/bmipy/badges/downloads.svg\n    :target: https://anaconda.org/conda-forge/bmipy\n    :alt: Anaconda-Server Badge\n\nInstall\n-------\n\nInstall *bmipy* with *pip*,\n\n.. code-block:: bash\n\n  $ pip install bmipy\n\nIf you're using Anaconda, you can also install *bmipy*\nwith conda from the *conda-forge* channel,\n\n.. code-block:: bash\n\n  $ conda install bmipy -c conda-forge\n\nTo build and install *bmipy* from source,\n\n.. code-block:: bash\n\n  $ git clone https://github.com/csdms/bmi-python\n  $ cd bmi-python\n  $ pip install .\n\nUsage\n-----\n\n.. code-block:: python\n\n  from bmipy import Bmi\n\n\n  class MyBmi(Bmi):\n\n      def initialize(self, config_file):\n          # Your implementation goes here\n\nA complete sample implementation is given in the\nhttps://github.com/csdms/bmi-example-python\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Basic Model Interface for Python",
    "version": "2.0.1",
    "project_urls": {
        "Documentation": "https://bmi.readthedocs.io",
        "Source": "https://github.com/csdms/bmi-python"
    },
    "split_keywords": [
        "bmi",
        "basic model interface"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "de224af81bc6c8546b3a1e2cd69bebb8f41644bdd1306361d8c32799a1115ad7",
                "md5": "d17566b4cbfd10ce5c925811c1fc748a",
                "sha256": "06f895711bba6b340c2a92411ca8a40a5eb8223ea18f20b6c7d8f5c7dc349b3d"
            },
            "downloads": -1,
            "filename": "bmipy-2.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d17566b4cbfd10ce5c925811c1fc748a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 12843,
            "upload_time": "2023-10-25T01:52:51",
            "upload_time_iso_8601": "2023-10-25T01:52:51.854543Z",
            "url": "https://files.pythonhosted.org/packages/de/22/4af81bc6c8546b3a1e2cd69bebb8f41644bdd1306361d8c32799a1115ad7/bmipy-2.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-10-25 01:52:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "csdms",
    "github_project": "bmi-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "bmipy"
}