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.

Project Status: Active - The project has reached a stable, usable state and is being actively developed. Build Status AppVeyor Build Status CRAN_Status_Badge CRAN RStudio mirror downloads Coverage Status 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. 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


Install from CRAN:


Install the development version from Github using devtools.


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:

use Pull Requests if you have changes you'd like to contribute.

Related work

  • mfdbatlantis MareFrame Atlantis routines
  • atlantistools data processing and visualisation tool for R
  • shinyrAtlantis
  • ratlantis R code for interfacing with Atlantis ecosystem modeling software
  • vat Visualizing Atlantis Tool (vat)
  • EastAntarctica_Atlantis Project work at Australian Antarctic Division and the Antarctic Climate and Ecosystems CRC
  • AtlantisNEUS_R R code (scripts and functions) to interact with and analyze output from the Atlantis NEAU End-2-end marine ecosystem model


See the package vignettes for examples.


rbgm 0.0.5

  • Included rgeos and spdplyr in Suggests, thanks to CRAN.

  • added new function 'read_bgm' as a more obvious version of the original read function 'bgmfile'

  • removed names from component sp lists to avoid troubles in sf causing troubles in mapview

rbgm 0.0.4

  • added vignettes, examples, more doc

  • removed some old functions

  • cleaned up for CRAN

  • fixed a gnarly bug due to lexicographic sorting on a list! Lines from faceSpatial were coming out in the sorted order of "face0", "face1", "face10", "face30" etc.

  • renamed "leftbox" and "rightbox" to "left" and "right"

  • readme includes all example files in bgmfiles

  • new example files added

  • added functions pointSpatial and nodeSpatial

  • new function bgmfile to replace deprecated read_bgm

  • new tests and changes to capture Guam_utm1 variant

rbgm 0.0.2

  • First fully working build ready for check.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.


0.1.0 by Michael D. Sumner, a year ago

Report a bug at

Browse source code at

Authors: Michael D. Sumner [aut, cre]

Documentation:   PDF Manual  

GPL-3 license

Imports dplyr, geosphere, rlang, reproj, sfheaders

Depends on raster, sp

Suggests bgmfiles, covr, knitr, rmarkdown, roxygen2, testthat

See at CRAN