Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an initial list of BMI design principles #105

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,21 @@ BMI is an element of the `CSDMS Workbench`_,
an integrated system of software tools, technologies, and standards
for building and coupling models.

BMI Design Principles
=====================

* Easy to implement. Preference goes to the implementer over the end user.
* Self describing.
* Common tasks are left up to a framework.
* Popeye Principle (“I am what I am”). BMI libraries just report about themselves.
* Language agnostic
* NOT intended to accommodate every model and use case.
* Intended for model coupling but not necessarily model-to-model coupling.
* A model can be a numerical software model but could also be a dataset.
* Does not inject itself into a model.
* Minimal but can be open to *extensions*.


*The Community Surface Dynamics Modeling System
is supported by the National Science Foundation.*

Expand Down