Skip to content

Major overhaul of documentation#84

Merged
bgroenks96 merged 152 commits into
mainfrom
bg/update-docs
Apr 7, 2026
Merged

Major overhaul of documentation#84
bgroenks96 merged 152 commits into
mainfrom
bg/update-docs

Conversation

@bgroenks96
Copy link
Copy Markdown
Collaborator

@bgroenks96 bgroenks96 commented Mar 15, 2026

Partially addresses #69

This PR reorganizes, update, and expands the documentation on Terrarium's core interfaces and currently implemented processes.

TODO list:

  • Add docpage outlining basic concepts in Terrarium
  • Split and expand overview docpage into separate section on "Extending Terrarium" which focuses more on technical details
  • Update docpages for soil processes
  • Add docpages for vegetation
  • Add docpages for SEB
  • Add docpages for surface hydrology
  • Add linear heat conduction example
  • Finish rewriting vegetation doc pages (@mahabadri check when done)
  • Add doc page or section for closure! and invclosure!
  • Add doc page or section on state variable initialization (specifically the auxiliary variable initializer interface)
  • Add documentation bibliography via DocumenterCitations.jl

https://numericalearth.github.io/Terrarium.jl/previews/PR84/

Copy link
Copy Markdown
Collaborator

@maximilian-gelbrecht maximilian-gelbrecht left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I won't have time to look over everything today, and somehow it doesn't work well to only show me the differences to the last review. Anyway, I am sure everything is good to merge, because it was already in a really good state before, and any small things that might still come up we can also just address in follow ups.

Also adds constant value initializer for soil saturation
This is a temporary fix, we should come up with a better solution for
handling input files that doesn't rely so much on the working directory.
CI on GitHub runs on CPU which takes way too long to simulate 30 days
at 1 degree resolution.
@bgroenks96
Copy link
Copy Markdown
Collaborator Author

All green again ✔️ 🎉

Like @maximilian-gelbrecht said, we can continue fixing small things in follow up PRs. @matteo-willeit maybe you can take another look at the published documentation after this is merged.

Thanks @mahabadri for taking the time to work on the vegetation docs and @matteo-willeit for all the great feedback!

@bgroenks96 bgroenks96 merged commit c0c8d4b into main Apr 7, 2026
8 checks passed
@matteo-willeit
Copy link
Copy Markdown
Collaborator

Sure, I will have a look when I'm back from vacation next Monday.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants