Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/csdms/bmi-example-c
An example of wrapping a model written in C with a BMI
https://github.com/csdms/bmi-example-c
bmi c csdms
Last synced: 3 days ago
JSON representation
An example of wrapping a model written in C with a BMI
- Host: GitHub
- URL: https://github.com/csdms/bmi-example-c
- Owner: csdms
- License: mit
- Created: 2019-10-10T23:03:00.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-28T16:24:38.000Z (4 months ago)
- Last Synced: 2024-08-28T18:08:46.977Z (4 months ago)
- Topics: bmi, c, csdms
- Language: C
- Homepage: https://bmi.readthedocs.io
- Size: 77.1 KB
- Stars: 1
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bmi.readthedocs.io/)
[](https://github.com/csdms/bmi-example-c/actions/workflows/test.yml)
# bmi-example-c
An example of implementing the
[C bindings](https://github.com/csdms/bmi-c)
for the CSDMS
[Basic Model Interface](https://bmi.readthedocs.io) (BMI).
## Overview
This is an example of implementing a BMI for a simple model
that solves the diffusion equation
on a uniform rectangular plate
with Dirichlet boundary conditions.
The model and its BMI are written in C.
Tests of the BMI are provided.
This repository is organized with the following directories:
- heat
- Holds the model, the BMI for the model, and a sample main program
- testing
- Tests that cover the BMI of the model
## Build/Install
This example can be built on Linux, macOS, and Windows.
**Prerequisites:**
* A C compiler
* CMake
* pkg-config
* The C BMI bindings. Follow the build and install directions
given in the
[README](https://github.com/csdms/bmi-c/blob/master/README.md)
in that repository. You can choose to install them from source or
through a conda binary.
### Linux and macOS
To build and install this example from source with cmake,
using the current C BMI version, run
mkdir _build && cd _build
export PKG_CONFIG_PATH= # optional: only needed for non-standard install location
cmake .. -DCMAKE_INSTALL_PREFIX=
make
make install
where `` is the base directory
in which the C BMI bindings have been installed
(`/usr/local` is the default).
When installing into a conda environment,
use the `$CONDA_PREFIX` environment variable.
The installation will look like
(on macOS, using v2.0 of the BMI specification):
```bash
.
|-- bin
| |-- run_bmiheatc
| `-- run_heatc
|-- include
| |-- bmi.h
| |-- heat.h
| `-- bmi_heat.h
`-- lib
|-- libbmiheatc.dylib
|-- libheatc.dylib
`-- pkgconfig
|-- bmic.pc
|-- heatc.pc
`-- bmiheatc.pc
4 directories, 10 files
```
From the build directory,
run unit tests on the sample implementation with
ctest
### Windows
An additional prerequisite is needed for Windows:
* Microsoft Visual Studio 2017 or Microsoft Build Tools for Visual Studio 2017
To configure this example from source with cmake
using the current C BMI version,
run the following in a [Developer Command Prompt](https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs)
mkdir _build && cd _build
set "PKG_CONFIG_PATH=" &:: optional: only needed for non-standard install location
cmake .. ^
-G "NMake Makefiles" ^
-DCMAKE_INSTALL_PREFIX= ^
-DCMAKE_BUILD_TYPE=Release
where `` is the base directory
in which the C BMI bindings have been installed.
The default is `"C:\Program Files (x86)"`.
Note that quotes and an absolute path are needed.
When using a conda environment, use `"%CONDA_PREFIX%\Library"`.
Then, to build and install:
cmake --build . --target install --config Release
From the build directory,
run unit tests on the sample implementation with
ctest
## Use
Run the heat model through its BMI with the `run_bmiheatc` program,
which takes a model configuration file
(see the [testing](./testing) directory for a sample)
as a required parameter.
If `run_bmiheatc` is in your path, run it with
run_bmiheatc config.txt
Output from the model is written to the file **bmiheatc.out**
in the current directory.