https://github.com/csdms/bmi-cxx

Basic Model Interface for C++
https://github.com/csdms/bmi-cxx

bmi c-plus-plus cmake csdms

Last synced: 11 days ago
JSON representation

Basic Model Interface for C++

• Host: GitHub
• URL: https://github.com/csdms/bmi-cxx
• Owner: csdms
• License: mit
• Created: 2015-01-24T00:17:45.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-06-24T21:19:01.000Z (6 months ago)
• Last Synced: 2024-06-24T22:57:26.427Z (6 months ago)
• Topics: bmi, c-plus-plus, cmake, csdms
• Language: C++
• Homepage: https://bmi.readthedocs.io
• Size: 48.8 KB
• Stars: 0
• Watchers: 8
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![DOI](https://zenodo.org/badge/29759595.svg)](https://zenodo.org/badge/latestdoi/29759595)

[![Build and Test](https://github.com/csdms/bmi-cxx/actions/workflows/test.yml/badge.svg)](https://github.com/csdms/bmi-cxx/actions/workflows/test.yml)

[![Anaconda-Server Badge](https://anaconda.org/conda-forge/bmi-cxx/badges/version.svg)](https://anaconda.org/conda-forge/bmi-cxx)

[![Anaconda-Server Badge](https://anaconda.org/conda-forge/bmi-cxx/badges/platforms.svg)](https://anaconda.org/conda-forge/bmi-cxx)

[![Anaconda-Server Badge](https://anaconda.org/conda-forge/bmi-cxx/badges/downloads.svg)](https://anaconda.org/conda-forge/bmi-cxx)

# bmi-cxx

C++ bindings for the CSDMS

[Basic Model Interface](https://bmi.readthedocs.io).

## Build/Install

The C++ BMI bindings can be built on Linux, macOS, and Windows.

Instructions are given below.

**Prerequisites:**

* A C++ compiler

* CMake

Alternately,

[conda binaries](https://anaconda.org/conda-forge/bmi-cxx)

have been built for Linux, macOS, and Windows.

Install the C++ BMI bindings (no build needed)

into an Anaconda distribution with

    conda install bmi-cxx -c conda-forge

### Linux and macOS

To install the C++ BMI bindings from source with cmake, run

    mkdir _build && cd _build

    cmake .. -DCMAKE_INSTALL_PREFIX=

    make install

where `` is the base directory

in which to install the bindings (`/usr/local` is the default).

When using a conda environment,

use the `$CONDA_PREFIX` environment variable.

The installation will look like:

```bash

.

|-- include

|   `-- bmi.hxx

`-- lib

    `-- pkgconfig

        `-- bmicxx.pc

```

### Windows

An additional prerequisite is needed for Windows:

* Microsoft Visual Studio 2017 or Microsoft Build Tools for Visual Studio 2017

To configure and install the C++ BMI bindings from source with cmake,

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

    cmake .. ^

	  -G "NMake Makefiles" ^

	  -DCMAKE_INSTALL_PREFIX= ^

	  -DCMAKE_BUILD_TYPE=Release

	cmake --build . --target install --config Release

where `` is the base directory in which to install the bindings.

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"`.

## Use

To write a BMI for a model,

include the `bmi.hxx` header and implement all the BMI functions

included in the interface defined therein.

BMI functions that aren't used

(e.g., `get_grid_x` for a uniform rectilinear grid)

can simply return the BMI_FAILURE status code.

A sample implementation is given in the

https://github.com/csdms/bmi-example-cxx

repository.