Skip to main content

A dummy BMI model that accepts any inputs and always outputs 0

Project description

bmi-dummy

A no-op Basic Model Interface (BMI) model for use with NextGen / NGIAB. It accepts any input variables and always returns 0.0 for every output at every time step.

Authored by Claude.

Install

pip install -e .

Usage

import numpy as np
from bmi_dummy import BmiDummy

model = BmiDummy()
model.initialize("/dev/null")   # or a YAML config path, or ""

while model.get_current_time() < model.get_end_time():
    model.set_value("input", np.array([42.0]))
    model.update()
    dest = np.zeros(1)
    model.get_value("output", dest)   # always 0.0

model.finalize()

Optional YAML config

start_time: 0.0
end_time: 86400.0
time_step: 3600.0
input_vars: [rainfall, temperature]
output_vars: [streamflow]

All keys are optional — /dev/null (empty file) falls back to defaults.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bmi_dummy-0.1.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bmi_dummy-0.1.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file bmi_dummy-0.1.0.tar.gz.

File metadata

  • Download URL: bmi_dummy-0.1.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for bmi_dummy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fabcf01981d2b03eaa8fdd364162bf538f84100eed8a5a14f00d403f4c140f8b
MD5 a2c5aa92337bbe95be059144d33f35ec
BLAKE2b-256 d530ce4067f41ba100ae4853878f57f7eced3ad470e656fb50a9672b1ab0df89

See more details on using hashes here.

File details

Details for the file bmi_dummy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: bmi_dummy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.11

File hashes

Hashes for bmi_dummy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aa77b55673fd8e9d8a589668e7666767a9976a97e418c7019ac04b16dd95fc56
MD5 b954dc0854ad5f1477b5308ecec74cf2
BLAKE2b-256 fced50051b96fab226ff62ae528d61bbdf8702e28e8a41be30eeecd815df978d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page