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

ClimaLand documentation to do list

Open AlexisRenchon opened this issue 5 months ago • 1 comments

  • [x] Make a decent "home page" and "getting started" page #736
  • [ ] Home page / index page: make a summary of features
  • [ ] Getting started: [add ideas]
  • [ ] Refactor structure: e.g., API should be last, tutorials maybe second... [suggestions are welcome]
  • [ ] Getting started: explain that ClimaLand is an API to build a model (standalone or integrated), if you want an API to run a simulation, go to ClimaLandSimulations.
  • [ ] Getting started: explain "low level" vs. "high level" API, for instance, ClimaLand is low level relative to ClimaLandSimulations
  • [ ] Getting started: explain what is an "API"
  • [ ] Introduction to standalone model: explain what we call a model, and how we build it in ClimaLand, why we use Abstract type and what is multiple dispatch, demonstrate with a super simple example (MWE, maybe simple T arrhenius of soil C...), maybe do a simple model without any prognostic variable, then one with a prognostic variable, then show integrated model by combining both

See also previous issues:

  • docs overhaul #240
  • folderstructure #712
  • stable and version not tracked, so we use dev... [bug] #681
  • make docs strict #357

Useful tutorials

  • [ ] Perform and analyze a regional simulation
  • [ ] Calibration, single sites and global

AlexisRenchon avatar Aug 30 '24 18:08 AlexisRenchon