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

Conversation

mcflugen
Copy link
Member

I thought it would be good to have a list of BMI design principles in the README. I'll list them here as well,

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.

@mdpiper
Copy link
Member

mdpiper commented Oct 27, 2022

These should be enumerated, like commandments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants