OceanBioME.jl
A tool to study the effectiveness and impacts of ocean carbon dioxide removal strategies.
https://github.com/OceanBioME/OceanBioME.jl
Category: Emissions
Sub Category: Carbon Capture
Keywords
biogeochemical-models biogeochemistry climate julia ocean ocean-modelling ocean-sciences oceanography
Keywords from Contributors
climate-change data-assimilation energy-system-model climate-science
Last synced: about 1 hour ago
JSON representation
Repository metadata
🌊 🦠🌿 A fast and flexible modelling environment written in Julia for modelling the coupled interactions between ocean biogeochemistry, carbonate chemistry, and physics
- Host: GitHub
- URL: https://github.com/OceanBioME/OceanBioME.jl
- Owner: OceanBioME
- License: mit
- Created: 2022-07-15T13:33:46.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-12-13T02:04:43.000Z (13 days ago)
- Last Synced: 2025-12-14T01:45:56.751Z (12 days ago)
- Topics: biogeochemical-models, biogeochemistry, climate, julia, ocean, ocean-modelling, ocean-sciences, oceanography
- Language: Julia
- Homepage: https://oceanbiome.github.io/OceanBioME.jl/
- Size: 310 MB
- Stars: 66
- Watchers: 6
- Forks: 24
- Open Issues: 33
- Releases: 48
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
README.md
Ocean Biogeochemical Modelling Environment
Description
OceanBioME is a flexible biogeochemical modelling environment written in Julia for modelling the coupled interactions between ocean biology, carbonate chemistry, and physics. OceanBioME can be run as a stand-alone box model, or coupled with Oceananigans.jl to run as a 1D column model or with 2 and 3D physics.
OceanBioME was developed with generous support from the Centre for Climate Repair CCR and the Gordon and Betty Moore Foundation as a tool to study the effectiveness and impacts of ocean carbon dioxide removal (CDR) strategies.
Installation:
First, download and install Julia
From the Julia prompt (REPL), type:
julia> using Pkg
julia> Pkg.add("OceanBioME")
Running your first model
As a simple example lets run a Nutrient-Phytoplankton-Zooplankton-Detritus (NPZD) model in a two-dimensional simulation of a buoyancy front. This example requires Oceananigans, so we install that first:
using Pkg; Pkg.add("Oceananigans")
using OceanBioME, Oceananigans
using Oceananigans.Units
grid = RectilinearGrid(CPU(), size = (160, 32), extent = (10000meters, 500meters), topology = (Bounded, Flat, Bounded))
biogeochemistry = NutrientPhytoplanktonZooplanktonDetritus(; grid)
model = NonhydrostaticModel(; grid, biogeochemistry,
advection = WENO(),
closure = AnisotropicMinimumDissipation(),
buoyancy = SeawaterBuoyancy(constant_salinity = true))
@inline front(x, z, μ, δ) = μ + δ * tanh((x - 7000 + 4 * z) / 500)
Páµ¢(x, z) = ifelse(z > -50, 0.03, 0.01)
Náµ¢(x, z) = front(x, z, 2.5, -2)
Táµ¢(x, z) = front(x, z, 9, 0.05)
set!(model, N = Náµ¢, P = Páµ¢, Z = Páµ¢, T = Táµ¢)
simulation = Simulation(model; Δt = 50, stop_time = 4days)
simulation.output_writers[:tracers] = JLD2Writer(model, model.tracers,
filename = "buoyancy_front.jld2",
schedule = TimeInterval(24minute),
overwrite_existing = true)
run!(simulation)
# Before running the visualization code below, make sure CairoMakie is installed:
using Pkg; Pkg.add("CairoMakie")
T = FieldTimeSeries("buoyancy_front.jld2", "T")
N = FieldTimeSeries("buoyancy_front.jld2", "N")
P = FieldTimeSeries("buoyancy_front.jld2", "P")
xc, yc, zc = nodes(T)
times = T.times
using CairoMakie
n = Observable(1)
T_lims = (8.94, 9.06)
N_lims = (0, 4.5)
P_lims = (0.007, 0.02)
Tâ‚™ = @lift interior(T[$n], :, 1, :)
Nâ‚™ = @lift interior(N[$n], :, 1, :)
Pâ‚™ = @lift interior(P[$n], :, 1, :)
fig = Figure(size = (1000, 520), fontsize = 20)
title = @lift "t = $(prettytime(times[$n]))"
Label(fig[0, :], title)
axis_kwargs = (xlabel = "x (m)", ylabel = "z (m)", width = 770, yticks = [-400, -200, 0])
ax1 = Axis(fig[1, 1]; title = "Temperature (°C)", axis_kwargs...)
ax2 = Axis(fig[2, 1]; title = "Nutrients concentration (mmol N / m³)",axis_kwargs...)
ax3 = Axis(fig[3, 1]; title = "Phytoplankton concentration (mmol N / m³)", axis_kwargs...)
hm1 = heatmap!(ax1, xc, zc, Tâ‚™, colorrange = T_lims, colormap = Reverse(:lajolla), interpolate = true)
hm2 = heatmap!(ax2, xc, zc, Nâ‚™, colorrange = N_lims, colormap = Reverse(:bamako), interpolate = true)
hm3 = heatmap!(ax3, xc, zc, Pâ‚™, colorrange = P_lims, colormap = Reverse(:bamako), interpolate = true)
Colorbar(fig[1, 2], hm1, ticks = [8.95, 9.0, 9.05])
Colorbar(fig[2, 2], hm2, ticks = [0, 2, 4])
Colorbar(fig[3, 2], hm3, ticks = [0.01, 0.02, 0.03])
rowgap!(fig.layout, 0)
record(fig, "buoyancy_front.gif", 1:length(times)) do i
n[] = i
end
https://github.com/OceanBioME/OceanBioME.jl/assets/26657828/d4a5dbc9-ffff-4ef0-8431-b9afc951142f
In this example OceanBioME is providing the biogeochemistry and the remainder is taken care of by Oceananigans.
For comprehensive documentation of the physics modelling see
Oceananigans' Documentation, and for
biogeochemistry and other features we provide read below.
Using GPU
To run the same example on a GPU we just need to construct the grid on the GPU; the rest is taken care of!
Just replace CPU() with GPU() in the grid construction with everything else left unchanged:
grid = RectilinearGrid(GPU(), size = (256, 32), extent = (500meters, 100meters), topology = (Bounded, Flat, Bounded))
Documentation
See the documentation for full description of the software package and more examples, as well as full descriptions of the included models and parametrisations.
Contributing
If you're interested in contributing to the development of OceanBioME we would appreciate your help!
If you'd like to work on a new feature, or if you're new to open source and want to crowd-source projects that fit your interests, please start a discussion.
For more information check out our contributor's guide.
Citing
If you use OceanBioME as part of your research, teaching, or other activities, we would be grateful if you could cite our work below and mention the package by name.
@article{OceanBioMEJOSS,
doi = {10.21105/joss.05669},
url = {https://doi.org/10.21105/joss.05669},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {90},
pages = {5669},
author = {Jago Strong-Wright and Si Chen and Navid C. Constantinou and Simone Silvestri and Gregory LeClaire Wagner and John R. Taylor},
title = {{OceanBioME.jl: A flexible environment for modelling the coupled interactions between ocean biogeochemistry and physics}},
journal = {Journal of Open Source Software}
}
If on top of citing the JOSS paper above, you need to cite a specific version of the package then please cite its corresponding version from the Zenodo archive.
Citation (CITATION.cff)
cff-version: "1.2.0"
authors:
- family-names: Strong-Wright
given-names: Jago
orcid: "https://orcid.org/0000-0002-7174-5283"
- family-names: Chen
given-names: Si
orcid: "https://orcid.org/0009-0002-1296-7166"
- family-names: Constantinou
given-names: Navid C
orcid: "https://orcid.org/0000-0002-8149-4094"
- family-names: Silvestri
given-names: Simone
orcid: "https://orcid.org/0000-0002-7156-946X"
- family-names: Wagner
given-names: Gregory LeClaire
orcid: "https://orcid.org/0000-0001-5317-2445"
- family-names: Taylor
given-names: John R
orcid: "https://orcid.org/0000-0002-1292-3756"
contact:
- family-names: Strong-Wright
given-names: Jago
orcid: "https://orcid.org/0000-0002-7174-5283"
doi: 10.5281/zenodo.8403490
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Strong-Wright
given-names: Jago
orcid: "https://orcid.org/0000-0002-7174-5283"
- family-names: Chen
given-names: Si
orcid: "https://orcid.org/0009-0002-1296-7166"
- family-names: Constantinou
given-names: Navid C
orcid: "https://orcid.org/0000-0002-8149-4094"
- family-names: Silvestri
given-names: Simone
orcid: "https://orcid.org/0000-0002-7156-946X"
- family-names: Wagner
given-names: Gregory LeClaire
orcid: "https://orcid.org/0000-0001-5317-2445"
- family-names: Taylor
given-names: John R
orcid: "https://orcid.org/0000-0002-1292-3756"
date-published: 2023-10-05
doi: 10.21105/joss.05669
issn: 2475-9066
issue: 90
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5669
title: "OceanBioME.jl: A flexible environment for modelling the
coupled interactions between ocean biogeochemistry and physics"
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05669"
volume: 8
title: "OceanBioME.jl: A flexible environment for modelling the coupled
interactions between ocean biogeochemistry and physics"
Owner metadata
- Name: OceanBioME
- Login: OceanBioME
- Email: js2430@damtp.cam.ac.uk
- Kind: organization
- Description: Organisaiton for OceanBioME.jl, a flexible ocean biogeochemical modelling enviroment
- Website: https://oceanbiome.github.io/OceanBioME.jl
- Location: United Kingdom
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/109746627?v=4
- Repositories: 2
- Last ynced at: 2023-07-12T17:32:06.599Z
- Profile URL: https://github.com/OceanBioME
GitHub Events
Total
- Create event: 39
- Commit comment event: 29
- Release event: 8
- Delete event: 23
- Member event: 2
- Pull request event: 43
- Fork event: 3
- Discussion event: 1
- Issues event: 36
- Watch event: 18
- Issue comment event: 158
- Push event: 304
- Pull request review comment event: 31
- Pull request review event: 44
Last Year
- Create event: 33
- Commit comment event: 24
- Release event: 6
- Delete event: 18
- Member event: 2
- Pull request event: 34
- Fork event: 2
- Discussion event: 1
- Issues event: 28
- Watch event: 14
- Issue comment event: 123
- Push event: 244
- Pull request review comment event: 29
- Pull request review event: 38
Committers metadata
Last synced: 4 days ago
Total Commits: 2,210
Total Committers: 15
Avg Commits per committer: 147.333
Development Distribution Score (DDS): 0.303
Commits in past year: 268
Committers in past year: 6
Avg Commits per committer in past year: 44.667
Development Distribution Score (DDS) in past year: 0.194
| Name | Commits | |
|---|---|---|
| Jago Stong-Wright | j****w@p****m | 1541 |
| Navid C. Constantinou | n****y | 304 |
| ciadht | c****9@c****k | 90 |
| johnryantaylor | j****r@g****m | 81 |
| coding-code123 | h****s@o****m | 76 |
| ali-ramadhan | a****n@g****m | 58 |
| Pietro Monticone | 3****e | 22 |
| Si Chen | s****0@c****k | 11 |
| M. A. Kowalski | m****0@c****k | 7 |
| Si Chen | c****1@g****m | 5 |
| emmabeniston | 1****n | 5 |
| CompatHelper Julia | c****y@j****g | 5 |
| simone-silvestri | s****0@g****m | 3 |
| iury simoes-sousa | i****t@p****e | 1 |
| Jago Strong-Wright | j****0@l****r | 1 |
Committer domains:
- cam.ac.uk: 2
- login-e-4.data.cluster: 1
- pm.me: 1
- julialang.org: 1
- charybdis.damtp.cam.ac.uk: 1
Issue and Pull Request metadata
Last synced: 5 days ago
Total issues: 85
Total pull requests: 241
Average time to close issues: 3 months
Average time to close pull requests: 12 days
Total issue authors: 15
Total pull request authors: 17
Average comments per issue: 4.6
Average comments per pull request: 2.57
Merged pull request: 174
Bot issues: 0
Bot pull requests: 4
Past year issues: 30
Past year pull requests: 48
Past year average time to close issues: 2 months
Past year average time to close pull requests: about 1 month
Past year issue authors: 8
Past year pull request authors: 9
Past year average comments per issue: 2.8
Past year average comments per pull request: 1.58
Past year merged pull request: 20
Past year bot issues: 0
Past year bot pull requests: 4
Top Issue Authors
- jagoosw (26)
- MarionBWeinzierl (12)
- ali-ramadhan (11)
- johnryantaylor (10)
- navidcy (7)
- Mikolaj-A-Kowalski (7)
- iuryt (3)
- glwagner (2)
- radka-j (1)
- vtamsitt (1)
- dorchard (1)
- syou83syou83 (1)
- francispoulin (1)
- emmabeniston (1)
- JuliaTagBot (1)
Top Pull Request Authors
- jagoosw (131)
- ciadht (30)
- navidcy (30)
- johnryantaylor (18)
- ali-ramadhan (9)
- github-actions[bot] (4)
- Mikolaj-A-Kowalski (3)
- syou83syou83 (3)
- dorchard (2)
- louis-de-neve (2)
- bethcandish (2)
- hannahmw1 (2)
- simone-silvestri (1)
- fossabot (1)
- pitmonticone (1)
Top Issue Labels
- bug (13)
- documentation (8)
- GPU (5)
- profiling (5)
- question (4)
- low_priority (4)
- enhancement (3)
- science (3)
- awaiting upstream change (2)
- package (2)
- wontfix (1)
- good first issue (1)
- tests (1)
- feature (1)
Top Pull Request Labels
- documentation (29)
- package (12)
- bug (8)
- science (6)
- GPU (6)
- enhancement (6)
- feature (4)
- tests (4)
- performance (3)
- oceananigans-bug (1)
- awaiting upstream change (1)
- joss (1)
- tech debt (1)
Package metadata
- Total packages: 3
-
Total downloads:
- julia: 112 total
- Total dependent packages: 0 (may contain duplicates)
- Total dependent repositories: 0 (may contain duplicates)
- Total versions: 153
proxy.golang.org: github.com/oceanbiome/oceanbiome.jl
- Homepage:
- Documentation: https://pkg.go.dev/github.com/oceanbiome/oceanbiome.jl#section-documentation
- Licenses: mit
- Latest release: v0.16.6 (published 14 days ago)
- Last Synced: 2025-12-22T21:07:21.683Z (3 days ago)
- Versions: 52
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
proxy.golang.org: github.com/OceanBioME/OceanBioME.jl
- Homepage:
- Documentation: https://pkg.go.dev/github.com/OceanBioME/OceanBioME.jl#section-documentation
- Licenses: mit
- Latest release: v0.16.6 (published 14 days ago)
- Last Synced: 2025-12-22T21:07:23.565Z (3 days ago)
- Versions: 52
- Dependent Packages: 0
- Dependent Repositories: 0
-
Rankings:
- Dependent packages count: 5.395%
- Average: 5.576%
- Dependent repos count: 5.758%
juliahub.com: OceanBioME
🌊 🦠🌿 A fast and flexible modelling environment written in Julia for modelling the coupled interactions between ocean biogeochemistry, carbonate chemistry, and physics
- Homepage: https://oceanbiome.github.io/OceanBioME.jl/
- Documentation: https://docs.juliahub.com/General/OceanBioME/stable/
- Licenses: MIT
- Latest release: 0.16.3 (published 25 days ago)
- Last Synced: 2025-12-06T06:25:22.293Z (20 days ago)
- Versions: 49
- Dependent Packages: 0
- Dependent Repositories: 0
- Downloads: 112 Total
-
Rankings:
- Dependent repos count: 9.94%
- Dependent packages count: 38.915%
- Average: 40.121%
- Forks count: 53.523%
- Stargazers count: 58.104%
Dependencies
- actions/checkout v2 composite
- julia-actions/setup-julia v1 composite
- actions/cache v1 composite
- actions/checkout v2 composite
- codecov/codecov-action v1 composite
- julia-actions/julia-buildpkg v1 composite
- julia-actions/julia-processcoverage v1 composite
- julia-actions/julia-runtest v1 composite
- julia-actions/setup-julia v1 composite
- JuliaRegistries/TagBot v1 composite
- actions/checkout v2 composite
Score: 12.021668922531894
