Skip to content

Update and add more examples and documentation #69

@bgroenks96

Description

@bgroenks96

Following #68, we will need to do a major overhaul of the documentation, which is anyway now several months out-of-date.

This should be a top priority since it's a major issue blocking a v0.1 release.

I think this can be broken down into a few subtasks:

  • Update documentation on AbstractModel and AbstractProcess interface
  • Update existing documentation on physics to include direct references to the relevant AbstractProcess types and coupling interfaces.
  • Add documentation on closure! and invclosure! interface as well as closure relations generally.
  • Add documentation on process coupling (probably in a new developer guide section)
  • Add example for soil hydrology
  • Improve existing example for coupled vegetation-soil model

Sub-issues

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions