Model documentation - Githubissues

ClimateMARGO / ClimateMARGO.jl

Julia implementation of MARGO, an idealized climate-economic modelling framework for Optimizing trade-offs between emissions Mitigation, Adaptation, carbon dioxide Removal, and solar Geoengineering.

https://margo.plutojl.org/

MIT License

67 stars 13 forks source link

Model documentation #2

Open hdrake opened 4 years ago

hdrake commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 4 years ago

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 commented 2 years ago

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.

fonsp commented 2 years ago

The plotting functions still need to be listed 📊