Updating documentation of static models on config page. #702
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #702 +/- ##
===========================================
+ Coverage 94.60% 94.66% +0.05%
===========================================
Files 73 73
Lines 4800 4833 +33
===========================================
+ Hits 4541 4575 +34
+ Misses 259 258 -1 ☔ View full report in Codecov by Sentry. |
| If `static=true`, the initial model behaviour depends on the data variables available in | ||
| the [`Data` object](../data/data.md). | ||
|
|
||
| * If the data object has all varibles in the model's `vars_populated_by_init`, then the |
There was a problem hiding this comment.
| * If the data object has all varibles in the model's `vars_populated_by_init`, then the | |
| * If the data object has all variables in the model's `vars_populated_by_init`, then the |
| @@ -198,15 +198,35 @@ All models (except `core`) accept a boolean configuration option, `static`, that | |||
| indicates if such a model should be updated every iteration (`static=false`, the | |||
| default behaviour) or not. | |||
|
|
|||
There was a problem hiding this comment.
I think it would be useful to add a sentence like 'To run the Virtual ecosystem, one more models can bet static,for example x and y to understand z' just to explain what this is about (or not) and highlight the potential of exploring individual models or combinations of models/interactions without running the whole complex thing.
| - **All present**: Then the update process is bypassed. | ||
| - **None present**: The update *is run just once*, keeping the same values for those | ||
| variables throughout the simulation. | ||
| If `static=true`, the initial model behaviour depends on the data variables available in |
There was a problem hiding this comment.
Maybe 'provided at the start of the simulation' instead of 'available? Just to make super clear what the workflow is?
Description
Draft of the documentation update for the static model. Built here: https://virtual-ecosystem.readthedocs.io/en/686-documentation-for-static-model/using_the_ve/configuration/config.html#static-models
Fixes #686
Type of change
Key checklist
pre-commitchecks:$ pre-commit run -a$ poetry run pytestFurther checks