{"id":23831994,"url":"https://github.com/csdms/bmi-tester","last_synced_at":"2025-10-24T01:43:03.215Z","repository":{"id":5298173,"uuid":"49972000","full_name":"csdms/bmi-tester","owner":"csdms","description":"Test a BMI in Python","archived":false,"fork":false,"pushed_at":"2024-04-29T22:05:15.000Z","size":339,"stargazers_count":1,"open_issues_count":4,"forks_count":3,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-29T23:25:57.941Z","etag":null,"topics":["bmi","csdms","python","testing-tools"],"latest_commit_sha":null,"homepage":"https://bmi-tester.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csdms.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-19T18:01:19.000Z","updated_at":"2024-06-11T00:05:31.643Z","dependencies_parsed_at":"2023-12-25T01:07:52.591Z","dependency_job_id":"40313b1e-9773-4d67-871c-41e5b950ac87","html_url":"https://github.com/csdms/bmi-tester","commit_stats":{"total_commits":195,"total_committers":5,"mean_commits":39.0,"dds":0.2205128205128205,"last_synced_commit":"0635f7b2bf7f521e5a6eeaf2dce179e4d0dfb414"},"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-tester","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-tester/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-tester/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-tester/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csdms","download_url":"https://codeload.github.com/csdms/bmi-tester/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232206387,"owners_count":18488512,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bmi","csdms","python","testing-tools"],"created_at":"2025-01-02T14:16:51.262Z","updated_at":"2025-10-15T01:40:19.030Z","avatar_url":"https://github.com/csdms.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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 *\\\u003cmodel\u003e:\\\u003cclass\u003e*. That is, in Python you would\nimport the *Hydrotrend* class as,\n\n```python\n\u003e\u003e\u003e 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Fbmi-tester","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsdms%2Fbmi-tester","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Fbmi-tester/lists"}