Skip to content

Commit be8c0be

Browse files
authored
Merge pull request #155 from pitmonticone/main
(0.9.0) Fix typos in code, docs, and docstrings
2 parents 8d3a355 + 74cdc73 commit be8c0be

18 files changed

+81
-82
lines changed

Project.toml

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "OceanBioME"
22
uuid = "a49af516-9db8-4be4-be45-1dad61c5a376"
33
authors = ["Jago Strong-Wright <[email protected]> and contributors"]
4-
version = "0.8.0"
4+
version = "0.9.0"
55

66
[deps]
77
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
@@ -29,7 +29,6 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
2929
Interpolations = "a98d9a8b-a2ab-59e6-89dd-64a1c18fca59"
3030
JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819"
3131
NetCDF = "30363a11-5582-574a-97bb-aa9a979735b9"
32-
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
3332
Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
3433
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
3534
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,4 @@ If you use OceanBioME as part of your research, teaching, or other activities, w
160160
}
161161
```
162162

163-
To cite a specific version of the package please also cite its [Zenode archive](https://doi.org/10.5281/zenodo.10038575).
163+
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](https://zenodo.org/doi/10.5281/zenodo.8403489).

docs/src/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
OceanBioME.jl is a fast and flexible ocean biogeochemical modelling environment. It is highly modular and is designed to make it easy to implement and use a variety of biogeochemical and physical models. OceanBioME is built to be coupled with physics models from [Oceananigans.jl](https://github.com/CliMA/Oceananigans.jl) allowing simulations across a wide range of spatial scales ranging from a global hydrostatic free surface model to non-hydrostatic large-eddy simulations. OceanBioME was designed specifically for ocean carbon dioxide removal applications. Notably, it includes active particles which allow individual-based models to be seamlessly coupled with the flow physics, ecosystem models, and carbonate chemistry.
44

5-
OceanBioME.jl currently provides a core of several biogeochemical models (Nutrient--Phytoplankton--Zooplankton--Detritus (NPZD) and [LOBSTER](https://doi.org/10.1029/2004JC002588), a medium complexity model, air-sea gas exchange models to provide appropriate top boundary conditions, and sediment models to for the benthic boundary. [PISCES](https://doi.org/10.5194/gmd-8-2465-2015) and other higher complexity models are in our future development plans.
5+
OceanBioME.jl currently provides a core of several biogeochemical models Nutrient--Phytoplankton--Zooplankton--Detritus (NPZD) and [LOBSTER](https://doi.org/10.1029/2004JC002588), a medium complexity model, air-sea gas exchange models to provide appropriate top boundary conditions, and sediment models to for the benthic boundary. [PISCES](https://doi.org/10.5194/gmd-8-2465-2015) and other higher complexity models are in our future development plans.
66

77
OceanBioME.jl includes a framework for integrating the growth of biological/active Lagrangian particles which move around and can interact with the (Eulerian) tracer fields - for example, consuming nutrients and carbon dioxide while releasing dissolved organic material. A growth model for sugar kelp is currently implemented using active particles, and this model can be used in a variety of dynamical scenarios including free-floating or bottom-attached particles.
88

docs/src/model_components/biogeochemical/LOBSTER.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -140,18 +140,18 @@ Additionally, the ``DIC`` and ``Alk`` equations are modified to replace each ``X
140140
| ``\mu_{sPOM}`` | `small_detritus_remineralisation_rate` | 1 / s |
141141
| ``\mu_{bPOM}`` | `large_detritus_remineralisation_rate` | 1 / s |
142142
| ``\gamma`` | `phytoplankton_exudation_fraction` | - |
143-
| ``\mu_n`` | `nitrifcaiton_rate` | 1 / 2 |
143+
| ``\mu_n`` | `nitrification_rate` | 1 / 2 |
144144
| ``\alpha_P`` | `ammonia_fraction_of_exudate` | - |
145145
| ``\alpha_Z`` | `ammonia_fraction_of_excriment` | - |
146146
| ``\alpha_d`` | `ammonia_fraction_of_detritus` | - |
147147
| ``R_P`` | `phytoplankton_redfield` | mmol C / mmol N |
148148
| ``R_O`` | `organic_redfield` | mmol C / mmol N |
149149
| ``R_{Chl:N}`` | `phytoplankton_chlorophyll_ratio` | mg Chl / mmol N |
150150
| ``\rho_{CaCO_3}`` | `organic_carbon_calcate_ratio` | mmol CaCO₃/ mmol C |
151-
| ``R_{O_2}`` | `respiraiton_oxygen_nitrogen_ratio` | mmol O / mmol N |
152-
| ``R_{nit}`` | `nitrifcation_oxygen_nitrogen_ratio` | mmol O / mmol N |
151+
| ``R_{O_2}`` | `respiration_oxygen_nitrogen_ratio` | mmol O / mmol N |
152+
| ``R_{nit}`` | `nitrification_oxygen_nitrogen_ratio` | mmol O / mmol N |
153153
| ``f_s`` | `slow_sinking_mortality_fraction` | - |
154-
| ``\mu_{DOM}`` | `disolved_organic_breakdown_rate` | 1 / s |
154+
| ``\mu_{DOM}`` | `dissolved_organic_breakdown_rate` | 1 / s |
155155
| ``\eta`` | `zooplankton_calcite_dissolution` | - |
156156

157157
All default parameter values are given in [Parameters](@ref parameters); and a more thorough explanation of new terms will be included in a publication that is in prep.

docs/src/model_components/individuals/slatissima.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ R = \left[R_A\left(\frac{\mu}{\mu_\text{max}} + \frac{J}{J_\text{max}}\right) +
126126

127127
| Symbol | Variable name | Units |
128128
|--------------------------|--------------------------------------|-------------------------|
129-
| ``A_0`` | `growth_rate_adjustement` | 1 / dm² |
129+
| ``A_0`` | `growth_rate_adjustment` | 1 / dm² |
130130
| ``\alpha`` | `photosynthetic_efficiency` | gC / dm² / s / einstein |
131131
| ``C_\text{min}`` | `minimum_carbon_reserve` | gC / gSW |
132132
| ``C_\text{struct}`` | `structural_carbon` | gC / gSW |
@@ -139,8 +139,8 @@ R = \left[R_A\left(\frac{\mu}{\mu_\text{max}} + \frac{J}{J_\text{max}}\right) +
139139
| ``k_N`` | `nitrogen_reserve_per_nitrogen` | g / gN |
140140
| ``N_\text{min}`` | `minimum_nitrogen_reserve` | gN / gSW |
141141
| ``N_\text{max}`` | `maximum_nitrogen_reserve` | gN / gSW |
142-
| ``m_2`` | `growth_adjustement_2` | - |
143-
| ``m_1`` | `growth_adjustement_1` | - |
142+
| ``m_2`` | `growth_adjustment_2` | - |
143+
| ``m_1`` | `growth_adjustment_1` | - |
144144
| ``\mu_\text{max}`` | `maximum_specific_growth_rate` | 1 / s |
145145
| ``N_\text{struct}`` | `structural_nitrogen` | gN / gSW |
146146
| ``P_1`` | `photosynthesis_at_ref_temp_1` | gC / dm² / s |

docs/src/model_components/sediments/instant_remineralisation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ where ``F_{OC}`` is the carbon flux (in this implementation the nitrogen flux mu
1818
|---------|-------------------------------------|-----------------|
1919
| ``E_0`` | `burial_efficiency_constant1` | - |
2020
| ``E_1`` | `burial_efficiency_constant2` | - |
21-
| ``k_B`` | `burial_efficiency_half_saturaiton` | mmol C / m² / s |
21+
| ``k_B`` | `burial_efficiency_half_saturation` | mmol C / m² / s |
2222

2323
## Model conservations
2424

docs/src/model_implementation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Here we describe how OceanBioME defines biogeochemical (BGC) models, how this va
55
## Model structure
66
OceanBioME BGC models are `struct`s of type `ContinuousFormBiogeochemistry`, which is of abstract type `AbstractContinuousFormBiogeochemistry` from Oceananigans. In Oceananigans this describes BGC models which are defined using continuous functions (depending continuously on ``x``, ``y``, and ``z``) rather than discrete functions (depending on ``i``, ``j``, ``k``). This allows the user to implement the BGC model equations without worrying about details of the grid or discretization, and then Oceananigans handles the rest.
77

8-
OceanBioME's `ContinuousFormBiogeochemistry` adds a layer on top of this which makes it easy to add [light attenuation models](@ref light), [sediment](@ref sediment), and [biologically active particles](@ref individuals) (or indivdiual-based models). OceanBioME's `ContinuousFormBiogeochemistry` includes parameters in which the types of these components are stored. This means that these model components will automatically be integrated into the BGC model without having to add new methods to call Oceananigans functions.
8+
OceanBioME's `ContinuousFormBiogeochemistry` adds a layer on top of this which makes it easy to add [light attenuation models](@ref light), [sediment](@ref sediment), and [biologically active particles](@ref individuals) (or individual-based models). OceanBioME's `ContinuousFormBiogeochemistry` includes parameters in which the types of these components are stored. This means that these model components will automatically be integrated into the BGC model without having to add new methods to call Oceananigans functions.
99

1010
## Implementing a model
1111

src/Boundaries/Sediments/instant_remineralization.jl

+8-8
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,28 @@
33
44
Hold the parameters and fields the simplest benthic boundary layer where
55
organic carbon is assumed to remineralise instantly with some portion
6-
becoming N, and a fraction being perminantly burried.
6+
becoming N, and a fraction being permanently buried.
77
88
Burial efficiency from [RemineralisationFraction](@citet).
99
"""
1010
struct InstantRemineralisation{FT, F, TE, B} <: FlatSediment
1111
burial_efficiency_constant1 :: FT
1212
burial_efficiency_constant2 :: FT
13-
burial_efficiency_half_saturaiton :: FT
13+
burial_efficiency_half_saturation :: FT
1414

1515
fields :: F
1616
tendencies :: TE
1717
bottom_indices :: B
1818

1919
InstantRemineralisation(burial_efficiency_constant1::FT,
2020
burial_efficiency_constant2::FT,
21-
burial_efficiency_half_saturaiton::FT,
21+
burial_efficiency_half_saturation::FT,
2222
fields::F,
2323
tendencies::TE,
2424
bottom_indices::B) where {FT, F, TE, B} =
2525
new{FT, F, TE, B}(burial_efficiency_constant1,
2626
burial_efficiency_constant2,
27-
burial_efficiency_half_saturaiton,
27+
burial_efficiency_half_saturation,
2828
fields,
2929
tendencies,
3030
bottom_indices)
@@ -34,7 +34,7 @@ end
3434
InstantRemineralisation(; grid,
3535
burial_efficiency_constant1::FT = 0.013,
3636
burial_efficiency_constant2::FT = 0.53,
37-
burial_efficiency_half_saturaiton::FT = 7)
37+
burial_efficiency_half_saturation::FT = 7)
3838
3939
Return a single-layer instant remineralisaiton model for NPZD bgc models.
4040
@@ -52,7 +52,7 @@ sediment_model = InstantRemineralisation(; grid)
5252
function InstantRemineralisation(; grid,
5353
burial_efficiency_constant1 = 0.013,
5454
burial_efficiency_constant2 = 0.53,
55-
burial_efficiency_half_saturaiton = 7.0)
55+
burial_efficiency_half_saturation = 7.0)
5656

5757
@warn "Sediment models are an experimental feature and have not yet been validated"
5858

@@ -67,7 +67,7 @@ function InstantRemineralisation(; grid,
6767

6868
return InstantRemineralisation(burial_efficiency_constant1,
6969
burial_efficiency_constant2,
70-
burial_efficiency_half_saturaiton,
70+
burial_efficiency_half_saturation,
7171
fields,
7272
tendencies,
7373
bottom_indices)
@@ -76,7 +76,7 @@ end
7676
adapt_structure(to, sediment::InstantRemineralisation) =
7777
InstantRemineralisation(adapt(to, sediment.burial_efficiency_constant1),
7878
adapt(to, sediment.burial_efficiency_constant2),
79-
adapt(to, sediment.burial_efficiency_half_saturaiton),
79+
adapt(to, sediment.burial_efficiency_half_saturation),
8080
adapt(to, sediment.fields),
8181
nothing,
8282
adapt(to, sediment.bottom_indices))

src/Boundaries/Sediments/simple_multi_G.jl

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ can be optionally specified.
6565
6666
The model is a single layer (i.e. does not include porous diffusion) model with three classes
6767
of sediment organic matter which decay at three different rates (fast, slow, refactory).
68-
The nitrifcation/denitrifcation/anoxic mineralisation fractions default to the parameterisation
68+
The nitrification/denitrification/anoxic mineralisation fractions default to the parameterisation
6969
of Soetaert et al. 2000; doi:[10.1016/S0012-8252(00)00004-0](https://doi.org/10.1016/S0012-8252(00)00004-0).
7070
7171
This model has not yet been validated or compared to observational data. The variety of degridation

0 commit comments

Comments
 (0)