| Name | bmi-tester JSON |
| Version |
0.5.9
JSON |
| download |
| home_page | |
| Summary | Test Python BMI bindings |
| upload_time | 2024-03-03 20:24:27 |
| maintainer | Eric Hutton, Mark Piper |
| docs_url | None |
| author | Eric Hutton |
| requires_python | >=3.10 |
| license | MIT |
| keywords |
bmi
csdms
model
python
testing
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# bmi-tester
[anaconda-badge]: https://anaconda.org/conda-forge/bmi-tester/badges/version.svg
[anaconda-link]: https://anaconda.org/conda-forge/bmi-tester
[build-badge]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml/badge.svg
[build-link]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml
[coverage-badge]: https://coveralls.io/repos/github/csdms/bmi-tester/badge.svg
[coverage-link]: https://coveralls.io/github/csdms/bmi-tester
[docs-badge]: https://readthedocs.org/projects/bmi-tester/badge/?version=latest
[docs-link]: https://readthedocs.org/projects/bmi-tester/
[pypi-badge]: https://badge.fury.io/py/bmi-tester.svg
[pypi-link]: https://pypi.org/project/bmi-tester/
[python-badge]: https://img.shields.io/pypi/pyversions/bmi-tester.svg
![[Build Status][build-link]][build-badge]
![[PyPI][pypi-link]][pypi-badge]
![[Anaconda][anaconda-link]][anaconda-badge]
![[Python][pypi-link]][python-badge]
![[Documentation][docs-link]][docs-badge]
![[Coverage][coverage-link]][coverage-badge]
## About
The *bmi-tester* is a command-line utility and Python library for testing
Basic Model Interface (BMI) implementations.
## Requirements
The *bmi-tester* requires Python 3. Additional dependencies can be found
in the project's *requirements.txt* file and can be installed using either
*pip* or *conda*.
In addition to these requirements, the *bmi-tester* also requires the
*gimli.units* package, which is a Python interface to the *udunits2*
C library, which is not available through *pip* but can be installed
using *conda*.
If you are a developer of the *bmi-tester* you will also want to install
additional dependencies for running the project's tests to make sure
that things are working as they should. These dependencies are listed
in *requirements-testing.txt* and can all be install with either *pip*
or *conda*.
## Installation
To install, first create a new environment in which the project will be
installed. This, although not necessary, will isolate the installation
so that there won't be conflicts with your base *Python* installation.
This can be done with *conda* as,
```bash
conda create -n bmi-tester python=3
conda activate bmi-tester
```
### Stable Release
The *bmi-tester*, and its dependencies, can most easily be installed
with *conda*,
```bash
conda install bmi-tester -c conda-forge
```
### From Source
After downloading the *bmi-tester* source code, run the following from
the project's top-level folder (the one that contains *pyproject.toml*) to
install into the current environment,
```bash
pip install -e .
```
## Usage
You can access the *bmi-tester* from the command line with the *bmi-test*
command. Use the *--help* option to get a brief description of the
command line arguments,
```bash
bmi-test --help
```
The *bmi-test* command takes a single argument, the name of the entry point
of the class that implements the BMI you would like to test. To demonstrate
how this works, we will use the *Hydrotrend* model as an example. To install
the Python BMI for *Hydrotrend*, use *conda*,
```bash
conda install pymt_hydrotrend -c conda-forge
```
Once installed, the following will test the BMI implementation for the
*Hydrotrend* class,
```bash
bmi-test pymt_hydrotrend:Hydrotrend
```
The entry point is given as *\<model>:\<class>*. That is, in Python you would
import the *Hydrotrend* class as,
```python
>>> from pymt_hydrotrend import Hydrotrend
```
## Links
- [Source code](http://github.com/csdms/bmi-tester): The
*bmi-tester* source code repository.
- [Documentation](http://bmi-tester.readthedocs.io/): User
documentation for *bmi-tester*
- [Get](http://bmi-tester.readthedocs.io/en/latest/getting.html):
Installation instructions
Raw data
{
"_id": null,
"home_page": "",
"name": "bmi-tester",
"maintainer": "Eric Hutton, Mark Piper",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "eric.hutton@colorado.edu, mark.piper@colorado.edu",
"keywords": "bmi,csdms,model,python,testing",
"author": "Eric Hutton",
"author_email": "eric.hutton@colorado.edu",
"download_url": "https://files.pythonhosted.org/packages/55/04/3d0e9e3a3408caaf3a0b1e68f358c73258f7a6a22e4d1df157a85ecffa44/bmi_tester-0.5.9.tar.gz",
"platform": null,
"description": "# bmi-tester\n\n[anaconda-badge]: https://anaconda.org/conda-forge/bmi-tester/badges/version.svg\n[anaconda-link]: https://anaconda.org/conda-forge/bmi-tester\n[build-badge]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml/badge.svg\n[build-link]: https://github.com/csdms/bmi-tester/actions/workflows/test.yml\n[coverage-badge]: https://coveralls.io/repos/github/csdms/bmi-tester/badge.svg\n[coverage-link]: https://coveralls.io/github/csdms/bmi-tester\n[docs-badge]: https://readthedocs.org/projects/bmi-tester/badge/?version=latest\n[docs-link]: https://readthedocs.org/projects/bmi-tester/\n[pypi-badge]: https://badge.fury.io/py/bmi-tester.svg\n[pypi-link]: https://pypi.org/project/bmi-tester/\n[python-badge]: https://img.shields.io/pypi/pyversions/bmi-tester.svg\n\n![[Build Status][build-link]][build-badge]\n![[PyPI][pypi-link]][pypi-badge]\n![[Anaconda][anaconda-link]][anaconda-badge]\n![[Python][pypi-link]][python-badge]\n![[Documentation][docs-link]][docs-badge]\n![[Coverage][coverage-link]][coverage-badge]\n\n## About\n\nThe *bmi-tester* is a command-line utility and Python library for testing\nBasic Model Interface (BMI) implementations.\n\n## Requirements\n\nThe *bmi-tester* requires Python 3. Additional dependencies can be found\nin the project's *requirements.txt* file and can be installed using either\n*pip* or *conda*.\n\nIn addition to these requirements, the *bmi-tester* also requires the\n*gimli.units* package, which is a Python interface to the *udunits2*\nC library, which is not available through *pip* but can be installed\nusing *conda*.\n\nIf you are a developer of the *bmi-tester* you will also want to install\nadditional dependencies for running the project's tests to make sure\nthat things are working as they should. These dependencies are listed\nin *requirements-testing.txt* and can all be install with either *pip*\nor *conda*.\n\n## Installation\n\nTo install, first create a new environment in which the project will be\ninstalled. This, although not necessary, will isolate the installation\nso that there won't be conflicts with your base *Python* installation.\nThis can be done with *conda* as,\n\n```bash\nconda create -n bmi-tester python=3\nconda activate bmi-tester\n```\n\n### Stable Release\n\nThe *bmi-tester*, and its dependencies, can most easily be installed\nwith *conda*,\n\n```bash\nconda install bmi-tester -c conda-forge\n```\n\n### From Source\n\nAfter downloading the *bmi-tester* source code, run the following from\nthe project's top-level folder (the one that contains *pyproject.toml*) to\ninstall into the current environment,\n\n```bash\npip install -e .\n```\n\n## Usage\n\nYou can access the *bmi-tester* from the command line with the *bmi-test*\ncommand. Use the *--help* option to get a brief description of the\ncommand line arguments,\n\n```bash\nbmi-test --help\n```\n\nThe *bmi-test* command takes a single argument, the name of the entry point\nof the class that implements the BMI you would like to test. To demonstrate\nhow this works, we will use the *Hydrotrend* model as an example. To install\nthe Python BMI for *Hydrotrend*, use *conda*,\n\n```bash\nconda install pymt_hydrotrend -c conda-forge\n```\n\nOnce installed, the following will test the BMI implementation for the\n*Hydrotrend* class,\n\n```bash\nbmi-test pymt_hydrotrend:Hydrotrend\n```\n\nThe entry point is given as *\\<model>:\\<class>*. That is, in Python you would\nimport the *Hydrotrend* class as,\n\n```python\n>>> from pymt_hydrotrend import Hydrotrend\n```\n\n## Links\n\n- [Source code](http://github.com/csdms/bmi-tester): The\n *bmi-tester* source code repository.\n- [Documentation](http://bmi-tester.readthedocs.io/): User\n documentation for *bmi-tester*\n- [Get](http://bmi-tester.readthedocs.io/en/latest/getting.html):\n Installation instructions\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Test Python BMI bindings",
"version": "0.5.9",
"project_urls": {
"Changelog": "https://github.com/csdms/bmi-tester/blob/master/CHANGES.rst",
"Documentation": "https://bmi-tester.readthedocs.io/",
"Homepage": "https://csdms.colorado.edu",
"Repository": "https://github.com/csdms/bmi-tester"
},
"split_keywords": [
"bmi",
"csdms",
"model",
"python",
"testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "55043d0e9e3a3408caaf3a0b1e68f358c73258f7a6a22e4d1df157a85ecffa44",
"md5": "d6819d83508085931f5364ca97f9c97d",
"sha256": "711c4993b0375a9008632e47639da6e2c23ac2377d0ffbaf54b7e35d00f9588c"
},
"downloads": -1,
"filename": "bmi_tester-0.5.9.tar.gz",
"has_sig": false,
"md5_digest": "d6819d83508085931f5364ca97f9c97d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15658,
"upload_time": "2024-03-03T20:24:27",
"upload_time_iso_8601": "2024-03-03T20:24:27.492139Z",
"url": "https://files.pythonhosted.org/packages/55/04/3d0e9e3a3408caaf3a0b1e68f358c73258f7a6a22e4d1df157a85ecffa44/bmi_tester-0.5.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-03 20:24:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "csdms",
"github_project": "bmi-tester",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "bmi-tester"
}
