Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,49 @@ language_info:
---

# The Soil Model implementation

## Model overview

TODO - This section needs to be properly populated

## Model variables

## Initialisation and update

The tables below show the variables that are required to initialise the soil model and
then update it at each time step.

```{code-cell} ipython3
---
mystnb:
markdown_format: myst
tags: [remove-input]
---
from IPython.display import display_markdown
from var_generator import generate_variable_table

display_markdown(
generate_variable_table(
"SoilModel", ["vars_required_for_init", "vars_required_for_update"]
),
raw=True,
)
```

## Generated variables

The soil model does not currently generate any variables. If that changes this section
will need to be updated.

## Updated variables

At each model step, the following variables are then updated.

```{code-cell} ipython3
---
mystnb:
markdown_format: myst
tags: [remove-input]
---
display_markdown(generate_variable_table("SoilModel", ["vars_updated"]), raw=True)
```
2 changes: 2 additions & 0 deletions virtual_ecosystem/models/soil/soil_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,8 @@ class SoilModel(
"arbuscular_supply_limit_n",
"arbuscular_supply_limit_p",
),
# TODO - If anything gets added to this section the implementation docs will need to
# be updated
vars_populated_by_first_update=(),
):
"""A class defining the soil model.
Expand Down