first set of dcumention edits

JuliaOcean / PlanktonIndividuals.jl

This package simulates the behaviors of an ensemble of phytoplankton individuals.

MIT License

30 stars 4 forks source link

first set of dcumention edits #30

Closed gaelforget closed 3 years ago

gaelforget commented 3 years ago

a few notes

State Variables: Sz and gen have no units; should say non-dimensional ?
I think it's more natural to reverse the order in which equations are shown, starting with the main equation(s), then its dependencies (e.g. PS then PC then PCmax)
VNH4_{max} vs VNH4max is kind of tricky. So I added a bit of text to make things more obvious. A different notation for either VNH4_{max} vs VNH4max may be better.

ps. need to run; will try going through the rest later today

gaelforget commented 3 years ago

more notes:

acronyms like PAR that still need to be defined?
"A 20% random noise is included but only if the initial conditions are generated by NamedTuple." seems kind of tricky. Could that be set via parameter with a default to either true or false, indicated in the docstring?
"The initial conditions of all the nutrient fields should be non-negative." ; could there be an error message for this?
not sure what you mean by "be aggregated into tracer fields"; do you mean gridded fields? not sure about aggregated?

gaelforget commented 3 years ago

Hi @zhenwu0728

For now I am done with reviewing the docs. Please take a look and let me know if changes are needed before merging. There are also a few items above listed above which I did not know how to address