search

ClimateFluidPhysics-ANU / MixedLayerThermoclineDynamics.jl

Julia packages that solves for a series of stacked thermocline layers coupled with a mixed layer on top.
https://climatefluidphysics-anu.github.io/MixedLayerThermoclineDynamics.jl/dev/
MIT License
3 stars 0 forks source link

Documentation #14

Open navidcy opened 3 years ago

navidcy commented 3 years ago

At some point we should have some basic documentation. At least for the features that are finalized. At the moment the docs are just a long list of all the docstrings. That's better than nothing, but some text and organization in the docs would help. And further down the road the docs will be enhanced with examples of some solutions.

dhruvbhagtani commented 3 years ago

Yep, I agree. We need it. I'll think of it after I'm done with the TPR and the 4th August deadline.

dhruvbhagtani commented 3 years ago

So, I see two possible ways of documentation:

  1. Documenting the numerics
  2. Showing the physical equations and how we've derived them.

For (1), we don't have much, so we'll have to start from scratch. This will be beneficial, because this will involve writing the FV numerics we'll eventually be using in the MLT model. For (2), we have a documentation on overleaf which is quite extensive, and we can put it up here for now, while we continue to write (1).

Your thoughts?

navidcy commented 3 years ago

Yes, for documentation we'll need to document the equations that are being solved, the numerics, and also other code-related features (e.g., what is a Grid and how you construct one, etc.). Also, it'll be good to have some tutorial(s) + examples.

We don't need to do that now, as the code is evolving rapidly! I just put the issue here to act as reminder.

I disagree with the attitude "put everything from overleaf here for now and continue with other issues". We should put in only what is relevant and applicable.

dhruvbhagtani commented 3 years ago

But till the time we are working on the numerics, if someone looks at this PR, shouldn't it be better to have some form of physical equations that this model is aiming to solve? Maybe we don't need to put up everything from overleaf, but that's actually a very clear representation of the MLT model.

navidcy commented 3 years ago

Oh I see, you meant put a link to the overleaf document here in the PR? That's fine! Yeah, do that.

(Initially I thought you meant we should pour everything from the overleaf document into the documentation of the repository...)