https://github.com/csdms/bmi-example-python-grpc4bmi
Run the Python BMI example through grpc4bmi
https://github.com/csdms/bmi-example-python-grpc4bmi
bmi csdms docker grpc4bmi python
Last synced: 12 days ago
JSON representation
Run the Python BMI example through grpc4bmi
- Host: GitHub
- URL: https://github.com/csdms/bmi-example-python-grpc4bmi
- Owner: csdms
- License: mit
- Created: 2024-04-17T18:24:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T21:21:16.000Z (over 1 year ago)
- Last Synced: 2025-02-16T17:56:19.513Z (about 1 year ago)
- Topics: bmi, csdms, docker, grpc4bmi, python
- Language: Dockerfile
- Homepage: https://bmi.csdms.io
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bmi.readthedocs.io/)
[](https://doi.org/10.5281/zenodo.17204647)
[](https://github.com/csdms/bmi-example-python-grpc4bmi/actions/workflows/test.yml)
[](https://github.com/csdms/bmi-example-python-grpc4bmi/actions/workflows/release.yml)
# bmi-example-python-grpc4bmi
Set up a [grpc4bmi](https://grpc4bmi.readthedocs.io) server
to run a containerized version
of the [Basic Model Interface](https://bmi.readthedocs.io) (BMI)
[Python example](https://github.com/csdms/bmi-example-python).
## Build
Build the server image locally with:
```
docker build --tag bmi-example-python-grpc4bmi .
```
The image is built on the [csdms/grpc4bmi](https://hub.docker.com/r/csdms/grpc4bmi) base image,
which is built on the [condaforge/miniforge3](https://hub.docker.com/r/condaforge/miniforge3) base image.
The OS is Linux/Ubuntu.
The grpc4bmi Python server,
as well as the Python BMI mappings and example
(consisting of the *Heat* model and a BMI implementation, *BmiHeat*)
are installed in `CONDA_DIR=/opt/conda`.
## Run
Use the grpc4bmi Docker client to access the BMI methods of the containerized model.
Install grpc4bmi with *pip*:
```
pip install grpc4bmi
```
Then, in a Python session, access the *Heat* model in the image built above with:
```python
from grpc4bmi.bmi_client_docker import BmiClientDocker
IMAGE_NAME = "bmi-example-python-grpc4bmi"
m = BmiClientDocker(image=IMAGE_NAME, image_port=55555, work_dir=".")
m.get_component_name()
del m # stop container cleanly
```
If the image isn't found locally, it's pulled from Docker Hub
(e.g., try substituting `IMAGE_NAME="csdms/bmi-example-python-grpc4bmi"` above).
For more in-depth examples of running the *Heat* model from grpc4bmi,
see the [examples](./examples) directory.
## Developer notes
A versioned, multiplatform image built from this repository is hosted on Docker Hub
at [csdms/bmi-example-python-grpc4bmi](https://hub.docker.com/r/csdms/bmi-example-python-grpc4bmi).
When this repository is tagged,
an image is automatically built and pushed to Docker Hub
by the [release](./.github/workflows/release.yml) CI workflow.
To manually build and push an update, run:
```
docker buildx build --platform linux/amd64,linux/arm64 -t csdms/bmi-example-python-grpc4bmi:latest --push .
```
A user can pull this image from Docker Hub with:
```
docker pull csdms/bmi-example-python-grpc4bmi
```
optionally with the `latest` tag or with a version tag.
## What are the Basic Model Interface and grpc4bmi?
The Basic Model Interface (BMI) is a set of functions for querying, modifying, running, and coupling models.
Learn more at https://bmi.csdms.io/.
grpc4bmi is a [gRPC](https://grpc.io/) wrapper for a model with a BMI.
Learn more at https://grpc4bmi.readthedocs.io/.
## Acknowledgment
This work is supported by the U.S. National Science Foundation under Award No. [2103878](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2103878), *Frameworks: Collaborative Research: Integrative Cyberinfrastructure for Next-Generation Modeling Science*.