A collection of box-geometry model (BGM) files for the Atlantis ecosystem model. Atlantis is a deterministic, biogeochemical, whole-of-ecosystem model (see < http://atlantis.cmar.csiro.au/> for more information).
A raw-data package with example .bgm files (box geometry model) for Atlantis ecosystem model.
Atlantis is a deterministic, biogeochemical, whole-of-ecosystem model: http://atlantis.cmar.csiro.au/.
PLEASE NOTE: this is not an official source of BGM for use in Atlantis.
See https://github.com/mdsumner/rbgm for an R package to read these files and work with the box geometry.
See https://github.com/AustralianAntarcticDivision/box-geometry-models for the project that collects the files used in this package.
Install from CRAN:
install.packages("bgmfiles")
Install the develop version from Github using devtools
.
devtools::install_github("AustralianAntarcticDivision/bgmfiles")
List the available raw files available in this package.
library(bgmfiles)files <- bgmfiles()print(basename(files))#> [1] "AEEC_poly_projETRS89_LAEA_snapped0p002.bgm"#> [2] "ams71.bgm"#> [3] "antarctica_28.bgm"#> [4] "antarctica_99.bgm"#> [5] "CalCurrentV3_utm.bgm"#> [6] "Final_CAM_Boxes_8.bgm"#> [7] "GOM_BGM.bgm"#> [8] "Guam_utm1.bgm"#> [9] "JFRE_ll.bgm"#> [10] "JFRE_xy.bgm"#> [11] "NGOM.bgm"#> [12] "Nordic02.bgm"#> [13] "VMPA_setas.bgm"
If needed filter based on a specific string with the pattern
argument:
afiles <- bgmfiles(pattern = "^antarc")print(basename(afiles))#> [1] "antarctica_28.bgm" "antarctica_99.bgm"
This package exists as a data package to install example files, there is just one function bgmfiles
that runs file finding functions:
list.files(system.file("extdata", package = "bgmfiles"), pattern = NULL, full.names = TRUE, recursive = TRUE)
We don't need to load or attach the package to find these files, but using the installation mechanism is very convenient for R use.
If you would like to contribute example BGM files or to the package:
or just get in touch directly via email.
added added Final_CAM_Boxes_8.bgm from Thomas Ihde
updated install notes
new file NGOM.bgm from Cameron Ainsworth
new files JFRE_ll.bgm and JFRE_xy.bgm of the Juan Fernández Ridge Ecosystem (JFRE) from Javier Porobic
bgmfiles
to do the work.NEWS.md
file to track changes to the package.