Skip to content

ongoing docs improvements #1212

@juliasloan25

Description

@juliasloan25

Remaining documentation improvements, to be done before August 2025.

Need to have

  • add tutorials:
    • fluxnet SoilCanopy [Kat]
    • fluxnet LandModel [Kat]
    • global LandModel [Kat]
    • global bucket [Kat]
    • SnowModel ? - convert from snowmip.jl
    • SoilSnowModel ?
    • How to change canopy and soil parameterizations. Note that as of Fluxnet and global run documentation #1288, these pages are in the docs but blank
  • pages to fill in science of - pages exist but are empty document soil and snow models #1263
    • RichardsModel
    • Energy Model - rename to EnergyHydrologyModel?
    • snow
    • surface water - delete?
  • update page: running your first simulation [Julia]
    • replace canopy GPP example with example setting up and running EnergyHydrology sim using default parameterizations and plotting
  • update page: model structure - add information about simulations, once implemented/in use
    • LandSimulation docstring has good info to start with
  • diagnostics
    • add a page(s) describing which diagnostics are available for each model type
  • move page: ClimaLand folder structure
    • move to developer docs folder/section
  • rename section: Tutorials -> Running simulations
    • move "Calibrating your ClimaLand model" under "calibration > tutorials"

Nice to have

  • add pages about:
    • running with prescribed atmospheres
    • timestepping information, or at least pointer to CTS.jl (maybe timestepping.jl tutorial is sufficient, but it should be more visible)
    • types of boundary conditions available
    • ClimaLand domains, how to set up sims on each

Desired table of contents

Right now our docs have so many tabs, it might be hard to know where to start. We could restructure to something like:

  • Running your first simulation (installation + simple example)
  • ClimaLand Simulations (many of our current tutorials, running on MPI, etc)
  • Developing with ClimaLand (many of our current tutorials, reorganized)
  • Calibrating ClimaLand Parameterizations and Parameters
  • Contributor Guide
  • FAQ (we could have question link to miscellaneous other pages? E.g. how to diagnostics work? What units does ClimaLand use? How do I restart a simulation?)

Other comments from @AlexisRenchon

In getting_started.md, there's an error due to "About.jl" not being installed. I know we removed it a while ago because of a bug. Maybe it's been fixed now? (I can do this in another PR)

the getting_started.md page is called "running your first simulation" yet doesn't have code to run a simulation (also for another PR maybe - I thought Julia had a PR for it but I can't find it anymore)

The file structure in the code doesn't match the menu structure of the docs. it makes it a bit hard to navigate.
docs menu:
image
docs code:
image

The page changing_canopy_parameterizations is empty
image

Maybe we don't want to show the output (or silence warning) of some box of code, e.g., running fluxnet simulations:
image

Note this seems quite important - some box of warnings are very long... (if needed I can help with this)

Can we rename "Leaderboard" to "Benchmark"? Benchmark is a well known modelling exercise, to compare model output to observation. Leaderboard is more an internal CliMA goal of showing we're the best model...

Note: I see that Kevin added warning boxes in the calibration docs. I think this is pretty neat and we should use it throughout the docs

image

APIs/shared_utilities, simulations, has a blank name (-) (which should be "LandSimulations" I believe)
image

APIs/Soil_Albedo rendering is bugged. It seems to be full of titles (hashtags)
image

Metadata

Metadata

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions