Skip to content

List R mappings and example #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

List R mappings and example #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
282ee78
List R mappings and example
mdpiper Dec 1, 2025
13967d2
Also link to R BMI in the README
mdpiper Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,13 @@ and are [acknowledged](./AUTHORS.rst).

The table below lists community-contributed
language specifications and examples
for two languages, Javascript and Julia.
for Javascript, Julia, and R.

| Language | Specification | Example implementation |
| ---------- | ------------- | ---------------------- |
| Javascript | [bmi-js] | [bmi-example-js] |
| Julia | [bmi-julia] | [bmi-example-julia] |
| R | [bmi-r] | [bmi-example-r] |

The default branch of this repository
reflects the current state of development for the BMI.
Expand Down Expand Up @@ -109,11 +110,13 @@ is supported by the National Science Foundation.*
[bmi-example-js]: https://github.com/uihilab/bmi-example-js
[bmi-example-julia]: https://github.com/csdms/bmi-example-julia
[bmi-example-python]: https://github.com/csdms/bmi-example-python
[bmi-example-r]: https://github.com/csdms/bmi-example-r
[bmi-fortran]: https://github.com/csdms/bmi-fortran
[bmi-java]: https://github.com/csdms/bmi-java
[bmi-js]: https://github.com/uihilab/bmi-js
[bmi-julia]: https://github.com/Deltares/BasicModelInterface.jl
[bmi-python]: https://github.com/csdms/bmi-python
[bmi-r]: https://github.com/csdms/bmi-r
[community surface dynamics modeling system]: https://csdms.colorado.edu
[csdms workbench]: https://csdms.colorado.edu/wiki/Workbench
[documentation]: https://bmi.readthedocs.io
Expand Down
6 changes: 5 additions & 1 deletion docs/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ in which the BMI is implemented.

BMI is a community standard.
Table 2 lists community-contributed language specifications and examples
for two languages, Javascript and Julia.
for Javascript, Julia, and R.

:::{table} **Table 2:** Community-contributed BMI languages.
:align: center
Expand All @@ -66,6 +66,7 @@ for two languages, Javascript and Julia.
| ---------- | ------------- | ------------ | -------------------- |
| Javascript | [bmi.js] | [bmi-js] | [bmi-example-js] |
| Julia | [bmi.jl] | [bmi-julia] | [bmi-example-julia] |
| R | [bmi.R] | [bmi-r] | [bmi-example-r] |
:::

Along with the examples,
Expand Down Expand Up @@ -155,18 +156,21 @@ Docs <https://bmi.readthedocs.io>
[bmi-example-js]: https://github.com/uihilab/bmi-example-js
[bmi-example-julia]: https://github.com/csdms/bmi-example-julia
[bmi-example-python]: https://github.com/csdms/bmi-example-python
[bmi-example-r]: https://github.com/csdms/bmi-example-r
[bmi-fortran]: https://github.com/csdms/bmi-fortran
[bmi-java]: https://github.com/csdms/bmi-java
[bmi-js]: https://github.com/uihilab/bmi-js
[bmi-julia]: https://github.com/Deltares/BasicModelInterface.jl
[bmi-python]: https://github.com/csdms/bmi-python
[bmi-r]: https://github.com/csdms/bmi-r
[bmi.f90]: https://github.com/csdms/bmi-fortran/blob/master/bmi.f90
[bmi.h]: https://github.com/csdms/bmi-c/blob/master/bmi.h
[bmi.hxx]: https://github.com/csdms/bmi-cxx/blob/master/bmi.hxx
[bmi.java]: https://github.com/csdms/bmi-java/blob/master/src/main/java/edu/colorado/csdms/bmi/BMI.java
[bmi.jl]: https://github.com/Deltares/BasicModelInterface.jl/blob/master/src/BasicModelInterface.jl
[bmi.js]: https://github.com/uihilab/BMI-JS/blob/main/bmijs/bmi.js
[bmi.py]: https://github.com/csdms/bmi-python/blob/master/src/bmipy/bmi.py
[bmi.R]: https://github.com/csdms/bmi-r/blob/main/R/bmi.R
[community surface dynamics modeling system]: https://csdms.colorado.edu
[csdms help desk]: https://github.com/csdms/help-desk
[csdms workbench]: https://csdms.colorado.edu/wiki/Workbench