Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/csdms/bmi-example-python

An example of wrapping a model written in Python with a BMI

https://github.com/csdms/bmi-example-python

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    1 of 4 committers (25.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.8%) to scientific vocabulary

Keywords

bmi csdms python

Keywords from Contributors

geosciences earth-system-model best-practices cxx pymt interface numerical-modeling
Last synced: 5 months ago · JSON representation

Repository

An example of wrapping a model written in Python with a BMI

Basic Info
  • Host: GitHub
  • Owner: csdms
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage: https://bmi.csdms.io
  • Size: 776 KB
Statistics
  • Stars: 13
  • Watchers: 9
  • Forks: 22
  • Open Issues: 8
  • Releases: 0
Topics
bmi csdms python
Created about 11 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Authors

README.rst 

.. image:: https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg
        :target: https://bmi.readthedocs.io/
        :alt: Basic Model Interface

.. image:: https://github.com/csdms/bmi-example-python/actions/workflows/test.yml/badge.svg
    :target: https://github.com/csdms/bmi-example-python/actions/workflows/test.yml
    :alt: CI status

.. image:: https://coveralls.io/repos/csdms/bmi-example-python/badge.png?branch=master
    :target: https://coveralls.io/r/csdms/bmi-example-python?branch=master
    :alt: Coverage status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/csdms/bmi
    :alt: Black

bmi-example-python
==================

An example of implementing the `Python bindings`_
for the CSDMS `Basic Model Interface`_ (BMI).

Overview
--------

This is an example of implementing a BMI for a simple model
that solves the diffusion equation
on a uniform rectangular plate
with Dirichlet boundary conditions.
The model and its BMI are written in Python 3.
Tests of the BMI are provided.

This repository is organized with the following directories:

*heat*
  Source code for the model and its BMI

*examples*
  Jupyter Notebooks that demonstrate how to run the model through its BMI

*tests*
  Tests that cover the BMI of the model

Build/Install
-------------

This example can be built and installed on Linux, macOS, and Windows.

**Prerequisites:**

* Python 3
* The Python BMI bindings. Follow the build and install directions
  given in the `README`_ in that repository. You can choose to install
  them from source, or through `pip` or `conda`.

To build/install this example from source,
using the current Python BMI version, run

.. code-block:: bash

  $ pip install -e .

To run the tests,

.. code-block:: bash

  $ pip install -r requirements-testing.txt
  $ make test


.. _Python bindings: https://github.com/csdms/bmi-python
.. _Basic Model Interface: https://bmi.readthedocs.io
.. _README: https://github.com/csdms/bmi-python/blob/master/README.rst

Owner

  • Name: Community Surface Dynamics Modeling System
  • Login: csdms
  • Kind: organization
  • Email: csdms@colorado.edu

Cyberinfrastructure for the quantitative modeling of earth and planetary surface processes

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
  • Delete event: 4
  • Issue comment event: 8
  • Push event: 47
  • Pull request review event: 3
  • Pull request event: 8
  • Create event: 7
Last Year
  • Issues event: 1
  • Watch event: 1
  • Delete event: 4
  • Issue comment event: 8
  • Push event: 47
  • Pull request review event: 3
  • Pull request event: 8
  • Create event: 7

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 228
  • Total Committers: 4
  • Avg Commits per committer: 57.0
  • Development Distribution Score (DDS): 0.25
Past Year
  • Commits: 3
  • Committers: 1
  • Avg Commits per committer: 3.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
mcflugen m****n@g****m 171
Mark Piper m****r@c****u 53
Ben van Werkhoven b****n@e****l 3
Mike Taves m****s@g****m 1
Committer Domains (Top 20 + Academic)
esciencecenter.nl: 1 colorado.edu: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 7
  • Total pull requests: 32
  • Average time to close issues: 4 months
  • Average time to close pull requests: 6 days
  • Total issue authors: 3
  • Total pull request authors: 6
  • Average comments per issue: 1.71
  • Average comments per pull request: 1.0
  • Merged pull requests: 27
  • Bot issues: 0
  • Bot pull requests: 1
Past Year
  • Issues: 3
  • Pull requests: 9
  • Average time to close issues: 5 minutes
  • Average time to close pull requests: about 6 hours
  • Issue authors: 3
  • Pull request authors: 3
  • Average comments per issue: 2.33
  • Average comments per pull request: 1.11
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 1
View more stats
Top Authors
Issue Authors
  • mdpiper (5)
  • BSchilperoort (1)
  • mcflugen (1)
Pull Request Authors
  • mdpiper (19)
  • mcflugen (11)
  • pre-commit-ci[bot] (2)
  • RolfHut (1)
  • mwtoews (1)
  • benvanwerkhoven (1)
Top Labels
Issue Labels
question (1)
Pull Request Labels