ClimateMARGO.jl icon indicating copy to clipboard operation
ClimateMARGO.jl copied to clipboard

Published 20 hours ago • verified publisher icon ClimateMARGO

Model documentation

Open hdrake opened this issue 4 years ago • 5 comments

Should add documentation using Documenter.jl which is mostly made up of documentation markdown files but also also nicely publishes the source code w/ source code docstrings.

hdrake avatar May 27 '20 20:05 hdrake

I've got a proof-of-concept of this working at https://github.com/hdrake/MARGO.jl/tree/documenting, following the step-by-step Documenter.jl guide, but haven't yet deployed it as a standalone github page.

hdrake avatar May 27 '20 22:05 hdrake

Planning on adding the bare minimum of documentation to https://github.com/hdrake/ClimateMARGO.jl/pull/28 before releasing v0.1.0.

  • [x] Landing page
  • [x] Installation instructions
  • [x] A basic example
  • [ ] Guide for contributors
  • [ ] Description of model parameters (by submodule)
  • [ ] Optimization process
  • [x] How to use the diagnostic functions

hdrake avatar Aug 01 '20 19:08 hdrake

Added some auto-generating docs in https://github.com/hdrake/ClimateMARGO.jl/pull/33 with Literate.jl, which turns a basic .jl julia script fill with special comment formatting into a beautiful .md document with code cells and ouputs (including figures!).

hdrake avatar Aug 02 '20 19:08 hdrake

Need to be updated to be consistent with the published version of the model!

Edit: As of v0.3.2, the documentation is once again consistent with the model.

hdrake avatar Dec 27 '21 15:12 hdrake

The plotting functions still need to be listed 📊

fonsp avatar Feb 09 '22 13:02 fonsp