Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/csdms/bmi-example-fortran
An example of wrapping a model written in Fortran with a BMI
https://github.com/csdms/bmi-example-fortran
bmi csdms fortran
Last synced: 3 days ago
JSON representation
An example of wrapping a model written in Fortran with a BMI
- Host: GitHub
- URL: https://github.com/csdms/bmi-example-fortran
- Owner: csdms
- License: mit
- Created: 2019-04-09T23:00:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-18T22:26:04.000Z (17 days ago)
- Last Synced: 2024-12-18T22:28:41.485Z (17 days ago)
- Topics: bmi, csdms, fortran
- Language: Fortran
- Homepage: https://bmi.csdms.io/
- Size: 95.7 KB
- Stars: 4
- Watchers: 7
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://bmi.readthedocs.io/)
[](https://github.com/csdms/bmi-example-fortran/actions?query=workflow%3ABuild%2FTest)
# bmi-example-fortran
An example of implementing the
[Fortran bindings](https://github.com/csdms/bmi-fortran)
for the CSDMS [Basic Model Interface](https://bmi.csdms.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.
Tests and examples of using the BMI are provided.
The model is written in Fortran 90.
The BMI is written in Fortran 2003.
This repository is organized with the following directories:
- heat
- Holds the model and a sample main program
- bmi_heat
- Holds the BMI for the model and a main program to run the
model through its BMI - test
- Unit tests for the BMI-ed model
- example
- Examples of controlling the model through its BMI
## Build/Install
This example can be built on Linux, macOS, and Windows.
**Prerequisites:**
* A Fortran compiler
* CMake or [Fortran Package Manager](https://fpm.fortran-lang.org/)
* If using CMake, the Fortran BMI bindings. Follow the build and
install directions given in the
[README](https://github.com/csdms/bmi-fortran/blob/master/README.md)
in that repository. You can choose to build them from source or
install them through a conda binary. If using fpm, the binding
will be automatically downloaded and built for you.
* pkg-config
### CMake - Linux and macOS
To configure and build this example from source with CMake,
using the current Fortran BMI version, run
cmake -B _build -DCMAKE_INSTALL_PREFIX=
cmake --build _build
where `` is the base directory
in which the Fortran BMI bindings have been installed
(`/usr/local` is the default).
When installing into a conda environment,
use the `$CONDA_PREFIX` environment variable.
Then, to install:
cmake --install _build
The installation will look like
(on macOS, using v2.0 of the Fortran BMI specification):
```bash
.
|-- bin
| |-- run_bmiheatf
| `-- run_heatf
|-- include
| |-- bmif_2_0.mod
| |-- bmiheatf.mod
| `-- heatf.mod
`-- lib
|-- libbmif.a
|-- libbmif.2.1.4.dylib
|-- libbmif.dylib -> libbmif.2.1.4.dylib
|-- libbmiheatf.dylib
|-- libheatf.dylib
`-- pkgconfig
|-- bmif.pc
|-- bmiheatf.pc
`-- heatf.pc
```
Run unit tests and examples of using the sample implementation with
ctest --test-dir _build
### CMake - Windows
An additional prerequisite is needed for Windows:
* Microsoft Visual Studio 2017 or Microsoft Build Tools for Visual Studio 2017
To configure and build this example from source with CMake
using the current Fortran BMI version,
run the following in a [Developer Command Prompt](https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs)
cmake -B _build -L -G Ninja -DCMAKE_INSTALL_PREFIX=
cmake --build _build
where `` is the base directory
in which the Fortran 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 install:
cmake --install _build
Run unit tests and examples of using the sample implementation with
ctest --test-dir _build
### Fortran Package Manager (fpm)
If you don't already have fpm installed, you can do so via Conda:
conda install fpm -c conda-forge
Then, to build and install:
fpm build --profile release
fpm install --prefix
where `` is the base directory in which to
install the model. Installation is optional.
To run the tests:
fpm test -- test/sample.cfg
Here, `test/sample.cfg` is passed as a command line parameter to the
run executables, and tells the tests where to find the test config
file.
To run all of the examples:
fpm run --example --all -- example
Similarly, `example` tells the example executables to look in the
`example` directory for config files. To run individual tests:
fpm run --example -- example
Where `` is the name of the example to run. To see
a list of available examples, run `fpm run --example`. Note that the
non-BMI heat model executable is not built by default when using fpm.
If you want to build and install this too, you can do so from the
heat directory:
cd heat
fpm build --profile release
fpm install --prefix
## Use
Run the heat model through its BMI with the `run_bmiheatf` program,
which takes a model configuration file
(see the [example](./example) directory for a sample)
as a required parameter.
If `run_bmiheatf` is in your path, run it with
run_bmiheatf test1.cfg
Output from the model is written to the file **bmiheatf.out**
in the current directory.
If you built the model using fpm, you can alternatively run the
program using
fpm run -- test.cfg