{"id":38730162,"url":"https://github.com/csdms/bmi-docker","last_synced_at":"2026-01-17T11:25:33.944Z","repository":{"id":305996025,"uuid":"850066110","full_name":"csdms/bmi-docker","owner":"csdms","description":"A Docker base image with the C, C++, Fortran, and Python BMI mappings and examples","archived":false,"fork":false,"pushed_at":"2025-09-25T23:20:42.000Z","size":17,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-09-26T01:12:41.247Z","etag":null,"topics":["bmi","c","csdms","cxx","docker","fortran","python"],"latest_commit_sha":null,"homepage":"https://bmi.csdms.io","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/csdms.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-08-30T20:08:01.000Z","updated_at":"2025-09-25T23:20:45.000Z","dependencies_parsed_at":"2025-07-23T05:21:46.755Z","dependency_job_id":"1d51f952-d96f-455b-b133-44cf316da3d7","html_url":"https://github.com/csdms/bmi-docker","commit_stats":null,"previous_names":["csdms/bmi-docker"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/csdms/bmi-docker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/csdms","download_url":"https://codeload.github.com/csdms/bmi-docker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/csdms%2Fbmi-docker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28507210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T10:25:30.148Z","status":"ssl_error","status_checked_at":"2026-01-17T10:25:29.718Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bmi","c","csdms","cxx","docker","fortran","python"],"created_at":"2026-01-17T11:25:33.840Z","updated_at":"2026-01-17T11:25:33.932Z","avatar_url":"https://github.com/csdms.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Basic Model Interface](https://img.shields.io/badge/CSDMS-Basic%20Model%20Interface-green.svg)](https://bmi.readthedocs.io/)\n[![DOI](https://zenodo.org/badge/850066110.svg)](https://doi.org/10.5281/zenodo.17204327)\n![Docker Image Version](https://img.shields.io/docker/v/csdms/bmi)\n\n# bmi-docker\n\nThe [Basic Model Interface](https://bmi.csdms.io) (BMI) mappings and examples for C, C++, Fortran, and Python, Dockerized.\n\nThe image built from these instructions can be used as a base for building models that expose a BMI in these languages,\nor for inter-language model coupling.\n\n## Build the image\n\nBuild an image locally with:\n```\ndocker build --tag bmi .\n```\nThe image is built on the [condaforge/miniforge3](https://hub.docker.com/r/condaforge/miniforge3/) base image.\nThe OS is Linux/Ubuntu.\n`conda`, as well as the BMI language mappings and examples, are installed in `CONDA_DIR=/opt/conda`.\nThe *base* environment is activated.\n\n## Run a container\n\nRun a container from this image interactively:\n```\ndocker run -it --rm bmi\n```\nThis starts a bash shell in the container where the language mappings and examples can be accessed.\n\n### C example\n\nRun the program `run_bmiheatc`\nfrom the [BMI C example](https://github.com/csdms/bmi-example-c)\nwith a configuration file:\n```bash\ncd /tmp\necho \"1.5, 8.0, 6, 5\" \u003e config.txt\nrun_bmiheatc config.txt\n```\nView the program's output with:\n```bash\ncat bmiheatc.out\n```\n\n### C++ example\n\nRun the program `run_bmiheatcxx`\nfrom the [BMI C++ example](https://github.com/csdms/bmi-example-cxx)\nwith a configuration file:\n```bash\ncd /tmp\necho \"1.5, 8.0, 6, 5\" \u003e config.txt\nrun_bmiheatcxx config.txt\n```\nView the program's output with:\n```bash\ncat bmiheatcxx.out\n```\n\n### Fortran example\n\nRun the program `run_bmiheatf`\nfrom the [BMI Fortran example](https://github.com/csdms/bmi-example-fortran)\nwith a configuration file:\n```bash\ncd /tmp\necho \"1.5, 8.0, 6, 5\" \u003e config.txt\nrun_bmiheatf config.txt\n```\nView the program's output with:\n```bash\ncat bmiheatf.out\n```\n\n### Python example\n\nStart a Python session to run the *heat* model through its BMI.\n```python\n\u003e\u003e\u003e from heat import BmiHeat\n\u003e\u003e\u003e x = BmiHeat()\n\u003e\u003e\u003e x.get_component_name()\n'The 2D Heat Equation'\n```\n\nThe Python BMI example includes a set of [example notebooks](https://github.com/csdms/bmi-example-python/tree/master/examples).\nRun them through a container.\n```bash\ndocker run -it -p 8888:8888 csdms/bmi:latest /bin/bash -c \"\\\n    conda install jupyter -y --quiet \u0026\u0026 \\\n    jupyter notebook \\\n    --notebook-dir=/opt/bmi-example-python/examples \\\n    --ip='*' --port=8888 \\\n    --no-browser --allow-root\"\n```\nThis is a little tricky, but\nexamine the output of the Jupyter server after it starts;\nit will include an URL from *localhost* that includes a security token.\nCopy/paste this URL into a browser to view and run the example notebooks.\n\n## Developer notes\n\nA versioned, multiplatform image built from this repository is hosted on Docker Hub\nat [csdms/bmi](https://hub.docker.com/repository/docker/csdms/bmi/).\nThis image is automatically built and pushed to Docker Hub\nwith the [release](./.github/workflows/release.yml) CI workflow.\nThe workflow is only run when the repository is tagged.\nTo manually build and push an update, run:\n```\ndocker buildx build --platform linux/amd64,linux/arm64 -t csdms/bmi:latest --push .\n```\nA user can pull this image from Docker Hub with:\n```\ndocker pull csdms/bmi\n```\noptionally with the `latest` tag or with a version tag.\n\n## What is the Basic Model Interface?\n\nThe Basic Model Interface (BMI) is a set of functions for querying, modifying, running, and coupling models.\nLearn more at https://bmi.readthedocs.io/.\n\n## Acknowledgment\n\nThis 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*.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Fbmi-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcsdms%2Fbmi-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcsdms%2Fbmi-docker/lists"}