Skip to content

Commit 1658ddf

Browse files
committed
updated docstrings
1 parent dc24e13 commit 1658ddf

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

docs/src/model_components/biogeochemical/LOBSTER.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@ julia> using OceanBioME, Oceananigans
1212
julia> grid = RectilinearGrid(size=(3, 3, 30), extent=(10, 10, 200));
1313
1414
julia> bgc_model = LOBSTER(; grid, carbonates = true)
15-
Lodyc-DAMTP Ocean Biogeochemical Simulation Tools for Ecosystem and Resources (LOBSTER) model (Float64)
15+
LOBSTER{Float64} with carbonates ✅, oxygen ❌, variable Redfield ratio ❌and (:sPOM, :bPOM) sinking
1616
Light attenuation: Two-band light attenuation model (Float64)
1717
Sediment: Nothing
1818
Particles: Nothing
19+
Modifiers: Nothing
1920
```
2021

2122
## Model equations

src/Models/AdvectedPopulations/LOBSTER/LOBSTER.jl

+2-1
Original file line numberDiff line numberDiff line change
@@ -246,10 +246,11 @@ julia> using Oceananigans
246246
julia> grid = RectilinearGrid(size=(3, 3, 30), extent=(10, 10, 200));
247247
248248
julia> model = LOBSTER(; grid)
249-
Lodyc-DAMTP Ocean Biogeochemical Simulation Tools for Ecosystem and Resources (LOBSTER) model (Float64)
249+
LOBSTER{Float64} with carbonates ❌, oxygen ❌, variable Redfield ratio ❌and (:sPOM, :bPOM) sinking
250250
Light attenuation: Two-band light attenuation model (Float64)
251251
Sediment: Nothing
252252
Particles: Nothing
253+
Modifiers: Nothing
253254
```
254255
"""
255256
function LOBSTER(; grid,

src/Models/AdvectedPopulations/NPZD.jl

+2-1
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,11 @@ julia> using Oceananigans
145145
julia> grid = RectilinearGrid(size=(20, 30), extent=(200, 200), topology=(Bounded, Flat, Bounded));
146146
147147
julia> model = NutrientPhytoplanktonZooplanktonDetritus(; grid)
148-
Nutrient Phytoplankton Zooplankton Detritus model (Float64)
148+
NutrientPhytoplanktonZooplanktonDetritus{Float64} model, with (:P, :D) sinking
149149
Light attenuation: Two-band light attenuation model (Float64)
150150
Sediment: Nothing
151151
Particles: Nothing
152+
Modifiers: Nothing
152153
```
153154
"""
154155
function NutrientPhytoplanktonZooplanktonDetritus(; grid,

0 commit comments

Comments
 (0)