unifhy-org / unifhy

A Unified Framework for Hydrology
https://unifhy-org.github.io/unifhy
BSD 3-Clause "New" or "Revised" License
11 stars 5 forks source link

Improve contributor's documentation on what can be a "component output" #57

Closed ThibHlln closed 2 years ago

ThibHlln commented 2 years ago

The guide for contributors is lacking explanations on what variable can be a "component output" (i.e. those additional variables that the contributor make available to be recorded on user's request).

In particular, it should be mentioned that only numpy arrays compatible in dimensions with the component space domain can be exposed as component outputs. Also, it is worth explaining the difference between "component outward transfer" and "component output", and that "component outward transfers" and "component states" are automatically exposed as "recordable" variables.