Tools for 'Box Geometry Model' (BGM) Files and Topology for the Atlantis Ecosystem Model

Facilities for working with Atlantis box-geometry model (BGM) files. Atlantis is a deterministic, biogeochemical, whole-of-ecosystem model. Functions are provided to read from BGM files directly, preserving their internal topology, as well as helper functions to generate spatial data from these mesh forms. This functionality aims to simplify the creation and modification of box and geometry as well as the ability to integrate with other data sources.

rbgm - R tools for Box Geometry model files

rbgm allows reading of geometry from BGM files, either in raw coordinate form or as Spatial objects or sf objects. The aim is to make all of the following straightforward:

• read of the BGM format, maintaining all topology and attributes
• use of the BGM specification for visualization and data extraction
• creation of BGM from shapefiles, R spatial objects and whatever else

Installation

Install from CRAN:

install.packages("rbgm")

Install the development version from Github using devtools.

# install.packages("devtools")
devtools::install_github("mdsumner/rbgm")

How can I contribute to rbgm?

Install, use, test the package, and let me know!

Please use the Issues tab on GitHub to add feature requests and bug reports: https://github.com/AustralianAntarcticDivision/rbgm/issues/

Examples

See the package vignettes for examples.

Please note that the ‘rbgm’ project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.