diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index 71af48b7a..b245d190b 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -21,3 +21,4 @@ Fixes # (issue)
- [ ] Code is commented, particularly in hard-to-understand areas
- [ ] Tests added that prove fix is effective or that feature works
+- [ ] Relevant documentation reviewed and updated
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 8722f6e2d..e34d427ad 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,6 +1,13 @@
name: Test and build
-on: [push, pull_request, release]
+# When does this run - new, reopened or updated PRs, pushes to main or develop and when
+# the workflow is called by another workflow, such as the publishing actions.
+on:
+ pull_request:
+ types: [opened, synchronize, reopened]
+ push:
+ branches: [main, develop]
+ workflow_call:
jobs:
qa:
@@ -19,7 +26,7 @@ jobs:
fail-fast: false
matrix:
os: [ ubuntu-latest, macos-latest, windows-latest ]
- python-version: [ "3.10", "3.11" ]
+ python-version: [ "3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v4
@@ -63,9 +70,6 @@ jobs:
- name: Install dependencies
run: poetry install
- - name: Set ipython kernel
- run: poetry run python -m ipykernel install --user --name=vr_python3
-
- name: Build docs using sphinx
run: |
cd docs
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
new file mode 100644
index 000000000..e711a2a2c
--- /dev/null
+++ b/.github/workflows/publish.yml
@@ -0,0 +1,103 @@
+name: Publishing
+
+on:
+ release:
+ types: [published]
+
+jobs:
+ # First, run the standard test suite - for this to work correctly, the workflow needs
+ # to inherit the organisation secrets used to authenticate to CodeCov.
+ # https://github.com/actions/runner/issues/1413
+ test:
+ uses: ./.github/workflows/ci.yml
+ secrets: inherit
+
+ # Next, build the package wheel and source releases and add them to the release assets
+ build-wheel:
+ needs: test
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+
+ # Build the package - this could use `poetry build` directly but pyproject.toml
+ # already has the build-system configured to use poetry so `pip` should pick that
+ # up automatically.
+ - name: Build sdist
+ run: |
+ python -m pip install --upgrade build
+ python -m build
+
+ # Upload the build outputs as job artifacts - these will be two files with x.y.z
+ # version numbers:
+ # - virtual_ecosystem-x.y.z-py3-none-any.whl
+ # - virtual_ecosystem-x.y.z.tar.gz
+ - uses: actions/upload-artifact@v4
+ with:
+ path: dist/virtual_ecosystem*
+
+ # Add the built files to the release assets, alongside the repo archives
+ # automatically added by GitHub. These files should then match exactly to the
+ # published files on PyPI.
+ - uses: softprops/action-gh-release@v1
+ with:
+ files: dist/virtual_ecosystem*
+
+ # Now attempt to publish the package to the TestPyPI site, where the virtual_ecosystem
+ # project has been configured to allow trusted publishing from this repo and workflow.
+ #
+ # The skip-existing option allows the publication step to pass even when the release
+ # files already exists on PyPI. That suggests something has gone wrong with the
+ # release or the build file staging and the release should not be allowed to continue
+ # to publish on PyPI.
+
+ publish-TestPyPI:
+ needs: build-wheel
+ name: Publish virtual_ecosystem to TestPyPI
+ runs-on: ubuntu-latest
+ permissions:
+ id-token: write
+
+ steps:
+ # Download the built package files from the job artifacts
+ - name: Download sdist artifact
+ uses: actions/download-artifact@v4
+ with:
+ name: artifact
+ path: dist
+
+ # Information step to show the contents of the job artifacts
+ - name: Display structure of downloaded files
+ run: ls -R dist
+
+ # Use trusted publishing to release the files downloaded into dist to TestPyPI
+ - name: Publish package distributions to TestPyPI
+ uses: pypa/gh-action-pypi-publish@release/v1
+ with:
+ repository-url: https://test.pypi.org/legacy/
+ # skip-existing: true
+
+ # The final job in the workflow is to publish to the real PyPI as long as the release
+ # name does not contain the tag 'test-pypi-only'
+ publish-PyPI:
+ if: ${{ ! contains(github.event.release.name, 'test-pypi-only')}}
+ needs: publish-TestPyPI
+ name: Publish virtual_ecosystem to PyPI
+ runs-on: ubuntu-latest
+ permissions:
+ id-token: write
+
+ steps:
+ # Download the built package files from the job artifacts
+ - name: Download sdist artifact
+ uses: actions/download-artifact@v4
+ with:
+ name: artifact
+ path: dist
+
+ # Information step to show the contents of the job artifacts
+ - name: Display structure of downloaded files
+ run: ls -R dist
+
+ # Use trusted publishing to release the files downloaded into dist to PyPI
+ - name: Publish package distributions to PyPI
+ uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.gitignore b/.gitignore
index 4f809f15f..0105a5a1f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -122,6 +122,8 @@ venv.bak/
# mkdocs documentation
/site
+docs/source/variables.rst
+docs/jupyter_execute/*.png
# mypy
.mypy_cache/
@@ -134,6 +136,5 @@ dmypy.json
# Mac DS Store files
.DS_Store
-# PYPI credentials
+# Local PyPI authentication tokens
.pypirc
-
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 6a1908673..60e0c2a5c 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -1,34 +1,22 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v4.5.0
+ rev: v4.6.0
hooks:
- id: check-merge-conflict
- id: debug-statements
- - repo: https://github.com/PyCQA/isort
- rev: "5.13.2"
+ - repo: https://github.com/astral-sh/ruff-pre-commit
+ rev: v0.6.2
hooks:
- - id: isort
- additional_dependencies: [toml]
- - repo: https://github.com/psf/black
- rev: "24.2.0"
- hooks:
- - id: black
- - repo: https://github.com/PyCQA/flake8
- rev: 7.0.0
- hooks:
- - id: flake8
- additional_dependencies: [flake8-docstrings]
+ - id: ruff # Run the linter.
+ args: [--fix, --exit-non-zero-on-fix]
+ - id: ruff-format # Run the formatter.
- repo: https://github.com/pre-commit/mirrors-mypy
- rev: "v1.8.0"
+ rev: "v1.11.2"
hooks:
- id: mypy
- additional_dependencies: [types-jsonschema, xarray]
+ additional_dependencies: [types-jsonschema, xarray, types-tabulate, numpy]
- repo: https://github.com/igorshubovych/markdownlint-cli
- rev: v0.39.0
+ rev: v0.41.0
hooks:
- id: markdownlint
- - repo: https://github.com/asottile/pyupgrade
- rev: v3.15.1
- hooks:
- - id: pyupgrade
- args: [--py310-plus]
\ No newline at end of file
+
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
index afb6eaa27..15f9a174b 100644
--- a/.readthedocs.yaml
+++ b/.readthedocs.yaml
@@ -22,7 +22,6 @@ build:
# VIRTUAL_ENV needs to be set manually for now.
# See https://github.com/readthedocs/readthedocs.org/pull/11152/
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
- - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry run python -m ipykernel install --user --name=vr_python3
# Build documentation in the docs/ directory with Sphinx
sphinx:
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
index 1e0f8b1f9..d2bcc7058 100644
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@@ -2,11 +2,11 @@
"recommendations": [
"Gruntfuggly.todo-tree",
"ms-python.python",
- "ms-python.vscode-pylance",
"ms-toolsai.jupyter",
"ms-toolsai.jupyter-keymap",
"ms-toolsai.jupyter-renderers",
"ms-vsliveshare.vsliveshare",
- "stkb.rewrap"
+ "stkb.rewrap",
+ "charliermarsh.ruff"
]
}
\ No newline at end of file
diff --git a/.vscode/settings.json b/.vscode/settings.json
index f06e3d2f5..c73dd7099 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,8 +1,4 @@
{
- "python.linting.flake8Enabled": true,
- "python.linting.mypyEnabled": true,
- "python.linting.enabled": true,
- "python.formatting.provider": "none",
"editor.formatOnSave": true,
"editor.rulers": [
88
@@ -18,8 +14,7 @@
"workbench.editorAssociations": {
"*.ipynb": "jupyter-notebook"
},
- "cSpell.words": [],
"[python]": {
- "editor.defaultFormatter": "ms-python.black-formatter"
+ "editor.defaultFormatter": "charliermarsh.ruff"
},
}
\ No newline at end of file
diff --git a/docs/source/_static/images/IMPERIAL_logo_RGB_Blue_safe_area_2024.png b/docs/source/_static/images/IMPERIAL_logo_RGB_Blue_safe_area_2024.png
new file mode 100644
index 000000000..b7aa54fdd
Binary files /dev/null and b/docs/source/_static/images/IMPERIAL_logo_RGB_Blue_safe_area_2024.png differ
diff --git a/docs/source/_static/images/abiotic_sketch.jpg b/docs/source/_static/images/abiotic_sketch.jpg
new file mode 100644
index 000000000..b5b9a0d57
Binary files /dev/null and b/docs/source/_static/images/abiotic_sketch.jpg differ
diff --git a/docs/source/_static/images/hydrology.svg b/docs/source/_static/images/hydrology.svg
new file mode 100644
index 000000000..0eb6b7743
--- /dev/null
+++ b/docs/source/_static/images/hydrology.svg
@@ -0,0 +1,785 @@
+
diff --git a/docs/source/_static/images/layer_structure.drawio b/docs/source/_static/images/layer_structure.drawio
new file mode 100644
index 000000000..1a78470a8
--- /dev/null
+++ b/docs/source/_static/images/layer_structure.drawio
@@ -0,0 +1 @@
+7V1tk6I4EP4189Ep3pGP6q5zu7ezu1c6dXWftiJEZRcJBzij++svyItAx5HBAJ7DWFurTeyEfp4knU4T7+TJZvfgI2/9SCzs3EmCtbuTP9xJkiiIQ/pfJNmnEkWMJSvfthLZUTCzf+O0YCLd2hYOCgVDQpzQ9opCk7guNsNYlnwX+T55KRZbEqdYq4dWGAhmJnKg9G/bCtexVBaEo/wPbK/WYenCApm/Vj7Zukl1d5K8PPzFlzcoVZWUD9bIIi85kfzxTp74hITxu6cA+98WP6NblAQHLaidE72HO92Ga+LHks9k7VLRB4Ljaz5+tgObuPHVZ/E+qTE1/7G2zW6CHYrfNP5I3+RqPYgIowVf0B77VPTFdilQBdUiUC0E4T41bWpBH7sF3I7Vk1zVmYZUufQUPOz/+j7/52nlidLP9aP7cz4QZTVW+4ycbaGeXMXYtUYRNegnl7hUOLZQsMaRXpF+WIcbJ3l7APBwQaCfgtAnvzIaiMn3vqMwxL57kEiCmJWbECeBRB4fXvQKvOWEX9gq0DC54wdMNjj097TAy5F8agLgOse7VOZjB4X2c5G8KOkDq0xdVsN3YrsRnkmHTdmY9NaBpAlFFQHZ+iZOvnXECihSzmoKkb/CIdBE3+Tu+yg6gP8mImg9ETgSQeFGhLKmxomg90TgSARJuBd5UUFqmwrDngocqSBwGxPKmhongtETgR8RxCEdEwxOXKDK2uVCOh/1XODCBY3f/CC27TOma9OeClyowM1nBJoaJ4LUE4EjESSe80PbTqMi91zgyAVuTiPQ1DgRlJ4I/IhQdvNq86B1f7GPMHKkAbcAY+u+Yh9f5EgDbq5iy56i1AcXeUaUuE0KQBM/Hnz9qm0+Dwe7+VL9sdr/MpXHH3jAWjhqDrXWeEHfrKI36T7ZJ9eyzWinLL5Oq8uKZN/xT0tGVCYM6L/RglDDS4KJXOLtYUF6IxraePSduwi8gy6hLIr0TE58fzqJrk5tx6GMPF3NbJq0Z7b1l8jEjBbP0xaHGxJ4a+wzCs1nSaE58QJiO4yKZllFC3aJUVpiFG81MguN00Jjm/aYlW0ix2HcVgXjVRYh89BHTrVoNEqbnZZruDmvwDD9krRl6mx3d9E+LyVtAIa0EO/C4tBVHISScW5JyVMSIcdeRYOXg5eRhmfshxEEo0QckqiRL2s7xDMvYpP84cVHHhgbT45skUK8e3VsS8cMpTxm6MkaNTf4ZavN/Ognycbpka4wsrzdq4DzyWyNLNtdwTsWikNiFf1GhVhn0dAsKHKw5xGmM4+F8HBpnqIDvIUzRqiMpXZq+D8LpdAQkkaFCNIllv6oRa8rsLRW0dIgbsOv0wgVtvUuYrWKh5bSva2zMGhnrB42bOnpdKzqwhVYWqpoabWx8aNC1PESS2drhI4trVc0tNzc6FEhnnOJpY3RRB9Pu7c0a6SWGZYur5z4WVpteE7sytJGTUuXQ1YcLd3w6NGVpUWwzq9o6nJYiKPHDlNJHqLUZrpijr/uHPNiL/TexXS2uapo01CIXm+BPbHYlQShQO+tG4QqK2p701q9xuyF/zs7svZcTA+gqTl+bD796bk/nfnTJyyiycLTBsHvwTVGqmuzIzb6q71BuS4ecYt1A00t86jhJSAn1yKdlau7FmpN14LHYptpaLEfzxvoh6Jxr4vC8U8soa4b92rNjnlGtQw01+6prOewHpHtxurPrHflnHUSHvJ9CEuDq48J1zHiRJiZXtHMIV4s6RVCddlhZHr9LWwV0qZXHjeyJxVfGzfaDYhqMDVhesMAyDUBaCzQoTE2caa3a//yxMkKU7capdZgRG80vln7iycXsF3Z32C5iPFOs1fAQPt3Gz3fPI5CJIO0aaPE9ThezjbK44yHLG/CO+6Ol7C9fH/apDhhn7FDvbEtK6qm1iY1L8wB5EevJQe61iroMA6WZpa8d3BEpSI4DW5ywLVElmjzzuERpSuABwZ2s3Sq9w6PcgXwSACeR7SzN9sNFS4KeWTlZC/Bwh5t9HWiuCRumBy5YjTrI5ZAlaGHIrY7W9WKhp4Jp+TcwDgAcLiC/LCk5q12PhvsTNMyriTGUt55NuqHVIZnVTW8q6JCt2Z4pb0ZxvSa69DlNbco6qBHM4Me6mkyXdShdbjmM3qcAE5G1zDB0FQaP+txyuGkd40TnB/T7YgepxxOatc4wVCL3sMEpye5a5ygG6H1OEGcuu5PQxgnUXucIE66zliUt4sU3GRUeqQgUkb3SMFzE+QeKbhtKXaPFFxEwbBIj5Qkd48UYx3VIwWRUrtHCq6k+gUvA6lWPQpmvh3sUtGT6yWkbiVrQNLLAFTMGgCH8nGzP3Tooifjb9T+cm37l4+94mZ/6KZFpwHcqv2rPLTVVNYY0/zQ93pP5mc9cdtU0hI72/pdjz6d5+zp0P7RSS23an+QM1mR/s09MqrASPLohgEAcZKKADSXNAwjxLMbtn85az5za7rqABrk//x27c/Igut4Asge2CvkwC36FMXcEadd5faKaq0zT0+mS5XyzkB/MAxlIrAjErSW6Ei6uzRikcuuMh0UBLY5X9tueikpWieUcSW5VCADSi+BXDuVquI52tS6aJ8r5kUFgtMNzn7Lo9TgU+0C5cEDaHEL6mZ1MZ19ONd+o73TQXvIklLrq3SXer9BVvVZzXuVyebX7vNKuAxO8BZrJwYqwH9o+Vh4o8Jh4LWdhYQRlwPfxgl6ilAGkV+WbhMdiZ2leyNdDMCo8su9ZehqupPVOmO7x78Q1+GGP0NX00fa1DsCoScAh9/bgPBz+70N+vH4w7Zx8eOvB8sf/wM=
\ No newline at end of file
diff --git a/docs/source/_static/images/layer_structure.svg b/docs/source/_static/images/layer_structure.svg
new file mode 100644
index 000000000..7ef5f6cbd
--- /dev/null
+++ b/docs/source/_static/images/layer_structure.svg
@@ -0,0 +1,4 @@
+
+
+
+
\ No newline at end of file
diff --git a/docs/source/_static/images/simulation_flow.drawio b/docs/source/_static/images/simulation_flow.drawio
new file mode 100644
index 000000000..9400d0b98
--- /dev/null
+++ b/docs/source/_static/images/simulation_flow.drawio
@@ -0,0 +1,332 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/_static/images/simulation_flow.svg b/docs/source/_static/images/simulation_flow.svg
new file mode 100644
index 000000000..6a7f46660
--- /dev/null
+++ b/docs/source/_static/images/simulation_flow.svg
@@ -0,0 +1,3 @@
+
+
+
\ No newline at end of file
diff --git a/docs/source/_static/images/step1.png b/docs/source/_static/images/step1.png
new file mode 100644
index 000000000..2b5608365
Binary files /dev/null and b/docs/source/_static/images/step1.png differ
diff --git a/docs/source/_static/images/step2.png b/docs/source/_static/images/step2.png
new file mode 100644
index 000000000..da2df1fc9
Binary files /dev/null and b/docs/source/_static/images/step2.png differ
diff --git a/docs/source/_static/images/ve_diagram.png b/docs/source/_static/images/ve_diagram.png
new file mode 100644
index 000000000..e250a9ad0
Binary files /dev/null and b/docs/source/_static/images/ve_diagram.png differ
diff --git a/docs/source/_static/images/ve_diagram.svg b/docs/source/_static/images/ve_diagram.svg
new file mode 100644
index 000000000..e09e0e96f
--- /dev/null
+++ b/docs/source/_static/images/ve_diagram.svg
@@ -0,0 +1,1164 @@
+
+
+
+
diff --git a/docs/source/_static/vr_full_model_configuration.toml b/docs/source/_static/vr_full_model_configuration.toml
new file mode 100644
index 000000000..d267d2d86
--- /dev/null
+++ b/docs/source/_static/vr_full_model_configuration.toml
@@ -0,0 +1,318 @@
+[core.data_output_options]
+save_initial_state = true
+out_path = "/tmp/ve_example/out"
+save_continuous_data = true
+save_final_state = true
+save_merged_config = true
+out_initial_file_name = "initial_state.nc"
+out_continuous_file_name = "all_continuous_data.nc"
+out_final_file_name = "final_state.nc"
+out_merge_file_name = "vr_full_model_configuration.toml"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "air_temperature_ref"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "relative_humidity_ref"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "atmospheric_pressure_ref"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "precipitation"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "atmospheric_co2_ref"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "mean_annual_temperature"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_climate_data.nc"
+var_name = "wind_speed_ref"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_elevation_data.nc"
+var_name = "elevation"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_surface_runoff_data.nc"
+var_name = "surface_runoff"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "pH"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "bulk_density"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "clay_fraction"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_c_pool_lmwc"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_c_pool_maom"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_c_pool_microbe"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_c_pool_pom"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_c_pool_necromass"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_enzyme_pom"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_soil_data.nc"
+var_name = "soil_enzyme_maom"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "litter_pool_above_metabolic"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "litter_pool_above_structural"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "litter_pool_woody"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "litter_pool_below_metabolic"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "litter_pool_below_structural"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "lignin_above_structural"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "lignin_woody"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_litter_data.nc"
+var_name = "lignin_below_structural"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_plant_data.nc"
+var_name = "plant_cohorts_n"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_plant_data.nc"
+var_name = "plant_cohorts_pft"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_plant_data.nc"
+var_name = "plant_cohorts_cell_id"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_plant_data.nc"
+var_name = "plant_cohorts_dbh"
+
+[[core.data.variable]]
+file = "/private/tmp/ve_example/data/example_plant_data.nc"
+var_name = "photosynthetic_photon_flux_density"
+
+[core.grid]
+grid_type = "square"
+cell_area = 8100
+cell_nx = 9
+cell_ny = 9
+xoff = -45.0
+yoff = -45.0
+
+[core.timing]
+start_date = "2013-01-01"
+update_interval = "1 month"
+run_length = "2 years"
+
+[core.layers]
+soil_layers = [
+ -0.25,
+ -1.0,
+]
+canopy_layers = 10
+above_canopy_height_offset = 2.0
+surface_layer_height = 0.1
+subcanopy_layer_height = 1.5
+
+[hydrology]
+initial_soil_moisture = 0.5
+initial_groundwater_saturation = 0.9
+
+[hydrology.depends]
+init = [
+ "plants",
+]
+update = [
+ "plants",
+ "abiotic_simple",
+]
+
+[abiotic_simple.depends]
+init = [
+ "plants",
+]
+update = []
+
+[[animal.functional_groups]]
+name = "carnivorous_bird"
+taxa = "bird"
+diet = "carnivore"
+metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_bird"
+excretion_type = "uricotelic"
+birth_mass = 0.1
+adult_mass = 1.0
+
+[[animal.functional_groups]]
+name = "herbivorous_bird"
+taxa = "bird"
+diet = "herbivore"
+metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_bird"
+excretion_type = "uricotelic"
+birth_mass = 0.05
+adult_mass = 0.5
+
+[[animal.functional_groups]]
+name = "carnivorous_mammal"
+taxa = "mammal"
+diet = "carnivore"
+metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_mammal"
+excretion_type = "ureotelic"
+birth_mass = 4.0
+adult_mass = 40.0
+
+[[animal.functional_groups]]
+name = "herbivorous_mammal"
+taxa = "mammal"
+diet = "herbivore"
+metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_mammal"
+excretion_type = "ureotelic"
+birth_mass = 1.0
+adult_mass = 10.0
+
+[[animal.functional_groups]]
+name = "carnivorous_insect"
+taxa = "insect"
+diet = "carnivore"
+metabolic_type = "ectothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_insect"
+excretion_type = "uricotelic"
+birth_mass = 0.001
+adult_mass = 0.01
+
+[[animal.functional_groups]]
+name = "herbivorous_insect"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "semelparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_insect"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
+
+[[animal.functional_groups]]
+name = "butterfly"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "semelparous"
+development_type = "indirect"
+development_status = "adult"
+offspring_functional_group = "caterpillar"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
+
+[[animal.functional_groups]]
+name = "caterpillar"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "nonreproductive"
+development_type = "indirect"
+development_status = "larval"
+offspring_functional_group = "butterfly"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
+
+[animal.depends]
+init = []
+update = []
+
+[litter.depends]
+update = [
+ "hydrology",
+ "abiotic_simple",
+]
+init = []
+
+[soil.depends]
+init = [
+ "hydrology",
+ "abiotic_simple",
+]
+update = [
+ "hydrology",
+ "abiotic_simple",
+]
+
+[plants]
+a_plant_integer = 12
+ftypes = [
+ { pft_name = "shrub", max_height = 1.0 },
+ { pft_name = "broadleaf", max_height = 50.0 },
+]
+
+[plants.depends]
+init = []
+update = [
+ "abiotic_simple",
+]
diff --git a/docs/source/_toc.yaml b/docs/source/_toc.yaml
new file mode 100644
index 000000000..07741f0e8
--- /dev/null
+++ b/docs/source/_toc.yaml
@@ -0,0 +1,215 @@
+root: index
+subtrees:
+ - titlesonly: True
+ maxdepth: 0
+ caption: The Virtual Ecosystem
+ entries:
+ - file: virtual_ecosystem/theory/theory
+ title: Theory
+ entries:
+ - file: virtual_ecosystem/theory/abiotic_theory
+ entries:
+ - file: virtual_ecosystem/theory/microclimate_theory
+ - file: virtual_ecosystem/theory/hydrology_theory
+ - file: virtual_ecosystem/theory/plant_theory
+ - file: virtual_ecosystem/theory/soil_theory
+ - file: virtual_ecosystem/theory/animal_theory
+ - file: virtual_ecosystem/implementation/implementation
+ title: Implementation
+ entries:
+ - file: virtual_ecosystem/implementation/science_model_overview
+ - file: virtual_ecosystem/implementation/core_components_overview
+ - file: virtual_ecosystem/implementation/abiotic_simple_implementation
+ - file: virtual_ecosystem/implementation/abiotic_implementation
+ - file: virtual_ecosystem/implementation/animal_implementation
+ - file: virtual_ecosystem/implementation/litter_implementation
+ - file: virtual_ecosystem/implementation/hydrology_implementation
+ - file: virtual_ecosystem/implementation/soil_implementation
+ - file: virtual_ecosystem/implementation/plants_implementation
+ - file: virtual_ecosystem/implementation/main_simulation
+ - file: virtual_ecosystem/implementation/variables
+
+ - caption: Using the Virtual Ecosystem
+ entries:
+ - file: using_the_ve/getting_started
+ entries:
+ - file: using_the_ve/ve_run
+ - file: using_the_ve/example_data
+ - file: using_the_ve/virtual_ecosystem_in_use
+ - file: using_the_ve/configuration/config
+ title: Configuring your model
+ entries:
+ - file: using_the_ve/configuration/axes
+ - file: using_the_ve/configuration/grid
+ - file: using_the_ve/configuration/constants
+ - file: using_the_ve/data/data
+ title: Adding data to the model
+ entries:
+ - file: using_the_ve/data/notes_preprocessing
+
+ - caption: Development
+ entries:
+ - file: development/contributing
+ entries:
+ - file: development/contributing/overview
+ - file: development/contributing/code_qa_and_typing
+ - file: development/contributing/code_testing
+ - file: development/contributing/github_actions
+ - file: development/contributing/release_process
+ - file: development/design
+ entries:
+ - file: development/design/core
+ - file: development/design/defining_new_models
+ - file: development/documentation
+ entries:
+ - file: development/documentation/documentation
+ - file: development/documentation/api_generation
+ - file: development/documentation/docstring_style
+ - file: development/documentation/jupyter_notebooks
+
+ - caption: API
+ entries:
+ - file: api/core.md
+ title: The core module
+ subtrees:
+ - titlesonly: True
+ entries:
+ - file: api/core/axes
+ title: The axes submodule
+ - file: api/core/base_model.md
+ title: The base_model submodule
+ - file: api/core/config.md
+ title: The config submodule
+ - file: api/core/constants.md
+ title: The constants submodule
+ - file: api/core/constants_class.md
+ title: The constants_class submodule
+ - file: api/core/constants_loader.md
+ title: The constants_loader submodule
+ - file: api/core/core_components.md
+ title: The core_components submodule
+ - file: api/core/data.md
+ title: The data submodule
+ - file: api/core/exceptions.md
+ title: The exceptions submodule
+ - file: api/core/grid.md
+ title: The grid submodule
+ - file: api/core/logger.md
+ title: The logger submodule
+ - file: api/core/readers.md
+ title: The readers submodule
+ - file: api/core/registry.md
+ title: The registry submodule
+ - file: api/core/schema.md
+ title: The schema submodule
+ - file: api/core/utils.md
+ title: The utils submodule
+ - file: api/core/variables.md
+ title: The variables submodule
+ - file: api/main.md
+ title: The main submodule
+ - file: api/models.md
+ entries:
+ - file: api/models/abiotic.md
+ title: The abiotic model
+ entries:
+ - file: api/models/abiotic/abiotic_model
+ title: The abiotic_model submodule
+ - file: api/models/abiotic/abiotic_constants
+ title: The abiotic_constants submodule
+ - file: api/models/abiotic/abiotic_tools
+ title: The abiotic_tools submodule
+ - file: api/models/abiotic/conductivities
+ title: The conductivities submodule
+ - file: api/models/abiotic/energy_balance
+ title: The energy_balance submodule
+ - file: api/models/abiotic/soil_energy_balance
+ title: The soil_energy_balance submodule
+ - file: api/models/abiotic/wind
+ title: The wind submodule
+ - file: api/models/abiotic_simple
+ title: The abiotic_simple model
+ entries:
+ - file: api/models/abiotic_simple/abiotic_simple_constants
+ title: The abiotic_simple_constants submodule
+ - file: api/models/abiotic_simple/abiotic_simple_model
+ title: The abiotic_simple_model submodule
+ - file: api/models/abiotic_simple/microclimate
+ title: The microclimate submodule
+ - file: api/models/animal
+ title: The animal model
+ entries:
+ - file: api/models/animal/animal_cohorts
+ title: The animal_cohorts submodule
+ - file: api/models/animal/animal_communities
+ title: The animal_communities submodule
+ - file: api/models/animal/animal_model
+ title: The animal_model submodule
+ - file: api/models/animal/animal_traits
+ title: The animal_traits submodule
+ - file: api/models/animal/constants
+ title: The constants submodule
+ - file: api/models/animal/decay
+ title: The decay submodule
+ - file: api/models/animal/functional_group
+ title: The functional_group submodule
+ - file: api/models/animal/plant_resources
+ title: The plant_resources submodule
+ - file: api/models/animal/protocols
+ title: The protocols submodule
+ - file: api/models/animal/scaling_functions
+ title: The scaling_functions submodule
+ - file: api/models/hydrology
+ title: The hydrology model
+ entries:
+ - file: api/models/hydrology/above_ground
+ title: The above_ground submodule
+ - file: api/models/hydrology/below_ground
+ title: The below_ground submodule
+ - file: api/models/hydrology/constants
+ title: The constants submodule
+ - file: api/models/hydrology/hydrology_model
+ title: The hydrology_model submodule
+ - file: api/models/hydrology/hydrology_tools
+ title: The hydrology_tools submodule
+ - file: api/models/litter
+ title: The litter model
+ entries:
+ - file: api/models/litter/carbon
+ title: The litter carbon submodule
+ - file: api/models/litter/chemistry
+ title: The litter chemistry submodule
+ - file: api/models/litter/constants
+ title: The constants submodule
+ - file: api/models/litter/env_factors
+ title: The env_factors submodule
+ - file: api/models/litter/input_partition
+ title: The input_partition submodule
+ - file: api/models/litter/litter_model
+ title: The litter_model submodule
+ - file: api/models/soil
+ title: The soil model
+ entries:
+ - file: api/models/soil/carbon
+ title: The carbon submodule
+ - file: api/models/soil/constants
+ title: The constants submodule
+ - file: api/models/soil/env_factors
+ title: The env_factors submodule
+ - file: api/models/soil/soil_model
+ title: The soil_model submodule
+ - file: api/models/plants
+ title: The plants model
+ entries:
+ - file: api/models/plants/plant_structures
+ title: The plant_structures submodule
+ - file: api/models/plants/plants_model
+ title: The plants_model submodule
+ - file: api/example_data
+ title: The example_data submodule
+
+ - caption: Reference
+ entries:
+ - file: bibliography
+ - file: genindex
+ - file: modindex
diff --git a/docs/source/api/core.md b/docs/source/api/core.md
index 7dab227f5..ca44e6d6f 100644
--- a/docs/source/api/core.md
+++ b/docs/source/api/core.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for `core` modules
diff --git a/docs/source/api/core/axes.md b/docs/source/api/core/axes.md
index e9dbb5d31..8e84b90de 100644
--- a/docs/source/api/core/axes.md
+++ b/docs/source/api/core/axes.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.axes` module
diff --git a/docs/source/api/core/base_model.md b/docs/source/api/core/base_model.md
index 71b565059..0e4d11571 100644
--- a/docs/source/api/core/base_model.md
+++ b/docs/source/api/core/base_model.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.base_model` module
@@ -21,6 +21,6 @@ kernelspec:
:autosummary:
:members:
:special-members: __init_subclass__, __repr__, __str__, __init__
- :private-members: _check_required_init_vars, _check_model_name,
- _check_model_update_bounds, _check_vars_updated
+ :private-members: _check_vars_required_for_init, _check_model_name,
+ _check_model_update_bounds, _check_vars_updated, _check_variables_attribute
```
diff --git a/docs/source/api/core/config.md b/docs/source/api/core/config.md
index 1f6e1e11b..383e38496 100644
--- a/docs/source/api/core/config.md
+++ b/docs/source/api/core/config.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.config` module
diff --git a/docs/source/api/core/constants.md b/docs/source/api/core/constants.md
index 76701743f..93d0ef27e 100644
--- a/docs/source/api/core/constants.md
+++ b/docs/source/api/core/constants.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.constants` module
diff --git a/docs/source/api/core/constants_class.md b/docs/source/api/core/constants_class.md
index aa31c8776..ada186495 100644
--- a/docs/source/api/core/constants_class.md
+++ b/docs/source/api/core/constants_class.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.constants_class` module
diff --git a/docs/source/api/core/constants_loader.md b/docs/source/api/core/constants_loader.md
index a29233f50..1722ef377 100644
--- a/docs/source/api/core/constants_loader.md
+++ b/docs/source/api/core/constants_loader.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.constants_loader` module
diff --git a/docs/source/api/core/core_components.md b/docs/source/api/core/core_components.md
index 2137af790..c197a52e7 100644
--- a/docs/source/api/core/core_components.md
+++ b/docs/source/api/core/core_components.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.core_components` module
@@ -21,4 +21,5 @@ kernelspec:
:autosummary:
:members:
:special-members: __post_init__
+ :private-members: _role_indices_bool, _role_indices_int
```
diff --git a/docs/source/api/core/data.md b/docs/source/api/core/data.md
index 43ae88cdf..afc0aa0c1 100644
--- a/docs/source/api/core/data.md
+++ b/docs/source/api/core/data.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.data` module
diff --git a/docs/source/api/core/exceptions.md b/docs/source/api/core/exceptions.md
index 10c5f825a..76228112e 100644
--- a/docs/source/api/core/exceptions.md
+++ b/docs/source/api/core/exceptions.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.exceptions` module
diff --git a/docs/source/api/core/grid.md b/docs/source/api/core/grid.md
index 00a5b788f..782d0a482 100644
--- a/docs/source/api/core/grid.md
+++ b/docs/source/api/core/grid.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.grid` module
diff --git a/docs/source/api/core/logger.md b/docs/source/api/core/logger.md
index 43c697228..9a78601d7 100644
--- a/docs/source/api/core/logger.md
+++ b/docs/source/api/core/logger.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.logger` module
diff --git a/docs/source/api/core/readers.md b/docs/source/api/core/readers.md
index b88636263..53b34e9af 100644
--- a/docs/source/api/core/readers.md
+++ b/docs/source/api/core/readers.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.readers` module
diff --git a/docs/source/api/core/registry.md b/docs/source/api/core/registry.md
index 5b68b7252..8e989060a 100644
--- a/docs/source/api/core/registry.md
+++ b/docs/source/api/core/registry.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.registry` module
diff --git a/docs/source/api/core/schema.md b/docs/source/api/core/schema.md
index f7ca5242a..5bf296bf4 100644
--- a/docs/source/api/core/schema.md
+++ b/docs/source/api/core/schema.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.schema` module
diff --git a/docs/source/api/core/utils.md b/docs/source/api/core/utils.md
index 7aa6d4d91..5ae24483d 100644
--- a/docs/source/api/core/utils.md
+++ b/docs/source/api/core/utils.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.core.utils` module
diff --git a/docs/source/api/core/variables.md b/docs/source/api/core/variables.md
new file mode 100644
index 000000000..c7a1866c6
--- /dev/null
+++ b/docs/source/api/core/variables.md
@@ -0,0 +1,23 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: vr_python3
+ language: python
+ name: vr_python3
+---
+
+# API documentation for the {mod}`~virtual_ecosystem.core.variables` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.core.variables
+ :autosummary:
+ :members:
+```
diff --git a/docs/source/api/example_data.md b/docs/source/api/example_data.md
index 266f2a6bb..d2b9fdcbc 100644
--- a/docs/source/api/example_data.md
+++ b/docs/source/api/example_data.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for `example_data` module
diff --git a/docs/source/api/main.md b/docs/source/api/main.md
index 39b7be39f..462a9399f 100644
--- a/docs/source/api/main.md
+++ b/docs/source/api/main.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for the main Virtual Ecosystem API
diff --git a/docs/source/api/models.md b/docs/source/api/models.md
new file mode 100644
index 000000000..5b06ecdae
--- /dev/null
+++ b/docs/source/api/models.md
@@ -0,0 +1,17 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# The Virtual Ecosystem models
diff --git a/docs/source/api/models/abiotic.md b/docs/source/api/models/abiotic.md
new file mode 100644
index 000000000..14b9a5257
--- /dev/null
+++ b/docs/source/api/models/abiotic.md
@@ -0,0 +1,21 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API reference for `abiotic` modules
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic
+```
diff --git a/docs/source/api/models/abiotic/abiotic_constants.md b/docs/source/api/models/abiotic/abiotic_constants.md
new file mode 100644
index 000000000..274acf354
--- /dev/null
+++ b/docs/source/api/models/abiotic/abiotic_constants.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.abiotic.constants` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.constants
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/models/abiotic/abiotic_model.md b/docs/source/api/models/abiotic/abiotic_model.md
new file mode 100644
index 000000000..4a5638d74
--- /dev/null
+++ b/docs/source/api/models/abiotic/abiotic_model.md
@@ -0,0 +1,31 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+
+# API documentation for the {mod}`~virtual_ecosystem.models.abiotic.abiotic_model` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.abiotic_model
+```
+
+## The {mod}`~virtual_ecosystem.models.abiotic.abiotic_model.AbioticModel` class
+
+```{eval-rst}
+.. autoclass:: virtual_ecosystem.models.abiotic.abiotic_model.AbioticModel
+ :autosummary:
+ :members:
+ :exclude-members: model_name
+```
diff --git a/docs/source/api/models/abiotic/abiotic_tools.md b/docs/source/api/models/abiotic/abiotic_tools.md
new file mode 100644
index 000000000..1fbcc2451
--- /dev/null
+++ b/docs/source/api/models/abiotic/abiotic_tools.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.abiotic.abiotic_tools` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.abiotic_tools
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/models/abiotic/conductivities.md b/docs/source/api/models/abiotic/conductivities.md
new file mode 100644
index 000000000..26a8f69f1
--- /dev/null
+++ b/docs/source/api/models/abiotic/conductivities.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.abiotic.conductivities` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.conductivities
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/models/abiotic/energy_balance.md b/docs/source/api/models/abiotic/energy_balance.md
new file mode 100644
index 000000000..52d99a125
--- /dev/null
+++ b/docs/source/api/models/abiotic/energy_balance.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.abiotic.energy_balance` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.energy_balance
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/models/abiotic/soil_energy_balance.md b/docs/source/api/models/abiotic/soil_energy_balance.md
new file mode 100644
index 000000000..cf9f5ae5d
--- /dev/null
+++ b/docs/source/api/models/abiotic/soil_energy_balance.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.abiotic.soil_energy_balance` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.soil_energy_balance
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/models/abiotic/wind.md b/docs/source/api/models/abiotic/wind.md
new file mode 100644
index 000000000..30aa24536
--- /dev/null
+++ b/docs/source/api/models/abiotic/wind.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.abiotic.wind` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.abiotic.wind
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/abiotic_simple.md b/docs/source/api/models/abiotic_simple.md
similarity index 87%
rename from docs/source/api/abiotic_simple.md
rename to docs/source/api/models/abiotic_simple.md
index bd878b6b3..a29560afb 100644
--- a/docs/source/api/abiotic_simple.md
+++ b/docs/source/api/models/abiotic_simple.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for `abiotic_simple` modules
diff --git a/docs/source/api/abiotic_simple/abiotic_constants.md b/docs/source/api/models/abiotic_simple/abiotic_simple_constants.md
similarity index 89%
rename from docs/source/api/abiotic_simple/abiotic_constants.md
rename to docs/source/api/models/abiotic_simple/abiotic_simple_constants.md
index 941291071..1b9ee9e70 100644
--- a/docs/source/api/abiotic_simple/abiotic_constants.md
+++ b/docs/source/api/models/abiotic_simple/abiotic_simple_constants.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API for the {mod}`~virtual_ecosystem.models.abiotic_simple.constants` module
diff --git a/docs/source/api/abiotic_simple/abiotic_simple_model.md b/docs/source/api/models/abiotic_simple/abiotic_simple_model.md
similarity index 93%
rename from docs/source/api/abiotic_simple/abiotic_simple_model.md
rename to docs/source/api/models/abiotic_simple/abiotic_simple_model.md
index d686d8b6c..eed0e3c5b 100644
--- a/docs/source/api/abiotic_simple/abiotic_simple_model.md
+++ b/docs/source/api/models/abiotic_simple/abiotic_simple_model.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
diff --git a/docs/source/api/abiotic_simple/microclimate.md b/docs/source/api/models/abiotic_simple/microclimate.md
similarity index 89%
rename from docs/source/api/abiotic_simple/microclimate.md
rename to docs/source/api/models/abiotic_simple/microclimate.md
index 6bd668157..e342e5bf3 100644
--- a/docs/source/api/abiotic_simple/microclimate.md
+++ b/docs/source/api/models/abiotic_simple/microclimate.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API for the {mod}`~virtual_ecosystem.models.abiotic_simple.microclimate` module
diff --git a/docs/source/api/animals.md b/docs/source/api/models/animal.md
similarity index 65%
rename from docs/source/api/animals.md
rename to docs/source/api/models/animal.md
index fc012ae3c..6ba507caa 100644
--- a/docs/source/api/animals.md
+++ b/docs/source/api/models/animal.md
@@ -9,13 +9,13 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API reference for `animals` modules
+# API reference for `animal` modules
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals
+.. automodule:: virtual_ecosystem.models.animal
```
diff --git a/docs/source/api/animals/animal_cohorts.md b/docs/source/api/models/animal/animal_cohorts.md
similarity index 62%
rename from docs/source/api/animals/animal_cohorts.md
rename to docs/source/api/models/animal/animal_cohorts.md
index 339270acd..51f08057f 100644
--- a/docs/source/api/animals/animal_cohorts.md
+++ b/docs/source/api/models/animal/animal_cohorts.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.animal_cohorts` module
+# API for the {mod}`~virtual_ecosystem.models.animal.animal_cohorts` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.animal_cohorts
+.. automodule:: virtual_ecosystem.models.animal.animal_cohorts
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/animal_communities.md b/docs/source/api/models/animal/animal_communities.md
similarity index 61%
rename from docs/source/api/animals/animal_communities.md
rename to docs/source/api/models/animal/animal_communities.md
index a9e1dfdb8..f844e7280 100644
--- a/docs/source/api/animals/animal_communities.md
+++ b/docs/source/api/models/animal/animal_communities.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.animal_communities` module
+# API for the {mod}`~virtual_ecosystem.models.animal.animal_communities` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.animal_communities
+.. automodule:: virtual_ecosystem.models.animal.animal_communities
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/animal_model.md b/docs/source/api/models/animal/animal_model.md
similarity index 63%
rename from docs/source/api/animals/animal_model.md
rename to docs/source/api/models/animal/animal_model.md
index 9f5f71eeb..e5d082187 100644
--- a/docs/source/api/animals/animal_model.md
+++ b/docs/source/api/models/animal/animal_model.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.animal_model` module
+# API for the {mod}`~virtual_ecosystem.models.animal.animal_model` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.animal_model
+.. automodule:: virtual_ecosystem.models.animal.animal_model
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/animal_traits.md b/docs/source/api/models/animal/animal_traits.md
similarity index 62%
rename from docs/source/api/animals/animal_traits.md
rename to docs/source/api/models/animal/animal_traits.md
index 9b5716b80..58ae3746e 100644
--- a/docs/source/api/animals/animal_traits.md
+++ b/docs/source/api/models/animal/animal_traits.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.animal_traits` module
+# API for the {mod}`~virtual_ecosystem.models.animal.animal_traits` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.animal_traits
+.. automodule:: virtual_ecosystem.models.animal.animal_traits
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/constants.md b/docs/source/api/models/animal/constants.md
similarity index 63%
rename from docs/source/api/animals/constants.md
rename to docs/source/api/models/animal/constants.md
index 895f4557d..bccff6e12 100644
--- a/docs/source/api/animals/constants.md
+++ b/docs/source/api/models/animal/constants.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.constants` module
+# API for the {mod}`~virtual_ecosystem.models.animal.constants` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.constants
+.. automodule:: virtual_ecosystem.models.animal.constants
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/decay.md b/docs/source/api/models/animal/decay.md
similarity index 64%
rename from docs/source/api/animals/decay.md
rename to docs/source/api/models/animal/decay.md
index 4e81c979d..0bc6f33df 100644
--- a/docs/source/api/animals/decay.md
+++ b/docs/source/api/models/animal/decay.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.decay` module
+# API for the {mod}`~virtual_ecosystem.models.animal.decay` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.decay
+.. automodule:: virtual_ecosystem.models.animal.decay
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/functional_group.md b/docs/source/api/models/animal/functional_group.md
similarity index 62%
rename from docs/source/api/animals/functional_group.md
rename to docs/source/api/models/animal/functional_group.md
index 00e4ac87e..de07137d9 100644
--- a/docs/source/api/animals/functional_group.md
+++ b/docs/source/api/models/animal/functional_group.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.functional_group` module
+# API for the {mod}`~virtual_ecosystem.models.animal.functional_group` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.functional_group
+.. automodule:: virtual_ecosystem.models.animal.functional_group
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/plant_resources.md b/docs/source/api/models/animal/plant_resources.md
similarity index 62%
rename from docs/source/api/animals/plant_resources.md
rename to docs/source/api/models/animal/plant_resources.md
index 841a95143..b5ab13317 100644
--- a/docs/source/api/animals/plant_resources.md
+++ b/docs/source/api/models/animal/plant_resources.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.plant_resources` module
+# API for the {mod}`~virtual_ecosystem.models.animal.plant_resources` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.plant_resources
+.. automodule:: virtual_ecosystem.models.animal.plant_resources
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/protocols.md b/docs/source/api/models/animal/protocols.md
similarity index 63%
rename from docs/source/api/animals/protocols.md
rename to docs/source/api/models/animal/protocols.md
index 12bfe56c3..0fc0fa7f7 100644
--- a/docs/source/api/animals/protocols.md
+++ b/docs/source/api/models/animal/protocols.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.protocols` module
+# API for the {mod}`~virtual_ecosystem.models.animal.protocols` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.protocols
+.. automodule:: virtual_ecosystem.models.animal.protocols
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/animals/scaling_functions.md b/docs/source/api/models/animal/scaling_functions.md
similarity index 61%
rename from docs/source/api/animals/scaling_functions.md
rename to docs/source/api/models/animal/scaling_functions.md
index ed5c80fb3..d54765d26 100644
--- a/docs/source/api/animals/scaling_functions.md
+++ b/docs/source/api/models/animal/scaling_functions.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API for the {mod}`~virtual_ecosystem.models.animals.scaling_functions` module
+# API for the {mod}`~virtual_ecosystem.models.animal.scaling_functions` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.animals.scaling_functions
+.. automodule:: virtual_ecosystem.models.animal.scaling_functions
:autosummary:
:members:
:exclude-members: model_name
diff --git a/docs/source/api/hydrology.md b/docs/source/api/models/hydrology.md
similarity index 86%
rename from docs/source/api/hydrology.md
rename to docs/source/api/models/hydrology.md
index 869ebf492..6b10b4ec1 100644
--- a/docs/source/api/hydrology.md
+++ b/docs/source/api/models/hydrology.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for `hydrology` modules
diff --git a/docs/source/api/hydrology/above_ground.md b/docs/source/api/models/hydrology/above_ground.md
similarity index 89%
rename from docs/source/api/hydrology/above_ground.md
rename to docs/source/api/models/hydrology/above_ground.md
index 3002bf6c7..269c40a35 100644
--- a/docs/source/api/hydrology/above_ground.md
+++ b/docs/source/api/models/hydrology/above_ground.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API for the {mod}`~virtual_ecosystem.models.hydrology.above_ground` module
diff --git a/docs/source/api/hydrology/below_ground.md b/docs/source/api/models/hydrology/below_ground.md
similarity index 89%
rename from docs/source/api/hydrology/below_ground.md
rename to docs/source/api/models/hydrology/below_ground.md
index d54b67c68..d926ab6f9 100644
--- a/docs/source/api/hydrology/below_ground.md
+++ b/docs/source/api/models/hydrology/below_ground.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API for the {mod}`~virtual_ecosystem.models.hydrology.below_ground` module
diff --git a/docs/source/api/hydrology/constants.md b/docs/source/api/models/hydrology/constants.md
similarity index 89%
rename from docs/source/api/hydrology/constants.md
rename to docs/source/api/models/hydrology/constants.md
index 37d40575c..ad8f22cb8 100644
--- a/docs/source/api/hydrology/constants.md
+++ b/docs/source/api/models/hydrology/constants.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API for the {mod}`~virtual_ecosystem.models.hydrology.constants` module
diff --git a/docs/source/api/hydrology/hydrology_model.md b/docs/source/api/models/hydrology/hydrology_model.md
similarity index 90%
rename from docs/source/api/hydrology/hydrology_model.md
rename to docs/source/api/models/hydrology/hydrology_model.md
index 6907151ea..50bfd4ff7 100644
--- a/docs/source/api/hydrology/hydrology_model.md
+++ b/docs/source/api/models/hydrology/hydrology_model.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
diff --git a/docs/source/api/models/hydrology/hydrology_tools.md b/docs/source/api/models/hydrology/hydrology_tools.md
new file mode 100644
index 000000000..ce5b77494
--- /dev/null
+++ b/docs/source/api/models/hydrology/hydrology_tools.md
@@ -0,0 +1,24 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API for the {mod}`~virtual_ecosystem.models.hydrology.hydrology_tools` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.hydrology.hydrology_tools
+ :autosummary:
+ :members:
+ :special-members: __init__
+```
diff --git a/docs/source/api/litter.md b/docs/source/api/models/litter.md
similarity index 86%
rename from docs/source/api/litter.md
rename to docs/source/api/models/litter.md
index 1f27db48f..8bf11fbe8 100644
--- a/docs/source/api/litter.md
+++ b/docs/source/api/models/litter.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for `litter` modules
diff --git a/docs/source/api/litter/litter_pools.md b/docs/source/api/models/litter/carbon.md
similarity index 73%
rename from docs/source/api/litter/litter_pools.md
rename to docs/source/api/models/litter/carbon.md
index e8936d071..e5d622c48 100644
--- a/docs/source/api/litter/litter_pools.md
+++ b/docs/source/api/models/litter/carbon.md
@@ -9,15 +9,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
-# API documentation for the {mod}`~virtual_ecosystem.models.litter.litter_pools` module
+# API documentation for the {mod}`~virtual_ecosystem.models.litter.carbon` module
```{eval-rst}
-.. automodule:: virtual_ecosystem.models.litter.litter_pools
+.. automodule:: virtual_ecosystem.models.litter.carbon
:autosummary:
:members:
```
diff --git a/docs/source/api/models/litter/chemistry.md b/docs/source/api/models/litter/chemistry.md
new file mode 100644
index 000000000..c76843e26
--- /dev/null
+++ b/docs/source/api/models/litter/chemistry.md
@@ -0,0 +1,23 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API documentation for the {mod}`~virtual_ecosystem.models.litter.chemistry` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.litter.chemistry
+ :autosummary:
+ :members:
+```
diff --git a/docs/source/api/litter/constants.md b/docs/source/api/models/litter/constants.md
similarity index 89%
rename from docs/source/api/litter/constants.md
rename to docs/source/api/models/litter/constants.md
index e703ab0a7..881ac2cfe 100644
--- a/docs/source/api/litter/constants.md
+++ b/docs/source/api/models/litter/constants.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.models.litter.constants` module
diff --git a/docs/source/api/models/litter/env_factors.md b/docs/source/api/models/litter/env_factors.md
new file mode 100644
index 000000000..bcd5213ee
--- /dev/null
+++ b/docs/source/api/models/litter/env_factors.md
@@ -0,0 +1,23 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API documentation for the {mod}`~virtual_ecosystem.models.litter.env_factors` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.litter.env_factors
+ :autosummary:
+ :members:
+```
diff --git a/docs/source/api/models/litter/input_partition.md b/docs/source/api/models/litter/input_partition.md
new file mode 100644
index 000000000..8dbbf4e4d
--- /dev/null
+++ b/docs/source/api/models/litter/input_partition.md
@@ -0,0 +1,23 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API documentation for the {mod}`~virtual_ecosystem.models.litter.input_partition` module
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.litter.input_partition
+ :autosummary:
+ :members:
+```
diff --git a/docs/source/api/litter/litter_model.md b/docs/source/api/models/litter/litter_model.md
similarity index 89%
rename from docs/source/api/litter/litter_model.md
rename to docs/source/api/models/litter/litter_model.md
index 3eacbdd5e..8daa492f2 100644
--- a/docs/source/api/litter/litter_model.md
+++ b/docs/source/api/models/litter/litter_model.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.models.litter.litter_model` module
diff --git a/docs/source/api/models/plants.md b/docs/source/api/models/plants.md
new file mode 100644
index 000000000..a5e2b487f
--- /dev/null
+++ b/docs/source/api/models/plants.md
@@ -0,0 +1,21 @@
+---
+jupytext:
+ cell_metadata_filter: -all
+ formats: md:myst
+ main_language: python
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.13.8
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# API reference for `plants` modules
+
+```{eval-rst}
+.. automodule:: virtual_ecosystem.models.plants
+```
diff --git a/docs/source/api/plants/plant_structures.md b/docs/source/api/models/plants/plant_structures.md
similarity index 95%
rename from docs/source/api/plants/plant_structures.md
rename to docs/source/api/models/plants/plant_structures.md
index f9b2f2fc8..19cd38e15 100644
--- a/docs/source/api/plants/plant_structures.md
+++ b/docs/source/api/models/plants/plant_structures.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# Plant structures for the {mod}`~virtual_ecosystem.models.plants` module
diff --git a/docs/source/api/plants/plants_model.md b/docs/source/api/models/plants/plants_model.md
similarity index 82%
rename from docs/source/api/plants/plants_model.md
rename to docs/source/api/models/plants/plants_model.md
index 37445774e..054eb0d7c 100644
--- a/docs/source/api/plants/plants_model.md
+++ b/docs/source/api/models/plants/plants_model.md
@@ -9,19 +9,13 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the plants model
-```{eval-rst}
-.. automodule:: virtual_ecosystem.models.plants
- :autosummary:
- :members:
-```
-
## The {mod}`~virtual_ecosystem.models.plants.plants_model` module
```{eval-rst}
diff --git a/docs/source/api/soil.md b/docs/source/api/models/soil.md
similarity index 86%
rename from docs/source/api/soil.md
rename to docs/source/api/models/soil.md
index de7e67fe7..a8730c8ae 100644
--- a/docs/source/api/soil.md
+++ b/docs/source/api/models/soil.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API reference for `soil` modules
diff --git a/docs/source/api/soil/carbon.md b/docs/source/api/models/soil/carbon.md
similarity index 88%
rename from docs/source/api/soil/carbon.md
rename to docs/source/api/models/soil/carbon.md
index c8ebd51e0..59edd1781 100644
--- a/docs/source/api/soil/carbon.md
+++ b/docs/source/api/models/soil/carbon.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.models.soil.carbon` module
diff --git a/docs/source/api/soil/constants.md b/docs/source/api/models/soil/constants.md
similarity index 89%
rename from docs/source/api/soil/constants.md
rename to docs/source/api/models/soil/constants.md
index 0018503a4..681a25db7 100644
--- a/docs/source/api/soil/constants.md
+++ b/docs/source/api/models/soil/constants.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.models.soil.constants` module
diff --git a/docs/source/api/soil/env_factors.md b/docs/source/api/models/soil/env_factors.md
similarity index 89%
rename from docs/source/api/soil/env_factors.md
rename to docs/source/api/models/soil/env_factors.md
index 6a9192d20..5f21ad6de 100644
--- a/docs/source/api/soil/env_factors.md
+++ b/docs/source/api/models/soil/env_factors.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.models.soil.env_factors` module
diff --git a/docs/source/api/soil/soil_model.md b/docs/source/api/models/soil/soil_model.md
similarity index 89%
rename from docs/source/api/soil/soil_model.md
rename to docs/source/api/models/soil/soil_model.md
index 34d3ccb8e..f35c9571a 100644
--- a/docs/source/api/soil/soil_model.md
+++ b/docs/source/api/models/soil/soil_model.md
@@ -9,9 +9,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# API documentation for the {mod}`~virtual_ecosystem.models.soil.soil_model` module
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 20240c6eb..a357613f9 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -11,35 +11,43 @@
documentation root, use os.path.abspath to make it absolute, like shown here.
"""
-import os
import sys
+import warnings
from dataclasses import dataclass, field
+from pathlib import Path
# Import Matplotlib to avoid this message in notebooks:
# "Matplotlib is building the font cache; this may take a moment."
import matplotlib.pyplot # noqa: F401
import sphinxcontrib.bibtex.plugin
+from sphinx.deprecation import RemovedInSphinx80Warning
from sphinxcontrib.bibtex.style.referencing import BracketStyle
from sphinxcontrib.bibtex.style.referencing.author_year import AuthorYearReferenceStyle
import virtual_ecosystem as ve
+from virtual_ecosystem.core import variables
+
+# Silence sphinx 8 warnings.
+warnings.filterwarnings("ignore", category=RemovedInSphinx80Warning)
+
# This path is required for automodule to be able to find and render the docstring
# example in the development section of the documentation. The path to the modules for
# the virtual_ecosystem package itself do not needed to be included here, providing
# sphinx is run within the poetry shell. RTD runs sphinx-build in the same directory
-# as this conf.py file, where we currently run it from the parent `docs` folder.
-
-on_rtd = os.environ.get("READTHEDOCS") == "True"
-if on_rtd:
- sys.path.append("development/documentation")
-else:
- sys.path.append("source/development/documentation")
+# as this conf.py file, where we currently run it from the parent `docs` folder, so
+# adding an absolute path is more reliable.
+sys.path.append(str(Path(__file__).parent / "development/documentation"))
version = ve.__version__
release = version
+# Update the variables file
+varfile = Path(__file__).parent / "variables.rst"
+variables.output_known_variables(varfile)
+
+
# -- Project information -----------------------------------------------------
project = "Virtual Ecosystem"
@@ -65,16 +73,25 @@
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.autosummary",
- # "sphinx.ext.autosectionlabel", # Generates hard to trace exception
+ "sphinx.ext.viewcode",
"sphinxcontrib.bibtex",
"sphinxcontrib.mermaid",
"myst_nb",
"sphinx_rtd_theme",
+ "sphinx_external_toc",
+ "sphinx_design",
]
autodoc_default_flags = ["members"]
autosummary_generate = True
+# Set up the external table of contents file path and configure
+external_toc_path = "_toc.yaml"
+external_toc_exclude_missing = False
+
+
+# Set up a bracketed citation style, register it with sphinxcontrib.bibtex, and then set
+# that style as the default.
def bracket_style() -> BracketStyle:
"""Function that defines round brackets citation style."""
return BracketStyle(
@@ -98,22 +115,31 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
"sphinxcontrib.bibtex.style.referencing", "author_year_round", MyReferenceStyle
)
-# Configure referencing style
bibtex_reference_style = "author_year_round"
-# Reference checking
+# Turn on nitpicky reference checking to ensure that all internal links and intersphinx
+# links are resolvable. Then ignore a whole bunch of annoying broken links.
nitpicky = True
nitpick_ignore = [
("py:class", "numpy.int64"),
("py:class", "numpy.float32"),
# HACK - core_components docstrings are being odd.
- ("py:class", "np.timedelta64"),
+ ("py:class", "NDArray"),
+ ("py:class", "np.int_"),
+ ("py:class", "np.str_"),
+ ("py:class", "np.bool_"),
+ ("py:class", "numpy.bool_"),
+ ("py:class", "np.float32"),
("py:class", "np.datetime64"),
+ ("py:class", "np.timedelta64"),
("py:class", "InitVar"),
+ ("py:class", "dataclasses.InitVar"),
("py:class", "Quantity"),
("py:class", "numpy._typing._array_like._ScalarType_co"),
- # TODO - Delete this once Vivienne has merged this feature into develop
- ("py:class", "virtual_ecosystem.models.abiotic.energy_balance.EnergyBalance"),
+ # God only knows why this is needed. We don't refer to pint.util.Quantity and it
+ # isn't in the pint objects.inv, so why the hell is intersphinx trying to build
+ # references to it.
+ ("py:class", "pint.util.Quantity"),
# Something off about JSONSchema intersphinx mapping?
("py:obj", "virtual_ecosystem.core.schema.ValidatorWithDefaults.ID_OF"),
# HACK - sphinx seems to thing GRID_STRUCTURE_SIG is a tuple not a type alias
@@ -127,19 +153,18 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
"xarray": ("https://docs.xarray.dev/en/stable/", None),
"shapely": ("https://shapely.readthedocs.io/en/stable/", None),
"jsonschema": ("https://python-jsonschema.readthedocs.io/en/stable/", None),
- # TODO - This is pinned to a particular pint version as the package is making
- # changes to how it handles typing, at some point it should be unpinned, i.e. set to
- # stable
- "pint": ("https://pint.readthedocs.io/en/0.21/", None),
+ "pint": ("https://pint.readthedocs.io/en/stable/", None),
}
+# Turn on figure numbering - this slows down build time a surprising amount!
+numfig = True
# Set auto labelling to section level
autosectionlabel_prefix_document = True
autosectionlabel_maxdepth = 2
# Myst configuration
-myst_enable_extensions = ["dollarmath", "deflist"]
+myst_enable_extensions = ["dollarmath", "deflist", "colon_fence"]
myst_heading_anchors = 3
# Enable mhchem for chemical formulae
@@ -168,7 +193,7 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
"development/training/.pytest_cache/*",
]
-master_doc = "index"
+# master_doc = "index"
# -- Options for HTML output -------------------------------------------------
@@ -186,9 +211,9 @@ class MyReferenceStyle(AuthorYearReferenceStyle):
# Toc options
"collapse_navigation": False,
"sticky_navigation": True,
- "navigation_depth": 0,
- "includehidden": False,
- "titles_only": True,
+ "navigation_depth": 4,
+ "includehidden": True,
+ "titles_only": False,
}
# Add any paths that contain custom static files (such as style sheets) here,
diff --git a/docs/source/data_recipes/CDS_toolbox_template.md b/docs/source/data_recipes/CDS_toolbox_template.md
deleted file mode 100644
index 871646c43..000000000
--- a/docs/source/data_recipes/CDS_toolbox_template.md
+++ /dev/null
@@ -1,185 +0,0 @@
----
-jupytext:
- cell_metadata_filter: -all
- formats: md:myst
- main_language: python
- text_representation:
- extension: .md
- format_name: myst
- format_version: 0.13
- jupytext_version: 1.13.8
-kernelspec:
- display_name: vr_python3
- language: python
- name: vr_python3
----
-
-# Climate data download from the COPERNICUS Climate data store and CDS toolbox
-
-The atmospheric variables from regional climate models or observations are typically
-provided in spatial and temporal resolutions that are different from the requirements
-of the Virtual Ecosystem. This document describes how to download climate data from
-the Copernicus [Climate Data Store](https://cds.climate.copernicus.eu/) (CDS) and basic
-pre-processing options using the
-[CDS toolbox](https://cds.climate.copernicus.eu/cdsapp#!/toolbox).
-You need to create a user account to access all data and functionalities.
-
-```{note}
-At present, the pre-processing does not include scaling or topographic adjustment.
-```
-
-## Climate input variables
-
-The abiotic module of the Virtual Ecosystem requires the following climate input
-variables (or derivatives) at each time step (default: monthly means):
-
-* Air temperature (typically 2m; mean, minimum, and maximum)
-* Air humidity (typically 2m; relative or specific humidity)
-* Air pressure (typically mean sea level or surface pressure)
-* Wind speed (typically 10m)
-* Precipitation
-
-and optionally:
-
-* atmospheric $\ce{CO_{2}}$ concentration
-* soil temperature
-* soil moisture
-
-## Recommended data sets
-
-We recommend the following data sets to force the Virtual Ecosystem microclimate
-simulations:
-
-* ERA5 / ERA5-Land
-
- ERA5 is the fifth generation ECMWF reanalysis for the global climate and weather for
- the past 4 to 7 decades. This reanalysis dataset combines model data with
- observations from across the world into a globally complete and consistent dataset
- using the laws of physics. The data is available in hourly and monthly averaged time
- steps at a spatial resolution is in 0.25 x 0.25 deg resolution. The data set starts
- in 1950 and is updated regularely.
-
- The full documentation and download link can be accessed
- [here for hourly data](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-single-levels?tab=overview)
- and [here for monthly data](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-single-levels-monthly-means?tab=overview)
-
- ERA5-Land is a reanalysis dataset providing a consistent view of the evolution of land
- variables over several decades at an enhanced resolution compared to ERA5 (0.1 x 0.1
- deg).
-
- The full documentation and download link can be accessed
- [here for hourly data](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-land?tab=overview)
- and [here for monthly data](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-land-monthly-means?tab=overview)
-
- Example code to manipulate downloaded ERA5-Land data as used in the `ve_run` example
- is available [here](../../../virtual_ecosystem/example_data/generation_scripts/climate_example_data.py).
-
-* WFDE5
-
- This global dataset provides bias-corrected reconstruction of near-surface
- meteorological variables derived from the fifth generation of the European Centre for
- Medium-Range Weather Forecasts (ECMWF) atmospheric reanalyses (ERA5). The output is
- available in hourly and daily time steps for the period 1979-2019 in 0.5 x 0.5 deg
- resolution.
-
- The full documentation and download link can be accessed
- [here](https://cds.climate.copernicus.eu/cdsapp#!/dataset/derived-near-surface-meteorological-variables?tab=overview)
- .
-
-* CORDEX-SEA
-
- This data set was created with regional climate models (RCM) as part of the
- Coordinated Regional Climate Downscaling Experiment (CORDEX). The spatial
- resolution is 0.22 x 0.22 deg, the spatial extent is 15°S to 27°N and 89 to 146°E,
- the temporal resolution depends on the selected period:
- * historical data (1950-2005) is available in hourly time step
- * scenario data (2006-2100; RCP 2.6, 4.5 and 8.5) is available in daily time step
-
- The full documentation and download link can be accessed [here](https://cds.climate.copernicus.eu/cdsapp#!/dataset/projections-cordex-domains-single-levels?tab=overview).
-
-* Atmospheric $\ce{CO_{2}}$
-
- Observed global $\ce{CO_{2}}$ levels (Mauna Loa, NOAA/GML) are available in monthly or
- annual resolution (1958 - present) [here](https://gml.noaa.gov/ccgg/trends/graph.html)
- . Monthly data derived from satellite observation (2002 - present) is available
- [here](https://cds.climate.copernicus.eu/cdsapp#!/dataset/satellite-carbon-dioxide?tab=overview)
- . Alternatively, reconstructed gridded monthly $\ce{CO_{2}}$ data for the historical
- period (1953 - 2013) and future CMIP6 scenarios (2015 - 2150) can be downloaded
- [here](https://zenodo.org/record/5021361) {cite:p}`cheng_wei_global_2021`.
-
-## Step-by-step example
-
-Follow one of the links above to access overview information about the data set. You
-find a detailed documentation of the data set in the 'Documentation' section. To select
-data, navigate to the tab 'Download Data'.
-
-### Selection
-
-This is an example of a selection of tabs to download historical '2m air temperature'
-from the CORDEX-SEA (you can download multiple variables and years in one request):
-
-* Domain (South-East Asia),
-* Experiment (here: 'historical', RCPs available)
-* Horizontal resolution ('0.22 degree x 0.22 degree')
-* Temporal resolution ('daily mean')
-* Variables (here: '2m_air_temperature')
-* Global climate model (here: 'mohc_hadgem2_es')
-* Regional climate model (here: 'gerics_remo2015')
-* Ensemble member (r1i1p1)
-* Start year and End year (here: 2001-2005)
-
-Once you selected the data, you can either download the dataset for further processing
-or click on 'show Toolbox request' at the bottom of the page, copy the code, and open
-the CDS toolbox editor.
-
-The code to manipulate climate data as used in the `ve_run` example is available
-[here](../../../virtual_ecosystem/example_data/generation_scripts/climate_example_data.py).
-
-### Toolbox template CORDEX-SEA
-
-The template below describes how to request a data set, reproject the data on a regular
-grid (note that the projection name is not changed!), select the area of interest,
-calculate the monthly means, and download the product. For illustration, the routine
-also plots the mean value. Adjust the 'data' lines to match your data request. You find
-the full documentation of the CDS toolbox [here](https://cds.climate.copernicus.eu/toolbox/doc/index.html).
-
-```{code-block} ipython
-# EXAMPLE CODE to preprocess CORDEX-SEA with CDS toolbox
-
-import cdstoolbox as ct
-
-@ct.application(title='Download data')
-@ct.output.download()
-@ct.output.figure()
-def download_application():
- data =ct.catalogue.retrieve(
- 'projections-cordex-domains-single-levels',
- {
- 'domain': 'south_east_asia',
- 'experiment': 'historical',
- 'horizontal_resolution': '0_22_degree_x_0_22_degree',
- 'temporal_resolution': 'daily_mean',
- 'variable': '2m_air_temperature',
- 'gcm_model': 'mohc_hadgem2_es',
- 'rcm_model': 'gerics_remo2015',
- 'ensemble_member': 'r1i1p1',
- 'start_year': '2001',
- 'end_year': '2005',
- }
- )
-
- regular = ct.geo.make_regular(data, xref='rlon', yref='rlat')
- sel_extent = ct.cube.select(regular, extent=[116., 118, 4., 6.])
- monthly_mean = ct.climate.monthly_mean(sel_extent)
-
- average = ct.cube.average(monthly_mean, dim='time')
- fig = ct.cdsplot.geomap(average)
-
- return monthly_mean, fig
-```
-
-The data handling for simulations is managed by the {mod}`~virtual_ecosystem.core.data`
-module and the {class}`~virtual_ecosystem.core.data.Data` class, which provides the
-data loading and storage functions for the Virtual Ecosystem. The data system is
-extendable to provide support for different file formats and axis validation but that is
-beyond the scope of this document.
diff --git a/docs/source/data_recipes/climate_data_recipes.md b/docs/source/data_recipes/climate_data_recipes.md
deleted file mode 100644
index 800275f43..000000000
--- a/docs/source/data_recipes/climate_data_recipes.md
+++ /dev/null
@@ -1,98 +0,0 @@
-# Climate data recipes
-
-This section provides examples for climate data downloading and simple pre-processing.
-
-The [Copernicus climate data store](./CDS_toolbox_template.md) section contains a list
-of recommended data sets to run the Virtual Ecosystem and describes how to download
-climate data from the Copernicus
-[Climate Data Store](https://cds.climate.copernicus.eu/) (CDS)
-and basic pre-processing options using the
-[CDS toolbox](https://cds.climate.copernicus.eu/cdsapp#!/toolbox).
-
-```{note}
-At present, the pre-processing does not include scaling or topographic adjustment.
-```
-
-Metadata:
-
-* Muñoz-Sabater,J. et al: ERA5-Land: A state-of-the-art global reanalysis dataset for
- land applications, Earth Syst. Sci. Data,13, 4349-4383, 2021.
- [https://doi.org/10.5194/essd-13-4349-2021](https://doi.org/10.5194/essd-13-4349-2021)
-* Product type: Monthly averaged reanalysis
-* Variable: 2m dewpoint temperature, 2m temperature, Surface pressure, Total
- precipitation
-* Year: 2013, 2014
-* Month: January, February, March, April, May, June, July, August, September, October,
- November, December
-* Time: 00:00
-* Sub-region extraction: North 6°, West 116°, South 4°, East 118°
-* Format: NetCDF3
-
-We have used a simple recipe from this data source to create the climate data used in
-the [example data](../virtual_ecosystem/example_data.md). The code in that recipe is
-shown below:
-
-````{admonition} climate_example_data.py
-:class: dropdown
-```{literalinclude} ../../../virtual_ecosystem/example_data/generation_scripts/climate_example_data.py
-```
-````
-
-In more detail, that script carries out the main steps perfomed to create the following
-input variables for the Virtual Ecosystem:
-
-* air temperature, [C]
-* relative humidity, [-]
-* atmospheric pressure, [kPa]
-* precipitation, [mm month^-1]
-* atmospheric $\ce{CO_{2}}$ concentration, [ppm]
-* mean annual temperature, [C]
-
-## Adjustment of units
-
-The standard output unit of ERA5-Land temperatures is Kelvin which needs to be converted
-to degree Celsius for the Virtual Ecosystem. This includes 2m air temperature and
-2m dewpoint temperature which are used to calculate relative humidity later.
-The standard output unit for total precipitation in ERA5-Land is meters which we need
-to convert to millimeters. Further, the data represents mean daily accumulated
-precipitation for the 9x9km grid box, so the value has to be scaled to monthly (here
-30 days).
-The standard output unit for surface pressure in ERA5-Land is Pascal (Pa) which we
-need to convert to Kilopascal (kPa).
-
-## Addition of missing variables
-
-In addition to the variables from the ERA5-Land data, a time series of atmospheric
-$\ce{CO_{2}}$ is needed. We add this here as a constant field across all grid cells and
-vertical layers. Mean annual temperature is calculated from the full time series of air
-temperatures; in the future, this should be done for each year.
-
-Relative humidity (RH) is also not a standard output from ERA5-Land but can be
-calculated from 2m dewpoint temperature (DPT) and 2m air temperature (T) as follows:
-
-$$ RH = \frac{100\exp(17.625 \cdot DPT)/(243.04+DPT)}
- {\exp(17.625 \cdot T)/(243.04+T)}
-$$
-
-## Matching Virtual Ecosystem grid and naming conventions
-
-Once all input units are adjusted, the variables are re-named according to the Virtual
-Ecosystem naming convention. The coordinate names have to be changed from
-`longitude/latitude` to `x/y` and the units from `minutes` to `meters`. The ERA5-Land
-coordinates are treated as the centre points of the grid cells which means that when
-setting up the grid, an offset of 4.5 km has to be added.
-
-```{note}
-The example data is run using a 90 x 90 m grid. This means that some form of
-spatial downscaling has to be applied to the dataset, for example by spatially
-interpolating coarser resolution climate data and including the effects of local
-topography. This is not yet implemented!
-```
-
-For the purpose of a example data simulation in the development stage, the script
-curently selects a 9 by 9 sample of the grid and overwrites the coordinates to align to
-the example grid resolution. Note that the resulting dataset does no longer match a
-digital elevation model for the area!
-
-At the moment, the dummy model iterates over time indices rather than real datetime.
-Therefore, we add a `time_index` dimension and coordinate to the dataset.
diff --git a/docs/source/development/code_development_strategy.md b/docs/source/development/code_development_strategy.md
deleted file mode 100644
index a4217af10..000000000
--- a/docs/source/development/code_development_strategy.md
+++ /dev/null
@@ -1,269 +0,0 @@
-# Development strategy and tool stack
-
-> Author: Currently, David Orme but intended to be collaborative.
-
-This document describes the key development tools and principles for the project. It
-includes suggestions made by the Research Software Engineering team in their proposal
-for some key tools.
-
-This document will likely move into our project documentation at some point!
-
-## Python environment
-
-Python is notorious for having many versions of key components and it is common to end
-up with multiple versions installed on single computers.
-
-
-
-Unless we manage this up front, we _will_ end up with problems from inconsistent
-versions. So:
-
-- We _will_ be using Python 3 and probably a minimum version of that. At the moment, I'm
- thinking 3.7+ for `dataclasses`, but maybe even 3.9+ for some advances in static
- typing.
-
-- We will use [`pyenv`](https://github.com/pyenv/pyenv) to maintain python environments.
- This allows us to keep multiple versions of Python in parallel and switch between them
- cleanly: we will want to be able to run code on different Python versions.
-
-- RSE have suggested we use [`poetry`](https://python-poetry.org/) as our tool for
- package installation and management. I have not used this but it would replace `pip`
- or `conda` and looks to provide a really streamlined way to manage dependencies and
- package publication.
-
-## Interactive development environment (IDE)
-
-This is not so critical, but it might make sense to use the same IDE programs (and
-plugins) for code development. I've used [PyCharm](https://www.jetbrains.com/pycharm/) a
-fair bit but more recently have been using
-[Visual Studio Code](https://code.visualstudio.com/). Both are free - PyCharm via an
-academic licensing program - PyCharm has greater complexity but I have sometimes found
-it a bit slow and finicky to use.
-
-## Code versioning platform and strategy
-
-We will be using [GitHub](https://github.org) as our repository for package code and
-documentation. We will be using the
-[Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) strategy for
-managing code development cycles.
-
-The idea behind GitFlow is to separate out code development and release into a clear
-branching structure, so that different branches are used for different purposes rather
-than everything happening on a single `trunk` branch.
-
-I've used this on several projects, mostly for the idea of release cycles, and I like it
-a lot. I have basically used three branches from the GitFlow concept:
-
-- `develop`: This is the branch on which code development occurs.
-- `release/x.y.z`: These are temporary branches that are used to take a particular
- commit from `develop` and make it available as a new release. The temporary branch is
- used to separate out all the usual building and checking and to allow review.
-- `master`: You do not work on the `master` branch. When a `release` version is good to
- go, then that branch and any commits on it are pushed onto `master`, essentially
- creating one big bundle of commits that move `master` from the code in version `x.y.z`
- to `x.y.z+1`. The commits in `release` are also copied back into `develop` so that it
- also contains the same code.
-
-However, GitFlow also uses `feature` branches - which are intended to separate the
-introduction of sizeable new features from `develop` until they are in a fairly complete
-state. I have not used this much and there has been some criticism of the level of
-branching and merging that can result.
-
-Using GitFlow is made easier by [`git` extensions](https://github.com/nvie/gitflow) that
-condense the commands for particular steps.
-
-## Continuous integration
-
-We will be using continuous integration (CI) to develop the code. This is a process
-where changes to the code in the repository trigger automatic processes to build and
-check the code. It is essentially an early warning system: if we make commits that break
-some of our working practices then the CI platform emails people to say it is broken.
-
-The CI process can be used for all sorts of checking (see below for more on these
-topics):
-
-- Unit testing: does our code still return the same expected values and behaviour?
-- Code quality: does it pass linting and have decent code coverage?
-- Documentation building: does the documentation all compile correctly?
-
-I have previously used [Travis CI](https://travis-ci.com) for this but they have just
-moved away from free support for open source projects. RSE have suggested Github
-Actions, and having just moved one project to that, it seems like a straightforward
-replacement.
-
-## Unit testing
-
-We will be using the `pytest` framework for unit testing. I have used this quite a bit
-and it is also the RSE recommendation.
-
-A **unit test** is a function that does something using the code and then contains a set
-of assertions about what the result of running the code should be. There are a wide
-range of assertions, such as that:
-
-- `adding_function(5, 2)` does indeed return `7`,
-- `adding_function(5, 'a')` throws a `ValueError`,
-- `do_this_thing(verbose=True)` emits the correct logging message
- (`INFO: I did a thing`).
-
-The `pytest` framework is very extendable:
-
-- _Fixtures_ are things that can be shared between tests: one might contain the code for
- loading a configuration file and returning the `config` object, rather than
- duplicating that code in each test needing a configuration.
-- Tests can be _paramaterised_: a test function can be wrapped in a decorator that
- provides multiple inputs and outputs, allowing the same test to check multiple use
- cases without duplicating code.
-- _Fake file systems_ can be created: ensuring that particular file resources appear in
- predictable places, so that tests do not fail because of local file paths.
-
-We will also likely make use of the `doctest` framework. This framework looks for
-instances of runnable code in examples in code documentation and checks that the values
-created by that code and reported in the documentation agree. The `pytest` framework
-does the main job of checking code, but `doctest` additionally makes sure examples in
-documentation are correct.
-
-I would also add to this using a _code coverage_ checker. I have not used one of these
-before but the idea is that, when unit testing is run, this tool records which parts of
-the code are used in the testing and identifies lines of code that are not run in any
-testing.
-
-## Code and documentation styling
-
-We need to adopt common practices for writing code and documentation. There are lots of
-aspects to this:
-
-- **Coding style**: I suggest we adopt the
- [Google coding style for Python](https://google.github.io/styleguide/pyguide.html).
- This is pretty wide ranging and include code layout, best practice for some use cases
- and how documentation within the code (`docstrings`) should be structured.
-
-- **Autoformatting**: RSE have suggested we use
- [`black`](https://black.readthedocs.io/en/stable/) as an automatic code formatter.
- I've never used a tool like this but the idea is to automatically enforce a particular
- style - the code file is transformed by `black` to meet the coding style. This makes
- it easier to avoid code style problems before code is committed to the repository.
-
-- **Linting**: A _linter_ is an tool that automatically checks whether a codefile
- conforms to a particular code style. I have previously used `pylint` but RSE have
- suggested we use [`flake8`](https://flake8.pycqa.org/en/latest/#), which helpfully
- supports the Google code style. This tool can be run locally, but it is also likely to
- be part of the CI suite of actions, to highlight when we have problems with bad style.
-
-- **Type checking**: RSE have suggested we use
- [mypy](https://mypy.readthedocs.io/en/stable/index.html) for static type checking,
- which I have not used before.
-
- The issue here is that Python code is often dynamically typed: the code does not
- specify the `type` of inputs or outputs of code. Since Python 3.0 - and with
- increasing detail in more recent versions - it is now possible to add explicit
- annotation to Python code that indicates the accepted types of inputs and the type of
- outputs. A tool like `mypy` automatically checks that an input of a given type is used
- in ways that make sense:
-
- ```python
- def my_func(x: int) -> int:
- val = 'value: ' + x
- return val
- ```
-
- This will fail - it attempts string concatenation on something that is expected to be
- an integer and then returns a string while claiming to return an integer.
-
-## Documentation
-
-There will be documentation. Lots of documentation. There are three components here that
-we need to address:
-
-- the approach we use to actually writing and structuring documentation content,
-- the framework used to deploy documentation from source files,
-- where we actually host documentation so that people can find and read it.
-
-### Content guidance
-
-RSE have pointed us towards the [Diátaxis framework](https://diataxis.fr/) which
-provides a useful breakdown of four distinct documentation modes (tutorial, how-to,
-explanation and reference) and how to approach these with users in mind. This is
-primarily about how to write the content.
-
-### The documentation framework
-
-The idea here is to write content in a quick and easy markup language and then let a
-documentation framework handle converting it all to HTML. We want to handle
-docuementation two broad file types:
-
-- **Reference documentation**: we will be using **docstrings** to provide the reference
- documentation for the code objects and structure. These are marked up descriptions of
- what code does that are included right in the code source. Doing this keeps the
- explanation of the code close to the code itself, making it easier for developers to
- understand how the code behaves.
-
- Documentation frameworks can extract the docstrings from the code and automatically
- create structured HTML files to provide a code reference.
-
- ```python
- def my_function(x: float) -> float:
- """
- This is a docstring that describes what `my_function` does.
-
- Args:
- x: A number to be doubled
-
- Returns:
- A value twice the value of `x`
- """
-
- return 2 * x
- ```
-
-- **Everything else**: this covers how tos, tutorials and explanation. These will be
- written in simple markup files, using a framework to convert the markup into HTML.
- However, for many of these files we will want _dynamic content_: this is typically
- going to be code that is run within the content show how to use the code or generate
- figures etc.
-
-There are a lot of frameworks around and things are moving fast in this area. The
-classic option for a Python project is [Sphinx](https://www.sphinx-doc.org/) but
-[mkdocs](https://www.mkdocs.org/) is also becomign popular. There is also the whole
-development of [Jupyterbook](https://jupyterbook.org/intro.html).
-
-RSE have recommended Sphinx: it is incredibly mature and feature rich, but that depth
-can get a bit confusing. `mkdocs` is a bit lighter and faster and has a very nice live
-preview system, but has a less mature automatic reference documentation system.
-
-Some notes:
-
-- Both of these will support dynamic content generation by running `jupyter` notebooks
- before conversion to HTML.
-
-- We have a choice of markup languages.
- [`RST`](https://en.wikipedia.org/wiki/ReStructuredText) is the traditional choice for
- Sphinx but `mkdocs` use Markdown. I find Markdown cleaner and the recent Markdown
- extension [`MyST`](https://myst-parser.readthedocs.io/en/latest/) gives it a similar
- functionality to RST.
-
- One minor issue here at the moment is that although Sphinx supports MyST for
- standalone files it cannot currently be used in docstrings, leading to a mixed use of
- RST and MyST. That is an area under active development though.
-
-I don't think the exact details are nailed down yet but I think we should start with
-Sphinx and MyST and be ready to adopt MyST in docstrings.
-
-### The documentation host site
-
-There are no end of places to host static HTML. You can create a website by just putting
-the content in an Amazon S3 bucket. GitHub has GitHub Pages, which runs a website from
-the content of a named branch in the same repo as the code.
-
-RSE have recommended [ReadTheDocs](https://readthedocs.org/). I've used this a lot and
-it is very good: it maintains versions of the documentation and builds the documentation
-from scratch whenever code is updated. It is supported by adverts, but they aren't very
-intrusive.
-
-I do have to say that I find it slightly fussy to have to watch and trouble shoot the
-remote documentation building as part of the release cycle. It is in some ways easier to
-build the docs locally and simply update the host with changes. However, that is very
-much in single code projects, and having a remote building process is a bit like having
-Continuous Integration for the documentation.
-
-Having said that: switching host is not a big deal, at least in the early stages of the
-project!
diff --git a/docs/source/development/contributing.md b/docs/source/development/contributing.md
new file mode 100644
index 000000000..402de26cf
--- /dev/null
+++ b/docs/source/development/contributing.md
@@ -0,0 +1 @@
+# Contributing to the Virtual Ecosystem
diff --git a/docs/source/development/contributing/code_qa_and_typing.md b/docs/source/development/contributing/code_qa_and_typing.md
new file mode 100644
index 000000000..c823cc9fd
--- /dev/null
+++ b/docs/source/development/contributing/code_qa_and_typing.md
@@ -0,0 +1,138 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+---
+
+# Code quality and static typing
+
+We use:
+
+* `pre-commit` to ensure common code standards and style, and
+* `mypy` to provide static typing of the `virtual_ecosystem` codebase.
+
+## Using `pre-commit`
+
+As described in the [developer overview](./overview.md), `pre-commit` is installed as by
+`poetry` as part of the `virtual_ecosystem` developer dependencies. At this point, it
+just need to be set up to run using:
+
+```sh
+poetry run pre-commit install
+poetry run pre-commit run --all-files
+```
+
+This can take a while on the first run, and when the configuration updates, as the tool
+needs to install or update all the hooks that are applied to changes within a commit.
+Usually the hooks only run on files changed by a particular `git commit` but using
+`pre-commit run --all-files` scans the entire codebase and is a commonly used check to
+make sure all is well.
+
+### The `pre-commit` configuration
+
+The project root includes a configuration file for `pre-commit` that sets the hooks that
+will be run on each commit. The contents of the file can be revealed below along with a
+short description of the roles of each hook.
+
+::::{dropdown} The `pre-commit-config.yaml` file
+:::{literalinclude} ../../../../.pre-commit-config.yaml
+:language: yaml
+:::
+::::
+
+`pre-commit-hooks`
+: We use these basic hooks to check for remaning `git` merge conflict markers in code
+files (`check-merge-conflicts` hook) and for debugger imports and `breakpoint()` calls
+(`dubug-statements` hook), which should not end up in code in the repository.
+
+`ruff-pre-commit`
+: This tool wraps the [`ruff`](https://docs.astral.sh/ruff/) code linter and formatter
+and we use both the linting (`ruff`) and formatting (`ruff-format`) hooks.
+
+`mypy`
+: We use a hook here to run the `mypy` static typing checks on newly committed code. See
+[below](#typing-with-mypy) for more information.
+
+`markdownlint`
+: Checks all markdown files for common formatting issues.
+
+### Output and configuration
+
+When `pre-commit` runs, you may see some lines about package installation and update,
+but the key information is the output below, which shows the status of the checks set up
+by each hook:
+
+```text
+check for merge conflicts............................................Passed
+debug statements (python)............................................Passed
+ruff.................................................................Passed
+ruff-format..........................................................Passed
+mypy.................................................................Passed
+markdownlint.........................................................Passed
+```
+
+### Updating `pre-commit`
+
+The hooks used by `pre-commit` are constantly being updated to provide new features or
+to update code to deal with changes in the implementation. You can update the hooks
+manually using `pre-commit autoupdate`, but the configuration is regularly updated
+through the [pre-commit.ci](https://pre-commit.ci/) service.
+
+## Typing with `mypy`
+
+Unlike many programming languages, Python does not require variables to be declared as
+being of a particular type. For example, in C++, this code creates a variable that is
+_explicitly_ an integer and a function that _explicitly_ requires an integer and returns
+an integer value. This is called **typing**.
+
+```c++
+int my_integer = 15;
+
+int fun(int num) {
+
+ printf("num = %d \n", num);
+
+ return 0;
+}
+```
+
+Python does not require explicit typing. That can be very useful but it can also make it
+very difficult to be clear what kinds of variables are being used. The
+`virtual_ecosystem` project
+requires static typing of the source code: the syntax for this started with [PEP
+484](https://peps.python.org/pep-0484/) and a set of quality assurance tools have
+developed to help support clear and consistent typing. We use
+[`mypy`](https://mypy.readthedocs.io/en/stable/) to check static typing. It does take a
+bit of getting used to but is a key tool in maintaining clear code and variable
+structures.
+
+## Supressing checking
+
+The `pre-commit` tools sometimes complain about things that we do not want to change.
+Almost all of the tools can be told to suppress checking, using comments with a set
+format to tell the tool what to do.
+
+This should not be done lightly: we are using these QA tools for a reason.
+
+* Code linting issued identified by `ruff` can be ignored by either using `# noqa: E501`
+ to ignore the issue for that line.
+* Code formatting changes suggested by `ruff-format` can be supressed by using the
+ `# fmt: off` tag at the end of a specific line or wrapping a section in `# fmt: off`
+ and then `# fmt: on`.
+* `mypy` uses the syntax `# type: ignore` comment to [suppress
+ warnings](https://mypy.readthedocs.io/en/stable/error_codes.html#silencing-errors-based-on-error-codes).
+ Again, `virtual_ecosystem` requires that you provide the specific `mypy` error code to
+ be ignored to avoid missing other issues: `# type: ignore[operator]`.
+* `markdownlint` catches issues in Markdown files and uses a range of [HTML comment
+ tags](https://github.com/DavidAnson/markdownlint?tab=readme-ov-file#configuration) to
+ suppress format warnings. An example is `` and
+ a list of the rule codes can be found
+ [here](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md).
diff --git a/docs/source/development/contributing/code_testing.md b/docs/source/development/contributing/code_testing.md
new file mode 100644
index 000000000..37492646f
--- /dev/null
+++ b/docs/source/development/contributing/code_testing.md
@@ -0,0 +1,80 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+---
+
+# Package testing
+
+The `virtual_ecosystem` package uses `pytest` to provide benchmark tests, unit tests and
+integration testing. In addition, `doctest` is used to maintain examples of code usage
+in the package docstrings and ensure that the documented return values are correct.
+
+## Using `pytest`
+
+The `tests` directory contains modules providing test suites for each of the different
+package modules. This includes at the moment:
+
+* unit testing of individual functions and methods
+* integration testing using combinations of modules.
+
+These are the main tests that ensure that the package is behaving as expected and that
+it produces stable outputs.
+
+Further future tests may include:
+
+* regression testing the output of the `virtual_ecosystem` code against previously
+existing implementations of some functionality, such as the `SPLASH` or `microclimc`
+packages
+* profiling
+
+The test suite can be run from repository using:
+
+```bash
+poetry run pytest
+```
+
+The `pyproject.toml` file contains `pytest` configuration details.
+
+## Using `doctest`
+
+The project is set up to allow package docstrings to validate examples of code use in
+docstrings. Including code examples in docstrings provides a way to provide simple
+examples of method or function use and generate an output: the `doctest` module is used
+to make sure that the code runs and gives the expected result. This isn't widely used at
+present but there is an example in the documentation for the
+[`CoreConsts`dataclass](../../api/core.md).
+
+We have configured `pytest` to automatically also run `doctest`, but you can manually
+check the tests in files using, for example:
+
+```bash
+poetry run python -m doctest virtual_ecosystem/core/constants.py
+```
+
+Normally, `doctest` is just used to test a return value: the value tested is the value
+printed to the console, so it is common to use some form of `round` to make sure values
+match.
+
+## Using `pytest-coverage` and `codecov`
+
+Using the plugin [pytest-coverage](https://pypi.org/project/pytest-cov/) you can
+generate coverage reports. You can run:
+
+```bash
+poetry run pytest --cov=
+```
+
+to perform coverage analysis. The report is stored with the name `index.html`. It can be
+used to determine if your contribution is adequately tested. The GitHub Actions
+[continuous integration workflow](./github_actions.md#continuous-integration-workflow)
+automatically uploads coverage data to the
+[CodeCov](https://app.codecov.io/gh/ImperialCollegeLondon/virtual_ecosystem) website.
diff --git a/docs/source/development/contributing/github_actions.md b/docs/source/development/contributing/github_actions.md
new file mode 100644
index 000000000..bb4418151
--- /dev/null
+++ b/docs/source/development/contributing/github_actions.md
@@ -0,0 +1,83 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+---
+
+# GitHub Actions
+
+The project uses several workflows using GitHub Actions to maintain code quality and
+confirm that the package and website are building correctly. The actions are defined in
+the `.github/workflows` directory and currently include:
+
+## Continuous integration workflow
+
+The `ci.yml` workflow runs when a pull request is opened and when new commits are made
+to an existing pull request. It is the main quality assurance check on new code and runs
+three jobs:
+
+* code quality assurance (`qa`): does the code pass all the `pre-commit` checks.
+* code testing (`test`): do all unit and integration tests in the `pytest` suite pass.
+* documentation building (`docs_build`): does the documentation build correctly.
+
+If any of those checks fail, you will need to push new commits to the pull request to
+fix the outstanding issues. The status of code checking for pull requests can be seen at:
+
+[https://github.com/ImperialCollegeLondon/virtual_ecosystem/actions](https://github.com/ImperialCollegeLondon/virtual_ecosystem/actions)
+
+Although GitHub Actions automates these steps for any pushes, pull requests and releases
+on the repository, you should also perform the same steps locally before submitting code
+to ensure that your code passes testing. The `pre-commit` test is automatic but follow
+the instructions for [running `pytest`](./code_testing.md) and [building the
+documentation](../documentation/documentation.md).
+
+::::{dropdown} CI workflow details
+:::{literalinclude} ../../../../.github/workflows/ci.yml
+:language: yaml
+:::
+::::
+
+## Publication workflow
+
+The `publish.yaml` workflow runs when a release is made on the GitHub site and uses
+trusted publishing to build the package and publish it on
+[PyPI](https://pypi.org/project/virtual_ecosystem/).
+
+The full workflow setup can be seen below, along with comments, but the basic flow is:
+
+1. When a GitHub release is published, the PyPI publication workflow is triggered.
+1. The standard continuous integration tests are run again, just to be sure!
+1. If the tests pass, the package is built and the wheel and source code are stored as
+ job artefacts.
+1. The built files are automatically added to the release assets.
+1. The built files are then also published to the Test PyPI server, which is configured
+ to automatically trust publications from this GitHub repository.
+1. As long as all the steps above succeed, the built files are now published to the
+ main PyPI site, which is also configured to trust publications from the repository.
+
+The last step of publication to the main PyPI site can be skipped by including the
+text `test-pypi-only` in the title text for the release. This allows pre-release
+tests and experimentation to be tested without automatically adding them to the
+official released versions.
+
+::::{dropdown} Publication workflow details
+:::{literalinclude} ../../../../.github/workflows/publish.yml
+:language: yaml
+:::
+::::
+
+## Updates to `pre-commit`
+
+The Virtual Ecosystem repository is registered with the
+[pre-commit.ci](https://pre-commit.ci/) service. This [runs and
+reports](https://results.pre-commit.ci/repo/github/471392759) the status of the
+`pre-commit` suite - which duplicates the `ci.yml` workflow above - but also adds weekly
+update checks on the `pre-commit` hooks used for the project.
diff --git a/docs/source/development/contributing/overview.md b/docs/source/development/contributing/overview.md
new file mode 100644
index 000000000..fb3da4663
--- /dev/null
+++ b/docs/source/development/contributing/overview.md
@@ -0,0 +1,727 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+---
+
+# Developing `virtual_ecosystem`
+
+This page gives an overview of the process of contributing code to the `virtual_ecosystem`
+package, along with the development environment and tools you will need to setup to work
+with the codebase.
+
+## What is a package contributor?
+
+Being a contributor is all about helping improve the `virtual_ecosystem` package. That
+could be something very small, like fixing typos in the package website, or something
+large, like adding a draft of an entirely new science module to the package.
+
+We welcome _all_ contributions, but we need to manage contributions of code and
+documentation to make sure everything works properly together and to keep the code and
+documentation consistent. We do a lot of this by using some automated tools that help
+keep the package well organised and ensure that it keeps giving the same results through
+time.
+
+These tools take a bit of getting used to and the rest of this document sets out how to
+get your computer set up to run them. It is a good idea to start off with a small
+contribution in order to get used to the workflow - please do reach out to other
+developers for help in getting things to work if you run into problems. We will expect
+you to have read this document and the linked details pages, but we do not expect them
+to be a perfect or complete explanation!
+
+## Contributing code
+
+The workflow for contributing to `virtual_ecosystem` currently follows the Gitflow
+strategy. The basic workflow is described below but [this AWS
+link](https://docs.aws.amazon.com/prescriptive-guidance/latest/choosing-git-branch-approach/gitflow-branching-strategy.html)
+provides an overview of the strategy.
+
+1. Decide what you want to work on. This could be an existing bug or feature request or
+ could be something new. If it is new, then create a new issue on Github describing
+ what you want to change or add. The issue tracker provides templates for bugs and
+ feature requests: please do provide as much detail as possible on the bug or the
+ feature you would like to provide. If you want to work on an existing issue, then
+ just add a comment and say you would like to work on it.
+
+ [https://github.com/ImperialCollegeLondon/virtual_ecosystem/issues](https://github.com/ImperialCollegeLondon/virtual_ecosystem/issues)
+
+ Whatever issue you do want to work on, do give other developers a chance to comment
+ on suggestions before putting a lot of effort in!
+
+1. On Github issue pages, there is a development link to "create a branch" for the
+ issue. The branch name will then start with the issue number, which makes branches
+ much easier to track, and is explicitly linked to the issue. Feel free to shorten the
+ branch name - it uses the issue title by default.
+
+1. Check that branch out locally and make commits to it, pushing them to GitHub
+ regularly. Do try and make frequent small commits with clear, specific commit
+ messages: a commit does not mean that an issue is completed, just that you want to
+ record your progress. The commit history can always be compressed at the merge stage
+ (see below).
+
+1. Create a pull request (PR) from the issue branch onto the `develop` branch. The PR
+ description should tag the issue being addressed and explain how the incoming code
+ fixes the issue. You can start a PR as 'draft' PR: this can be a useful way to start
+ describing a PR content and checking that testing is passing before opening a PR up
+ for review.
+
+ We prefer pull requests to be small, with the aim of reviewing and merging frequently
+ the smallest functional unit of work that you can. This helps stop pull requests
+ getting stalled on more and more complex tasks and makes code review fast.
+
+1. Check that the continuous integration testing passes and fix any issues causing test
+ failures.
+
+1. Request reviews from other package developers using the Review section on the PR
+ page. A PR cannot be merged into `develop` until at least one approving review has
+ been added to the code. Reviews will often suggest changes to the code and you should
+ discuss those suggestions and implement them.
+
+ Hopefully, you will have talked to other developers during the process of writing the
+ PR and should have some ideas of who to ask for a review. If not, please request
+ [`davidorme`](https://github.com/davidorme) to review the PR and we can then work out
+ which of the core team is best placed to give feedback.
+
+1. Once a PR has been approved, the PR can be merged into `develop` and the branch can
+ be deleted.
+
+ The `Merge Pull Request` button provides alternative merge strategies. The default is
+ to create a "merge commit" - all of the commits on the PR are merged individually to
+ `develop` - but you can also "squash and commit" - which squashes all of the commits
+ into a single commit and message before merging. Squashing commits can be really
+ helpful to avoid a bunch of minor 'typo' commit messages, but can also make it harder
+ to find commits that made bigger changes on a branch. In general, we use "merge
+ commits", but if the commit history on a branch is mostly a sequence of minor edits,
+ feel free to squash.
+
+## The package development environment
+
+The short descriptions below provide the key commands needed to set up your development
+environment and provide links to more detailed descriptions of code development for
+`virtual_ecosystem`. The [example setup script](#setup-script-example) below gathers
+the commands together into a single script, currently only for Linux.
+
+### Python environment
+
+You will need to install Python to develop `virtual_ecosystem`. The package is currently
+tested against the following Python versions: 3.10, 3.11 and 3.12. You should install
+one of these versions before you start developing `virtual_ecosystem`.
+
+We highly recommend using [`pyenv`](https://github.com/pyenv/pyenv) or
+[`pyenv-win`](https://github.com/pyenv-win/pyenv-win) to manage your Python
+installations. These tools allow you to manage multiple different python versions in
+parallel and to switch between them. However, these extra steps are not necessary to get
+started.
+
+### Package management
+
+We use [`poetry`](https://python-poetry.org/docs/#installation) for dependency
+management and for managing development environments and you will need to install it.
+The `virtual_ecosystem` package currently uses `poetry` version 1.8.2 and you should
+specify this when installing to avoid conflicts with the package management process.
+
+For the typical installation process, this would be as simple as:
+
+```sh
+curl -SSL https://install.python-poetry.org | python3 - --version 1.8.2
+```
+
+### Installing `virtual_ecosystem`
+
+To develop `virtual_ecosystem`, you will also need to install [`git`](https://git-scm.com/)
+and then clone the `virtual_ecosystem` GitHub repository.
+
+```sh
+git clone https://github.com/ImperialCollegeLondon/virtual_ecosystem.git
+```
+
+You can now use `poetry` to install the package dependencies. This is not just the
+package requirements for end users of the package, but also a wider set of tools used in
+package development. `poetry` uses the
+[pyproject.toml](https://github.com/ImperialCollegeLondon/virtual_ecosystem/blob/develop/pyproject.toml)
+file to configure the dependencies that will be installed.
+
+```bash
+poetry install
+```
+
+That command will install all of the packages required to use the Virtual Ecosystem and
+all of the packages required to develop the code.
+
+::::{dropdown} Output from `poetry install`
+
+``` text
+Installing dependencies from lock file
+
+Package operations: 180 installs, 1 update, 0 removals
+
+- Installing attrs (23.2.0)
+- Installing rpds-py (0.18.1)
+- Installing referencing (0.35.1)
+- Installing six (1.16.0)
+- Installing jsonschema-specifications (2023.12.1)
+- Installing platformdirs (4.2.2)
+- Installing python-dateutil (2.9.0.post0)
+- Installing traitlets (5.14.3)
+- Installing types-python-dateutil (2.9.0.20240316)
+- Installing arrow (1.3.0)
+- Installing fastjsonschema (2.20.0)
+- Installing jsonschema (4.22.0)
+- Installing jupyter-core (5.7.2)
+- Installing pycparser (2.22)
+- Installing pyzmq (26.0.3)
+- Installing tornado (6.4.1)
+- Installing cffi (1.16.0)
+- Installing fqdn (1.5.1)
+- Installing idna (3.7)
+- Installing isoduration (20.11.0)
+- Installing jsonpointer (3.0.0)
+- Installing jupyter-client (8.6.2)
+- Installing markupsafe (2.1.5)
+- Installing nbformat (5.10.4)
+- Installing ptyprocess (0.7.0)
+- Installing rfc3339-validator (0.1.4)
+- Installing rfc3986-validator (0.1.1)
+- Installing soupsieve (2.5)
+- Installing uri-template (1.3.0)
+- Installing webcolors (24.6.0)
+- Installing webencodings (0.5.1)
+- Installing argon2-cffi-bindings (21.2.0)
+- Installing asttokens (2.4.1)
+- Installing beautifulsoup4 (4.12.3): Installing...
+- Installing bleach (6.1.0): Installing...
+- Installing certifi (2024.6.2)
+- Installing charset-normalizer (3.3.2)
+- Installing bleach (6.1.0): Installing...
+- Installing certifi (2024.6.2)
+- Installing charset-normalizer (3.3.2)
+- Installing beautifulsoup4 (4.12.3)
+- Installing bleach (6.1.0): Installing...
+- Installing certifi (2024.6.2)
+- Installing charset-normalizer (3.3.2)
+- Installing certifi (2024.6.2)
+- Installing charset-normalizer (3.3.2)
+- Installing bleach (6.1.0)
+- Installing certifi (2024.6.2)
+- Installing charset-normalizer (3.3.2)
+- Installing defusedxml (0.7.1)
+- Installing exceptiongroup (1.2.1)
+- Installing executing (2.0.1)
+- Installing jinja2 (3.1.4)
+- Installing jupyterlab-pygments (0.3.0)
+- Installing mdurl (0.1.2)
+- Installing mistune (3.0.2)
+- Installing nbclient (0.10.0)
+- Installing packaging (24.1)
+- Installing pandocfilters (1.5.1)
+- Installing parso (0.8.4)
+- Installing pure-eval (0.2.2)
+- Installing pygments (2.18.0)
+- Installing python-json-logger (2.0.7)
+- Installing pyyaml (6.0.1)
+- Installing sniffio (1.3.1)
+- Installing terminado (0.18.1)
+- Installing typing-extensions (4.12.2)
+- Installing tinycss2 (1.3.0)
+- Installing urllib3 (2.2.2)
+- Installing wcwidth (0.2.13)
+- Installing alabaster (0.7.16)
+- Installing anyio (4.4.0)
+- Installing argon2-cffi (23.1.0)
+- Installing babel (2.15.0): Pending...
+- Installing decorator (5.1.1)
+- Installing docutils (0.20.1): Installing...
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing decorator (5.1.1)
+- Installing docutils (0.20.1): Installing...
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing babel (2.15.0): Installing...
+- Installing decorator (5.1.1)
+- Installing docutils (0.20.1): Installing...
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing docutils (0.20.1)
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing decorator (5.1.1)
+- Installing docutils (0.20.1)
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing babel (2.15.0)
+- Installing decorator (5.1.1)
+- Installing docutils (0.20.1)
+- Installing h11 (0.14.0)
+- Installing imagesize (1.4.1)
+- Installing jedi (0.19.1): Installing...
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing jedi (0.19.1)
+- Installing jupyter-events (0.10.0)
+- Installing jupyter-server-terminals (0.5.3)
+- Installing latexcodec (3.0.0)
+- Installing markdown-it-py (3.0.0)
+- Installing matplotlib-inline (0.1.7)
+- Installing nbconvert (7.16.4)
+- Installing overrides (7.7.0)
+- Installing pexpect (4.9.0)
+- Installing prometheus-client (0.20.0)
+- Installing prompt-toolkit (3.0.47)
+- Installing requests (2.32.3)
+- Installing send2trash (1.8.3)
+- Installing snowballstemmer (2.2.0)
+- Installing sphinxcontrib-applehelp (1.0.8)
+- Installing sphinxcontrib-devhelp (1.0.6)
+- Installing sphinxcontrib-htmlhelp (2.0.5)
+- Installing sphinxcontrib-jsmath (1.0.1)
+- Installing sphinxcontrib-qthelp (1.0.7)
+- Installing sphinxcontrib-serializinghtml (1.1.10)
+- Installing stack-data (0.6.3)
+- Installing tomli (2.0.1)
+- Installing websocket-client (1.8.0)
+- Installing zipp (3.19.2)
+- Installing appnope (0.1.4)
+- Installing click (8.1.7)
+- Installing comm (0.2.2)
+- Installing debugpy (1.8.2): Downloading... 0%
+- Installing distlib (0.3.8)
+- Installing distlib (0.3.8)
+- Installing debugpy (1.8.2): Downloading... 10%
+- Installing distlib (0.3.8)
+- Installing distlib (0.3.8)
+- Installing debugpy (1.8.2): Downloading... 40%
+- Installing distlib (0.3.8)
+- Installing distlib (0.3.8)
+- Installing debugpy (1.8.2): Downloading... 90%
+- Installing distlib (0.3.8)
+- Installing distlib (0.3.8)
+- Installing debugpy (1.8.2): Downloading... 100%
+- Installing distlib (0.3.8)
+- Installing distlib (0.3.8)
+- Installing debugpy (1.8.2): Installing...
+- Installing distlib (0.3.8)
+- Installing distlib (0.3.8)
+- Installing debugpy (1.8.2)
+- Installing distlib (0.3.8)
+- Installing filelock (3.15.4)
+- Installing httpcore (1.0.5)
+- Installing importlib-metadata (8.0.0)
+- Installing iniconfig (2.0.0)
+- Installing ipython (8.26.0)
+- Installing json5 (0.9.25)
+- Installing jupyter-server (2.14.1)
+- Installing locket (1.0.0)
+- Installing mdit-py-plugins (0.4.1)
+- Installing nest-asyncio (1.6.0)
+- Installing numpy (1.26.4)
+- Installing pluggy (1.5.0)
+- Installing psutil (6.0.0)
+- Installing pybtex (0.24.0)
+- Installing pytz (2024.1)
+- Installing ruamel-yaml-clib (0.2.8)
+- Installing sphinx (7.3.7)
+- Installing tabulate (0.9.0)
+- Installing sqlalchemy (2.0.31)
+- Installing toolz (0.12.1)
+- Installing tzdata (2024.1)
+- Installing async-lru (2.0.4)
+- Installing cfgv (3.4.0)
+- Installing cftime (1.6.4): Downloading... 0%
+- Installing cloudpickle (3.0.0)
+- Installing cloudpickle (3.0.0)
+- Installing cftime (1.6.4): Downloading... 100%
+- Installing cloudpickle (3.0.0)
+- Installing cloudpickle (3.0.0)
+- Installing cftime (1.6.4): Installing...
+- Installing cloudpickle (3.0.0)
+- Installing contourpy (1.2.1)
+- Installing coverage (7.5.4)
+- Installing cycler (0.12.1)
+- Installing cloudpickle (3.0.0)
+- Installing contourpy (1.2.1)
+- Installing coverage (7.5.4)
+- Installing cycler (0.12.1)
+- Installing cftime (1.6.4)
+- Installing cloudpickle (3.0.0)
+- Installing contourpy (1.2.1)
+- Installing coverage (7.5.4)
+- Installing cycler (0.12.1)
+- Installing fonttools (4.53.0): Installing...
+- Installing fsspec (2024.6.1)
+- Installing httpx (0.27.0)
+- Installing identify (2.5.36)
+- Installing fsspec (2024.6.1)
+- Installing httpx (0.27.0)
+- Installing identify (2.5.36)
+- Installing fonttools (4.53.0)
+- Installing fsspec (2024.6.1)
+- Installing httpx (0.27.0)
+- Installing identify (2.5.36)
+- Installing ipykernel (6.29.4)
+- Installing jupyter-cache (1.0.0)
+- Installing jupyter-lsp (2.2.5)
+- Installing jupyterlab-server (2.27.2)
+- Installing kiwisolver (1.4.5)
+- Installing mdformat (0.7.17)
+- Installing mypy-extensions (1.0.0)
+- Installing myst-parser (3.0.1)
+- Installing nodeenv (1.9.1)
+- Installing notebook-shim (0.2.4)
+- Installing pandas (2.2.2)
+- Installing partd (1.4.2)
+- Installing pillow (10.3.0)
+- Installing pybtex-docutils (1.0.3)
+- Installing pyparsing (3.1.2)
+- Installing pytest (7.4.4)
+- Installing ruamel-yaml (0.18.6)
+- Updating setuptools (70.0.0 -> 70.1.1)
+- Installing sortedcontainers (2.4.0)
+- Installing sphinxcontrib-jquery (4.1)
+- Installing virtualenv (20.26.3)
+- Installing autodocsumm (0.2.12)
+- Installing dask (2023.12.1)
+- Installing dpath (2.2.0)
+- Installing hypothesis (6.104.1)
+- Installing isort (5.13.2)
+- Installing jupyterlab (4.2.3): Downloading... 20%
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0): Installing...
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1): Installing...
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1): Installing...
+- Installing jupyterlab (4.2.3): Downloading... 40%
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1): Installing...
+- Installing mypy (1.10.1)
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab (4.2.3): Downloading... 80%
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab (4.2.3): Downloading... 100%
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab (4.2.3): Installing...
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing jupyterlab (4.2.3)
+- Installing jupyterlab-myst (2.4.2)
+- Installing jupytext (1.16.2)
+- Installing matplotlib (3.9.0)
+- Installing mdformat-frontmatter (0.4.1)
+- Installing mdformat-tables (0.4.1)
+- Installing mypy (1.10.1)
+- Installing myst-nb (1.1.1)
+- Installing netcdf4 (1.7.1.post1)
+- Installing pint (0.20.1)
+- Installing pre-commit (2.21.0)
+- Installing pydocstyle (6.3.0)
+- Installing pytest-cov (3.0.0)
+- Installing pytest-datadir (1.5.0)
+- Installing pytest-mock (3.14.0)
+- Installing scipy (1.14.0)
+- Installing shapely (2.0.4)
+- Installing sphinx-design (0.6.0)
+- Installing sphinx-external-toc (1.0.1)
+- Installing sphinx-rtd-theme (2.0.0)
+- Installing sphinxcontrib-bibtex (2.6.2)
+- Installing sphinxcontrib-mermaid (0.9.2)
+- Installing tomli-w (1.0.0)
+- Installing tqdm (4.66.4)
+- Installing types-dataclasses (0.6.6)
+- Installing types-jsonschema (4.22.0.20240610)
+- Installing types-tqdm (4.66.0.20240417)
+- Installing xarray (2024.6.0)
+
+Installing the current project: virtual_ecosystem (0.1.1a4)
+```
+
+::::
+
+Poetry uses a virtual environment for package development: all packages are installed to
+a stand-alone python environment that is only used for `virtual_ecosystem` development.
+This makes sure that the development environment is consistent across python versions
+and different developers. However, when you are working on the command line, you need to
+**explicitly use the `virtual_ecosystem` environment** to run any command that needs to
+use the `virtual_ecosystem` environment - and that is pretty much everything described
+in this document. There are two options to do this:
+
+1. You can add `poetry run` before a command to make sure that single command is run
+ using the `poetry` environment. This approach is used in the example commands below.
+1. You can use `poetry shell` to start a new shell that uses this environment: you can
+ then run commands without needing `poetry run` and they should use the correct
+ enviroment. This is usually more convenient.
+
+You should now be able to run the following command to see that `virtual_ecosystem` is
+installed and is showing the current version.
+
+```sh
+poetry run python -c "import virtual_ecosystem; print(virtual_ecosystem.__version__)"
+```
+
+You can have parallel virtual environments for different Python versions: the command
+`poetry env list` can be used to show available environments and `poetry env use` can be
+used to add new environments and switch between existing environments.
+
+### Key developer tools
+
+This is not an exhaustive list, but the packages installed by `poetry` including the
+following standalone tools that can be used in developing your code and documentation.
+
+- `ipython`: an improved interactive Python shell. If you are running code in Python
+ from the command line, this is the one to use. Visual Studio Code likes to use it.
+
+- `jupyterlab`: an interactive computing server, providing elegant notebooks for
+ documentation and how-to guides, as well as debugging and development discussion.
+
+- `jupytext`: this allows `jupyter` to use Markdown formatted notebooks - in particular
+ the extended [MyST Markdown](https://myst-parser.readthedocs.io/en/latest/) variety
+ which will also be used for documentation.
+
+### Updating `poetry` and package versions
+
+You will not need to do this when setting up your development environment but one of the
+things that `poetry` does is to maintain a fixed set of compatible required packages.
+The `pyproject.toml` files sets constraints on package versions, but the particular
+combination to be used for a given commit is resolved and stored in the `poetry.lock`
+file.
+
+- If you want to **add a package** - either using `poetry add` or by manually updating
+ `pyproject.toml` - you will then need to run `poetry update` to check that a
+ compatible set of package versions exists and to update the `poetry.lock` file.
+
+- If you want to **update a package** then `poetry update` will update all the required
+ packages and update `poetry.lock`. You can use `poetry update package_name` to only
+ update a particular requirement.
+
+- The `poetry install` command - as shown above - can be re-run to re-install the
+ package. You will typically only need to do this if commands provided by the package
+ have changed and need to be updated.
+
+If you pull code from GitHub that changes `pyproject.toml` and `poetry.lock`, you should
+also run `poetry update` to bring your environment in line with other developers.
+
+### Installing and using `pre-commit`
+
+Development of the `virtual_ecosystem` package uses [`pre-commit`](https://pre-commit.com/).
+This is a python tool that runs a set of checks on `git` commits and stops the commit from
+completing when any of those checks fail. We use `pre-commit` to help catch a wide range
+of common issues and make sure that all code pushed to the GitHub repository meets some
+simple quality assurance checks and uses some common formatting standards.
+
+There is a detailed description of the `pre-commit` output and the configured checks
+and update process on the [code quality assurance page](./code_qa_and_typing.md).
+Briefly, the main elements are to use `pre-commit` to run code quality and formatting
+checks using the `ruff` tool and static typing using `mypy`.
+
+The `pre-commit` tool is installed by the `poetry install` step above, so you now need
+to install the `virtual_ecosystem` configuration for `pre-commit` and run the tool to
+set up the environment and check it is all working.
+
+```sh
+poetry run pre-commit install
+poetry run pre-commit run --all-files
+```
+
+That might take a little while to run on the first use. Once you have done this, every
+`git commit` will generate similar output and your commit will fail if issues are found.
+
+### Static typing with `mypy`
+
+The `python` programming language does not _require_ code objects to be typed, but the
+`virtual_ecosystem` package uses [type hints](https://peps.python.org/pep-0484/) to
+annotate code. Those type hints are then checked using the `mypy` static type checker,
+which is installed by `poetry` and is run as one of the `pre-commit` checks.
+
+The `mypy` package and the plugins we use are all installed by `poetry`. See the [code
+quality assurance page](./code_qa_and_typing.md) for more information on using `mypy`.
+
+### Package testing
+
+All code in the `virtual_ecosystem` package should have accompanying unit tests, using
+`pytest`. Look at the existing test suite in the `tests/unit` directory to see the
+structure and get a feel for what they should do, but essentially unit tests should
+provide a set of known inputs to a function and check that the expected answer (which
+could be an Exception) is generated.
+
+Again, the `pytest` package and plugins are installed by `poetry`. See the [code testing
+page](./code_testing.md) for more details but you should be able to check the tests run
+using the following command. Be warned that the `mypy` steps can be very time consuming
+on the first run, but `pytest` does some cacheing that makes them quicker when they next
+run.
+
+```sh
+poetry run pytest
+```
+
+### The `example_data` module
+
+The `virtual_ecosystem` package includes the [`example_data`
+submodule](../../using_the_ve/example_data.md) that provides a simple configuration and
+initial data inputs for running a simulation. This is widely used in the `pytest` suite
+and may be useful in developing your own tests.
+
+### Documentation
+
+We use `sphinx` to maintain the documentation for `virtual_ecosystem` and Google style
+docstrings using the `napoleon` formatting to provide API documentation for the code.
+We use MyST Markdown to provide dynamically built usage examples. See the [documentation
+pages](../documentation/documentation.md) for details but to get started, the following
+code can be used to build the documentation.
+
+```bash
+# Build docs using sphinx
+cd docs
+poetry run sphinx-build -W --keep-going source build
+```
+
+Once that command completes, the file `docs/build/html/index.html` can be opened to view
+the built documentation.
+
+### GitHub Actions
+
+We use GitHub Action workflows to update `pre-commit`, run code quality checks on pull
+requests, and to automate the publication of package releases on PyPI. See the [GitHub
+Actions page](./github_actions.md) for details.
+
+### Package version releases
+
+We use trusted publishing from GitHub releases to release new versions of the
+`virtual_ecosystem` to
+[PyPI](https://pypi.org/project/virtual_ecosystem/). Releases are also picked up and
+archived on [Zenodo](https://doi.org/10.5281/zenodo.8366847). See the [release process
+page](./release_process.md) for details.
+
+## Setup script example
+
+The scripts below bundle all the commands together to show the set up process, including
+using `pyenv` to mangage `python` versions, ending by running the unit tests. This sets
+up everything you need, ready to start developing on the `virtual_ecosystem`.
+
+:::{admonition} Setup script
+
+``` sh
+!/bin/bash
+
+# pyenv and poetry use sqlite3. You _may_ need to install these requirements first.
+sudo apt install sqlite3 sqlite3-doc libsqlite3-dev
+
+# install pyenv to manage parallel python environments
+curl | bash
+
+# Manually edit .bash_profile or .profile to setup pyenv:
+
+# export PYENV_ROOT="$HOME/.pyenv":
+# [[ -d $PYENV_ROOT/bin ]] && export PATH="$PYENV_ROOT/bin:$PATH":
+# eval "$(pyenv init -)"
+
+# Install a python version
+pyenv install 3.11
+
+# Install poetry
+curl -sSL https://install.python-poetry.org | python3 -
+
+# Manually add poetry to path in profile file:
+
+# export PATH="/home/validate/.local/bin:$PATH"
+
+# Clone the repository
+git clone https://github.com/ImperialCollegeLondon/virtual_ecosystem.git
+
+# Configure the virtual_ecosystem repo to use python 3.11
+cd virtual_ecosystem
+pyenv local 3.11
+poetry env use 3.11
+
+# Install the package with poetry
+poetry install
+
+# Install pre-commit and check
+poetry run pre-commit install
+poetry run pre-commit run --all-files
+
+# Run the test suite
+poetry run pytest
+
+```
+
+:::
diff --git a/docs/source/development/contributing/release_process.md b/docs/source/development/contributing/release_process.md
new file mode 100644
index 000000000..d7384e990
--- /dev/null
+++ b/docs/source/development/contributing/release_process.md
@@ -0,0 +1,138 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+---
+
+# Package release process
+
+The package release process has four stages. The last two steps are automated:
+
+* Merge changes from the `develop` branch onto `main` that will form the new release
+ version.
+* Publish a release on GitHub - this is basically just a specific tagged commit on
+ `main` that has some associated release notes.
+* Publish the code on Zenodo.
+* Publish the built code packages to PyPI - this is the packaged version of the code
+ that users will install and use. The `virtual_ecosystem` package uses the trusted
+ publishing mechanism to make it easy to add new release to PyPI.
+
+## Pre-release candidates and experimental releases
+
+The documentation below describes the process for 'official' releases of the Virtual
+Ecosystem, but it is sometimes useful to be able to release a test version or a release
+candidate. This can of course follow exactly the same instructions as below - an
+official release candidate is fine! However, you _can_ create a release from any
+branch, so it is possible to make a test release from `release/X.Y.Z` branch. This
+should always be discussed with the wider developer team.
+
+In this case, you may want to include the text `test-pypi-only` in the release name.
+This will publish the package on the Test PyPI archive but not the main PyPI archive.
+This has some advantages - we don't clutter up the official releases with experimental
+versions - but the test archive does not necessarily include all the versions of
+required packages needed and so is not really suitable for versions intended for testing
+by end users. See below for more information on how this option works.
+
+## Generate the code commit to be released
+
+The release process for new versions of the `virtual_ecosystem` package is managed using
+pull requests to the `main` branch to create a specific commit that will be released.
+The steps of the process are:
+
+1. **Create a new release branch** from the `develop` branch called `release/X.Y.Z` ,
+ where `X.Y.Z` is the expected release version number.
+
+1. Update the `pyproject.toml` file to use the expected release versions number and
+ commit that change. You can use `poetry version` command to increment the major,
+ minor and patch version but it is almost as easy to edit the file by hand.
+
+1. That commit should set the standard `ci.yaml` actions going, which includes
+ code QA, testing and docs building. However, you should also check the documentation
+ builds on Read The Docs.
+
+ Log in to [https://readthedocs.org](https://readthedocs.org) which is the admin site
+ controlling the build process. From the Versions tab, activate the `release/X.Y.Z`
+ branch and wait for it to build. Check the Builds tab to see that it has built
+ successfully! If it has built succesfully, do check pages to make sure that page code
+ has executed successfully, and then go back to the Versions tab and deactivate and
+ hide the branch. If the release branch needs any changes, do come back and check that
+ those changes have also built successfully.
+
+1. **Start a pull request against the `main` branch**. The PR will transfer all of the
+ changes to the `develop` branch since the last release on to the `main` branch. The
+ PR description should provide a good explanation of the functionality that is being
+ changed or added in this version, and an explanation of the suggested version number
+ increment. For example, "This PR fixes a bug in calculating plant growth and so is a
+ patch release from v.0.1.8 to v0.1.9".
+
+1. **The CI testing obviously now needs to pass**. Any issues need to be resolved by
+ commits or PRs onto the `release/x.y.x` branch.
+
+1. **The PR also must be reviewed**. The code itself has already gone through the
+ review process to be merged into `develop`, so this is not a code review so much as a
+ review of the justification for a release.
+
+1. **The branch can then be merged into `main`**. Do _not_ delete the release branch at
+ this point.
+
+1. **Create a second PR to merge the release branch into `develop`.** This is to
+ synchronise any release changes (including the version number change) between the
+ `main` and `develop` branches.
+
+## Create the GitHub release
+
+The head of the `main` branch is now at the commit that will be released as version
+`X.Y.Z`. The starting point is to **go to the [draft new release
+page](https://github.com/ImperialCollegeLondon/virtual_ecosystem/releases/new)**. The
+creation of a new release is basically attaching notes and files to a specific commit on
+a target branch. The steps are:
+
+1. On that release page, the **release target** dropdown should essentially always be
+ set to `main`: the whole point in this branch is to act as a release branch.
+
+1. You need to provide a tag for the commit to be released - so you need to **tag the
+ commit on the `main` branch** using the format `vX.Y.Z`. You can:
+
+ * Create the tag locally using `git tag vX.Y.Z` and then push the tag using `git push
+ --tags`. You can then select the existing tag from the drop down on the release
+ page.
+ * Alternatively, you can simply type the tag name into that drop down and the tag
+ will be created alongside the draft release.
+
+1. You will need to choose a title for the release: basically `Release vX.Y.Z` is fine.
+ However, the title text also provides a mechanism for suppressing automatic trusted
+ publication to the main PyPI server by using `Release vX.Y.Z test-pypi-only`. See
+ below for details.
+
+1. You can create release notes automatically - this is basically a list of the commits
+ being added since the last release - and can also set the version as a pre-release.
+ This is different from having an explicit release version number (e.g. `X.Y.Za1`) -
+ it is just a marker used on GitHub.
+
+ At this point, you can either save the draft or simply publish it. It is probably
+ good practice to save the draft and then have a discussion with the other developers
+ about whether to publish it.
+
+1. Once everyone is agreed **publish the release**: this will **automatically** publish
+ the release on PyPI.
+
+## Publish the package on PyPI
+
+We publish to _two_ package servers:
+
+* The
+ [TestPyPI](https://test.pypi.org/project/virtual_ecosystem/) server is a final check
+ to make sure that the package build and publication process is working as expected.
+* The package builds are then published to the main
+ [PyPI](https://pypi.org/project/virtual_ecosystem/) server for public use.
+
+The `virtual_ecosystem` repository is set up to use trusted publishing through [a Github
+Actions workflow](./github_actions.md#publication-workflow).
diff --git a/docs/source/development/design.md b/docs/source/development/design.md
new file mode 100644
index 000000000..f62d756c8
--- /dev/null
+++ b/docs/source/development/design.md
@@ -0,0 +1 @@
+# The design of the Virtual Ecosystem
diff --git a/docs/source/development/defining_new_models.md b/docs/source/development/design/defining_new_models.md
similarity index 97%
rename from docs/source/development/defining_new_models.md
rename to docs/source/development/design/defining_new_models.md
index cfab20d31..84ac8aea5 100644
--- a/docs/source/development/defining_new_models.md
+++ b/docs/source/development/design/defining_new_models.md
@@ -7,15 +7,15 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# Creating new Virtual Ecosystem models
The Virtual Ecosystem initially contains a set of models defining core components of
-an ecosystem, examples include the `abiotic`, `animals`, `plants` and `soil` models.
+an ecosystem, examples include the `abiotic`, `animal`, `plants` and `soil` models.
However, the simulation is designed to be modular:
* Different combinations of models can be configured for a particular simulation.
@@ -169,7 +169,7 @@ The {attr}`~virtual_ecosystem.core.base_model.BaseModel.model_name` attribute
configuration files. This **must** match the chosen submodule name for the model, so the
module `virtual_ecosystem.models.freshwater` must use `freshwater` as the model name.
-The {attr}`~virtual_ecosystem.core.base_model.BaseModel.required_init_vars` attribute
+The {attr}`~virtual_ecosystem.core.base_model.BaseModel.vars_required_for_init` attribute
: This is a tuple that sets which variables must be present in the data used to create a
new instance of the model. Each entry should provide a variable name and then another
tuple that sets any required axes for the variable. For example:
@@ -204,7 +204,7 @@ class FreshWaterModel(
BaseModel,
model_name = "freshwater",
model_update_bounds = ("1 day", "1 month"),
- required_init_vars = (('temperature', ('spatial', )), ),
+ vars_required_for_init = (('temperature', ('spatial', )), ),
vars_updated = ("average_P_concentration",),
):
"""Docstring describing model.
@@ -293,10 +293,10 @@ run from a set of configuration files, the model now needs to define two things:
The [JSONSchema](https://json-schema.org/) document in the module root directory defines
the configuration options for the model. A detailed description of the configuration
-system works can be found [here](../virtual_ecosystem/core/config.md) but the schema
-definition is used to validate configuration files for a Virtual Ecosystem simulation
-that uses your model. Essentially, it defines all of the `__init__` arguments that are
-unique to your model.
+system works can be found [here](../../using_the_ve/configuration/config.md) but the
+schema definition is used to validate configuration files for a Virtual Ecosystem
+simulation that uses your model. Essentially, it defines all of the `__init__` arguments
+that are unique to your model.
Writing JSONSchema documents can be very tedious. The following tools may be of use:
diff --git a/docs/source/development/developer_setup.md b/docs/source/development/developer_setup.md
deleted file mode 100644
index 562c247b1..000000000
--- a/docs/source/development/developer_setup.md
+++ /dev/null
@@ -1,208 +0,0 @@
-# Developer setup
-
-This document is a help file for developers setting up a computer to work with the
-Virtual Ecosystem codebase.
-
-## Python version
-
-We decided (June 2022) to support Python 3.9+:
-
-- Recent new versions of `numpy` (^1.22.0) are 3.8+
-- Python 3.9 enabled generics in type hints (list\[float\] not List\[float\])
-
-## Python installation
-
-We recommend using `pyenv` or `pyenv-win` to manage parallel Python environments:
-
-- [Install notes](https://github.com/pyenv/pyenv#installation)
-
-## Base python packages
-
-The package manager `poetry` (see below) handles the installation of the required
-packages for the project, but there are several packages that are more widely useful and
-should be installed for the base `pyenv` installation of each Python version. These
-should then be available for all virtual environments (see below!) using that Python
-version.
-
-- `ipython`: an improved interactive Python shell. If you are running code in Python
- from the command line, this is the one to use. Visual Studio Code likes to use it.
-
-- `jupyterlab`: an interactive computing server, providing elegant notebooks for
- documentation and how-to guides, as well as debugging and development discussion.
-
-- `jupytext`: this allows `jupyter` to use Markdown formatted notebooks - in particular
- the extended [MyST Markdown](https://myst-parser.readthedocs.io/en/latest/) variety
- which will also be used for documentation.
-
-```sh
-# Set the python version to install
-pyenv local 3.9.12
-# Install these into the package base
-pip install ipython jupyterlab jupytext
-```
-
-## The `poetry` package manager
-
-The next step is to install `poetry` and then use this to install the development
-environment for the package.
-
-- Install `poetry` following
- [the instructions](https://python-poetry.org/docs/#installation).
-- Note that the installation also includes a step to configure your computer to find the
- installed `poetry` command!
-- Use `poetry` to install the development environment. This step installs all the
- packages listed in the `pyproject.toml` file for the project, and specifically a set
- of versions that `poetry` has found to be mutually compatible and that are listed in
- the `poetry.lock` file.
-
-```bash
-cd path/to/vr_repo/root
-poetry install
-```
-
-You should then see output describing the creation of a virtual environment and the
-installation of the required packages into that environment. For example:
-
-```bash
-dorme@MacBook-Pro virtual_ecosystem % poetry install
-Creating virtualenv virtual-ecosystem-Laomc1u4-py3.10 in /Users/dorme/Library/Caches/pypoetry/virtualenvs
-Installing dependencies from lock file
-
-Package operations: 39 installs, 0 updates, 0 removals
-
- • Installing pyparsing (3.0.9)
- • Installing attrs (21.4.0)
- • Installing distlib (0.3.4)
- • Installing filelock (3.7.1)
- • Installing iniconfig (1.1.1)
- • Installing mccabe (0.6.1)
- • Installing mdurl (0.1.1)
- • Installing mypy-extensions (0.4.3)
- • Installing packaging (21.3)
- • Installing platformdirs (2.5.2)
- • Installing pluggy (1.0.0)
- • Installing py (1.11.0)
- • Installing pycodestyle (2.8.0)
- • Installing pyflakes (2.4.0)
- • Installing six (1.16.0)
- • Installing tomli (2.0.1)
- • Installing typing-extensions (4.2.0)
- • Installing cfgv (3.3.1)
- • Installing click (8.1.3)
- • Installing coverage (6.4.1)
- • Installing flake8 (4.0.1)
- • Installing identify (2.5.1)
- • Installing markdown-it-py (2.1.0)
- • Installing mypy (0.961)
- • Installing nodeenv (1.7.0)
- • Installing pathspec (0.9.0)
- • Installing pytest (7.1.2)
- • Installing pyyaml (6.0)
- • Installing toml (0.10.2)
- • Installing virtualenv (20.15.1)
- • Installing black (22.6.0)
- • Installing isort (5.10.1)
- • Installing mdformat (0.7.14)
- • Installing numpy (1.23.0)
- • Installing pre-commit (2.19.0)
- • Installing pytest-cov (3.0.0)
- • Installing pytest-flake8 (1.1.1)
- • Installing pytest-mock (3.8.1)
- • Installing pytest-mypy (0.9.1)
-
-Installing the current project: virtual_ecosystem (0.1.0)
-```
-
-## Using the virtual environments
-
-In order to use the virtual environments (`venv`) created by `poetry`, you need to make
-sure the one you want is activated and then launch a new shell using that `venv`. You
-may have parallel `venv` for different Python versions and you can check this using
-`poetry env list`:
-
-```bash
-dorme@MacBook-Pro virtual_ecosystem % poetry env list
-virtual-ecosystem-Laomc1u4-py3.10 (Activated)
-virtual-ecosystem-Laomc1u4-py3.9
-dorme@MacBook-Pro virtual_ecosystem %
-```
-
-You can now launch a shell using that `venv`.
-
-```bash
-dorme@MacBook-Pro virtual_ecosystem % poetry shell
-Spawning shell within /Users/dorme/Library/Caches/pypoetry/virtualenvs/virtual-ecosystem-Laomc1u4-py3.10
-dorme@MacBook-Pro virtual_ecosystem % . /Users/dorme/Library/Caches/pypoetry/virtualenvs/virtual-ecosystem-Laomc1u4-py3.10/bin/activate
-(virtual-ecosystem-Laomc1u4-py3.10) dorme@MacBook-Pro virtual_ecosystem %
-```
-
-The command line prompt has been updated to show the active `venv`.
-
-## Installing `pre-commit` hooks
-
-Now you have an active `venv` that includes the `pre-commit` package, which is one of
-the developer dependencies specified in `pyproject.toml`. The `.pre-commit-config.yaml`
-file defines the set of pre-commit checks that we want to use, and those can be
-installed using:
-
-```bash
-pre-commit install
-```
-
-You should then see output describing the installation of the software required for the
-pre-commit hooks. Once that has been done, the hooks are active:
-
-- the contents of any `git commit` must pass those checks.
-- If it does not, the commit will not happen and you will see which hooks have failed
- and why.
-- You will need to `git add` further changes to those files to a point where they pass
- the checks.
-
-## Setting up `git flow`
-
-In this project we make use of
-[`gitflow-avh`](https://github.com/petervanderdoes/gitflow-avh), as it offers a helpful
-extended set of publishing commands. Installation instructions for different operating
-systems can be found
-[here](https://github.com/petervanderdoes/gitflow-avh/wiki/Installation). As example, on
-MacOS it can be installed using the following command:
-
-```bash
-brew install git-flow-avh
-```
-
-Now that `git-flow-avh` is installed, `git flow` should be initialised for the repo by
-calling:
-
-```bash
-git flow init
-```
-
-This generates a number of questions, these are shown below along with the answers that
-should be given. N.B. that in most cases the default is fine, and so the question can be
-skipped by pressing the enter key.
-
-```bash
-Which branch should be used for bringing forth production releases?
- - develop
- - main
- - testing_training
-Branch name for production releases: [main] main
-
-Which branch should be used for integration of the "next release"?
- - develop
- - testing_training
-Branch name for "next release" development: [develop] develop
-
-How to name your supporting branch prefixes?
-Feature branches? [feature/]
-Bugfix branches? [bugfix/]
-Release branches? [release/]
-Hotfix branches? [hotfix/]
-Support branches? [support/]
-Version tag prefix? [] v
-Hooks and filters directory? [/usr/file/structure/virtual_ecosystem/.git/hooks]
-```
-
-Once this is done `git flow` has been setup and new branches can be created using
-`git flow` commands
diff --git a/docs/source/development/documentation.md b/docs/source/development/documentation.md
new file mode 100644
index 000000000..0dbf69ca6
--- /dev/null
+++ b/docs/source/development/documentation.md
@@ -0,0 +1 @@
+# Documentation development
diff --git a/docs/source/development/documentation/docstring_style.py b/docs/source/development/documentation/docstring_style.py
index 6576880cb..f5181d9b0 100644
--- a/docs/source/development/documentation/docstring_style.py
+++ b/docs/source/development/documentation/docstring_style.py
@@ -2,10 +2,11 @@
because a header is required at the top of the markdown source page where the API docs
will be inserted using the ``automodule`` declaration, so we do not repeat it here.
-That does mean that we need to stop ``flake8`` complaining about a missing blank line
-after the first line and a missing full stop at the end of that line, which we can do
-using the comment ``# noqa: D205, D415`` after the docstring closes.
-""" # noqa: D205, D415
+That does mean that we need to stop ``ruff`` complaining about a missing blank line
+after the first line, which we can do using the comment ``# noqa: D205`` after the
+docstring closes. Sometimes - and a bit mysteriously - ``ruff`` also complains about
+missing punctuation at the end of the docstring - this requires ``# noqa: D205, D415``.
+""" # noqa: D205
AN_OBJECT: str = "An object in the module"
"""This is a docstring for a module attribute."""
diff --git a/docs/source/development/documentation/documentation.md b/docs/source/development/documentation/documentation.md
new file mode 100644
index 000000000..2138181e3
--- /dev/null
+++ b/docs/source/development/documentation/documentation.md
@@ -0,0 +1,178 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3
+ language: python
+ name: python3
+---
+
+# Documentation
+
+This page describes the documentation of the `virtual_ecosystem` package, which is
+hosted at:
+
+[https://virtual-ecosystem.readthedocs.io](https://virtual-ecosystem.readthedocs.io)
+
+The Virtual Ecosystem project is documented using the
+[`sphinx`](https://www.sphinx-doc.org/en/master/) document generation system. This
+includes documentation to:
+
+* present the scientific background underpinning the `virtual_ecosystem` package,
+* provide tutorials in using the package,
+* demonstrate how to use the package components in more detail, and
+* technical details of the application program interface (API) of the underlying code.
+
+This broadly follows the [Diátaxis framework](https://diataxis.fr/), which
+provides a useful breakdown of four distinct documentation modes (tutorial, how-to,
+explanation and reference) and how to approach these with users in mind.
+
+## Documentation guide
+
+The `docs/source` directory contains the content and `sphinx` configuration to build the
+package website. In addition to the top level index pages, we have three main content
+directories:
+
+* The `api` directory contains some simple stub files that are used to link to API
+content generated from docstrings.
+* The `development` directory contains details on code development, model design, and
+documentation for the `virtual_ecosystem`.
+* The `using_the_ve` directory contains user guides and code examples. It also contains
+information on climate data download and pre-processing.
+
+### MyST Markdown and notebooks
+
+All of the documentation in `docs/source` uses [MyST
+Markdown](https://myst-parser.readthedocs.io/en/latest/) rather than the
+reStructuredText (`.rst`) format. Markdown is easier to write and read and the MyST
+Markdown extension is a literate programming format that allows Markdown pages to be run
+using Jupyter to generate dynamic content to show package use.
+
+In addition to displaying static text, MyST Markdown can also be used to write notebook
+files that contain code. We use the `myst-nb` extension to `sphinx` to allow those
+notebooks to be run when the documentation is built, allowing code examples and
+demonstrations to be included in the documentation.
+
+For more information, see the [Jupyter notebooks](./jupyter_notebooks.md) page.
+
+### Table of contents
+
+We use the `sphinx_external_toc` package to maintain a table of contents for the
+package. This table of contents is used to populate the site menu that appears on the
+left of the webpage. The file `docs/source/_toc.yml` sets the structure of the table and
+you will need to add new documentation files to this file for them to appear in the table.
+The documentation build process will fail if it finds files in `docs/source` that are
+not included in the table of contents!
+
+### Docstrings
+
+The `virtual_ecosystem` package uses docstrings written in the [Google
+style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
+This allows the function documentation to be stored alongside the code and it is included
+in the documentation using the `sphinx` `autodoc` extension. See the code itself for
+examples of the documentation formatting and typical content.
+
+At the moment, we use the `autodoc` plugins for `sphinx` to convert docstrings to HTML
+and build the online API documentation. Unfortunately, the `autodoc` package is
+hard-coded to expect docstrings to use reStructuredText, which means that at the moment
+**all docstrings have to be written in `rst` format**. At some point, we'd like to
+switch away to using Markdown throughout, but for the moment look at the existing
+docstrings to get examples of how the formatting differs.
+
+```{admonition} More information
+
+* The [docstring style](docstring_style.md) page includes some simple dummy code
+ demonstrating the docstring style adopted by the project. It is based on the [Google
+ Python code
+ style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
+
+* The [API generation](api_generation.md) page explains how to include the API
+ for a new module in the project documentation. It also shows how the dummy code
+ above is rendered as HTML by that process.
+```
+
+Also see the [section on using `doctests`](../contributing/code_testing.md) to include
+and validate simple usage examples in docstrings.
+
+### Referencing
+
+Both the `docs/source` and docstrings uses the `sphinxcontrib-bibtex` package to support
+citations. This uses Latex like citation keys in the documentation to insert references
+and build a bibliography. The `sphinx` configuration in `docs/source/conf.py` provides a
+custom Author/Year citation style. The reference library in `source/refs.bib` needs to
+be kept up to date with the literature for the project.
+
+The three common use cases are shown below using a couple of reference tags
+(`campbell_introduction_2012` and `porporato_hydrologic_2003`) that are included
+in the current [reference library](../../bibliography.md).
+
+* Cite with date in parentheses (``{cite:t}`campbell_introduction_2012` ``): the model
+ implemented in {cite:p}`campbell_introduction_2012`.
+* Cite with reference(s) in parentheses
+ (``{cite:p}`campbell_introduction_2012,porporato_hydrologic_2003` ``): using the P
+ Model {cite:t}`campbell_introduction_2012,porporato_hydrologic_2003`.
+* Cite as above but suppressing the parentheses to allow text before or after the
+ citation (``(see {cite:alp}`campbell_introduction_2012` for details)``): the class
+ implements the P Model (see {cite:alp}`campbell_introduction_2012` for details).
+
+## Building the documentation
+
+The `sphinx` package is used to build an HTML version of the package documentation
+provided in `docs/source` and to include the API documentation provided in the code
+docstrings. The `sphinx` building process requires some extra packages, but these are
+included in the `docs` group in `pyproject.toml` and should be installed.
+
+In order to build the package documentation, Jupyter needs to be able to associate the
+documentation files with the Python environment managed by `poetry`. Fortunately, the
+`poetry shell` and `poetry run` commands update the Jupyter kernel specifications so
+that the `python3` kernel name points to the `poetry` environment. For example:
+
+```bash
+$ poetry run jupyter kernelspec list
+Available kernels:
+ ...
+ python3 .../pyrealm-QywIOHcp-py3.10/share/jupyter/kernels/python3
+```
+
+In order to build the package documentation, the following command can then be used:
+
+```bash
+# Build docs using sphinx
+cd docs
+poetry run sphinx-build -M html source build -W --keep-going
+```
+
+Once that has completed, you can open the file `docs/build/html/index.html` to view the
+locally built documentation in a browser.
+
+The `sphinx` build process typically only runs on updated or changed files, to save time
+when generating the documentation. If you want to completely rebuild the documentation
+from scratch - if you are changing the table of contents or the links for example - then
+the command `sphinx-build -M clean source build` can be used to remove the existing
+built documentation before rebuilding as above.
+
+## Quality assurance on documentation
+
+The `pre-commit` configuration for the project includes two components that run quality
+checking on documentation before it can be committed to GitHub. Neither of these attempt
+to automatically fix documentation content: there is quite a lot of variation in
+particular markup flavours and it is for too easy for autoformatters to break content
+rather than fix it.
+
+1. We have configured `ruff` to use the [`pydocstyle`
+ ruleset](https://docs.astral.sh/ruff/rules/#pydocstyle-d), which checks for
+ consistent documentation style and matches docstring contents to the function and
+ method signatures.
+
+1. We use the [`markdownlint-cli`](https://github.com/igorshubovych/markdownlint-cli)
+ package to maintain quality on Markdown documents, including Jupyter notebooks. This
+ applies a set of [quality checking
+ rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md) to ensure
+ common standards for Markdown content. Again, [comments in a Markdown
+ document](https://github.com/DavidAnson/markdownlint#configuration) can be used to
+ suppress particular rules where appropriate.
diff --git a/docs/source/development/documentation/jupyter_notebooks.md b/docs/source/development/documentation/jupyter_notebooks.md
index 57fb6f80d..dda97f01c 100644
--- a/docs/source/development/documentation/jupyter_notebooks.md
+++ b/docs/source/development/documentation/jupyter_notebooks.md
@@ -53,74 +53,27 @@ currently active `poetry` virtual environment:
The `jupyter` system can be setup to run notebooks in a number of different languages
and even different environments of the same language. Each option is setup as a
**kernel**, which is basically a pointer to a particular programming environment or
-virtual environment.
-
-To make sure that `virtual_ecosystem` project notebooks are always built using the
-correct virtual environment on all systems (including developer machines, ReadTheDocs
-and Github Actions), this project requires that `jupyter` is set up to use the virtual
-environment created by `poetry` under the `vr_python3` kernel name. There is a good
-discussion of the background for this
-[here](https://janakiev.com/blog/jupyter-virtual-envs/).
-
-In order to install that kernel, run the following line:
-
-```zsh
-poetry run python -m ipykernel install --user --name=vr_python3
-```
-
-When you run `jupyter-lab` now, you should be able to select the `vr_python3` kernel to
-run the code cells. That command is doing some subtle and important things:
-
-- Python is being run in the active `poetry` virtual environment (`poetry run`).
-- The active `python` environment is then being installed as a kernel specification.
-- It is being installed into a location that is available for the user from anywhere
- they run `jupyter` (`--user`).
-- It is being installed with the name `vr_python3` (`--name vr_python3`).
-
-The choice of kernel name is **important** because `jupyter` uses the kernel specified
-in the notebook metadata and we want it to be stable. The kernel name:
-
-- needs to point to a virtual environment including the `virtual_ecosystem` package
- and dependencies, and
-- should be consistent across supported Python versions and developer machines.
-
-The options are:
-
-- By default, it would be installed as `python3`, which is way too generic.
-- The `poetry` venv name contains a hash (e.g. `Laomc1u4`) which uniquely identifies the
- project directory and helps `poetry` track the project-specific venvs. This is a
- **spectacularly bad** kernel name because files would change as they are run on
- different developer machines.
-- Using the `vr_python3` name is hopefully unique and should be a stable pointer to a
- venv that includes the `virtual_ecosystem` package and dependencies.
-
-Just to point to the gory details, there is now a `kernelspec` called `vr_python3`. That
-is just a pointer to a JSON file that points to the machine-specific venv location.
+virtual environment. Each notebook should specify which kernel is to be used when
+executing any code, and we need to ensure two things.
+
+- The selected kernel needs to point to a virtual environment including the
+ `virtual_ecosystem` package and dependencies, and
+- the kernel should be available consistently across supported Python versions,
+ developer machines, GitHub runners used for testing and also within the ReadTheDocs
+ build environment.
+
+Fortunately, when `poetry run` or `poetry shell` are used, the `jupyter` kernels are
+updated to set the `python3` kernel to point to the active `poetry` virtual environment.
+This ensures that Jupyter is invoked in the correct environment on all platforms. We can
+check this by running the following, which shows the `python3` kernel pointing to the
+`python3` kernel Virtual Ecosystem virtual environment: that path will vary between
+machines but `poetry` will ensure that the link is set correctly.
```zsh
-% jupyter kernelspec list
+% poetry run jupyter kernelspec list
Available kernels:
- ir /Users/dorme/Library/Jupyter/kernels/ir
- julia-1.0 /Users/dorme/Library/Jupyter/kernels/julia-1.0
- vr_python3 /Users/dorme/Library/Jupyter/kernels/vr_python3
-```
-
-```zsh
-% cat /Users/dorme/Library/Jupyter/kernels/vr_python3/kernel.json
-{
- "argv": [
- "/Users/dorme/Library/Caches/pypoetry/virtualenvs/virtual-ecosystem-Laomc1u4-py3.10/bin/python",
- "-m",
- "ipykernel_launcher",
- "-f",
- "{connection_file}"
- ],
- "display_name": "vr_python3",
- "language": "python",
- "metadata": {
- "debugger": true
- }
-}%
+ ir ../Jupyter/kernels/ir
+ python3 ../pypoetry/virtualenvs/virtual-ecosystem-In6MogPy-py3.11/share/jupyter/kernels/python3
```
## Notebook formats
@@ -155,7 +108,7 @@ with some really useful features.
To be used with `jupytext`, MyST Markdown files need to include a YAML preamble at the
very top of the file. This is used to set document metadata about the Markdown variety
-and also code execution data like the `jupyter` kernel. This is where the `vr_python3`
+and also code execution data like the `jupyter` kernel. This is where the `python3`
kernel name is set.
```yaml
@@ -170,9 +123,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
```
@@ -181,7 +134,7 @@ header:
```zsh
% jupytext --set-format md:myst simple.md
-% jupytext --set-kernel vr_python3 simple.md
+% jupytext --set-kernel python3 simple.md
```
There **is a downside** to using Markdown notebooks. The `.ipynb` format includes the
@@ -194,8 +147,7 @@ GitHub.
In summary:
- We only commit notebooks in MyST Markdown format
-- Notebooks should use the `vr_python3` kernel, so that they will hopefully run on any
- machine that has set up the `kernelspec` correctly.
+- Notebooks should use the `python3` kernel.
- GitHub will render the markdown and code cells correctly but none of the executed
outputs will be shown.
- However, the notebooks **will be executed** by the `sphinx` documentation system,
@@ -210,7 +162,7 @@ In summary:
All Myst Markdown content in a notebook will be checked using `markdownlint` when the
file is committed to GitHub (see
-[here](overview.md#quality-assurance-on-documentation)). In addition, the following
+[here](documentation.md#quality-assurance-on-documentation)). In addition, the following
tools may be useful:
### Using `black` with `jupytext`
@@ -225,21 +177,3 @@ jupytext --pipe black my_markdown.md
Note that this **does not format** Python code that is simply included in a Markdown
cell - essentially text that is formatted as if it were Python code. It **only** formats
code within a Jupyter notebook `{code-cell}` or `{code-block}` section.
-
-### The `mdformat` tool
-
-```{warning}
-The following tool is essentially `black` for Markdown files, which is great.
-At the moment, although it handles MyST Markdown, it has not been extended to include
-some extensions to MyST which we use. As a result, it can introduce errors. In the
-future, we may be able to configure it to automatically tidy Markdown content.
-```
-
-This is an autoformatter for Markdown, with specific extensions to handle the Myst
-Markdown variety and the YAML frontmatter (`mdformat-myst` and `mdformat-frontmatter`).
-It is configured using `.mdformat.toml`, to set up line wrapping length and default list
-formatting.
-
-```zsh
-mdformat my_markdown.md
-```
diff --git a/docs/source/development/documentation/overview.md b/docs/source/development/documentation/overview.md
deleted file mode 100644
index 528cb765c..000000000
--- a/docs/source/development/documentation/overview.md
+++ /dev/null
@@ -1,125 +0,0 @@
----
-jupytext:
- cell_metadata_filter: -all
- formats: md:myst
- main_language: python
- text_representation:
- extension: .md
- format_name: myst
- format_version: 0.13
- jupytext_version: 1.13.8
----
-
-# Documentation system overview
-
-The Virtual Ecosystem project is documented using the
-[`sphinx`](https://www.sphinx-doc.org/en/master/) document generation system. This
-includes documentation to:
-
-* present the scientific background underpinning the `virtual_ecosystem` package,
-* provide tutorials in using the package,
-* demonstrate how to use the package components in more detail, and
-* technical details of the application program interface (API) of the underlying code.
-
-The project makes use of the following technologies within `sphinx` to structure the
-documentation content and then render that content as the [project
-website](https://virtual-ecosystem.readthedocs.io/).
-
-## Sphinx build process
-
-The documentation sources for `virtual_ecosystem` are stored in the `docs/source`
-directory along with the `sphinx` configuration file `conf.py`. As noted below, the
-`sphinx` build process will need to run and build Jupyter notebooks. This requires the
-extra setup step shown below and [explained
-here](jupyter_notebooks.md#jupyter-kernel-setup).
-
-```zsh
-poetry run python -m ipykernel install --user --name=vr_python3
-```
-
-The HTML documentation can be built from `docs` folder from the command line using the
-commands below and will be built in the `docs/build/html` directory. You can open
-`docs/build/html/index.html` in a browser to see the documentation.
-
-```sh
-cd docs/
-# Optionally, to rebuild from scratch
-make clean
-# To build the HTML pages
-make html
-```
-
-The `make html` command will only build pages for files that have changed recently, and
-it can sometimes be necessary to use `make clean` to remove all of the existing built
-pages in order to rebuild the documentation from scratch.
-
-## MyST Markdown
-
-All of the documentation apart from code docstrings is written using [MyST
-Markdown](https://myst-parser.readthedocs.io/), which provides an extended set of
-Markdown features. MyST also provides a parser for MyST Markdown content (`myst-parser`)
-that allows pages written in MyST to be rendered in `sphinx`. It is a simple replacement
-for the [RST format](https://docutils.sourceforge.io/rst.html).
-
-## Jupyter Notebooks
-
-In addition to static content, both 'tutorial' and 'how to' pages can contain actual
-Python code demonstrating how to use the components of the `virtual_ecosystem` package.
-These pages are written using [Jupyter](https://jupyter.org/) notebooks. These notebooks
-can be worked on interactively by developers using [`jupyter`](https://jupyter.org/) and
-can also be run by `sphinx`, using the [`myst-nb`
-extension](https://myst-nb.readthedocs.io/), to automatically run the code in the
-notebooks and then convert the content into web pages. We use the MyST Markdown format
-for writing Jupyter notebooks, making use of the [`jupytext`
-extension](https://jupytext.readthedocs.io/) to Jupyter.
-
-```{admonition} More information
-See the [Jupyter Notebooks](jupyter_notebooks.md) page for more information on using
-Jupyter notebooks in the documentation.
-```
-
-## Docstrings
-
-All of the code provided in the `virtual_ecosystem` package should be extensively
-documented in place using docstrings. We use the
-[`napoleon` extension](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/) to
-`sphinx` to provide a more legible docstring style. We also use the [`autodoc`
-extension](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html)
-to automatically generate API webpages directly from the docstrings. At present, it is
-not easy to use MyST Markdown with the `autodoc` extension, so unfortunately
-**docstrings must be written using RST format**.
-
-```{admonition} More information
-
-* The [docstring style](docstring_style.md) page includes a simple dummy code model
- demonstrating the docstring style adopted by the project. It is based on the [Google
- Python code
- style](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html).
-
-* The [API generation](api_generation.md) page explains how to include the API
- for a new module in the project documentation. It also shows how the dummy code model
- mentioned above is rendered as HTML by that process.
-```
-
-## Quality assurance on documentation
-
-The `pre-commit` configuration for the project includes two components that run quality
-checking on documentation before it can be committed to GitHub. Neither of these attempt
-to automatically fix documentation content: there is quite a lot of variation in
-particular markup flavours and it is for too easy for autoformatters to break content
-rather than fix it.
-
-1. We use the [`flake8-docstrings`
- extension](https://github.com/pycqa/flake8-docstrings) to `flake8` to validate the
- formatting of all docstrings in the code base. The `# noqa: error_code` comment can
- be used to suppress [docstring
- errors](https://www.pydocstyle.org/en/latest/error_codes.html#default-conventions)
- when appropriate.
-
-1. We use the [`markdownlint-cli`](https://github.com/igorshubovych/markdownlint-cli)
- package to maintain quality on Markdown documents, including Jupyter notebooks. This
- applies a set of [quality checking
- rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md) to ensure
- common standards for Markdown content. Again, [comments in a Markdown
- document](https://github.com/DavidAnson/markdownlint#configuration) can be used to
- suppress particular rules where appropriate.
diff --git a/docs/source/genindex.md b/docs/source/genindex.md
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/source/index.md b/docs/source/index.md
index 4b984bdf7..c35dbb028 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -12,9 +12,8 @@ kernelspec:
# Welcome to the Virtual Ecosystem
-This repository is the home for the development of the Virtual Ecosystem. The Virtual
-Ecosystem is a project to develop a simulation of all of the major processes involved
-in a real ecosystem including the:
+The Virtual Ecosystem is a project to develop a simulation of all of the major processes
+involved in a real ecosystem including the:
- growth and demographic processes of the primary producers within the forest,
- microclimatic processes within and around the ecosystem,
@@ -22,13 +21,37 @@ in a real ecosystem including the:
- biotic and abiotic processes within the soil, and the
- growth and demography of heterotrophs.
-## Project details
+The project is open-source and is being developed using the Python programming language.
-This project is funded by a 2021 Distinguished Scientist award from the
-[NOMIS Foundation](https://nomisfoundation.ch) to Professor Robert Ewers:
+## What to read next
-- [NOMIS Award details](https://nomisfoundation.ch/people/robert-ewers/)
-- [NOMIS project summary](https://nomisfoundation.ch/research-projects/a-virtual-rainforest-for-understanding-the-stability-resilience-and-sustainability-of-complex-ecosystems/)
+The project documentation and the underlying code are big, so here are some quick links
+to help guide you in finding out more about the Virtual Ecosystem. Are you interested
+in:
+
+- Reading more about the [scientific theories](./virtual_ecosystem/theory/theory.md)
+ underlying the development of the Virtual Ecosystem.
+- Exploring the
+ [big picture workflow](./virtual_ecosystem/implementation/implementation.md) of the
+ implementation of the Virtual Ecosystem.
+- Getting started by [installing the Virtual
+ Ecosystem](./using_the_ve/getting_started.md) and running a simple example.
+- Moving on to [configuring your own simulation](./using_the_ve/configuration/config.md)
+ and [providing new data](./using_the_ve/data/data.md).
+- Contributing to the [development](./development/contributing.md) of the Virtual
+ Ecosystem.
+- Simply taking a look at the code! The project is open source and is developed on the
+ [ImperialCollegeLondon/virtual_ecosystem](https://github.com/ImperialCollegeLondon/virtual_ecosystem)
+ repository on GitHub.
+
+## About the project
+
+::::{grid} 1 1 2 2
+
+:::{grid-item-card} Project details
+
+This project is funded by a 2021 [Distinguished Scientist award]()
+from the [NOMIS Foundation](https://nomisfoundation.ch) to Professor Ewers.
```{image} _static/images/logo-nomis-822-by-321.png
:alt: NOMIS logo
@@ -38,13 +61,15 @@ This project is funded by a 2021 Distinguished Scientist award from the
The research is based at [Imperial College London](https://imperial.ac.uk):
-```{image} _static/images/IMP_ML_1CS_4CP_CLEAR-SPACE.png
+```{image} _static/images/IMPERIAL_logo_RGB_Blue_safe_area_2024.png
:alt: Imperial logo
:class: bg-primary
:width: 250px
```
-## Project Team
+:::
+
+:::{grid-item-card} Project Team
- Professor Robert Ewers
- Olivia Daniel
@@ -53,120 +78,12 @@ The research is based at [Imperial College London](https://imperial.ac.uk):
- Dr. Vivienne Groner
- Dr. Jacob Cook
- Dr. Taran Rallings
+- Professor Priyanga Amarasekare
The research team are supported by the Imperial College London
-[Research Software Engineering](https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/research-software-engineering/)
+[Research Software Engineering](https://www.imperial.ac.uk/admin-services/ict/self-service/research-support/rcs/service-offering/research-software-engineering/)
team.
-```{eval-rst}
-.. toctree::
- :maxdepth: 4
- :caption: The Virtual Ecosystem
-
- virtual_ecosystem/module_overview.md
- virtual_ecosystem/usage.md
- virtual_ecosystem/example_data.md
- virtual_ecosystem/main_simulation.md
- virtual_ecosystem/constants.md
- virtual_ecosystem/soil/soil_details.md
- virtual_ecosystem/core/grid.md
- virtual_ecosystem/core/data.md
- virtual_ecosystem/core/axes.md
- virtual_ecosystem/core/config.md
-```
-
-```{eval-rst}
-.. toctree::
- :maxdepth: 4
- :caption: API reference
-
- Main
- Example data
- Core Overview
- Configuration
- Logger
- Grid
- Data
- File readers
- Core axes
- Base Model
- Core Components
- Core Constants
- Constants Classes
- Constants Loader
- Schema
- Module Registry
- Utility functions
- Custom exceptions
- Soil Overview
- Soil Model
- Soil Carbon
- Soil Environmental Factors
- Soil Constants
- Abiotic Simple Overview
- Abiotic Simple Model
- Abiotic Simple Microclimate
- Abiotic Simple Constants
- Hydrology Overview
- Hydrology Model
- Hydrology Above-ground
- Hydrology Below-ground
- Hydrology Constants
- Animal Overview
- Animal Model
- Animal Communities
- Animal Protocols
- Animal Cohorts
- Animal Functional Groups
- Animal Traits
- Animal Scaling Functions
- Animal Constants
- Animal Decay
- Animal Plant Resources
- Litter Overview
- Litter Model
- Litter Pools
- Litter Constants
- Plants Model
- Plants Structures
-```
-
-```{eval-rst}
-.. toctree::
- :maxdepth: 4
- :caption: Command line tools
+:::
- command_line_tools/ve_run.md
-```
-
-```{eval-rst}
-.. toctree::
- :maxdepth: 4
- :caption: Development
-
- Strategy
- Developer Setup
- Documentation Overview
- Jupyter Notebooks
- Docstring Style
- API Generation
- Core Design
- Adding New Models
-```
-
-```{eval-rst}
-.. toctree::
- :maxdepth: 4
- :caption: Climate data resources
-
- Overview climate data
- Copernicus climate data store
-```
-
-```{eval-rst}
-.. toctree::
- :maxdepth: 0
- :caption: Bibliography
-
- bibliography.md
-```
+::::
diff --git a/docs/source/modindex.md b/docs/source/modindex.md
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/source/refs.bib b/docs/source/refs.bib
index d0dd1174e..7cffe25e9 100644
--- a/docs/source/refs.bib
+++ b/docs/source/refs.bib
@@ -1,3 +1,104 @@
+
+@article{geary_guide_2020,
+author = {Geary, William and Bode, Michael and Doherty, Tim and Fulton, Elizabeth and Nimmo, Dale and Tulloch, Ayesha and Tulloch, Vivitskaia and Ritchie, Euan},
+year = {2020},
+month = {09},
+pages = {},
+title = {A guide to ecosystem models and their environmental applications},
+volume = {4},
+journal = {Nature ecology & evolution},
+doi = {10.1038/s41559-020-01298-8}
+}
+
+@article{best_joint_2011,
+ title={The Joint UK Land Environment Simulator (JULES), model description--Part 1: energy and water fluxes},
+ author={Best, Martin J and Pryor, M and Clark, DB and Rooney, Gabriel G and Essery, R and M{\'e}nard, CB and Edwards, JM and Hendry, MA and Porson, A and Gedney, N and others},
+ journal={Geoscientific Model Development},
+ volume={4},
+ number={3},
+ pages={677--699},
+ year={2011},
+ publisher={Copernicus GmbH}
+}
+
+@article{clark_joint_2011,
+ title={The Joint UK Land Environment Simulator (JULES), model description--Part 2: carbon fluxes and vegetation dynamics},
+ author={Clark, DB and Mercado, LM and Sitch, S and Jones, CD and Gedney, N and Best, MJ and Pryor, M and Rooney, GG and Essery, RLH and Blyth, E and others},
+ journal={Geoscientific Model Development},
+ volume={4},
+ number={3},
+ pages={701--722},
+ year={2011},
+ publisher={Copernicus GmbH}
+}
+
+@article{singh_hydrologic_2018,
+author={Singh, Vijay P.},
+title = {Hydrologic modeling: progress and future directions},
+journal = {Geoscience Letters},
+volume = {5},
+number = {15},
+doi = {10.1186/s40562-018-0113-z},
+url = {https://doi.org/10.1186/s40562-018-0113-z},
+year = {2018}
+}
+
+@article{kemppinen_microclimate_2024,
+author = {Kemppinen, Julia and Lembrechts, Jonas J. and Van Meerbeek, Koenraad and Carnicer, Jofre and Chardon, Nathalie Isabelle and Kardol, Paul and Lenoir, Jonathan and Liu, Daijun and Maclean, Ilya and Pergl, Jan and Saccone, Patrick and Senior, Rebecca A. and Shen, Ting and Słowińska, Sandra and Vandvik, Vigdis and von Oppen, Jonathan and Aalto, Juha and Ayalew, Biruk and Bates, Olivia and Bertelsmeier, Cleo and Bertrand, Romain and Beugnon, Rémy and Borderieux, Jeremy and Brůna, Josef and Buckley, Lauren and Bujan, Jelena and Casanova-Katny, Angelica and Christiansen, Ditte Marie and Collart, Flavien and De Lombaerde, Emiel and De Pauw, Karen and Depauw, Leen and Di Musciano, Michele and Díaz Borrego, Raquel and Díaz-Calafat, Joan and Ellis-Soto, Diego and Esteban, Raquel and de Jong, Geerte Fälthammar and Gallois, Elise and Garcia, Maria Begoña and Gillerot, Loïc and Greiser, Caroline and Gril, Eva and Haesen, Stef and Hampe, Arndt and Hedwall, Per-Ola and Hes, Gabriel and Hespanhol, Helena and Hoffrén, Raúl and Hylander, Kristoffer and Jiménez-Alfaro, Borja and Jucker, Tommaso and Klinges, David and Kolstela, Joonas and Kopecký, Martin and Kovács, Bence and Maeda, Eduardo Eiji and Máliš, František and Man, Matěj and Mathiak, Corrie and Meineri, Eric and Naujokaitis-Lewis, Ilona and Nijs, Ivan and Normand, Signe and Nuñez, Martin and Orczewska, Anna and Peña-Aguilera, Pablo and Pincebourde, Sylvain and Plichta, Roman and Quick, Susan and Renault, David and Ricci, Lorenzo and Rissanen, Tuuli and Segura-Hernández, Laura and Selvi, Federico and Serra-Diaz, Josep M. and Soifer, Lydia and Spicher, Fabien and Svenning, Jens-Christian and Tamian, Anouch and Thomaes, Arno and Thoonen, Marijke and Trew, Brittany and Van de Vondel, Stijn and van den Brink, Liesbeth and Vangansbeke, Pieter and Verdonck, Sanne and Vitkova, Michaela and Vives-Ingla, Maria and von Schmalensee, Loke and Wang, Runxi and Wild, Jan and Williamson, Joseph and Zellweger, Florian and Zhou, Xiaqu and Zuza, Emmanuel Junior and De Frenne, Pieter},
+title = {Microclimate, an important part of ecology and biogeography},
+journal = {Global Ecology and Biogeography},
+volume = {33},
+number = {6},
+pages = {e13834},
+keywords = {animal ecology, biodiversity, biogeography, climate change, data acquisition, ecosystem management, microclimate, modelling, plant ecology},
+doi = {https://doi.org/10.1111/geb.13834},
+url = {https://onlinelibrary.wiley.com/doi/abs/10.1111/geb.13834},
+eprint = {https://onlinelibrary.wiley.com/doi/pdf/10.1111/geb.13834},
+note = {e13834 GEB-2023-0294.R2},
+year = {2024}
+}
+
+
+@incollection{bramer_chapter_2018,
+title = {Chapter Three - Advances in Monitoring and Modelling Climate at Ecologically Relevant Scales},
+editor = {David A. Bohan and Alex J. Dumbrell and Guy Woodward and Michelle Jackson},
+series = {Advances in Ecological Research},
+publisher = {Academic Press},
+volume = {58},
+pages = {101-161},
+year = {2018},
+booktitle = {Next Generation Biomonitoring: Part 1},
+issn = {0065-2504},
+doi = {https://doi.org/10.1016/bs.aecr.2017.12.005},
+url = {https://www.sciencedirect.com/science/article/pii/S0065250417300302},
+author = {Isobel Bramer and Barbara J. Anderson and Jonathan Bennie and Andrew J. Bladon and Pieter {De Frenne} and Deborah Hemming and Ross A. Hill and Michael R. Kearney and Christian Körner and Amanda H. Korstjens and Jonathan Lenoir and Ilya M.D. Maclean and Christopher D. Marsh and Michael D. Morecroft and Ralf Ohlemüller and Helen D. Slater and Andrew J. Suggitt and Florian Zellweger and Phillipa K. Gillingham},
+keywords = {Climate modelling, Habitat heterogeneity, Microclimate, Microsensors, Meteorological, Small scale, Topoclimate},
+}
+@unpublished{ewers_new_2024,
+ title = {New insights to be gained from a Virtual Ecosystem},
+ author = {Ewers, Robert M. Mark and Cook, Jacob and Daniel, Olivia and Orme, David and Groner, Vivienne and Joshi, Jaideep and Rallings, Anna and Rallings, Taran and Amarasekare, Priyanga},
+ journal = {EcoEvoRxiv},
+ year = {2024},
+ doi = {https://doi.org/10.32942/X26W5B},
+ note = {},
+}
+
+@book{campbell_introduction_2012,
+ title = {An introduction to environmental biophysics},
+ publisher = {Springer Science {\textbackslash}\& Business Media},
+ author = {Campbell, Gaylon S and Norman, John},
+ year = {2012},
+}
+
+@phdthesis{wilson_role_2020,
+ address = {Leeds, United Kingdom},
+ type = {{PhD} {Thesis}},
+ title = {The role of surface albedo changes in tropical forest loss and its climate impact},
+ school = {University of Leeds, School of Earth and Environment},
+ author = {Wilson, J. M.},
+ year = {2020},
+}
+
@article{porporato_hydrologic_2003,
title = {Hydrologic controls on soil carbon and nitrogen cycles. {I}. {Modeling} scheme},
volume = {26},
@@ -8,7 +109,7 @@ @article{porporato_hydrologic_2003
number = {1},
urldate = {2023-11-14},
journal = {Advances in Water Resources},
- author = {Porporato, A and D’Odorico, P and Laio, F and Rodriguez-Iturbe, I},
+ author = {Porporato, A and D'Odorico, P and Laio, F and Rodriguez-Iturbe, I},
month = jan,
year = {2003},
pages = {45--58},
@@ -32,6 +133,27 @@ @article{orwin_organic_2011
}
+@article{yasuda_turbulent_1988,
+ title = {Turbulent diffusivity and diurnal variations in the atmospheric boundary layer.},
+ volume = {43},
+ doi = {https://doi.org/10.1007/BF00128403},
+ journal = {Boundary-layer meteorology},
+ author = {Yasuda, N.},
+ year = {1988},
+ pages = {209--221},
+}
+
+@article{henderson-sellers_new_1984,
+ title = {A new formula for latent heat of vaporization of water as a function of temperature},
+ volume = {110},
+ doi = {https://doi.org/10.1002/qj.49711046626},
+ number = {466},
+ journal = {Quarterly Journal of the Royal Meteorological Society},
+ author = {Henderson-Sellers, B.},
+ year = {1984},
+ pages = {1186--1190},
+}
+
@book{monteith_light_1969,
address = {Madison, Wisconsin, U.S.A.},
series = {Physiological aspects of crop yield},
@@ -670,3 +792,51 @@ @article{linacre_estimating_1968
year = {1968},
pages = {49--63},
}
+
+@article{parton_dynamics_1988,
+ title = {Dynamics of {C}, {N}, {P} and {S} in grassland soils: a model},
+ volume = {5},
+ copyright = {http://www.springer.com/tdm},
+ issn = {0168-2563, 1573-515X},
+ shorttitle = {Dynamics of {C}, {N}, {P} and {S} in grassland soils},
+ url = {http://link.springer.com/10.1007/BF02180320},
+ doi = {10.1007/BF02180320},
+ language = {en},
+ number = {1},
+ urldate = {2024-07-03},
+ journal = {Biogeochemistry},
+ author = {Parton, W. J. and Stewart, J. W. B. and Cole, C. V.},
+ month = feb,
+ year = {1988},
+ pages = {109--131},
+}
+
+@article{krinner_dynamic_2005,
+ title = {A dynamic global vegetation model for studies of the coupled atmosphere‐biosphere system},
+ volume = {19},
+ copyright = {http://onlinelibrary.wiley.com/termsAndConditions\#vor},
+ issn = {0886-6236, 1944-9224},
+ url = {https://agupubs.onlinelibrary.wiley.com/doi/10.1029/2003GB002199},
+ doi = {10.1029/2003GB002199},
+ language = {en},
+ number = {1},
+ urldate = {2024-07-03},
+ journal = {Global Biogeochemical Cycles},
+ author = {Krinner, G. and Viovy, Nicolas and De Noblet‐Ducoudré, Nathalie and Ogée, Jérôme and Polcher, Jan and Friedlingstein, Pierre and Ciais, Philippe and Sitch, Stephen and Prentice, I. Colin},
+ month = mar,
+ year = {2005},
+ pages = {2003GB002199},
+}
+
+@article{harfoot_madingley_2014,
+ title={Emergent Global Patterns of Ecosystem Structure and Function from a Mechanistic General Ecosystem Model},
+ author={Harfoot, Michael B. J. and Newbold, Tim and Tittensor, Derek P. and Emmott, Stephen and Hutton, Jon and Lyutsarev, Vassily and Smith, Matthew J. and Scharlemann, J{\"o}rn P. W. and Purves, Drew W.},
+ journal={PLOS Biology},
+ volume={12},
+ number={4},
+ pages={e1001841},
+ year={2014},
+ publisher={Public Library of Science},
+ doi={10.1371/journal.pbio.1001841},
+ url={https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1001841}
+}
\ No newline at end of file
diff --git a/docs/source/virtual_ecosystem/core/axes.md b/docs/source/using_the_ve/configuration/axes.md
similarity index 98%
rename from docs/source/virtual_ecosystem/core/axes.md
rename to docs/source/using_the_ve/configuration/axes.md
index 6636a016e..f0bd53c4d 100644
--- a/docs/source/virtual_ecosystem/core/axes.md
+++ b/docs/source/using_the_ve/configuration/axes.md
@@ -8,9 +8,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# Core axes
diff --git a/docs/source/virtual_ecosystem/core/config.md b/docs/source/using_the_ve/configuration/config.md
similarity index 98%
rename from docs/source/virtual_ecosystem/core/config.md
rename to docs/source/using_the_ve/configuration/config.md
index 6c2eff04c..3defbd6f5 100644
--- a/docs/source/virtual_ecosystem/core/config.md
+++ b/docs/source/using_the_ve/configuration/config.md
@@ -9,6 +9,12 @@ set of [`JSON Schema`](https://json-schema.org). If this passes, a combined outp
saved as a permanent record of the model configuration. This configuration is also saved
as a dictionary accessible to other modules and scripts.
+::::{dropdown} An example configuration file
+:::{literalinclude} ../../_static/vr_full_model_configuration.toml
+:language: toml
+:::
+::::
+
## Configuration files
We decided to use `toml` as our configuration file format because it is: easily human
diff --git a/docs/source/virtual_ecosystem/constants.md b/docs/source/using_the_ve/configuration/constants.md
similarity index 91%
rename from docs/source/virtual_ecosystem/constants.md
rename to docs/source/using_the_ve/configuration/constants.md
index c01ed328d..e8249dbd9 100644
--- a/docs/source/virtual_ecosystem/constants.md
+++ b/docs/source/using_the_ve/configuration/constants.md
@@ -15,7 +15,7 @@ is fine to use different values for them across different simulations.
## Using non-default values for constants
If you want to use a non-default value for a constant this can be accomplished using the
-[configuration system](core/config.md). The configuration for each specific model
+[configuration system](./config.md). The configuration for each specific model
contains a `constants` section. Within this section constants are grouped based on the
name of the data class they belong to. An example of this can be seen below:
@@ -29,4 +29,4 @@ Any values supplied in this way will be used to override the default values for
class in question. Only constants for which non-default values are supplied will be
replaced. Anything that is not included within the configuration will just take the
default value, which is set in the data class (see
-[here](../development/defining_new_models.md) for further details).
+[here](../../development/design/defining_new_models.md) for further details).
diff --git a/docs/source/virtual_ecosystem/core/grid.md b/docs/source/using_the_ve/configuration/grid.md
similarity index 99%
rename from docs/source/virtual_ecosystem/core/grid.md
rename to docs/source/using_the_ve/configuration/grid.md
index 5850021f7..2af73f4f8 100644
--- a/docs/source/virtual_ecosystem/core/grid.md
+++ b/docs/source/using_the_ve/configuration/grid.md
@@ -8,9 +8,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# The `core.grid` module
diff --git a/docs/source/virtual_ecosystem/core/data.md b/docs/source/using_the_ve/data/data.md
similarity index 97%
rename from docs/source/virtual_ecosystem/core/data.md
rename to docs/source/using_the_ve/data/data.md
index abd85e4d4..170255b66 100644
--- a/docs/source/virtual_ecosystem/core/data.md
+++ b/docs/source/using_the_ve/data/data.md
@@ -8,9 +8,9 @@ jupytext:
format_version: 0.13
jupytext_version: 1.13.8
kernelspec:
- display_name: vr_python3
+ display_name: Python 3 (ipykernel)
language: python
- name: vr_python3
+ name: python3
---
# Adding and using data with the Virtual Ecosystem
@@ -59,7 +59,7 @@ simulation. Validators may also standardise or subset input datasets to map them
particular axis configuration.
For more details on the different core axes and the alternative mappings applied by
-validators see the [core axis](axes.md) documentation.
+validators see the [core axis](../configuration/axes.md) documentation.
## Creating a `Data` instance
@@ -148,8 +148,8 @@ A variable can be accessed from the `data` object using the variable name as a k
the data is returned as an :class:`xarray.DataArray` object.
Note that the `x` and `y` coordinates have been mapped onto the internal `cell_id`
-dimension used to label the different grid cells (see the [Grid](./grid.md)
-documentation for details).
+dimension used to label the different grid cells (see the
+[Grid](../configuration/grid.md) documentation for details).
```{code-cell}
# Get the temperature data
diff --git a/docs/source/using_the_ve/data/notes_preprocessing.md b/docs/source/using_the_ve/data/notes_preprocessing.md
new file mode 100644
index 000000000..8d549b628
--- /dev/null
+++ b/docs/source/using_the_ve/data/notes_preprocessing.md
@@ -0,0 +1,38 @@
+# Notes on climate data pre-processing
+
+The atmospheric variables from regional climate models, observations, or reanalysis are
+typically provided in spatial resolutions that are much coarser than the
+requirements of the Virtual Ecosystem, and follow different naming and unit conventions.
+Please check the following:
+
+* **Does the input climate data match the model grid?**
+
+ This match is necessary for the model to run and to have the effects of topography and
+ elevation incorporated that we described in the
+ [theory section](../../virtual_ecosystem/theory/microclimate_theory.md#factors-affecting-microclimate).
+ This spatial downscaling step is not included in the Virtual Ecosystem.
+
+* **What is the reference height?**
+
+ Different data sources provide data at
+ different vertical levels and with different underlying assumptions, which lead to
+ biases in the model output. For example, the reference height can be 1.5 m or 2 m, above
+ ground or above the canopy, measured or interpolated. In the Virtual Ecosystem, the
+ reference height is assumed to be 2 m above the top of the canopy (2 m above the
+ ground in absence of vegetation).
+
+* **What are the expected units?**
+
+ Make sure that the units of the required input variables match those of the required
+ variables in the table above, e.g temperatures in Celsius, pressure in kPa, etc.
+
+* **What are the variables names?**
+
+ Check the input data variable names match the Virtual Ecosystem naming convention
+ as listed in the table above.
+
+We have used a simple pre-processing script to create the climate data used in
+the [example data](../../using_the_ve/example_data.md) from ERA5-Land monthly averaged
+data, downloaded from the Copernicus Climate Data Store
+[here](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-land-monthly-means?tab=overview).
+The code is available [here](../../using_the_ve/example_data.md#climate-data).
diff --git a/docs/source/virtual_ecosystem/example_data.md b/docs/source/using_the_ve/example_data.md
similarity index 90%
rename from docs/source/virtual_ecosystem/example_data.md
rename to docs/source/using_the_ve/example_data.md
index c2f0cc488..8520b8cbb 100644
--- a/docs/source/virtual_ecosystem/example_data.md
+++ b/docs/source/using_the_ve/example_data.md
@@ -1,9 +1,9 @@
# Virtual Ecosystem example data
Example data is included with Virtual Ecosystem to provide an introduction to the file
-formats and configuration. Using this data is described in the [usage](./usage.md)
-documentation and this page describes the structure and contents of the example data
-folder.
+formats and configuration. Using this data is described in the [getting
+started](./getting_started.md) page - this page describes the structure and contents of
+the example data folder.
It might be useful to install the `ve_example` directory to a location of your choice
when reading these notes, using the command shown below, but the contents of the key
@@ -54,7 +54,7 @@ The example configuration files are:
````
* The **`animal_functional_groups.toml`** file provides basic configuration for the
- `animals` model to set functional group definitions.
+ `animal` model to set functional group definitions.
````{admonition} config/animal_functional_groups.toml
:class: dropdown
@@ -168,8 +168,21 @@ The `example_climate_data.nc` file provides:
The dummy climate data for the example simulation is based on monthly ERA5-Land data
which can be downloaded from the [Copernicus climate data store](https://cds.climate.copernicus.eu/cdsapp#!/dataset/reanalysis-era5-single-levels-monthly-means?tab=overview).
-See the [climate data recipes page](../data_recipes/climate_data_recipes.md) for more
-details.
+
+Metadata:
+
+* Muñoz-Sabater,J. et al: ERA5-Land: A state-of-the-art global reanalysis dataset for
+ land applications, Earth Syst. Sci. Data,13, 4349-4383, 2021.
+ [https://doi.org/10.5194/essd-13-4349-2021](https://doi.org/10.5194/essd-13-4349-2021)
+* Product type: Monthly averaged reanalysis
+* Variable: 2m dewpoint temperature, 2m temperature, Surface pressure, Total
+ precipitation
+* Year: 2013, 2014
+* Month: January, February, March, April, May, June, July, August, September, October,
+ November, December
+* Time: 00:00
+* Sub-region extraction: North 6°, West 116°, South 4°, East 118°
+* Format: NetCDF3
### Hydrology data
@@ -246,7 +259,8 @@ The `example_soil_data.nc` file provides:
This code creates a set of plausible values for which the
{mod}`~virtual_ecosystem.models.soil.soil_model` absolutely has to function sensibly
-for. Descriptions of the soil pools can be found [here](./soil/soil_details.md).
+for. Descriptions of the soil pools can be found
+[here](../virtual_ecosystem/theory/soil_theory.md).
````{admonition} soil_example_data.py
:class: dropdown
@@ -299,7 +313,7 @@ The `example_litter_data.nc` file provides:
The generation script creates a set of plausible values for which the {mod}`~virtual_ecosystem.models.litter.litter_model`
absolutely has to function sensibly for.
-Descriptions of the litter pools can be found [here](./soil/soil_details.md).
+Descriptions of the litter pools can be found [here](../virtual_ecosystem/theory/soil_theory.md).
````{admonition} litter_example_data.py
:class: dropdown
diff --git a/docs/source/using_the_ve/getting_started.md b/docs/source/using_the_ve/getting_started.md
new file mode 100644
index 000000000..e157a9faf
--- /dev/null
+++ b/docs/source/using_the_ve/getting_started.md
@@ -0,0 +1,48 @@
+# Getting started
+
+## Installing the Virtual Ecosystem model
+
+For most users the best way to get started with the Virtual Ecosystem package is to
+[install Python](https://www.python.org/downloads/) and then install the Virtual
+Ecosystem using the `pip` package installer.
+
+```sh
+pip install virtual-ecosystem
+```
+
+This will always install the most recent release of the Virtual Ecosystem model. Note
+that the package is still being developed so these are currently early development (or
+'alpha') releases, so the package details may change rapidly.
+
+If you are more interested in playing around with the development of the model, then you
+will need to follow the [overview of the code contribution
+process]../development/contributing/overivew.md), which covers the installation of the
+tools required for code development, testing and building documentation.
+
+## Running an example Virtual Ecosystem simulation
+
+Some example data is included with Virtual Ecosystem to provide an introduction to the
+file formats and configuration. To try Virtual Ecosystem using this example data, you
+first need to install the data to a location of your choice. The command below will
+create the `ve_example` directory at the location you choose and install all of the
+configuration and data files to run a model.
+
+```shell
+ve_run --install-example /path/
+```
+
+You can then run the model itself:
+
+```shell
+ve_run /path/ve_example/config \
+ --outpath /path/ve_example/config/out \
+ --logfile /path/ve_example/out/ve_example.log
+```
+
+The [Virtual Ecosystem in use](virtual_ecosystem_in_use.md) page provides a walkthrough
+of this process, showing the typical outputs of the model run process, and also provides
+some simple plots of model inputs and ouputs.
+
+Once you want to start digging into the structure of the model and inputs, the [example
+data](./example_data.md) pages provides a detailed description of the contents of the
+`ve_example` directory.
diff --git a/docs/source/command_line_tools/ve_run.md b/docs/source/using_the_ve/ve_run.md
similarity index 100%
rename from docs/source/command_line_tools/ve_run.md
rename to docs/source/using_the_ve/ve_run.md
diff --git a/docs/source/using_the_ve/virtual_ecosystem_in_use.md b/docs/source/using_the_ve/virtual_ecosystem_in_use.md
new file mode 100644
index 000000000..14841c286
--- /dev/null
+++ b/docs/source/using_the_ve/virtual_ecosystem_in_use.md
@@ -0,0 +1,299 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# Using the Virtual Ecosystem
+
+The code below is a brief demonstration of the Virtual Ecosystem model in operation.
+The workflow of the model is:
+
+## Create the model configuration and initial data
+
+Here we are using the example data supplied with the `virtual_ecosystem`
+package, which supplies a set of example data files and a simple model configuration
+to run a simulation. The following command line arguments set up the example data
+directory in Linux, Mac or Windows Subsystem for Linux (WSL).
+
+```{code-cell} ipython3
+import pathlib
+
+import matplotlib.pyplot as plt
+import matplotlib.dates as mdates
+import numpy as np
+import xarray
+```
+
+```{code-cell} ipython3
+:tags: [remove-cell]
+
+%%bash
+# Remove any existing VE data directory in the /tmp/ directory
+if [ -d /tmp/ve_example ]; then
+ rm -r /tmp/ve_example
+fi
+```
+
+```{code-cell} ipython3
+%%bash
+# Install the example data directory from the Virtual Ecosystem package
+ve_run --install-example /tmp/
+```
+
+The `ve_example` directory contains the following files:
+
+* the `config` directory of TOML format configuration files,
+* the `data` and `source` directories of netCDF format data files,
+* the `generation_scripts` directory containing example recipes for generating files, and
+* the `out` directory, which will be used to store model outputs.
+
+```{code-cell} ipython3
+# Get a generator of files in the example directory
+example_files = (p for p in pathlib.Path("/tmp/ve_example/").rglob("*") if p.is_file())
+
+# Print the relative paths of files
+for file in example_files:
+ print(file.relative_to("/tmp/ve_example"))
+```
+
+## Run the Virtual Ecosystem model
+
+Now the example data and configuration have been set up, the `ve_run` command can be
+used to execute a Virtual Ecosystem simulation. The `progress` option shows the progress
+of the simulation through the various modelling stages.
+
+```{code-cell} ipython3
+%%bash
+ve_run /tmp/ve_example/config \
+ --out /tmp/ve_example/out \
+ --logfile /tmp/ve_example/out/logfile.log \
+ --progress \
+```
+
+The log file is very long and shows the process of running the model. The code below
+shows the start and end lines from the log to give and idea of what it contains.
+
+```{code-cell} ipython3
+# Open and read the log
+with open("/tmp/ve_example/out/logfile.log") as log:
+ log_entries = log.readlines()
+
+# Print the first lines
+for entry in log_entries[:6]:
+ print(entry.strip())
+
+print("...")
+
+# Print the last lines
+for entry in log_entries[-5:]:
+ print(entry.strip())
+```
+
+## Looking at the results
+
+The Virtual Ecosystem writes out a number of data files:
+
+* `initial_state.nc`: A single compiled file of the initial input data.
+* `all_continuous_data.nc`: An optional record of time series data of the variables
+ updated at each time step.
+* `final_state.nc`: The model data state at the end of the final step.
+
+These files are written to the standard NetCDF data file format.
+
+```{code-cell} ipython3
+# Load the generated data files
+initial_state = xarray.load_dataset("/tmp/ve_example/out/initial_state.nc")
+continuous_data = xarray.load_dataset("/tmp/ve_example/out/all_continuous_data.nc")
+final_state = xarray.load_dataset("/tmp/ve_example/out/final_state.nc")
+```
+
+### Initial state and input data
+
+The `initial_state.nc` file contains all of the data required to run the model. For some
+variables - such as elevation and soil pH - this just provides the initial or constant
+values across the grid cells to be calculated. Other variables - such as precipitation
+and temperature - provide a time series of data at a reference height above the canopy
+that are used to that drive (or force) the behaviour of the model through time.
+
+```{code-cell} ipython3
+extent = [
+ float(initial_state.x.min()),
+ float(initial_state.x.max()),
+ float(initial_state.y.min()),
+ float(initial_state.y.max()),
+]
+
+# Make two side by side plots
+fig, (ax1, ax2) = plt.subplots(ncols=2, figsize=(10, 5))
+
+# Elevation
+im1 = ax1.imshow(initial_state["elevation"].to_numpy().reshape((9, 9)), extent=extent)
+ax1.set_title("Elevation (m)")
+fig.colorbar(im1, ax=ax1, shrink=0.7)
+
+# Initial soil carbon
+im2 = ax2.imshow(initial_state["pH"].to_numpy().reshape((9, 9)), extent=extent)
+ax2.set_title("Soil pH (-)")
+fig.colorbar(im2, ax=ax2, shrink=0.7)
+
+plt.tight_layout();
+```
+
+For some variables, it may be useful to visualise spatial structure in 3 dimensions.
+The obvious candidate is elevation.
+
+```{code-cell} ipython3
+# Extract the elevation data for a 3D plot
+top = initial_state["elevation"].to_numpy()
+x = continuous_data["x"].to_numpy()
+y = continuous_data["y"].to_numpy()
+bottom = np.zeros_like(top)
+width = depth = 90
+```
+
+```{code-cell} ipython3
+# Make a 3D barplot of the elevation
+fig = plt.figure(figsize=(10, 8))
+ax = fig.add_subplot(projection="3d")
+colors = plt.cm.turbo(top.flatten() / float(top.max()))
+
+poly = ax.bar3d(x, y, bottom, width, depth, top, shade=True, color=colors)
+ax.set_title("Elevation (m)")
+
+cell_bounds = range(0, 811, 90)
+ax.set_xticks(cell_bounds)
+ax.set_yticks(cell_bounds);
+```
+
+For other variables, such as air temperature and precipitation, the initial data
+also provides time series data at reference height that are used to force the
+simulation across the configured time period.
+
+```{code-cell} ipython3
+initial_state
+```
+
+```{code-cell} ipython3
+# Make two side by side plots
+fig, (ax1, ax2) = plt.subplots(ncols=2, figsize=(12, 5))
+
+# Air temperature
+ax1.plot(initial_state["time_index"], initial_state["air_temperature_ref"])
+ax1.set_title("Air temperature forcing across grid cells")
+ax1.set_ylabel("Air temperature (°C)")
+ax1.set_xlabel("Time step (months)")
+
+# Precipitation
+ax2.plot(initial_state["time_index"], initial_state["precipitation"])
+ax2.set_title("Precipitation forcing across grid cells")
+ax2.set_ylabel("Total monthly precipitation (mm)")
+ax2.set_xlabel("Time step (months)");
+```
+
+### Model outputs
+
+The continuous data and final state datasets contain variables describing the
+model state through the simulation process. These can be visualised as
+spatial grids, individual time series within grid cells and as the three
+dimensional structure of the vertical layers within the simulation.
+
+#### Spatial data
+
+Using the soil carbon held as **mineral-associated organic matter** as an example:
+
+```{code-cell} ipython3
+# Make three side by side plots
+fig, axes = plt.subplots(ncols=3, figsize=(10, 5))
+
+# Plot start and end MAOM
+val_min = continuous_data["soil_c_pool_maom"].min()
+val_max = continuous_data["soil_c_pool_maom"].max()
+
+# Plot 3 time slices
+for idx, ax in zip([0, 10, 23], axes):
+ im = ax.imshow(
+ continuous_data["soil_c_pool_maom"][idx, :].to_numpy().reshape((9, 9)),
+ extent=extent,
+ vmax=val_max,
+ vmin=val_min,
+ )
+ ax.set_title(f"Time step: {idx}")
+
+fig.colorbar(im, ax=axes, orientation="vertical", shrink=0.5)
+plt.suptitle("Soil carbon: mineral-associated organic matter", y=0.78, x=0.45);
+```
+
+#### Temporal data
+
+The plot below shows the **mineral-associated organic matter** data as a time series
+showing the values in each cell across time.
+
+```{code-cell} ipython3
+plt.plot(continuous_data["time_index"], continuous_data["soil_c_pool_maom"])
+plt.xlabel("Time step")
+plt.ylabel("Soil carbon as MAOM");
+```
+
+#### Vertical structure
+
+The Virtual Ecosystem creates a vertical dimension that is used to record canopy
+heights and soil depths across the grid.
+
+```{code-cell} ipython3
+# Extract the x and y location of the grid cell centres and layer heights
+# for all observations at a given time step.
+time_index = 0
+
+x_3d = (
+ continuous_data["x"]
+ .broadcast_like(continuous_data["layer_heights"][time_index])
+ .to_numpy()
+ .flatten()
+ + 45
+)
+y_3d = (
+ continuous_data["y"]
+ .broadcast_like(continuous_data["layer_heights"][time_index])
+ .to_numpy()
+ .flatten()
+ + 45
+)
+z_3d = continuous_data["layer_heights"][time_index].to_numpy().flatten()
+
+# Extract the air temperature for those points to colour the 3D data.
+temp_vals = continuous_data["air_temperature"][time_index].to_numpy().flatten()
+```
+
+```{code-cell} ipython3
+# Generate a 3 dimensional plot of layer heights showing temperature.
+
+fig = plt.figure(figsize=(10, 8))
+ax = fig.add_subplot(projection="3d")
+
+cmap = plt.get_cmap("turbo")
+paths = ax.scatter(x_3d, y_3d, z_3d, c=temp_vals, cmap=cmap)
+fig.colorbar(
+ paths,
+ ax=ax,
+ orientation="vertical",
+ shrink=0.6,
+ label="Air temperature (°C)",
+ pad=0.1,
+)
+
+ax.set_xlabel("Easting (m)")
+ax.set_ylabel("Northing (m)")
+ax.set_zlabel("Layer height (m)")
+
+ax.set_xticks(cell_bounds)
+ax.set_yticks(cell_bounds);
+```
diff --git a/docs/source/virtual_ecosystem/implementation/abiotic_implementation.md b/docs/source/virtual_ecosystem/implementation/abiotic_implementation.md
new file mode 100644
index 000000000..b808bc677
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/abiotic_implementation.md
@@ -0,0 +1,254 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# The abiotic model implementation
+
+```{warning}
+The process-based abiotic model is still under development and currently not available
+for Virtual Ecosystem simulations with `ve_run`. This page provides a brief summary of
+the current status and the directions in which we aim to take the model development
+forward.
+```
+
+## Required variables
+
+The tables below show the variables that are required to initialise the abiotic model
+and then update it at each time step. Please check also the
+[notes on climate data pre-processing](../../using_the_ve/data/notes_preprocessing.md).
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+from IPython.display import display_markdown
+from var_generator import generate_variable_table
+
+display_markdown(
+ generate_variable_table(
+ 'AbioticModel',
+ ['vars_required_for_init', 'vars_required_for_update']
+ ),
+ raw=True
+)
+```
+
+## Model overview
+
+### Radiation
+
+The representation of radiation is currently limited to reflection/absorption of direct
+downward shortwave radiation and the emission of longwave radiation as part of the
+energy balance. Net radiation at the surface $R_N$ is calculated as:
+
+$$R_N = S_0 \cdot (1 - \alpha) - \epsilon_{s} \sigma T^{4}$$
+
+where $S_0$ is the incoming shortwave radiation, $\alpha$ is the albedo of the leaf/soil
+surface, $\epsilon$ is the emissivity of the leaf/surface and $T$ is the temperature of
+the leaf/soil surface.
+
+In the future, we aim to implement a diurnal cycle of incoming radiation including the
+effects of topography on sun angle as well as diffuse radiation.
+
+### Soil energy balance
+
+The ``models.abiotic.soil_energy_balance`` submodule determines the energy balance at
+the surface by calculating how incoming solar radiation that reaches the surface is
+partitioned in sensible, latent, and ground heat flux. The sensible heat flux from the
+soil surface is given by:
+
+$$H_{S} = \frac {\rho_{air} C_{air} (T_{S} - T_{b}^{A})}{r_{A}}$$
+
+where $T_{S}$ is the soil surface temperature, $T_{b}^{A}$ is the
+temperature of the bottom air layer and $r_{A}$ is the aerodynamic resistance
+of the soil surface, given by
+
+$$r_{A} = \frac {C_{S}}{u_{b}}$$
+
+where $u_{b}$ is the wind speed in the bottom air layer and $C_{S}$ is
+the soil surface heat transfer coefficient.
+
+Latent heat flux $\lambda E_S$ is derived by conversion of surface evaporation as
+calculated by the hydrology model, and ground heat flux $G$ is calculated as the residual:
+
+$$G = R_N - H_S - \lambda E_S$$
+
+After the flux partitioning, we determine the soil temperatures at different depths.
+At the moment, this is achieved with linear interpolation between the surface and
+soil temperature at 1 m depth. In the future, we aim for a mechanistic implementation.
+
+### Canopy energy balance
+
+Given that the time increments of the model are an hour or longer,
+we can assume that below-canopy heat and vapour exchange attain steady state and heat
+storage in the canopy does not need to be simulated explicitly
+{cite:p}`maclean_microclimc_2021`.
+(For applications where very fine-temporal resolution data might be needed, heat and
+vapour exchange must be modelled as transient processes, and heat storage by the canopy,
+and the exchange of heat between different layers of the canopy, must be considered
+explicitly, see {cite:t}`maclean_microclimc_2021`. This is currently not implemented.)
+
+Under steady-state, the balance equation for the leaves in each canopy layer is as
+follows (after {cite:t}`maclean_microclimc_2021`):
+
+```{math}
+ & R_{abs} - R_{em} - H - \lambda E \\
+ & = R_{abs} - \epsilon_{s} \sigma T_{L}^{4} - c_{P}g_{Ha}(T_{L} - T_{A})
+ - \lambda g_{v} \frac {e_{L} - e_{A}}{p_{A}} \\
+ & = 0
+```
+
+where $R_{abs}$ is absorbed radiation, $R_{em}$ emitted radiation, $H$
+the sensible heat flux, $\lambda E$ the latent heat flux, $\epsilon_{s}$ the
+emissivity of the leaf, $\sigma$ the Stefan-Boltzmann constant, $T_{L}$ the
+absolute temperature of the leaf, $T_{A}$ the absolute temperature of the air
+surrounding the leaf, $\lambda$ the latent heat of vapourisation of water,
+$e_{L}$ the effective vapour pressure of the leaf, $e_{A}$ the vapour
+pressure of air and $p_{A}$ atmospheric pressure. $g_{Ha}$ is the heat
+conductance between leaf and atmosphere, $g_{v}$ represents the conductance
+for vapour loss from the leaves as a function of the stomatal conductance $g_{c}$.
+
+A challenge in solving this equation is the dependency of latent heat and emitted
+radiation on leaf temperature. We use a linearisation approach to solve the equation for
+leaf temperature and air temperature simultaneously after
+{cite:t}`maclean_microclimc_2021`.
+
+The air temperature surrounding the leaf $T_{A}$ is assumed to be influenced
+by leaf temperature $T_{L}$, soil temperature $T_{0}$, and reference air
+temperature $T_{R}$ as follows:
+
+$$g_{tR} c_{p} (T_{R} - T_{A}) + g_{t0} c_{p} (T_{0} - T_{A}) + g_{L} c_{p} (T_{L} - T_{A})
+= 0$$
+
+where $c_{p}$ is the specific heat of air at constant pressure and
+$g_{tR}$, $g_{t0}$ and $g_{L}$ are conductance from reference
+height, the ground and from the leaf, respectively.
+$g_{L} = 1/(1/g_{HA} + 1/g_{z})$ where $g_{HA}$ is leaf boundary layer
+conductance and $g_{z}$ is the sub-canopy turbulent conductance at the height
+of the leaf over the mean distance between the leaf and the air.
+
+Defining $T_{L} - T_{A}$ as $\Delta T$ and rearranging gives:
+
+$$T_{A} = a_{A} + b_{A} \Delta T_{L}$$
+
+where $a_{A} = \frac{(g_{tR} T_{R} + g_{t0} T_{0})}{(g_{tR} + g_{t0})}$ and
+$b_{A} = \frac{g_{L}}{(g_{tR} + g_{t0})}$ .
+
+The sensible heat flux between the leaf and the air is given by
+
+$$g_{Ha} c_{p} (T_{L} - T_{A}) = b_{H} \Delta T_{L}$$
+
+where $b_{H} = g_{Ha} c_{p}$. The equivalent vapour flux equation is
+
+$$g_{tR}(e_{R} - e_{a}) + g_{t0} (e_{0} - e_{a}) + g_{v} (e_{L} - e_{a}) = 0$$
+
+where $e_{L}$, $e_{A}$, $e_{0}$ and $e_{R}$ are the vapour
+pressure of the leaf, air, soil and air at reference height, respectively, and
+$g_{v}$ is leaf conductance for vapour given by
+$g_{v} = \frac{1}{(\frac{1}{g_{c} + g_{L})}}$ where $g_{c}$ is stomatal
+conductance. Assuming the leaf to be saturated, and approximated by
+$e_{s} [T_{R}]+\Delta_{v} [T_{R}]\Delta T_{L}$ where $\Delta_{v}$ is the
+slope of the saturated pressure curve at temperature $T_{R}$, and rearranging
+gives
+
+$$e_{a} = a_{E} + b_{E} \Delta T_{L}$$
+
+where
+$a_{E} = \frac{(g_{tR} e_{R} + g_{t0} e_{0} + g_{v} e_{s}[T_{R}])}{(g_{tR} + g_{t0} + g_{v})}$
+and $b_{E} = \frac{(\Delta_{V} [T_{R}])}{(g_{tR} + g_{t0} + g_{v})}$.
+
+The latent heat term is given by
+
+$$\lambda E = \frac{\lambda g_{v}}{p_{a}} (e_{L} - e_{A})$$
+
+Substituting $e_{A}$ for its linearized form, again assuming $e_{L}$
+is approximated by $e_{s} [T_{R}]+\Delta_{v} [T_{R}]\Delta T_{L}$, and
+rearranging gives:
+
+$$\lambda E = a_{L} + b_{L} \Delta T_{L},$$
+
+where $a_{L} = \frac{\lambda g_{v}}{p_{a}} (e_{s} [T_{R}] - a_{E})$ and
+$b_{L} = \frac{\lambda g_{v}}{p_{a}} (\Delta_{V} [T_{R}] - b_{E})$.
+
+The radiation emitted by the leaf $R_{em}$ is given by the Stefan Boltzmann
+law and can be linearised as follows:
+
+$$R_{em} = a_{R} + b_{R} \Delta T_{L}$$
+
+where $a_{R} = \epsilon_{s} \sigma a_{A}^{4}$ and
+$b_{R} = 4 \epsilon_{s} \sigma (a_{A}^{3} b_{A} + T_{R}^{3})$.
+
+The full heat balance equation for the difference between leaf and canopy air
+temperature becomes
+
+$$\Delta T_{L} = \frac{R_{abs} - a_{R} - a_{L}}{(1 + b_{R} + b_{L} + b_{H})}$$
+
+The equation is then used to calculate air and leaf temperature as follows:
+
+$$T_{A} = a_{A} + b_{A} \Delta T_{L}$$
+
+and
+
+$$T_{L} = T_{A} + \Delta T_{L}.$$
+
+### Wind
+
+The wind profile determines the exchange of heat, water, and $\ce{CO_{2}}$ between soil
+and atmosphere below the canopy as well as the exchange with the atmosphere above the canopy.
+
+The wind profile above the canopy is described as follows (based on
+{cite:t}`campbell_introduction_1998` as implemented in {cite:t}`maclean_microclimc_2021`):
+
+$$u_z = \frac{u^{*}}{0.4} ln \frac{z-d}{z_M} + \Psi_M$$
+
+where $u_z$ is wind speed at height $z$ above the canopy, $d$ is
+the height above ground within the canopy where the wind profile extrapolates to
+zero, $z_m$ the roughness length for momentum, $\Psi_M$ is a diabatic
+correction for momentum and $u^{*}$ is the friction velocity, which gives the
+wind speed at height $d + z_m$.
+
+The wind profile below canopy is derived as follows:
+
+$$u_z = u_h \exp(a(\frac{z}{h} - 1))$$
+
+where $u_z$ is wind speed at height $z$ within the canopy, $u_h$
+is wind speed at the top of the canopy at height $h$, and $a$ is a wind
+attenuation coefficient given by $a = 2 l_m i_w$, where $c_d$ is a drag
+coefficient that varies with leaf inclination and shape, $i_w$ is a
+coefficient describing relative turbulence intensity and $l_m$ is the mean
+mixing length, equivalent to the free space between the leaves and stems. For
+details, see {cite:t}`maclean_microclimc_2021`.
+
+## Updated variables
+
+The table below shows the complete set of model variables that are updated at each model
+step.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'AbioticModel',
+ ['vars_updated']
+ ),
+ raw=True
+)
+```
diff --git a/docs/source/virtual_ecosystem/implementation/abiotic_simple_implementation.md b/docs/source/virtual_ecosystem/implementation/abiotic_simple_implementation.md
new file mode 100644
index 000000000..cb34b15c7
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/abiotic_simple_implementation.md
@@ -0,0 +1,156 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# The abiotic simple model implementation
+
+This section walks through the steps in generating and updating the
+[abiotic_simple](virtual_ecosystem.models.abiotic_simple.abiotic_simple_model)
+model which is currently the default abiotic model version in the Virtual Ecosystem
+configuration.
+
+## Required variables
+
+The abiotic_simple model requires a timeseries of the following variables to
+initialise and update the model. Please check also the
+[notes on climate data pre-processing](../../using_the_ve/data/notes_preprocessing.md).
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+from IPython.display import display_markdown
+from var_generator import generate_variable_table
+
+display_markdown(
+ generate_variable_table(
+ 'AbioticSimpleModel',
+ ['vars_required_for_init', 'vars_required_for_update']
+ ),
+ raw=True
+)
+```
+
+## Model overview
+
+The `abiotic_simple` model is a simple regression model that estimates microclimatic
+variables based on empirical relationships between leaf area index (LAI) and atmospheric
+temperature (T), relative humidity (RH), and vapour pressure deficit (VPD) to derive
+logarithmic profiles of these variables from external climate data such as regional
+climate models or satellite observations. The model also provides information on
+atmospheric pressure and $\ce{CO_{2}}$ and soil temperatures at different depths.
+
+This sections describes the workflow of the `abiotic_simple` model update step.
+At each time step when the model updates, the
+{py:meth}`~virtual_ecosystem.models.abiotic_simple.microclimate.run_microclimate`
+function is called to perform the steps outlined below.
+
+### Step 1: Linear regression above ground
+
+The linear regression for below canopy values (1.5 m) is based on
+{cite:t}`hardwick_relationship_2015` as
+
+$$y = m * LAI + c$$
+
+where $y$ is the variable of interest, $m$ is the gradient
+(see {py:class}`~virtual_ecosystem.models.abiotic_simple.constants.AbioticSimpleBounds`)
+and $c$ is the intersect which we set to the external data values,
+see {numref}`abiotic_simple_step1`.
+We assume that the gradient remains constant throughout the simulation.
+
+:::{figure} ../../_static/images/step1.png
+:name: abiotic_simple_step1
+:alt: Abiotic simple step1
+:class: bg-primary
+:width: 450px
+
+Linear regression between leaf area index (LAI) and temperature (T) or
+vapour pressure deficit (VPD) at 1.5 m above the ground. The y-axis is intersected
+at the temperature at reference height. Orange crosses indicate 1.5m and reference height.
+:::
+
+### Step 2: Logarithmic interpolation above ground
+
+The values for any other aboveground heights, including but not limited to
+canopy layers and surface layer, are calculated by logarithmic regression and
+interpolation between the input 2 m above the canopy and the 1.5 m values, see
+{numref}`abiotic_simple_step2`.
+
+:::{figure} ../../_static/images/step2.png
+:name: abiotic_simple_step2
+:alt: Abiotic simple step2
+:class: bg-primary
+:width: 450px
+
+Logarithmic interpolation between temperature (T) or vapour pressure deficit
+(VPD) at 1.5 m and the reference height 2m above the canopy. This approach returns
+values at any height of interest. Orange crosses indicate 1.5 m and reference height as
+in {numref}`abiotic_simple_step1`.
+:::
+
+### Step 3: Broadcasting constant atmospheric properties
+
+The model also broadcasts the reference values for atmospheric pressure and
+$\ce{CO2}$ to all atmospheric levels as they are currently assumed to remain constant
+during one time step.
+
+### Step 4: Linear interpolation below ground
+
+Soil temperatures are interpolated between the surface layer and the
+temperature at 1 m depth which approximately equals the mean annual temperature, i.e.
+can assumed to be constant over the year.
+
+## Generated variables
+
+When the abiotic simple model initialises, it uses the input data to populate the following
+variables. When the model first updates, it then sets further variables.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'AbioticSimpleModel',
+ ['vars_populated_by_init', 'vars_populated_by_first_update']
+ ),
+ raw=True
+)
+```
+
+## Updated variables
+
+The table below shows the complete set of model variables that are updated at each model
+step.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'AbioticSimpleModel',
+ ['vars_updated']
+ ),
+ raw=True
+)
+```
diff --git a/docs/source/virtual_ecosystem/implementation/animal_implementation.md b/docs/source/virtual_ecosystem/implementation/animal_implementation.md
new file mode 100644
index 000000000..42ff1f90a
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/animal_implementation.md
@@ -0,0 +1,2 @@
+
+# The Animal Model implementation
diff --git a/docs/source/virtual_ecosystem/implementation/core_components_overview.md b/docs/source/virtual_ecosystem/implementation/core_components_overview.md
new file mode 100644
index 000000000..43aa7ce28
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/core_components_overview.md
@@ -0,0 +1,92 @@
+
+# Implementation of the core components
+
+The first stages in a simulation are the configuration and initialisation of the core
+components.
+
+## The configuration
+
+The model core and each science model has a set of configuration options that set how
+the simulation is set up and how the science models run. These configuration options are
+defined by **model schema files** that:
+
+* document the required elements for configuring the core system or model,
+* provide any default values, and
+* implement basic validation.
+
+When a simulation starts, the Virtual Ecosystem:
+
+* Loads the user-provided configuration files and checks the file formats are valid.
+* Collates the configuration settings into a single unified configuration.
+* Loads the model schemas for the core and requested science models and uses this to
+ validate the congfiguration.
+* The validation process populates any missing options from the default values.
+* The configuration validation will fail if:
+ * Any options are duplicated within the configuration.
+ * Any configuration settings are not valid, given the rules in the model schema.
+ * Any required fields without defaults are not completed.
+
+Further details can be found in the [configuration
+documentation](../../using_the_ve/configuration/config.md).
+
+## The grid
+
+Next, the spatial structure of the simulation is configured as a [`Grid`
+object](../../using_the_ve/configuration/grid.md) that defines the area, coordinate system
+and geometry of the individual cells that will be used in the simulation. The grid is
+also used to establish grid cell neighbours and connectivity across the spatial domain.
+
+## The vertical layer structure
+
+The vertical layer structure of the Virtual Ecosystem can be configured to change a
+number of elements, including: the maximum number of canopy layers, the number and
+depths of soil layers, and the maximum soil depth for microbial activity. The
+[LayerStructure core component](virtual_ecosystem.core.core_components.LayerStructure)
+resolves these settings into a vertical layer structure and provides the model code
+with indexing to extract particular layers from within vertically structured data (see
+{numref}`fig_layer_structure`).
+
+:::{figure} ../../_static/images/layer_structure.svg
+:name: fig_layer_structure
+:alt: Vertical Layer Structure
+:width: 650px
+
+The vertical layer structure of a Virtual Ecosystem simulation. The main layer structure
+is shown on the left, including variable numbers of filled canopy layers across grid
+cells. The right hand side shows the most commonly used sets of layers within the
+vertical layer structure. (click to zoom).
+:::
+
+## Loading and validation of input data
+
+All of the variables required to initialise and run the simulation are then loaded into
+an internal [`Data` object](../../using_the_ve/data/data.md). The model configuration
+provides the location of the file containing each required variables and the Data object
+is then used to load the data, checking that:
+
+* the input files are valid and can be read, and
+* that the data in files is congruent with the rest of the configuration, such as
+ checking the dimensionality and shape of [core
+ axes](../../using_the_ve/configuration/axes.md) like the spatial grid.
+
+## Simulation timescale
+
+The simulation runs between two dates with an update interval at which each science
+model is recalculated. These values are defined in the `core` configuration and are
+now validated to ensure that the start date, end date and update interval are sensible.
+
+:::{note}
+The calculation of simulation run time is currently not calendar aware and so timing
+uses 12 equal length months and equal length years, ignoring leap years.
+:::
+
+## Core constants
+
+The [core constants](../../api/core/constants.md) contains values that are shared across
+the whole simulation. This includes:
+
+* Global scientific constants, such as the gravitational constant $G$.
+* Simulation constants that are either:
+ * required to configure the core components, such as the maximum depth of biologically
+ active soil, or
+ * used by multiple science models and so are defined in a single location.
diff --git a/docs/source/virtual_ecosystem/implementation/hydrology_implementation.md b/docs/source/virtual_ecosystem/implementation/hydrology_implementation.md
new file mode 100644
index 000000000..17cbb7f3b
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/hydrology_implementation.md
@@ -0,0 +1,428 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# The hydrology model implementation
+
+This section walks through the steps in generating and updating the
+[hydrology](../../../../virtual_ecosystem/models/hydrology/hydrology_model.py)
+model which is part of the default Virtual Ecosystem configuration. The key processes
+are illustrated in {numref}`hydrology`.
+
+The processes [within a grid cell](#within-grid-cell-hydrology) are loosely based
+on the LISFLOOD model {cite}`van_der_knijff_lisflood_2010`. The processes
+[across the model grid](#across-grid-hydrology) are loosely based on
+the [pysheds](https://github.com/mdbartos/pysheds) package.
+
+:::{figure} ../../_static/images/hydrology.svg
+:name: hydrology
+:alt: Hydrology
+:class: bg-primary
+:width: 600px
+
+Hydrology processes in Virtual Ecosystem (click to zoom). Yellow boxes
+represent atmospheric input variables, green box and arrows indicate where water
+enters and leaves the plant model.
+:::
+
+```{note}
+Many of the underlying processes are problematic at a monthly timestep, which is
+currently the only supported update interval. As a short-term work around, the input
+precipitation is randomly distributed over 30 days and input evapotranspiration is
+divided by 30, and the return variables are monthly means or monthly accumulated values.
+```
+
+## Required variables
+
+The tables below show the variables that are required to initialise the hydrology model
+and then update it at each time step.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+from IPython.display import display_markdown
+from var_generator import generate_variable_table
+
+display_markdown(
+ generate_variable_table(
+ 'HydrologyModel',
+ ['vars_required_for_init', 'vars_required_for_update']
+ ),
+ raw=True
+)
+```
+
+The model also requires several parameters that as described in detail in
+{py:class}`~virtual_ecosystem.models.hydrology.constants.HydroConsts`.
+The default values are set for forest ecosystems.
+
+## Within grid cell hydrology
+
+The vertical component of the hydrology model determines the water balance within each
+grid cell. This includes [above ground](../../api/models/hydrology/above_ground.md)
+processes such as rainfall, canopy interception, and surface runoff out of the grid cell.
+The [below ground](../../api/models/hydrology/below_ground.md) component considers
+infiltration, bypass flow, percolation (= vertical flow), soil moisture and matric
+potential, horizontal sub-surface flow out of the grid cell, and changes in
+groundwater storage.
+
+### Canopy interception
+
+Canopy interception is estimated using the following storage-based equation after
+{cite:t}`aston_rainfall_1979` and {cite:t}`merriam_note_1960` as implemented in
+{cite:t}`van_der_knijff_lisflood_2010`:
+
+$$\textrm{Int} = S_{max} \left[1 - \exp\left(\frac{-k \cdot R \cdot \delta t}{S_{max}}\right)\right]$$
+
+where $Int$ (mm) is the interception per time step, $S_{max}$ (mm) is the maximum
+interception, $R$ (mm) is the rainfall intensity per time step and the factor $k$
+accounts for the density of the vegetation.
+
+$S_{max}$ is calculated using an empirical equation
+{cite}`von_hoyningen-huene_interzeption_1981`:
+
+```{math}
+\begin{cases}
+ 0.935 + 0.498 \cdot \text{LAI} - 0.00575 \cdot \text{LAI}^{2}, & \text{LAI} > 0.1 \\
+ 0, & \text{LAI} \le 0.1,
+\end{cases}
+```
+
+where LAI is the average Leaf Area Index (m2 m-2). $k$ is estimated as:
+
+$$k=0.046 \cdot LAI$$
+
+### Water at the surface
+
+Precipitation that reaches the surface is defined as incoming precipitation minus canopy
+interception (throughfall and stemflow are currently not implemented). The water at the
+surface can follow different trajectories: runoff at the surface,
+remain at the surface as searchable resource for animals, return to the atmosphere via
+evaporation, or infiltrate into the soil where it can be taken up by plants or percolate
+to the groundwater.
+
+### Surface Runoff
+
+Surface runoff is calculated with a simple bucket model based on
+{cite:t}`davis_simple_2017`: if precipitation exceeds top soil moisture capacity, the
+excess water is added to runoff and top soil moisture is set to soil
+moisture capacity value; if the top soil is not saturated, precipitation is
+added to the current soil moisture level and runoff is set to zero.
+
+### Searchable resource
+
+Some of the water that land at the surface is stored in depressions as puddles or
+larger standing water that is a searchable resources for animals. This is currently not
+implemented.
+
+### Evaporation
+
+The implementation of soil evaporation is based on classical bulk aerodynamic formulation.
+We use the so-called 'alpha' method to estimate the evaporative flux
+{cite}`mahfouf_comparative_1991` and the implementation by
+{cite:t}`barton_parameterization_1979`:
+
+$$\alpha = \frac{1.8 \cdot \Theta}{\Theta + 0.3}$$
+
+$$E_{g} = \frac{\rho_{air}}{R_{a}} \cdot (\alpha \cdot q_{sat}(T_{s}) - q_{g})$$
+
+where $\Theta$ is the available top soil moisture (relative volumetric water
+content), $E_{g}$ is the evaporation flux (W m-2), $\rho_{air}$ is the
+density of air (kg m-3), $R_{a}$ is the aerodynamic resistance (unitless),
+$q_{sat}(T_{s})$ (unitless) is the saturated specific humidity, and
+$q_{g}$ is the surface specific humidity (unitless).
+
+In a final step, the bare soil evaporation is adjusted to shaded soil evaporation
+{cite:t}`supit_system_1994`:
+
+$$E_{act} = E_{g} \cdot \exp(-\kappa_{gb} \cdot LAI)$$
+
+where $\kappa_{gb}$ is the extinction coefficient for global radiation, and
+$LAI$ is the total leaf area index.
+
+### Infiltration
+
+Infiltration is currently handeled in a very simplistic way: the water that 'fits in the
+topsoil bucket' is added to the topsoil layer. We aim to implement a more realistic
+process that accounts for soil type specific infiltration capacities.
+
+### Bypass flow
+
+Bypass flow is here defined as the flow that bypasses the soil matrix and drains
+directly to the groundwater. During each time step, a fraction of the water that is
+available for infiltration is added to the groundwater directly (i.e. without first
+entering the soil matrix). It is assumed that this fraction is a power function of
+the relative saturation of the superficial and upper soil layers. This results in
+the following equation (after {cite:t}`van_der_knijff_lisflood_2010`):
+
+$$D_{pref, gw} = W_{av} \cdot (\frac{w_{1}}{w_{s1}})^{c_{pref}}$$
+
+$D_{pref, gw}$ is the amount of preferential flow per time step (mm),
+$W_{av}$ is the amount of water that is available for infiltration, and
+$c_{pref}$ is an empirical shape parameter. This parameter affects how much of
+the water available for infiltration goes directly to groundwater via preferential
+bypass flow; a value of 0 means all surface water goes directly to groundwater, a
+value of 1 gives a linear relation between soil moisture and bypass flow.
+The equation returns a preferential flow component that becomes increasingly
+important as the soil gets wetter.
+
+### Vertical flow
+
+To calculate the flow of water through unsaturated soil, we use the Richards equation.
+First, the function calculates the effective saturation $S$ and effective hydraulic
+conductivity $K(S)$ based on the moisture content $\Theta$ using the Mualem-van
+Genuchten model {cite}`van_genuchten_closed-form_1980`:
+
+$$S = \frac{\Theta - \Theta_{r}}{\Theta_{s} - \Theta_{r}}$$
+
+and
+
+$$K(S) = K_{s} \cdot \sqrt{S} \cdot (1-(1-S^{1/m})^{m})^{2}$$
+
+where $\Theta_{r}$ is the residual moisture content,$\Theta_{s}$ is the saturated
+moisture content, $K_{s}$ is the saturated hydraulic conductivity, and $m=1-1/n$ is a
+shape parameter derived from the non-linearity parameter $n$. Then, the function applies
+Darcy's law to calculate the water flow rate $q$ in $\frac{m^3}{s^1}$ considering the
+effective hydraulic conductivity:
+
+$$q = - K(S) \cdot (\frac{dh}{dl}-1)$$
+
+where $\frac{dh}{dl}$ is the hydraulic gradient with $l$ the length of the flow path in
+meters (here equal to the soil depth).
+
+```{note}
+There are severe limitations to this approach on the temporal and spatial scale of this
+model and this can only be treated as a very rough approximation!
+```
+
+### Soil moisture and matrix potential
+
+Soil moisture is updated for each layer by removing the vertical flow
+of the current layer and adding it to the layer below. The implementation is based
+on {cite:t}`van_der_knijff_lisflood_2010`. Additionally, the evapotranspiration is
+removed from the second soil layer.
+
+For some model functionalities, such as plant water uptake and soil microbial activity,
+soil moisture needs to be converted to matric potential. The model provides a coarse
+estimate of soil water potential :$\Psi_{m}$ taken from
+{cite:t}`campbell_simple_1974`:
+
+$$\Psi_{m} = \Psi_{e} \cdot (\frac{\Theta}{\Theta_{s}})^{b}$$
+
+where $\Psi_{e}$ is the air-entry, $\Theta$ is the volumetric water content,
+$\Theta_{s}$ is the saturated water content, and $b$ is the water retention curvature
+parameter.
+
+### Subsurface flow and groundwater storage
+
+Groundwater storage and transport are modelled using two parallel linear reservoirs,
+similar to the approach used in the HBV-96 model
+{cite}`lindstrom_development_1997` and the LISFLOOD
+{cite}`van_der_knijff_lisflood_2010` (see for full documentation).
+
+The upper zone represents a quick runoff component, which includes fast groundwater
+and subsurface flow through macro-pores in the soil. The lower zone represents the
+slow groundwater component that generates the base flow.
+
+The outflow from the upper zone to the channel, $Q_{uz}$, (mm), equals:
+
+$$Q_{uz} = \frac{1}{T_{uz}} \cdot UZ \cdot \Delta t$$
+
+where $T_{uz}$ is the reservoir constant for the upper groundwater layer
+(days), and $UZ$ is the amount of water that is stored in the upper zone (mm).
+The amount of water stored in the upper zone is computed as follows:
+
+$$UZ = D_{ls,gw} + D_{pref,gw} - D{uz,lz}$$
+
+where $D_{ls,gw}$ is the flow from the lower soil layer to groundwater,
+$D_{pref,gw}$ is the amount of preferential flow or bypass flow per time step,
+$D_{uz,lz}$ is the amount of water that percolates from the upper to the lower
+zone, all in (mm).
+
+The water percolates from the upper to the lower zone is the inflow to the lower
+groundwater zone. This amount of water is provided by the upper groundwater zone.
+$D_{uz,lz}$ is a fixed amount per computational time step and it is defined as
+follows:
+
+$$D_{uz,lz} = min(GW_{perc} \cdot \Delta t, UZ)$$
+
+where $GW_{perc}$, [mm day], is the maximum percolation rate from the upper to
+the lower groundwater zone. The outflow from the lower zone to the channel is then
+computed by:
+
+$$Q_{lz} = \frac{1}{T_{lz}} \cdot LZ \cdot \Delta t$$
+
+$T_{lz}$ is the reservoir constant for the lower groundwater layer, (days),
+and $LZ$ is the amount of water that is stored in the lower zone, (mm).
+$LZ$ is computed as follows:
+
+$$LZ = D_{uz,lz} - (GW_{loss} \cdot \Delta t)$$
+
+where $D_{uz,lz}$ is the percolation from the upper groundwater zone, (mm),
+and $GW_{loss}$ is the maximum percolation rate from the lower groundwater
+zone, (mm day-1).
+
+The amount of water defined by $GW_{loss}$ never rejoins the river channel and
+is lost beyond the catchment boundaries or to deep groundwater systems. The larger
+the value of $GW_{loss}$, the larger the amount of water that leaves the system.
+
+## Across grid hydrology
+
+The second part of the hydrology model calculates the horizontal water movement across
+the full model grid including accumulated surface runoff and sub-surface flow, and river
+discharge rate.
+
+The flow direction of water above and below ground is based on a digital elevation model
+which needs to be provided as a NetCDF file at the start of the simulation.
+Here an description of the steps that happen during the hydrology model
+initialisation (plotting only for illustration):
+
+```{code-cell} ipython3
+# # Read elevation datafrom NetCDF
+import numpy as np
+import xarray as xr
+from xarray import DataArray
+
+input_file = "../../../../virtual_ecosystem/example_data/data/example_elevation_data.nc"
+digital_elevation_model = xr.open_dataset(input_file)
+elevation = digital_elevation_model['elevation']
+```
+
+```{code-cell} ipython3
+# Plot the elevation data
+import matplotlib.pyplot as plt
+from matplotlib import colors
+
+plt.figure(figsize=(10, 6))
+elevation.plot(cmap='terrain')
+plt.title('Elevation, m')
+plt.xlabel('x')
+plt.ylabel('y')
+plt.show()
+```
+
+```{code-cell} ipython3
+# Create Grid and Data objects and add elevation data (this happens automatically)
+from virtual_ecosystem.core.grid import Grid
+from virtual_ecosystem.core.data import Data
+
+grid = Grid(grid_type="square", cell_area=8100, cell_nx=9, cell_ny=9, xoff=-45, yoff=-45)
+data = Data(grid=grid)
+data['elevation'] = elevation
+```
+
+The initialisation step of the hydrology model finds all the neighbours for each grid
+cell and determine which neigbour has the lowest elevation. The code below returns the
+neighbours of the grid cell with `cell_id = 56` as an example.
+
+```{code-cell} ipython3
+grid.set_neighbours(distance=100)
+grid.neighbours[56]
+```
+
+Based on that relationship, the model determines all upstream neighbours
+for each grid cell and creates a drainage map, i.e. a dictionary that contains for each
+grid cell all upstream grid cells. For example, `cell_id = 56` has four upstream cells
+with the indices `[47, 56, 57, 65]`.
+
+```{code-cell} ipython3
+from virtual_ecosystem.models.hydrology.above_ground import calculate_drainage_map
+
+drainage_map = calculate_drainage_map(
+ grid=grid,
+ elevation=np.array(data["elevation"]),
+)
+```
+
+The accumulated surface runoff is the calculated in each grid cell as the sum of current
+runoff and the runoff from upstream cells at the previous time step.
+
+```{code-cell} ipython3
+from virtual_ecosystem.models.hydrology.above_ground import accumulate_horizontal_flow
+
+previous_accumulated_runoff = DataArray(np.full(81, 10), dims='cell_id')
+surface_runoff = DataArray(np.full(81, 1), dims='cell_id')
+
+accumulated_runoff = accumulate_horizontal_flow(
+ drainage_map=drainage_map,
+ current_flow=surface_runoff,
+ previous_accumulated_flow=previous_accumulated_runoff,
+)
+
+# Plot accumulated runoff map
+reshaped_data = DataArray(accumulated_runoff.to_numpy().reshape(9,9))
+plt.figure(figsize=(10, 6))
+reshaped_data.plot(cmap='Blues')
+plt.title('Accumulated runoff, mm')
+plt.xlabel('x')
+plt.ylabel('y')
+plt.show()
+```
+
+Total river discharge is calculated as the sum of above- and below ground horizontal
+flow and converted to river discharge rate in m3/s.
+
+```{note}
+The hydrology model requires a spinup period to establish a steady state flow of
+accumulated above and below ground flow - each simulation time step then represents the
+total flow through a grid cell. This is currently not implemented.
+
+To close the water balance, water needs to enter and leave the grid at some point. These
+boundaries are currently not implemented.
+```
+
+## Generated variables
+
+When the hydrology model initialises, it uses the input data to populate the following
+variables. When the model first updates, it then sets further variables.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'HydrologyModel',
+ ['vars_populated_by_init', 'vars_populated_by_first_update']
+ ),
+ raw=True
+)
+```
+
+## Updated variables
+
+The table below shows the complete set of model variables that are updated at each model
+step.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'HydrologyModel',
+ ['vars_updated']
+ ),
+ raw=True
+)
+```
diff --git a/docs/source/virtual_ecosystem/implementation/implementation.md b/docs/source/virtual_ecosystem/implementation/implementation.md
new file mode 100644
index 000000000..1762c9a65
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/implementation.md
@@ -0,0 +1,115 @@
+---
+jupyter:
+ jupytext:
+ text_representation:
+ extension: .md
+ format_name: pandoc
+ format_version: 3.2
+ jupytext_version: 1.16.2
+ kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+ nbformat: 4
+ nbformat_minor: 5
+---
+
+# The implementation of the Virtual Ecosystem
+
+The main workflow of the Virtual Ecosystem ({numref}`fig_simulation_flow`) has the
+following steps:
+
+- Users provide a set of **configuration files** that define how a particular simulation
+ should run.
+- That configuration is validated and compiled into **configuration object** that is
+ shared across the rest of the simulation.
+- The configuration is then used to create several **core components**: the spatial
+ grid, the core constants, the vertical layer structure and the model timing. These
+ components are also shared across the simulation.
+- The configuration also sets the locations of the **initial input data**. These
+ variables are then loaded into the core **data store**, with validation to check that
+ the data are compatible with the model configuration.
+- The configuration also defines a set of **science models** that should be used in the
+ simulation. These are now configured, checking that any configurations settings
+ specific to each science model are valid.
+- The configured models are then **initialised**, checking that the data store contains
+ all required initial data for the model and carrying out any calculations for the
+ initial model state.
+- The system now iterates forward over the configured time steps. At each time step,
+ there is an **update** step for each science model. The model execution order is
+ defined by the set of variables required for each model, to ensure that all required
+ variables are updated before being used.
+
+:::{figure} ../../_static/images/simulation_flow.svg
+:name: fig_simulation_flow
+:alt: Simulation workflow
+:width: 650px
+
+The workflow of a Virtual Ecosystem simulation (click to zoom).
+:::
+
+## Configuration files
+
+The configuration files use the [`TOML`](https://toml.io/en/) format to provide all of
+the details for running a simulation: the spatial layout, the locations of the initial
+input data, everything. See the [configuration
+documentation](../../using_the_ve/configuration/config.md) in the Using the Virtual
+Ecosystem section to find out more.
+
+## Core Components
+
+The Virtual Ecosystem uses several core components to validate and coordinate shared
+configuration settings and to initialise model structures. The components are listed
+below but also see the [core components overview](./core_components_overview.md) for
+more detail:
+
+- The Config object, containing the validated configuration.
+- The Grid object, containing the shared spatial structure of the simulation.
+- The LayerStructure object, which is used to coordinate the vertical structure of the
+ simulation from the top of the canopy down to the lowest soil layer.
+- The CoreConstants object, which is used to provide fixed constant values that are
+ shared across science models. Each model will have a separate model constants object
+ that is used to set model-specific constants.
+- The ModelTiming object, which is used to validate the runtime and update frequency of
+ the simulation.
+- The Data object, which is used to store all of the initial input data along with the
+ variables representing the rest of the model state. This is also used to pass data
+ between the different models.
+
+## Data
+
+The Virtual Ecosystem primarily expects data to be imported from files in [NetCDF
+format](https://www.unidata.ucar.edu/software/netcdf/). This is not the easiest format
+to work with but the datasets in the Virtual Ecosystem are commonly multi-dimensional
+arrays (e.g. space and time), and the NetCDF format supports this kind of data, as well
+as providing critical metadata for data validation.
+
+
+
+The Virtual Ecosystem has a long list of the
+[variables](../../../../virtual_ecosystem/data_variables.toml) that are used to set up
+the simulation and then update the model state through time. The configuration files
+need to provide the locations of the variables required to initialise each science
+model.
+
+## Science models
+
+The science models in the Virtual Ecosystem all share a common framework, which is used
+to coordinate the initialisation and update processes within each model. Each model has
+an implementation page describing the initialisation and update stages and required
+data, but the [science model overview](./science_model_overview.md) page provides a
+quick summary of the models and how they work.
+
+The current suite of science models are:
+
+- the [simple abiotic model](./abiotic_simple_implementation.md),
+- the [process-based abiotic model](./abiotic_implementation.md),
+- the [hydrology model](./hydrology_implementation.md),
+- the [animal model](./animal_implementation.md),
+- the [plants model](./plants_implementation.md),
+- the [soil model](./soil_implementation.md), and
+- the [litter model](./litter_implementation.md).
+
+New models [can be added](../../development/design/defining_new_models.md) to the
+Virtual Ecosystem, although this requires reasonable programming expertise.
diff --git a/docs/source/virtual_ecosystem/implementation/litter_implementation.md b/docs/source/virtual_ecosystem/implementation/litter_implementation.md
new file mode 100644
index 000000000..408606622
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/litter_implementation.md
@@ -0,0 +1 @@
+# The Litter Model implementation
diff --git a/docs/source/virtual_ecosystem/implementation/main_simulation.md b/docs/source/virtual_ecosystem/implementation/main_simulation.md
new file mode 100644
index 000000000..75b3a0dfe
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/main_simulation.md
@@ -0,0 +1,78 @@
+# Virtual Ecosystem simulation flow
+
+:::{warning}
+This section is outdated and is being retained while the information is moved into new
+homes.
+:::
+
+## Model configuration
+
+The loaded configuration should include the configuration details for each individual
+science model. These are now used to initialise each requested model using the
+{meth}`~virtual_ecosystem.core.base_model.BaseModel.from_config` method defined
+for each model. This method checks that the configuration is valid for the science
+model.
+
+## Model setup
+
+Some models require an additional setup step to calculate values for internal variables
+from the initial loaded data or to set up further structures within the model, such as
+representations of plant or animal communities. Each model will run the
+{meth}`~virtual_ecosystem.core.base_model.BaseModel.setup` method defined for the
+specific model. In simple science models, this method may not actually need to do
+anything.
+
+## Model spinup
+
+Some models may then require a spin up step to allow initial variables to reach an
+equilibrium before running the main simulation. Again, each model will run the
+{meth}`~virtual_ecosystem.core.base_model.BaseModel.spinup` method defined for the
+specific model, and again this may not need to do anything for simple models.
+
+## Model update
+
+At this point, the model instance is now ready for simulation. The
+{meth}`~virtual_ecosystem.core.base_model.BaseModel.update` method for each science
+model is run as part of the simulation process described below.
+
+## Simulation process
+
+Now that the simulation core and science models have been configure and initialised,
+along with any setup or spinup steps, the simulation itself starts.
+
+### Saving the initial state
+
+The `data` object has now been populated with all of the configured data required to run
+the model. The simulation configuration can optionally provide a filepath that will be
+used to output a single data file of the initial simulation state.
+
+### Simulation
+
+The science models are now iterated over the configured simulation timescale, running
+from the start time to the end time with a time step set by the update interval. At each
+step all models are updated. If the simulation has been configured to output continuous
+data, the relevant variables will also be saved.
+
+### Saving the final state
+
+After the full simulation loop has been completed, the final simulation state held in
+the `Data` object can be optionally be saved to a path provided in the configuration,
+defaulting to saving the data.
+
+### Combining continuous data
+
+If the model has been set up to output continuous time data, then there is a final step
+to combine the output files into a single file. This step is required as the continuous
+data is saved at every time step, resulting in a large number of files. Continuous data
+files are found by searching the output folder for files matching the pattern
+`"continuous_state*.nc"`. All these files are loaded, combined into a single dataset,
+and then deleted. This combined dataset is then saved in the output folder with the file
+name `"all_continuous_data.nc"`.
+
+```{warning}
+The function to combine the continuous data files reads in **all** files in the
+specified output folder that match the pattern `"continuous_state*.nc"`. If a file is
+included that matches this pattern but was not generated by the current simulation, the
+complete continuous data file will end up either being corrupted or containing incorrect
+information. In addition to this, the spurious files will likely be deleted.
+```
diff --git a/docs/source/virtual_ecosystem/implementation/plants_implementation.md b/docs/source/virtual_ecosystem/implementation/plants_implementation.md
new file mode 100644
index 000000000..93a4f304c
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/plants_implementation.md
@@ -0,0 +1,127 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# The Plants Model implementation
+
+## Required variables
+
+The tables below show the variables that are required to initialise the plants model and
+then update it at each time step.
+
+```{code-cell}
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+from IPython.display import display_markdown
+from var_generator import generate_variable_table
+
+display_markdown(
+ generate_variable_table(
+ 'PlantsModel',
+ ['vars_required_for_init', 'vars_required_for_update']
+ ),
+ raw=True
+)
+```
+
+## Model overview
+
+The required variables starting with `plant_cohorts_` provide the initial inventory of
+the plants growing within each cell in the simulation. These variables are one
+dimensional arrays that together form a 'data frame', with each row representing a plant
+cohort. Each cohort:
+
+* occurs in a single cell (`plant_cohorts_cell_id`),
+* has an initial size as the diameter at breast height (`plant_cohorts_dbh`),
+* has an initial number of individuals (`plant_cohorts_n`), and
+* a plant functional type (`plant_cohort_pft`).
+
+The plant functional types (PFT) for a simulat are set in the configuration of the Plant
+Model. Each PFT defines a set of traits that determine the geometry of stem growth, root
+and leaf turnover rates, wood density and respiration costs.
+
+The Plant Model works by using the cohort data within each cell to generate the heights
+and vertical canopy profiles of all individuals. These are then used to build a
+community wide canopy structure under the perfect-plasticity approximation model
+{cite}`purves_predicting_2008`. The area of the grid cell is used to constrain the
+community-wide distribution of crown area into closure layers: as the canopies of taller
+trees use up the available space in the top most layer, shorter trees then fill up lower
+canopy layers until all of the community crown-area is allocated to a canopy layer.
+
+These canopy layers then define the vertical light profile through the canopy. The
+photosynthetic photon flux density (PPFD) is partially intercepted by each canopy layer,
+giving the eventual PPFD reaching ground level.
+
+The P Model {cite}`prentice_balancing_2014` is then used to estimate the light use
+efficiency for each individual across their canopy contributions to each canopy layer.
+The specific canopy conditions of air temperature, vapor pressure deficit, atmospheric
+pressure and $\ce{CO2}$ concentration define the optimal trade-off between carbon uptake
+and water loss for the leaves in each canopy layer. The PPFD flux intercepted by each
+layer can then be used to scale the light use efficienct up to the gross primary
+productivity (GPP) of each layer, and these can be summed across layers to generate per
+stem GPP.
+
+The Virtual Ecosystem then uses the T model {cite}`li_simulation_2014` to estimate the
+increase in diameter at breast height from the GPP. The T model estimates maintenance
+and respiration costs for a given stem and then allocates the resulting net-primary
+productivity (NPP) to growth, generating an expected change in diameter at breast height
+given the wood density, stem geometry and NPP. These calculated increments are then
+applied to the cohorts and the larger stems are used for the next update.
+
+Mortality and reproduction have not yet been implemented.
+
+## Generated variables
+
+The calculations described above result in the following variables being calculated and
+saved within the model data store, and then updated
+
+```{code-cell}
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'PlantsModel',
+ ['vars_populated_by_init', 'vars_populated_by_first_update']
+ ),
+ raw=True
+)
+```
+
+## Updated variables
+
+The table below shows the complete set of model variables that are updated at each model
+step.
+
+```{code-cell}
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+
+display_markdown(
+ generate_variable_table(
+ 'PlantsModel',
+ ['vars_updated']
+ ),
+ raw=True
+)
+```
diff --git a/docs/source/virtual_ecosystem/implementation/science_model_overview.md b/docs/source/virtual_ecosystem/implementation/science_model_overview.md
new file mode 100644
index 000000000..22e55525b
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/science_model_overview.md
@@ -0,0 +1,242 @@
+# The Virtual Ecosystem science models
+
+This page provides an overview of the implementations of each science model. These
+descriptions are intentionally brief to allow you to see all of the different science
+model components in a single location. Each section provides links to additional detail
+on the implementation or to the documentation of the actual Python classes and function
+that provide the implementation.
+
+## Abiotic models
+
+Abiotic models provide the three-dimensional microclimate for the Virtual Ecosystem.
+Using a small set of input variables from external sources such as reanalysis or
+regional climate models, the model calculates atmospheric and soil parameters that
+drive the dynamics of plants, animals, and microbes at different vertical levels:
+
+- above canopy (canopy height + reference measurement height, typically 2 m)
+- canopy (dynamic heights provided by plant model)
+- surface (10 cm above ground)
+- topsoil (25 cm below ground)
+- subsoil (minimum of one layer at 1 m depth)
+
+At the moment, the default option is the
+[abiotic_simple](../../api/models/abiotic_simple.md) model, a simple regression
+model that estimates microclimatic variables based on empirical data for a monthly
+model timestep.
+In parallel, we are working on a process-based
+[abiotic](../../api/models/abiotic.md) model, which will provide microclimate on
+a (sub-)daily resolution. Both versions of the abiotic model provide the following key
+variables at relevant vertical levels:
+
+- Air temperature (°C), relative humidity (-), and vapour pressure deficit (VPD, kPa)
+- Soil temperature (°C)
+- Atmospheric $\ce{CO_{2}}$ concentration (ppm)
+- Atmospheric Pressure (kPa)
+
+### Simple Abiotic Model
+
+The [abiotic_simple](../../api/models/abiotic_simple.md) model is a one-column model
+that operates on a grid cell basis and does not consider horizontal exchange of energy,
+atmospheric water, and momentum. The model uses linear regressions from
+{cite}`hardwick_relationship_2015` and {cite}`jucker_canopy_2018` to predict
+atmospheric temperature, relative humidity, and vapour pressure deficit
+at ground level (1.5 m) given the above canopy conditions and leaf area index of
+intervening canopy. A vertical profile across all atmospheric layers is then
+interpolated using a logarithmic curve between the above canopy observation and ground
+level prediction. Soil temperature is interpolated between the surface layer and the
+soil temperature at 1 m depth which roughly equals the mean annual temperature.
+The model also provides a constant vertical profile of atmospheric pressure and
+atmospheric $\ce{CO_{2}}$ based on external inputs.
+
+### Process-based Abiotic Model
+
+The process-based [abiotic](../../api/models/abiotic.md) model will contain a sub-daily
+mechanistic representation of the radiation balance, the energy
+balance, and wind profiles. Submodules will be closely coupled to the hydrology and
+plants models through the exchange of energy and water. The model will also provides a
+constant vertical profile of atmospheric pressure and atmospheric $\ce{CO_{2}}$ based on
+external inputs. Most processes will be calculated on a per grid cell basis; horizontal
+exchange of properties will be considered at a later stage. The first model draft is
+loosely based on the 'microclimc' model by {cite}`maclean_microclimc_2021`.
+
+```{note}
+Some of the features described here are not yet implemented.
+```
+
+#### Radiation balance
+
+The radiation balance submodule will calculate location-specific solar irradiance
+(shortwave), reflection and scattering of shortwave radiation from canopy and surface, a
+vertical profile of net shortwave radiation, and outgoing longwave radiation from canopy
+and surface. A basic version of the surface and canopy radiation balance is currently
+included in the energy balance submodule.
+
+#### Energy balance
+
+The [energy balance](../../api/models/abiotic/energy_balance.md) and
+[soil energy balance](../../api/models/abiotic/soil_energy_balance.md) submodules will
+derive sensible and latent heat fluxes from canopy layers and surface to the atmosphere.
+Part of the net radiation will be converted into soil heat flux. Based on these
+turbulent fluxes, air temperature, canopy temperature, relative humidity, and soil
+temperature will be updated simultaneously at each level. The vertical mixing between
+layers is assumed to be driven by
+[heat conductance](../../api/models/abiotic/conductivities.md) because turbulence is
+typically low below the canopy {cite}`maclean_microclimc_2021`.
+
+#### Wind
+
+The [wind](../../api/models/abiotic/wind.md) submodule will calculate the above- and
+within-canopy wind profiles for the Virtual Ecosystem. These profiles determine the
+exchange of heat and water between soil and atmosphere below the canopy
+as well as the exchange with the atmosphere above the canopy.
+
+## Hydrology Model
+
+The [hydrology](../../api/models/hydrology.md) model simulates the hydrological
+processes in the Virtual Ecosystem. We placed hydrology in a separate model to allow
+easy replacement with a different hydrology model. Also, this separation provides more
+flexibility in defining the order of models an/or processes in the overall Virtual
+Ecosystem workflow.
+
+```{note}
+Some of the features described here are not yet implemented.
+```
+
+### Vertical hydrology components
+
+The vertical component of the hydrology model determines the water balance within each
+grid cell. This includes [above ground](../../api/models/hydrology/above_ground.md)
+processes such as rainfall, intercept, and surface runoff out of the grid cell.
+The [below ground](../../api/models/hydrology/below_ground.md) component considers
+infiltration, bypass flow, percolation (= vertical flow), soil moisture and matric
+potential, horizontal sub-surface flow out of the grid cell, and changes in
+groundwater storage.
+The model is loosely based on the LISFLOOD model {cite}`van_der_knijff_lisflood_2010`.
+
+### Horizontal hydrology components
+
+The second part of the hydrology model calculates the horizontal water movement across
+the full model grid including accumulated surface runoff and sub-surface flow, and river
+discharge rate, [see](../../api/models/hydrology/above_ground.md). The flow direction is
+based on a digital elevation model.
+
+## Plant Model
+
+The Plant Model models the primary production from plants in the Virtual Ecosystem. We
+use the P Model {cite}`prentice_balancing_2014,wang_towards_2017`, to estimate the
+optimal balance between water loss and photosynthetic productivity and hence gross
+primary productivity (GPP). The P Model requires estimates of the following drivers:
+
+- Air temperature (°C)
+- Vapour pressure deficit (VPD, Pa)
+- Atmospheric pressure (Pa)
+- Atmospheric $\ce{CO_{2}}$ concentration (parts per million)
+- Fraction of absorbed photosynthetically active radiation ($F_{APAR}$, unitless)
+- Photosynthetic photon flux density (PPFD, $\mu \text{mol}, m^{-2}, s^{-1}$)
+
+GPP is then allocated to plant maintenance, respiration and growth using the T Model
+{cite}`li_simulation_2014`.
+
+This growth model is used to simulate the demographics of cohorts of key plant
+functional types (PFTs) under physiologically structured population models developed in
+the [Plant-FATE](https://jaideep777.github.io/libpspm/) framework. The framework uses
+the perfect-plasticity approximation (PPA, {cite:t}`purves_predicting_2008`) to model
+the canopy structure of the plant community, the light environments of different PFTs
+and hence the change in the size-structured demography of each PFT through time.
+
+## Soil Model
+
+The principal function of the Soil Model is to model the cycling of nutrients. This
+cycling is assumed to be primarily driven by microbial activity, which in turn is
+heavily impacted by both environmental and soil conditions. Plant-microbe interactions
+are taken to principally be either exchanges of or competition for nutrients, and so are
+modelled within the same nutrient cycling paradigm. Three specific nutrient cycles are
+incorporated into this model:
+
+### Carbon cycle
+
+The Carbon cycle uses as its basic structure a recently described soil-pool model termed
+the Millennial model {cite}`abramoff_millennial_2018`. This model splits carbon into
+five separate pools: particulate organic matter, low molecular weight carbon (LMWC),
+mineral associated organic matter, aggregates and microbial biomass. Though plant root
+exudates feed directly into the LMWC pool, most biomass input will less direct and occur
+via litter decomposition. Thus, we utilize a common set of litter pools
+{cite}`kirschbaum_modelling_2002`, that are divided between above- and below-ground
+pools, and by biomass source (e.g. deadwood).
+
+### Nitrogen cycle
+
+The Nitrogen cycle is strongly coupled to the carbon cycle, therefore tracking the
+stoichiometry of the carbon pools is key to modelling it correctly. In addition,
+specific forms of nitrogen are explicitly modelled. They are as follows: a combined
+$\ce{NH_{3}}$ and $\ce{NH_{4}^{+}}$ pool to represent the products of nitrogen
+fixation and ammonification, a $\ce{NO_{3}^{-}}$ pool to represent the products of
+nitrification, and a $\ce{NO_{2}^{-}}$ pool to capture the process of denitrification.
+
+### Phosphorous cycle
+
+The Phosphorus cycle is similarly coupled to the carbon cycle. The additional inorganic
+pools tracked in this case are as follows: primary phosphorus in the form of weatherable
+minerals, mineral phosphorus which can be utilized by plants and microbes, secondary
+phosphorus which is mineral associated but can be recovered as mineral phosphorus, and
+occluded phosphorus which is irrecoverably bound within a mineral structure.
+
+### Further details
+
+Further theoretical background for the Soil Model can be found
+[here](../theory/soil_theory.md).
+
+## Animal Model
+
+The Animal Model simulates the animal consumers for the Virtual Ecosystem. We follow the
+Madingley Model {cite}`harfoot_madingley_2014` to provide the foundational structure
+as well as some of the dynamics. The key processes of the model are:
+
+- foraging and trophic dynamics
+- migration
+- birth
+- metamorphosis
+- metabolism
+- natural mortality
+
+### Functional Groups
+
+Animals within the Animal Model are sorted into functional groups, not biological
+species. Functional groups share functional traits and body-mass ranges and
+so behave similarly within the ecosystem. Defining a functional group within the
+Animal Model requires the following traits:
+
+- name
+- taxa: mammal, bird, insect
+- diet: herbivore, carnivore
+- metabolic type: endothermic, ectothermic
+- reproductive type: semelparous, iteroparous, nonreproductive
+- development type: direct, indirect
+- development status: adult, larval
+- offspring functional group
+- excretion type: ureotelic, uricotelic
+- birth mass (kg)
+- adult mass (kg)
+
+A set of these functional groups are used to define an instance of the Animal Model.
+
+### Animal Cohorts
+
+Animals are represented as age-specific cohorts, containing many individuals of the
+same functional type. The key Animal Model processes are run at the cohort level.
+We track the internal state of the average individual of that cohort over time to
+determine the resulting dynamics, such that events like starvation and metamorphosis
+occur based on that cohort's internal state. Predator-prey interactions, likewise, occur
+between animal cohorts as part of foraging system.
+
+## Disturbance Model
+
+```{warning}
+This model is not yet in development.
+```
+
+Introducing disturbances (e.g. logging) into the model will usually require making
+alterations to the state of multiple models. As such, different disturbance models are
+collected in a separate Disturbance Model. This model will be capable of altering the
+state of all the other models, and will do so in a manner that allows the source of the
+changes to be explicitly identified.
diff --git a/docs/source/virtual_ecosystem/implementation/soil_implementation.md b/docs/source/virtual_ecosystem/implementation/soil_implementation.md
new file mode 100644
index 000000000..43807e5c2
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/soil_implementation.md
@@ -0,0 +1,2 @@
+
+# The Soil Model implementation
diff --git a/docs/source/virtual_ecosystem/implementation/var_generator.py b/docs/source/virtual_ecosystem/implementation/var_generator.py
new file mode 100644
index 000000000..0600a6cb7
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/var_generator.py
@@ -0,0 +1,151 @@
+"""Utility functions to generate model variable listings."""
+
+from dataclasses import fields
+
+from virtual_ecosystem.core import variables
+
+# TODO - merge these into a single generate_model_variable_markdown and probably move it
+# inside the variables submodule.
+
+
+def generate_variable_listing(model_name: str, var_attributes: list[str]) -> str:
+ """Generate variable listings for a model."""
+
+ # populate the known variables registry if empty
+ if not variables.KNOWN_VARIABLES:
+ variables.register_all_variables()
+
+ # Find the model reference
+ models = {m.__name__: m for m in variables._discover_models()}
+ if model_name not in models:
+ raise ValueError("Unknown model name")
+ model = models[model_name]
+
+ # Define listing headings for each attribute:
+ vattr_headings = {
+ "vars_required_for_init": "Variables required to initialise the model",
+ "vars_updated": "Variables updated by the model",
+ "vars_required_for_update": "Variables required to update the model",
+ "vars_populated_by_init": "Variables populated by initialising the model",
+ "vars_populated_by_first_update": "Variables by the first update of the model",
+ }
+
+ # Collect the listings for each requested variable attribute into a string
+ return_value = ""
+
+ for vattr in var_attributes:
+ # Trap bad attributes
+ if vattr not in vattr_headings:
+ raise ValueError("Unknown variable attribute")
+
+ # Get the listing
+ listing = "\n".join(
+ [
+ f"* {v.description} (``{v.name}``, {v.unit})"
+ for k, v in variables.KNOWN_VARIABLES.items()
+ if k in getattr(model, vattr)
+ ]
+ )
+ # Add listing
+ return_value += f"\n**{vattr_headings[vattr]}**\n{listing}"
+
+ return return_value
+
+
+def generate_all_variable_markdown(
+ fields_to_display: list[str] | None, widths=list[int] | None
+) -> str:
+ """Generate markdown table for all variables model."""
+
+ # populate the known variables registry if empty
+ if not variables.KNOWN_VARIABLES:
+ variables.register_all_variables()
+
+ # Get the fields to add as columns
+ if fields_to_display is None:
+ fields_to_display = [f.name for f in fields(variables.Variable)]
+
+ # Set the widths of the fields
+ if widths is not None:
+ widths_tag = ":widths: " + " ".join([str(w) for w in widths]) + "\n"
+ else:
+ widths_tag = ""
+
+ # Get those properties as table row headers
+ table_rows = ["* - " + " - ".join([f"{fld}\n" for fld in fields_to_display])]
+
+ # Add the variables formatted as list table rows
+ for v in variables.KNOWN_VARIABLES.values():
+ table_rows.append(
+ "* - " + " - ".join([f"{getattr(v,fld)}\n" for fld in fields_to_display])
+ )
+
+ # Wrap the variable rows in the rest of the list table syntax
+ table = (
+ """
+:::{list-table}
+:header-rows: 1
+:width: 100%
+:align: "left"
+:class: "datatable"
+"""
+ + widths_tag
+ + "".join(table_rows)
+ + "\n:::\n"
+ )
+
+ return table
+
+
+def generate_variable_table(model_name: str, var_attributes: list[str]) -> str:
+ """Generate variable listings for a model."""
+
+ # populate the known variables registry if empty
+ if not variables.KNOWN_VARIABLES:
+ variables.register_all_variables()
+
+ # Find the model reference
+ models = {m.__name__: m for m in variables._discover_models()}
+ if model_name not in models:
+ raise ValueError("Unknown model name")
+ model = models[model_name]
+
+ # Define listing headings for each attribute:
+ vattr_headings = {
+ "vars_required_for_init": "Variables required to initialise the model",
+ "vars_updated": "Variables updated by the model",
+ "vars_required_for_update": "Variables required to update the model",
+ "vars_populated_by_init": "Variables populated by initialising the model",
+ "vars_populated_by_first_update": (
+ "Variables populated by the first model update"
+ ),
+ }
+
+ # Collect the listings for each requested variable attribute into a string
+ return_value = ""
+
+ for vattr in var_attributes:
+ # Trap bad attributes
+ if vattr not in vattr_headings:
+ raise ValueError("Unknown variable attribute")
+
+ # Get the variables formatted as list table rows
+ listing = "\n".join(
+ [
+ f"* - `{v.name}`\n - {v.description}\n - {v.unit}"
+ for k, v in variables.KNOWN_VARIABLES.items()
+ if k in getattr(model, vattr)
+ ]
+ )
+
+ # Wrap the variable rows in the rest of the list table syntax
+ table = (
+ ":::{list-table}\n"
+ + ':header-rows: 1\n:widths: 30 40 10\n:width: 100%\n:align: "left"\n\n'
+ + "* - Name\n - Description\n - Unit\n"
+ + listing
+ + "\n:::\n"
+ )
+ return_value += f"\n**{vattr_headings[vattr]}**\n\n{table}"
+
+ return return_value
diff --git a/docs/source/virtual_ecosystem/implementation/variables.md b/docs/source/virtual_ecosystem/implementation/variables.md
new file mode 100644
index 000000000..64b4f2013
--- /dev/null
+++ b/docs/source/virtual_ecosystem/implementation/variables.md
@@ -0,0 +1,51 @@
+---
+jupytext:
+ formats: md:myst
+ text_representation:
+ extension: .md
+ format_name: myst
+ format_version: 0.13
+ jupytext_version: 1.16.2
+kernelspec:
+ display_name: Python 3 (ipykernel)
+ language: python
+ name: python3
+---
+
+# Virtual Ecosystem variables
+
+All variables used by Virtual Ecosystem that represent a physical quantity and that are
+either provided as input or produced as part of the simulation need to be registered
+and documented.
+
+## Known variables
+
+The table below summarises the variables currently available in Virtual Ecosystem and
+used by one or another of the existing models. It is followed by a more complete listing
+showing which models use each variable and at what stage during the model initialisation
+or update process. For instructions on how to add new variables visit the [API
+documentation](../../api/core/variables.md) section.
+
+```{code-cell} ipython3
+---
+tags: [remove-input]
+mystnb:
+ markdown_format: myst
+---
+from IPython.display import display_markdown
+from var_generator import generate_all_variable_markdown
+
+display_markdown(
+ generate_all_variable_markdown(
+ fields_to_display= ["name", "description", "unit", "axis"],
+ widths = [30, 40, 15, 15],
+ ),
+ raw=True
+)
+```
+
+## Detailed variable listing
+
+```{eval-rst}
+.. include:: ../../variables.rst
+```
diff --git a/docs/source/virtual_ecosystem/main_simulation.md b/docs/source/virtual_ecosystem/main_simulation.md
deleted file mode 100644
index 314c51680..000000000
--- a/docs/source/virtual_ecosystem/main_simulation.md
+++ /dev/null
@@ -1,179 +0,0 @@
-# Virtual Ecosystem simulation flow
-
-This document describes the main simulation flow of the Virtual Ecosystem model. The
-main stages are:
-
-* setup of the **simulation core** that provides shared resources and functions
-* setup of the individual **science models** that simulate the behaviour of different
-components of the Virtual Ecosystem, and
-* iteration of the simulation over the configured timescale.
-
-```{mermaid}
-flowchart TD
- A[ve_run] --> B
- B --> F
- C --> F
- D --> F
- D --> G
- E --> F
- H --> H2
- subgraph Core
- direction LR
- B[Load configuration] --> C[Create grid]
- C --> D[Load data]
- D --> E[Validate timescale]
- end
- subgraph Setup science models
- direction LR
- F[Model configuration] --> G[Model setup]
- G --> H[Model spinup]
- end
- subgraph Simulation
- H2[Save initial state] --> I[Start time]
- I --> J[Update interval]
- J --> K[Update science models]
- K --> L[Save current state]
- L --> J
- L --> M[End time]
- M --> N[Save final state]
- N --> O[Combine continuous data]
- end
-```
-
-## Core setup
-
-The first stage in the simulation is the configuration and initialisation of the core
-resources and functionality.
-
-### Loading configuration files
-
-First, a set of user-provided configuration files in `TOML` format for a simulation are
-loaded. These files are then validated to ensure:
-
-* that they are valid `TOML`,
-* and that all the required settings are present and not duplicated.
-
-Some settings will be filled automatically from defaults settings and so can be omitted,
-but validation will fail if mandatory settings are omitted. Further details can be found
-in the [configuration documentation](./core/config.md).
-
-### Grid creation
-
-Next, the spatial structure of the simulation is configured as a [`Grid`
-object](./core/grid.md) that defines the area, coordinate system and geometry of the
-individual cells that will be used in the simulation.
-
-### Loading and validation of input data
-
-All of the data required to initialise and run the simulation is then loaded into an
-internal [`Data` object](./core/data.md). The model configuration sets the locations of
-files containing required variables and this configuration is passed into the
-{meth}`~virtual_ecosystem.core.data.Data.load_data_config` method, which ensures that:
-
-* the input files are valid and can be read, and
-* that the data in files is congruent with the rest of the configuration, such as
- checking the dimensionality and shape of [core axes](./core/axes.md) like the spatial
- grid.
-
-### Simulation timescale
-
-The simulation runs between two dates with an update interval at which each science
-model is recalculated. These values are defined in the `core` configuration and are
-now validated to ensure that the start date, end date and update interval are sensible.
-
-```{note}
-The simulation uses 12 equal length months (30.4375 days) and equal length years (365.25
-days), ignoring leap years.
-```
-
-## Science models
-
-The Virtual Ecosystem is implemented as model objects, each of which is responsible for
-simulating a particular aspect of the ecosystem ecosystem. The models used for the
-specific simulation run can be set in the configuration and will typically include the
-four standard models:
-
-* the [`AbioticSimpleModel`](../api/abiotic_simple.md),
-* the `AnimalModel`,
-* the `PlantModel` and the
-* [`SoilModel`](../api/soil.md)
-
-but this can be [extended to include new models](../development/defining_new_models.md)
-or adopt different combinations of models.
-
-Once a list of models to configure has been extracted from the configuration, all
-science models run through a set of steps to prepare for the simulation to start. Each
-step is represented using a set of standard model methods that are run in the following
-order.
-
-### Model configuration
-
-The loaded configuration should include the configuration details for each individual
-science model. These are now used to initialise each requested model using the
-{meth}`~virtual_ecosystem.core.base_model.BaseModel.from_config` method defined
-for each model. This method checks that the configuration is valid for the science
-model.
-
-### Model setup
-
-Some models require an additional setup step to calculate values for internal variables
-from the initial loaded data or to set up further structures within the model, such as
-representations of plant or animal communities. Each model will run the
-{meth}`~virtual_ecosystem.core.base_model.BaseModel.setup` method defined for the
-specific model. In simple science models, this method may not actually need to do
-anything.
-
-### Model spinup
-
-Some models may then require a spin up step to allow initial variables to reach an
-equilibrium before running the main simulation. Again, each model will run the
-{meth}`~virtual_ecosystem.core.base_model.BaseModel.spinup` method defined for the
-specific model, and again this may not need to do anything for simple models.
-
-### Model update
-
-At this point, the model instance is now ready for simulation. The
-{meth}`~virtual_ecosystem.core.base_model.BaseModel.update` method for each science
-model is run as part of the simulation process described below.
-
-## Simulation process
-
-Now that the simulation core and science models have been configure and initialised,
-along with any setup or spinup steps, the simulation itself starts.
-
-### Saving the initial state
-
-The `data` object has now been populated with all of the configured data required to run
-the model. The simulation configuration can optionally provide a filepath that will be
-used to output a single data file of the initial simulation state.
-
-### Simulation
-
-The science models are now iterated over the configured simulation timescale, running
-from the start time to the end time with a time step set by the update interval. At each
-step all models are updated. If the simulation has been configured to output continuous
-data, the relevant variables will also be saved.
-
-### Saving the final state
-
-After the full simulation loop has been completed, the final simulation state held in
-the `Data` object can be optionally be saved to a path provided in the configuration,
-defaulting to saving the data.
-
-### Combining continuous data
-
-If the model has been set up to output continuous time data, then there is a final step
-to combine the output files into a single file. This step is required as the continuous
-data is saved at every time step, resulting in a large number of files. Continuous data
-files are found by searching the output folder for files matching the pattern
-`"continuous_state*.nc"`. All these files are loaded, combined into a single dataset,
-and then deleted. This combined dataset is then saved in the output folder with the file
-name `"all_continuous_data.nc"`.
-
-```{warning}
-The function to combine the continuous data files reads in **all** files in the
-specified output folder that match the pattern `"continuous_state*.nc"`. If a file is
-included that matches this pattern but was not generated by the current simulation, the
-complete continuous data file will end up either being corrupted or containing incorrect
-information. In addition to this, the spurious files will likely be deleted.
-```
diff --git a/docs/source/virtual_ecosystem/module_overview.md b/docs/source/virtual_ecosystem/module_overview.md
deleted file mode 100644
index 0a29aed80..000000000
--- a/docs/source/virtual_ecosystem/module_overview.md
+++ /dev/null
@@ -1,207 +0,0 @@
-# The Virtual Ecosystem models
-
-This document provides a brief overview of the models that make up the Virtual
-Ecosystem.
-
-## Core Model
-
-The `core` model is responsible for:
-
-- **Model configuration**: running a model requires a configuration file to set the
- various options to be used. The `core` model provides loading and validation routines
- for this configuration.
-
-- **Logger configuration**: the various models in the Virtual Ecosystem can emit a lot
- of logging information and the `core` model is used to set up the logging depth and
- log files.
-
-- **Spatial grid setup**: a model typically contains individual cells to capture spatial
- heterogeneity and establish landscape scale processes. The `core` model supports the
- configuration of those cells and potentially mapping of habitats to cells.
-
-- **Input validation**: once a model is configured, the `core` model is able to
- validate the various inputs to the model to make sure that they are consistent with
- the spatial grid configuration and each other.
-
-- **Cell initiation and timekeeping**: each cell contains instances of the various
- models used to simulate behaviour within that cell. The `core` model sets up those
- instances.
-
-- **Timekeeping**: the `core` model is also responsible for the timekeeping of the
- simulation - ensuring that the models execute the right commands at the right time.
-
-## Plant Model
-
-The Plant Model models the primary production from plants in the Virtual Ecosystem. We
-use the P Model {cite}`prentice_balancing_2014,wang_towards_2017`, to estimate the
-optimal balance between water loss and photosynthetic productivity and hence gross
-primary productivity (GPP). The P Model requires estimates of the following drivers:
-
-- Air temperature (°C)
-- Vapour pressure deficit (VPD, Pa)
-- Atmospheric pressure (Pa)
-- Atmospheric $\ce{CO_{2}}$ concentration (parts per million)
-- Fraction of absorbed photosynthetically active radiation ($F_{APAR}$, unitless)
-- Photosynthetic photon flux density (PPFD, $\mu \text{mol}, m^{-2}, s^{-1}$)
-
-GPP is then allocated to plant maintenance, respiration and growth using the T Model
-{cite}`li_simulation_2014`.
-
-This growth model is used to simulate the demographics of cohorts of key plant
-functional types (PFTs) under physiologically structured population models developed in
-the [Plant-FATE](https://jaideep777.github.io/libpspm/) framework. The framework uses
-the perfect-plasticity approximation (PPA, {cite:t}`purves_predicting_2008`) to model
-the canopy structure of the plant community, the light environments of different PFTs
-and hence the change in the size-structured demography of each PFT through time.
-
-## Soil Model
-
-The principal function of the Soil Model is to model the cycling of nutrients. This
-cycling is assumed to be primarily driven by microbial activity, which in turn is
-heavily impacted by both environmental and soil conditions. Plant-microbe interactions
-are taken to principally be either exchanges of or competition for nutrients, and so are
-modelled within the same nutrient cycling paradigm. Three specific nutrient cycles are
-incorporated into this model:
-
-### Carbon cycle
-
-The Carbon cycle uses as its basic structure a recently described soil-pool model termed
-the Millennial model {cite}`abramoff_millennial_2018`. This model splits carbon into
-five separate pools: particulate organic matter, low molecular weight carbon (LMWC),
-mineral associated organic matter, aggregates and microbial biomass. Though plant root
-exudates feed directly into the LMWC pool, most biomass input will less direct and occur
-via litter decomposition. Thus, we utilize a common set of litter pools
-{cite}`kirschbaum_modelling_2002`, that are divided between above- and below-ground
-pools, and by biomass source (e.g. deadwood).
-
-### Nitrogen cycle
-
-The Nitrogen cycle is strongly coupled to the carbon cycle, therefore tracking the
-stoichiometry of the carbon pools is key to modelling it correctly. In addition,
-specific forms of nitrogen are explicitly modelled. They are as follows: a combined
-$\ce{NH_{3}}$ and $\ce{NH_{4}^{+}}$ pool to represent the products of nitrogen
-fixation and ammonification, a $\ce{NO_{3}^{-}}$ pool to represent the products of
-nitrification, and a $\ce{NO_{2}^{-}}$ pool to capture the process of denitrification.
-
-### Phosphorous cycle
-
-The Phosphorus cycle is similarly coupled to the carbon cycle. The additional inorganic
-pools tracked in this case are as follows: primary phosphorus in the form of weatherable
-minerals, mineral phosphorus which can be utilized by plants and microbes, secondary
-phosphorus which is mineral associated but can be recovered as mineral phosphorus, and
-occluded phosphorus which is irrecoverably bound within a mineral structure.
-
-### Further details
-
-Further theoretical background for the Soil Model can be found
-[here](./soil/soil_details.md).
-
-## Animal Model
-
-## Abiotic Model
-
-The Abiotic Model provides the microclimate for the Virtual Ecosystem.
-Using a small set of input variables from external sources such as reanalysis or
-regional climate models, the model calculates atmospheric and soil parameters that
-drive the dynamics of plants, animals, and microbes at different vertical levels:
-
-- above canopy (canopy height + reference measurement height, typically 2m)
-- canopy layers (maximum of ten layers, minimum one layers)
-- subcanopy (2 m)
-- surface layer (10 cm)
-- soil layers (currently one near surface layer and one layer at 1 m below ground)
-
-At the moment, the default option is a simple regression model that estimates
-microclimate for a monthly time step. We are also working on a process-based abiotic
-model that runs on a shorter time step, typically sub-daily, and could be used to run
-the Virtual Ecosystem in high temporal resolution or for representative days per month.
-Both versions of the abiotic model provide the following variables at different vertical
-levels:
-
-- Air temperature, relative humidity, and vapour pressure deficit
-- Soil temperature
-- Atmospheric $\ce{CO_{2}}$ concentration
-- Atmospheric Pressure
-
-### Simple Abiotic Model
-
-The Simple Abiotic Model is a one-column model that operates on a grid cell basis and
-does not consider horizontal exchange of energy, atmospheric water, and momentum.
-The model uses linear regressions from {cite}`hardwick_relationship_2015` and
-{cite}`jucker_canopy_2018` to predict
-atmospheric temperature, relative humidity, and vapour pressure deficit
-at ground level (1.5 m) given the above canopy conditions and leaf area index of
-intervening canopy. A vertical profile across all atmospheric layers is then
-interpolated using a logarithmic curve between the above canopy observation and ground
-level prediction. Soil temperature is interpolated between the surface layer and the air
-temperature at around 1 m depth which equals the mean annual temperature.
-The model also provides a constant vertical profile of atmospheric pressure and
-atmospheric $\ce{CO_{2}}$.
-
-### Process-based Abiotic Model
-
-The Process-based Abiotic Model will contain five subroutines: radiation, energy balance
-, water balance, wind, and atmospheric $\ce{CO_{2}}$. The model will be based on the
-'microclimc' model by {cite}`maclean_microclimc_2021`.
-
-#### Radiation
-
-The Radiation submodule calculates location-specific solar irradiance
-(shortwave), reflection and scattering of shortwave radiation from canopy and surface,
-vertical profile of net shortwave radiation, and outgoing longwave radiation from canopy
-and surface. This will likely be replaced by the SPLASH model in the future.
-
-#### Energy balance
-
-The Energy balance submodule derives sensible and latent heat fluxes from canopy and
-surface to the atmosphere, and updates air temperature, relative humidity, and vapor
-pressure deficit at each level. The vertical mixing between levels is assumed to be
-driven by heat conductance because turbulence is typically low below the canopy
-{cite}`maclean_microclimc_2021`. Part of the net radiation is converted into soil heat
-flux. The vertical exchange of heat between soil levels is coupled to the atmospheric
-mixing.
-
-#### Water balance
-
-The Water balance submodule will link atmospheric humidity to the hydrology model and
-coordinate the exchange of water between pools, i.e. between the soil, plants, animals,
-and the atmosphere.
-
-#### Wind
-
-The wind submodule calculates the above- and within-canopy wind profiles for the Virtual
-Ecosystem. These profiles will determine the exchange of heat, water, and $\ce{CO_{2}}$
-between soil and atmosphere below the canopy as well as the exchange with the atmsophere
-above the canopy.
-
-#### Atmospheric $\ce{CO_{2}}$
-
-The Atmospheric $\ce{CO_{2}}$ submodule will calculate the vertical profile of
-atmospheric $\ce{CO_{2}}$ below the canopy. It will include the carbon assimilation/
-respiration from plants and respiration from animals and soil microbes and mix
-vertically depending on wind speed below the canopy.
-
-## Hydrology Model
-
-The Hydrology model simulates the hydrological processes in the Virtual Ecosystem. We
-placed hydrology in a separate model in order to allow easy replacement with a different
-hydrology model. Also, this provides more flexibility in defining the order of
-models an/or processes in the overall Virtual Ecosystem workflow.
-
-The first part of the Hydrology model determines the water balance within each
-grid cell including rainfall, intercept, surface runoff out of the grid cell,
-infiltration, percolation (= vertical flow), soil moisture profile, and
-horizontal sub-surface flow out of the grid
-cell.
-
-The second part of the submodule calculates the water balance across the full model
-grid including accumulated surface runoff, sub-surface flow, return flow, and streamflow
-. This second part is still in development.
-
-## Disturbance Model
-
-Introducing disturbances (e.g. logging) into the model will usually require making
-alterations to the state of multiple models. As such, different disturbance models are
-collected in a separate Disturbance Model. This model will be capable of altering the
-state of all the other models, and will do so in a manner that allows the source of the
-changes to be explicitly identified.
diff --git a/docs/source/virtual_ecosystem/theory/abiotic_theory.md b/docs/source/virtual_ecosystem/theory/abiotic_theory.md
new file mode 100644
index 000000000..fc6e77064
--- /dev/null
+++ b/docs/source/virtual_ecosystem/theory/abiotic_theory.md
@@ -0,0 +1,28 @@
+# The abiotic environment
+
+The abiotic component of the Virtual Ecosystem focuses on non-living environmental
+factors that influence ecosystem dynamics. These factors encompass
+[microclimate](./microclimate_theory.md) and [hydrology](./hydrology_theory.md)
+processes, which are critical for understanding and predicting ecological
+responses of organisms to various environmental conditions, interactions between
+organisms that shape communities, and the geographical distribution of species.
+
+The microclimate and hydrology components rely on first principles by incorporating
+fundamental physical laws to simulate
+[local radiation, energy, and carbon balance](./microclimate_theory.md#balancing-energy-water-and-carbon)
+as well as [local](./hydrology_theory.md#local-water-balance) and
+[catchment scale water cycle dynamics](./hydrology_theory.md#catchment-scale-water-balance)
+to predict how microclimatic conditions and hydrological processes interact and evolve
+over time.
+
+:::{figure} ../../_static/images/abiotic_sketch.jpg
+:name: abiotic_sketch
+:alt: Abiotic sketch
+:class: bg-primary
+:width: 650px
+
+The key processes in a terrestrial abiotic environment at the example of a
+tropical rainforest. The system simultaneously balances carbon cycle (green), radiation
+(orange), energy (red), water (blue), and momentum through turbulent transfer (black).
+Copyright: Vivienne Groner.
+:::
diff --git a/docs/source/virtual_ecosystem/theory/animal_theory.md b/docs/source/virtual_ecosystem/theory/animal_theory.md
new file mode 100644
index 000000000..8fc37e705
--- /dev/null
+++ b/docs/source/virtual_ecosystem/theory/animal_theory.md
@@ -0,0 +1 @@
+# Theory of the animals
diff --git a/docs/source/virtual_ecosystem/theory/hydrology_theory.md b/docs/source/virtual_ecosystem/theory/hydrology_theory.md
new file mode 100644
index 000000000..f17b8127e
--- /dev/null
+++ b/docs/source/virtual_ecosystem/theory/hydrology_theory.md
@@ -0,0 +1,263 @@
+# Hydrology
+
+This page provides an overview of the [key factors](#factors-affecting-hydrology)
+influencing the hydrology of an ecosystem, the main processes that drive the
+hydrological cycle at [local scale](#local-water-balance) and
+[catchment scale](#catchment-scale-water-balance),
+[state variables](#key-hydrological-variables-and-processes) involved in these processes
+and the [links between hydrology and biotic processes](#links-between-hydrology-and-biotic-processes)
+Further, this page offers a brief overview over
+hydrological [data collection](#data-collection) and [modelling](#hydrology-modelling)
+approaches as well as open
+[challenges and limitations](#challenges-and-limitations) in hydrological research.
+
+The implementation of these concepts in the Virtual Ecosystem is described in detail
+[here](../implementation/hydrology_implementation.md).
+
+## Definition
+
+In the context of the Virtual Ecosystem, hydrology is defined as the distribution and
+movement of water both on and below the Earth's surface as well as through organisms.
+
+Water is crucial in an ecosystem for several reasons. It is essential for the survival
+of all living organisms, providing the medium for biochemical reactions and cellular
+processes. Further, water plays a key role in many ecosystem processes such as
+photosynthesis, nutrient cycling, and the decomposition of organic matter. Water facilitates
+the movement of nutrients and minerals within the soil which enables plant growth and
+maintains soil health. Aquatic environments, such as rivers, lakes, and wetlands, provide
+habitats for a wide range of species which supports biodiversity. Additionally, water
+bodies influence microclimates by regulating temperatures through heat
+absorption and release.
+
+## Factors affecting hydrology
+
+The hydrology on an ecosystem is mostly determined by macro- and microclimate,
+topography, soil and geology, vegetation type and structure, and human activities such
+as land use change.
+
+### Climate
+
+* **Precipitation**: The amount, timing, and type of precipitation (rain, snow, etc.)
+directly influence water availability and flow patterns.
+* **Temperature**: Temperature affects evaporation rates and the amount of water that
+plants and soil can retain.
+* **Evapotranspiration**: The combined process of evaporation and transpiration affects
+water loss from the surface to the atmosphere.
+
+### Topography
+
+* **Slope**: The steepness of the terrain affects how quickly water runs off the surface
+and infiltrates the soil.
+* **Elevation**: Higher elevations tend to receive more precipitation, which impacts
+water flow and distribution.
+* **Landforms**: Natural features such as mountains, valleys, and plains influence the
+direction and speed of water movement.
+
+### Soil and Geology
+
+* **Soil type**: Different soil types (sand, clay, loam) have varying capacities to retain
+and filter water.
+* **Permeability**: The ability of soil and rock to absorb and transmit water affects
+groundwater recharge and surface runoff.
+* **Rock formations**: The composition and structure of underlying rock formations influence
+groundwater storage and flow.
+
+### Vegetation
+
+* **Plant types**: Different species of plants have varying water needs and capacities
+to absorb and transpire water.
+* **Density**: Dense vegetation can slow down surface runoff, enhance infiltration, and
+reduce soil erosion.
+* **Root systems**: Deep and extensive root systems can increase soil stability and
+improve water infiltration and retention.
+
+### Human activities
+
+* **Deforestation**: Removing trees and vegetation decreases transpiration, increases runoff,
+and contributes to soil erosion.
+* **Agriculture**: Irrigation, crop type, and farming practices influence water usage,
+runoff, and infiltration.
+* **Water management practices**: Dams, reservoirs, and water diversion projects impact the
+natural distribution and availability of water.
+* **Urbanization**: Development and construction alter natural water flow, increase surface
+runoff, and reduce infiltration.
+
+## Key hydrological variables and processes
+
+### Local water balance
+
+The local water balance is, similar to the microclimate, driven by large scale hydrological
+patterns and affects the living conditions for organisms at the local scale.
+The local water balance can be represented by the equation:
+
+$$\Delta S = P − ET − R$$ (water_balance)
+
+where $\Delta S$ represents the net change in water stored in the system, $P$ stands
+for precipitation, the total water input, $ET$ is the evapotranspiration with accounts
+for water loss to the atmosphere, and runoff $R$ represents water that flows out of
+the system.
+
+The water balance include above and below ground processes that together describe the
+flow of water through the system:
+
+#### Above ground
+
+* **Precipitation**: This includes all forms of water input from the atmosphere, such as
+rain, snow, sleet, and hail. The quantity and frequency of precipitation directly affect
+the amount of water entering the local system.
+* **Intercept**: Some precipitation is caught and held by plant leaves, branches, and
+stems before it reaches the ground. This intercepted water can either evaporate back into
+the atmosphere or eventually drip to the soil.
+* **Evapotranspiration**: Evaporation describes the process where water is converted
+from liquid to vapor and released into the atmosphere from surfaces like soil, water
+bodies, and vegetation. Transpiration rferns to the release of water vapor from plants
+into the atmosphere through small openings in their leaves called stomata.
+Combined, these processes account for water loss from the surface and vegetation to the
+atmosphere.
+
+* **Surface runoff**: The portion of precipitation that flows over the land surface
+toward streams, rivers, and other water bodies. Runoff is influenced by factors such as
+land slope, soil saturation, and land use. High runoff can lead to erosion and nutrient
+loss.
+
+#### Below ground
+
+* **Infiltration**: The process where water on the ground surface enters the soil.
+Infiltration rates depend on soil type, soil moisture, land cover, and land management
+practices. Enhanced infiltration reduces surface runoff and recharges groundwater.
+* **Bypass flow**: Some of the water that infiltarted into the soil bypasses the soil
+matrix and drains directly to the groundwater, for example through soil pipes.
+* **Groundwater flow**: Water that infiltrates the soil can percolate down to recharge
+groundwater aquifers. Groundwater flow contributes to maintaining base flow in rivers
+and streams during dry periods. The rate of groundwater flow is determined by the
+permeability of subsurface materials and the hydraulic gradient.
+* **Storage changes**: Water storage can occur in various forms such as soil moisture,
+surface water bodies (lakes, reservoirs), and groundwater. Changes in storage are
+influenced by the balance between inputs (precipitation) and outputs (evapotranspiration,
+runoff, groundwater flow).
+* **Root water uptake**: A fraction of soil water is extracted by plants. On average,
+the amount of water extracted from soil is approximately the same as transpiration rates.
+
+### Catchment scale water balance
+
+At catchment scale, horizontal movement and distribution is considered. This includes
+above and below ground flow of water.
+
+* **Surface runoff and surface water flow**: Runoff represents the portion of precipitation
+that flows over the land surface and into streams, rivers, and lakes. Surface water flow
+dynamics are influenced by topography, soil characteristics, land cover, and human
+activities.
+* **Groundwater Flow and Storage**: Water that infiltrates the soil can move horizontally
+through aquifers, contributing to groundwater storage. Horizontal groundwater flow
+interacts with surface water bodies, influencing base flow in rivers and streams.
+
+## Links between hydrology and biotic processes
+
+Understanding the interactions between hydrology and biota is essential for ecosystem
+management, conservation efforts, and predicting the impacts of environmental changes
+on water resources and biodiversity.
+
+* **Vegetation and transpiration**: Vegetation plays a critical role in the hydrological
+cycle by influencing water uptake and transpiration rates. Plant roots absorb water from
+the soil, which is then released into the atmosphere through transpiration, affecting
+local humidity and precipitation patterns.
+
+* **Influence on soil moisture**: The presence and density of vegetation affect soil
+moisture levels through interception of rainfall and shading of the ground surface.
+Changes in vegetation cover can impact soil infiltration rates and runoff, altering
+local water availability and flow dynamics.
+
+* **Biotic nutrient cycling**: Biota such as microbes and plants participate in nutrient
+cycling, affecting soil fertility and water quality. Nutrient uptake by vegetation and
+subsequent decomposition of organic matter influence nutrient concentrations in surface
+and groundwater.
+
+* **Ecosystem services**: Riparian vegetation along water bodies provides habitat and
+stabilizes streambanks, reducing erosion and sediment transport. Wetlands act as natural
+filters, improving water quality by trapping sediments and absorbing nutrients before
+water enters larger water bodies.
+
+* **Feedbacks and adaptations**: Biota within aquatic ecosystems adapt to hydrological
+changes, influencing community structure and biodiversity. In turn, changes in biotic
+composition can feedback to alter water flow patterns and nutrient dynamics within the
+ecosystem.
+
+## Methods for hydrology science
+
+This section gives a broad overview over common methods and models in hydrology
+research. A review on the progress and future of hydrological modelling is given by
+{cite:t}`singh_hydrologic_2018`.
+
+### Data collection
+
+Effective hydrology modelling relies on accurate data collection, ideally from a
+combination of sources:
+
+* **Meteorological stations**: Meteorological stations provide detailed, real-time data
+on precipitation, humidity, and sometime soil moisture for locations across an area.
+Data collection instruments include rain gauges, stream gauges, and soil moisture sensors.
+* **Remote sensing**: Satellite imagery and aerial surveys provide spatial and temporal
+data on precipitation patterns, land cover, and surface water dynamics.
+* **In-situ measurements**: Ground-based sensors complement provide high-resolution data
+on specific local conditions.
+* **Reanalysis**: Reanalysis data sets such as ERA5 represent a combination of observations
+and modelling which can complement measurements by filling gaps in spatial cover and
+timeseries.
+
+### Hydrology modelling
+
+Hydrology models employ diverse methodologies to simulate the movement and distribution
+of water within natural systems.
+
+### Models
+
+* **Rainfall-Runoff models** simulate the transformation of precipitation into runoff,
+accounting for factors like soil infiltration, evapotranspiration, and land cover
+characteristics.
+* **Groundwater flow models** utilize principles of fluid mechanics to simulate the
+movement of water through subsurface aquifers, considering geologic properties,
+recharge rates, and extraction activities.
+* **Integrated watershed models** combine surface water and groundwater components to
+provide a comprehensive view of water resources within a watershed, facilitating watershed
+management and land use planning decisions.
+
+### Tools and techniques
+
+* **Modeling tools** include Geographic Information Systems (GIS), statistical software,
+and specialized hydrological modeling platforms.
+* **Techniques** such as data assimilation, uncertainty analysis, and scenario testing help
+improve model accuracy and reliability.
+
+### Applications
+
+* Hydrological models are used for flood forecasting, water resource management,
+drought assessment, and climate change impact studies.
+* They support decision-making in agriculture, urban planning, and environmental
+conservation by predicting water availability and mitigating risks.
+
+## Challenges and limitations
+
+* **Data scarcity and quality**: Limited availability of hydrological data in certain
+regions hinders accurate modeling and forecasting. Data quality issues, such as
+measurement errors or inconsistencies, can affect model reliability and decision outcomes.
+
+* **Complexity of natural systems**: Natural variability and non-linear interactions in
+hydrological processes pose challenges for model representation and prediction.
+Incorporating spatial heterogeneity and temporal dynamics requires advanced modeling
+techniques and computational resources.
+
+* **Uncertainty and assumptions**: Uncertainty in model parameters, input data, and future
+climate projections affects the reliability of hydrological predictions.
+Assumptions made in model development and simplifications of complex processes can
+introduce biases and uncertainties.
+
+* **Human and environmental disturbance**: Anthropogenic activities such as land use
+change, urbanization, and water infrastructure development alter hydrological patterns.
+Environmental changes, including deforestation, climate variability, and extreme weather
+events, challenge the resilience of hydrological systems.
+
+* **Interdisciplinary integration**: Effective integration of hydrological modeling with
+other disciplines such as ecology, economics, and policy-making requires
+interdisciplinary collaboration. Addressing societal needs and sustainable water
+management goals requires holistic approaches that consider socio-economic and
+environmental factors.
diff --git a/docs/source/virtual_ecosystem/theory/microclimate_theory.md b/docs/source/virtual_ecosystem/theory/microclimate_theory.md
new file mode 100644
index 000000000..b70880774
--- /dev/null
+++ b/docs/source/virtual_ecosystem/theory/microclimate_theory.md
@@ -0,0 +1,321 @@
+# Microclimate
+
+This page provides an overview of the [key factors](#factors-affecting-microclimate)
+influencing the microclimate of an ecosystem, the
+[main processes](#balancing-energy-water-and-carbon) that drive the energy, carbon, and
+water cycle,
+[state variables](#key-microclimatic-state-variables) involved in these processes and
+the [links between microclimate and biotic processes](#links-between-microclimate-and-biotic-processes).
+Further, this page offers a brief overview over
+microclimate [data collection](#microclimate-data-collection) and
+[modelling](#microclimate-modelling) approaches as well as open
+[challenges and limitations](#challenges-and-limitations) in microclimate research.
+
+The implementation of these concepts in the Virtual Ecosystem is described in detail
+here for the [simple abiotic model](../implementation/abiotic_simple_implementation.md)
+and the [process-based abiotic model](../implementation/abiotic_implementation.md).
+
+## Definition
+
+Microclimates are defined as the local climate conditions that organisms and ecosystems
+are exposed to. In terrestrial ecosystems, microclimates often deviate strongly from the
+climate representative of a large geographic region, the macroclimate
+{cite}`kemppinen_microclimate_2024`.
+For example, the temperature directly above a rainforest canopy might be modulated
+due to small scale variations in topography and aspect. The temperature above the canopy
+is typically several degrees higher than near the surface, the surface
+under a dense canopy tends to be cooler than unshaded surface spots, and temperatures
+generally decrease with elevation.
+
+Many ecosystems have a high spatial variability of microclimates providing
+suitable habitats for a diverse range of species. Scales of microclimates typically
+range between 0.1-100 m horizontally, 10-100 m vertically, and seconds to minutes
+temporally {cite}`bramer_chapter_2018`.
+
+## Factors affecting microclimate
+
+Microclimates are mediated by macroclimate, topography, vegetation tye and structure, and
+soil. Many of these factors can be affected by human cativities, for example through
+deforestation and other land use changes.
+
+### Macroclimate
+
+* **Solar radiation**: The latitude and associated seasonal changes of the sun angle determine
+the amount of solar energy received at a location. Local features like tree cover can
+create microclimatic variations in sunlight exposure.
+* **Baseline temperature**: Macroclimate establishes the general temperature range for a
+region. Local features can cause variations within this range (e.g., heat islands,
+shaded areas).
+* **Precipitation patterns**: The overall amount and distribution of precipitation are
+dictated by macroclimate. Local factors such as topography can modify precipitation
+(e.g., rain shadows, increased moisture in valleys).
+* **Wind patterns**: Large-scale atmospheric circulation influences
+regional wind patterns. Local topography and vegetation structures can alter wind flow,
+leading to microclimatic differences.
+* **Humidity levels**: The macroclimate sets the general humidity level of an area.
+Proximity to water bodies, vegetation density, and soil moisture can create localized
+variations.
+* **Seasonal variations**: Seasonal changes in temperature, precipitation, and solar
+radiation are governed by the macroclimate.
+
+### Topography
+
+* **Elevation**: The height above sea level affects temperature, pressure, and
+precipitation. Higher areas tend to be cooler, have a lower pressure, and have a higher
+chance of receiving precipitation as snow.
+* **Slope and aspect**: The angle and direction of a slope influence sunlight exposure,
+wind exposure, and water runoff. This can affect microclimate directly (e.g. temperature
+, moisture availability) and indirectly (e.g. soil erosion changes surface properties).
+
+### Vegetation
+
+* **Leaf Area Index (LAI)**: The leaf area per unit ground area influences light
+penetration, temperature, and humidity. LAI is an important factor in determining the
+productivity and energy balance of an ecosystem.
+* **Canopy cover**: The proportion of the ground covered by the vertical projection of
+tree crowns affects light availability, wind patterns, and temperature.
+* **Plant height**: The height of vegetation can influence wind patterns, shading,
+and temperature.
+
+### Soil
+
+* **Soil albedo**: The reflectivity of the soil determines how much incoming solar
+radiation is reflected to the sky.
+* **Soil type**: The soil type affects the thermal and hydraulic properties of the soil
+which determine how well heat is stored and conducted and how easily water infiltrates,
+evaporates, and percolates through the soil.
+* **Soil moisture**: Soil moisture is a key factor in partitioning turbulent fluxes at
+the surface. Evaporative cooling and the associated buffering effect of vegetation of
+maximum temperatures.
+
+## Balancing energy, water, and carbon
+
+The dynamics of microclimate in a terrestrial ecosystem in primarily driven by five key
+components: radiation balance, energy balance, water balance, carbon balance, and
+turbulent transfer (see {numref}`abiotic_sketch`). These components are connected
+through the exchange of
+energy, water, and carbon and can be described with the general energy balance equation:
+
+$$
+R_N & = (1 - \alpha) S_\downarrow + L_\downarrow - \epsilon \sigma (T_{sfc} + 273.15)^4 \\
+ & = H + L_{v}E + G + NPP
+$$
+
+where $R_N$ is the net radiation at the surface, $\alpha$ is the surface albedo,
+$S_\downarrow$ and $L_\downarrow$ are downwelling shortwave and longwave radiation,
+respectively. $\epsilon$ is the emissivity of the surface, $\sigma$ is the
+Stefan-Boltzmann constant, and $T_sfc$ is the surface temperature in Celsius.
+$H$ is the sensible heat flux, $L_v E$ is the latent heat flux, $G$ is the ground heat
+flux, and $NPP$ stands for net primary productivity.
+
+* **Radiation balance**: The radiation balance refers to the equilibrium between incoming
+solar radiation and outgoing terrestrial radiation within an ecosystem. How much
+radiation is reflected, scattered and absorbed depends on the albedo and structure of
+the surface and vegetation.
+* **Energy balance**: The energy balance describes the equilibrium of absorbed and released
+energy at a surface, for example the soil surface or the canopy. This balance is closely
+coupled to the radiation balance through net radiation, which is partitioned into
+turbulent fluxes (latent, sensible, and ground heat flux), used for photosynthesis, and
+changes in heat storage.
+* **Water balance**: The water balance refers to the equilibrium of absorbed and released
+water by different (here abiotic) ecosystem components. This balance is linked to the
+energy balance via evapotranspiration and latent heat flux from the soil surface.
+The hydrology on catchment scale is described in more detail [here](./hydrology_theory.md).
+* **Carbon balance**: The carbon balance is linked to the radiation, energy and water
+balance by net primary productivity: the conversion of light, atmospheric carbon, water,
+(and nutrients) into biomass minus respiration. The carbon cycle continues as plant biomass
+is either eaten by herbivores or falls to the ground where it is decomposed. If not
+respired by animals or plants, carbon enters the soil where it is and eventually
+recycled to the atmosphere.
+* **Turbulent transfer**: The turbulent transfer and wind mix all the atmospheric
+properties vertically and horizontally, leading to ecosystem characteristic patterns and
+profiles of microclimatic variables.
+
+## Key microclimatic state variables
+
+### Solar Radiation
+
+* **Direct solar radiation**: Sunlight that reaches the surface directly from the sun
+affects temperatures, photosynthesis in plants, and the energy balance of an area.
+* **Diffuse solar radiation**: Sunlight scattered by molecules and particles in the
+atmosphere is essential for plant growth in shaded or cloudy conditions.
+* **Photosynthetically Active Radiation (PAR)**: PAR is the portion of sunlight
+(400-700 nm wavelength) that plants use for photosynthesis.
+
+### Temperature
+
+* **Air temperature**: Air temperature at different vertical levels within and below
+vegetation cover is probably the most important microclimate variable because it
+determines metabolic rates, growth, and survival of organisms.
+* **Soil temperature**: The temperature of the soil at various depths affects plant
+growth, root activity, and microbial activity. Soil temperature can significantly differ
+from air temperature due to soil composition and moisture content.
+* **Surface temperature**: The temperature of the ground or other surfaces can be
+significantly different from the air temperature above; often it is much hotter.
+
+### Humidity
+
+* **Relative humidity**: The percentage of moisture in the air relative to the maximum
+amount the air can hold at that temperature. It impacts endotherm comfort, plant
+transpiration, and microbial activity.
+* **Vapour pressure deficit (VPD)**: The difference between the amount of
+moisture in the air and how much moisture the air can hold when it is saturated. VPD is a
+crucial factor for plant transpiration and water stress; higher VPD indicates a greater
+potential for evaporation and transpiration.
+* **Soil moisture**: The amount of water contained within soil affects evaporation rates
+, soil microbial activity, and the availability of water for plants.
+* **Soil matric potential**: Soil matric potential refers to the energy status of water
+in soil which represents the force per unit area that the soil matrix exerts on water due
+to capillary and adsorptive forces. It influences the movement and availability of water
+to plants, with lower values indicating drier conditions and higher values indicating
+wetter conditions.
+
+### Wind
+
+* **Wind Speed**: The rate at which air is moving horizontally influences
+temperature regulation, evaporation rates, and the dispersion of atmospheric gasses.
+* **Wind Direction**: The direction from which the wind is blowing affects microclimate
+by influencing temperature distribution, humidity, and the transport of seeds and pollen.
+* **Turbulence**: Turbulence refers to the irregular, chaotic movement of air that affects
+the mixing of atmospheric elements. Turbulence influences heat exchange, moisture
+distribution, and the dispersion of aerosols.
+
+### Precipitation
+
+* **Rainfall**: The amount of rain that falls in a given area over a specific period.
+Rainfall is vital for replenishing water sources and maintaining soil moisture.
+* **Snowfall**: The amount of snow that falls, which can be measured as snow depth or water
+equivalent. Snowfall influences temperature regulation, soil moisture, and water supply.
+* **Dew and Frost**: The formation of water droplets or ice crystals on surfaces, which can
+affect plant health and soil conditions. Dew and frost are critical in areas where
+precipitation is low.
+
+### Atmospheric Pressure
+
+Barometric pressure describes the pressure exerted by the atmosphere at a given point.
+Pressure decreases with height and influences weather patterns; changes in atmospheric
+pressure can indicate upcoming weather changes, such as storms.
+
+### Atmospheric $\ce{CO_{2}}$
+
+Although atmospheric $\ce{CO_{2}}$ is not a microclimatic variable, it is closely tied
+in the balance of energy through its critical role in photosynthesis. It should therefore
+be considered when studying the dynamics on ecosystems.
+
+## Links between microclimate and biotic processes
+
+Microclimates affect biota in a number of ways. Physically, microclimate shapes the
+3-dimensional vegetation structure that organisms live in. Physiologically, temperatures
+in particular affect metabolic rates. Further, microclimates drive behaviour, species
+interactions, and evolutionary processes.
+
+### Habitat suitability
+
+* **Temperature**: Microclimatic temperature variations influence the distribution and
+behaviour of organisms. Certain species thrive in specific temperature ranges provided by
+microclimates.
+* **Moisture availability**: Local soil moisture and humidity levels determine the types
+of plants and animals that can survive in an area, affecting germination, growth, and
+reproduction.
+* **Light levels**: Microclimatic variations in sunlight due to canopy cover or terrain
+affect photosynthesis rates and plant growth.
+* **Soil conditions**: Microclimate influences soil temperature, moisture, and nutrient
+availability, which are critical for plant productivity and microbial activity.
+
+### Animal behaviour and distribution
+
+* **Thermal regulation**: Animals use microclimatic variations to regulate their body
+temperature, such as basking in sunny areas or seeking shade.
+* **Foraging and nesting**: Microclimatic conditions affect the availability of food
+resources and suitable nesting sites for animals.
+
+### Species interactions
+
+* **Competition and predation**: Microclimates can create microhabitats that support
+different species, influencing competition and predation dynamics.
+* **Pollination and seed dispersal**: Microclimatic conditions affect the activity of
+pollinators and the dispersal mechanisms of seeds, shaping plant reproduction and
+distribution.
+
+### Microbial activity
+
+* **Decomposition Rates**: Soil moisture and temperature, influenced by microclimate,
+affect the activity of decomposers and nutrient cycling in ecosystems.
+* **Soil Microbiome**: Microclimatic conditions influence the diversity and function of
+soil microbial communities, impacting soil health and plant growth.
+
+### Adaptation and evolution
+
+* **Local Adaptations**: Organisms may develop specific adaptations to survive in the unique
+conditions of their microclimate, leading to genetic diversity.
+* **Microclimatic Niches**: Species may exploit distinct microclimatic niches, reducing
+competition and promoting biodiversity within an ecosystem.
+
+### Stress and resilience
+
+* **Environmental Stressors**: Microclimatic extremes (e.g., drought, frost) can impose
+stress on biota, affecting survival and reproductive success.
+* **Refugia**: Microclimates can offer refugia for species when macroclimatic conditions
+become unfavourable, e.g. under climate change or during extreme events.
+* **Resilience Mechanisms**: Biota may develop resilience mechanisms such as dormancy,
+migration, or phenotypic plasticity to cope with microclimatic variability.
+
+## Methods for microclimate science
+
+This section gives a broad overview over common methods and models in microclimate
+research. Recent advances in data aquisition for microclimate research and microclimate
+modelling are provided in a comprehensive review by {cite:t}`kemppinen_microclimate_2024`.
+
+### Microclimate data collection
+
+Effective microclimate modelling relies on accurate data collection, ideally from a
+combination of sources:
+
+* **Meteorological stations**: Meteorological stations provide detailed, real-time data
+on temperature, humidity, wind speed, and solar radiation for locations across an area.
+* **Remote sensing**: Satellites, planes, drones, and other technologies offer
+extensive spatial coverage, capturing data on land surface temperatures and
+vegetation health.
+* **In-situ measurements**: Ground-based sensors complement provide high-resolution data
+on specific local conditions.
+* **Reanalysis**: Reanalysis data sets such as ERA5 represent a combination of observations
+and modelling which can complement measurements by filling gaps in spatial cover and timeseries.
+
+### Microclimate modelling
+
+Microclimate models use various computational approaches to simulate the interactions
+between atmospheric, terrestrial, and hydrological processes:
+
+* **Energy balance models** calculate the exchange of energy between the surface and the
+atmosphere, accounting for factors like radiation, convection, and conduction.
+* **Statistical models** utilize historical data to identify patterns and predict future
+conditions.
+* **Process-based models**, which incorporate physical laws and biological processes,
+offer a detailed simulation of microclimate dynamics over time and space, providing
+insights into how changes in one factor may impact the entire system.
+
+## Challenges and limitations
+
+* **Data availability and quality**: Microclimate models require high-resolution, long-term
+meteorological data for calibration and validation. Most ecosystems, especially in
+remote areas, lack sufficient weather stations and ground observations to offer the data
+required to model microclimate accurately.
+* **Computational resources**: High-resolution microclimate models can be computationally
+intensive, requiring significant processing power and time.
+* **Model complexity**: Accurately simulating microclimate processes involves complex
+interactions between various atmospheric, terrestrial, and hydrological factors. Not all
+of these interactions are well understood. Simplifications and assumptions necessary for
+computational feasibility can reduce model accuracy.
+* **Parameter sensitivity**: Microclimate models are highly sensitive to input parameters
+such as soil moisture, vegetation cover, and land surface properties. Small errors in
+these parameters can lead to significant deviations in model outputs.
+* **Representation of extreme events**: Accurately modelling extreme weather events with
+high spatial and temporal precision (e.g., heatwaves, storms) is difficult due to their
+complex and unpredictable nature. However, these events can have disproportionate impacts
+on ecosystem dynamics and in particular mortality rates.
+* **Integration with other models**: Combining microclimate models with broader
+ecological or hydrological models involves addressing compatibility and consistency issues.
+This includes for example interconnected processes happing at different time scales.
+* **Human impacts**: Incorporating the effects of human activities (e.g. urbanization,
+land use changes, conservation actions) into microclimate models adds another layer of
+complexity.
diff --git a/docs/source/virtual_ecosystem/theory/plant_theory.md b/docs/source/virtual_ecosystem/theory/plant_theory.md
new file mode 100644
index 000000000..1b6d6ed98
--- /dev/null
+++ b/docs/source/virtual_ecosystem/theory/plant_theory.md
@@ -0,0 +1 @@
+# Theory of the plants
diff --git a/docs/source/virtual_ecosystem/soil/soil_details.md b/docs/source/virtual_ecosystem/theory/soil_theory.md
similarity index 98%
rename from docs/source/virtual_ecosystem/soil/soil_details.md
rename to docs/source/virtual_ecosystem/theory/soil_theory.md
index 2324af5ba..08fcf97e1 100644
--- a/docs/source/virtual_ecosystem/soil/soil_details.md
+++ b/docs/source/virtual_ecosystem/theory/soil_theory.md
@@ -1,7 +1,6 @@
-# Further details of soil module
+# Theory of the soil and litter
-This document contains details of the plan for the soil module. At some future date it
-should probably be split into multiple pages.
+This page provides an overview of the theory underlying the soil module.
## Soil carbon pools
diff --git a/docs/source/virtual_ecosystem/theory/theory.md b/docs/source/virtual_ecosystem/theory/theory.md
new file mode 100644
index 000000000..54300df04
--- /dev/null
+++ b/docs/source/virtual_ecosystem/theory/theory.md
@@ -0,0 +1,93 @@
+# The theory of the Virtual Ecosystem
+
+Ecosystems are complex systems that arise from the interplay between
+[animals](./animal_theory.md),
+[plants](./plant_theory.md),
+and [soil microbes](./soil_theory.md) with their
+[abiotic environment](./abiotic_theory.md). Many of these interactions are
+non-linear and happen across a wide range of spatial and temporal scales which makes
+ecosystem dynamics and emergent phenomena such as resilience to environmental stressors
+challenging to understand and predict.
+
+Despite rapid advancements in the development of detailed ecological models for
+terrestrial ecosystems
+{cite}`best_joint_2011,
+clark_joint_2011,
+harfoot_madingley_2014,
+fatichi_mechanistic_2019,
+geary_guide_2020`
+, most models are limited in the breadth of processes being incorporated, and in the
+diversity of users that might benefit from such models.
+
+The general approach of the **Virtual Ecosystem** is to build on these model frameworks,
+and to connect this prior work into a single modelling framework
+that provides a fully mechanistic, fully integrated representation of key abiotic and
+biotic processes that govern three key emergent properties of terrestrical ecosystems:
+their stability, resilience, and sustainability.
+
+We think we can replicate complex
+ecosystem dynamics by focussing on the physiology of individual organisms and how
+that’s influenced by the abiotic environment simulated based on first-principles physics
+{numref}`ve_diagram`. The development serves the perspectives of a wide variety of users
+and disciplines (see Box; Virtual Ecosystem Project Team 2024).
+
+:::{figure} ../../_static/images/ve_diagram.svg
+:name: ve_diagram
+:alt: A diagram of the four domains in the Virtual Ecosystem
+:scale: 70 %
+:align: left
+
+The key processes in the Virtual Ecosystem (from {cite:alp}`ewers_new_2024`).
+The model aims to replicate ecosystem dynamics across four
+ecological domains: plants, animals, soil, and the abiotic environment. These domains are
+dynamically connected through the transfer of matter and energy.
+:::
+
+:::{card}User Stories
+User stories serve as a project management tool that outlines the criteria for project
+success. Below, we present example user stories as outlined in {cite}`ewers_new_2024`,
+each equally vital in defining the success of a holistic ecosystem model. Fulfilling
+the requirements of all user stories is necessary for the model to achieve complete
+success.
+
+Core user stories
+
+* As a systems ecologist, I will be able to identify any core components and
+sub-networks that exert strong control over the full system dynamics, so that I can
+understand the mechanisms underlying ecosystem stability.
+* As a disturbance ecologist, I will be able to track the attenuation of external
+perturbations through the system, so that I can understand the mechanisms underlying
+ecosystem resilience.
+* As a sustainability scientist, I will be able to calculate the rate at which ecosystem
+services are provided, so that I can make predictions about the long-term sustainability
+of the ecosystem.
+* As a biogeochemist, I will be able to track the flow of carbon, nitrogen and
+phosphorus through the ecosystem, so that I can quantify elemental balances and
+residence times.
+* As a computational ecologist, I will have a modular tool that will allow me to
+contrast different approaches to modelling ecosystems, so that I can better understand
+the processes that drive ecosystem dynamics.
+* As a community ecologist, I will be able to predict the spatial and temporal
+distribution of biomass within and among functional groups, so that I can understand how
+functional diversity is maintained.
+
+Applied User stories
+
+* As a hydrologist, I will be able to predict the frequency and magnitude of flood
+events, so that I can design downstream flood defences.
+* As a field ecologist, I will be able to identify knowledge gaps that significantly
+impair our ability to predict ecosystem dynamics, so that I can prioritise future data
+collection activities.
+* As an applied ecologist, I will be able to examine the impact of climate change and
+extreme climatic events on ecosystem dynamics, so that I can predict the likely future
+state of the ecosystem.
+* As a conservation biologist, I will be able to examine the impacts of invasion,
+introduction and extinction on ecosystem dynamics, so that I can quantify the
+importance of species-level conservation actions.
+* As a climate scientist or carbon offsetting company, I will be able to examine the net
+carbon sequestration potential of an ecosystem over decadal to centennial timescales.
+* As a resource manager, I will be able to predict the outcomes of competing sets of
+management strategies, so that I can make informed decisions about implementing
+cost-effective management actions.
+
+:::
diff --git a/docs/source/virtual_ecosystem/usage.md b/docs/source/virtual_ecosystem/usage.md
deleted file mode 100644
index e0db659be..000000000
--- a/docs/source/virtual_ecosystem/usage.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# Basic Virtual Ecosystem model usage
-
-## Installing the Virtual Ecosystem model
-
-For most users the best way to make use of the Virtual Ecosystem package is to install
-it via `pip`. It should be noted, however, that this isn't currently possible.
-
-Developer installation should be carried out using poetry. This is achieved by creating
-a local copy of the Virtual Ecosystem `git` repository. The package is then installed
-by calling navigating to the repository and calling:
-
-```shell
-poetry install
-```
-
-This will install the model and all its dependencies. The model entry points (e.g.
-`ve_run`) can then be made use of by calling `poetry run {name_of_entrypoint}`, or by
-entering a poetry shell (by calling `poetry shell`). When actively developing it is
-generally better to be within a poetry shell, as this ensures that you have command line
-access to all relevant dependencies.
-
-## Running an example Virtual Ecosystem simulation
-
-Some example data is included with Virtual Ecosystem to provide
-an introduction to the file formats and configuration. To try Virtual Ecosystem using
-this example data, you first need to install the data to a location of your choice. The
-command below will create the `ve_example` directory at the location you choose and
-install all of the configuration and data files to run a model.
-
-```shell
-ve_run --install-example /path/
-```
-
-You can then run the model itself:
-
-```shell
-ve_run /path/ve_example/config \
- --outpath /path/ve_example/config/out \
- --logfile /path/ve_example/out/ve_example.log
-```
-
-Once you want to start digging into the structure of the model and inputs, the [example
-data](./example_data.md) pages provides a detailed description of the contents of the
-`ve_example` directory.
diff --git a/poetry.lock b/poetry.lock
index 1cc431947..8cb3d5412 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1,26 +1,146 @@
+# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.
+
[[package]]
name = "alabaster"
version = "0.7.16"
description = "A light, configurable Sphinx theme"
-category = "dev"
optional = false
python-versions = ">=3.9"
+files = [
+ {file = "alabaster-0.7.16-py3-none-any.whl", hash = "sha256:b46733c07dce03ae4e150330b975c75737fa60f0a7c591b6c8bf4928a28e2c92"},
+ {file = "alabaster-0.7.16.tar.gz", hash = "sha256:75a8b99c28a5dad50dd7f8ccdd447a121ddb3892da9e53d1ca5cca3106d58d65"},
+]
+
+[[package]]
+name = "anyio"
+version = "4.4.0"
+description = "High level compatibility layer for multiple asynchronous event loop implementations"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "anyio-4.4.0-py3-none-any.whl", hash = "sha256:c1b2d8f46a8a812513012e1107cb0e68c17159a7a594208005a57dc776e1bdc7"},
+ {file = "anyio-4.4.0.tar.gz", hash = "sha256:5aadc6a1bbb7cdb0bede386cac5e2940f5e2ff3aa20277e991cf028e0585ce94"},
+]
+
+[package.dependencies]
+exceptiongroup = {version = ">=1.0.2", markers = "python_version < \"3.11\""}
+idna = ">=2.8"
+sniffio = ">=1.1"
+typing-extensions = {version = ">=4.1", markers = "python_version < \"3.11\""}
+
+[package.extras]
+doc = ["Sphinx (>=7)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx-rtd-theme"]
+test = ["anyio[trio]", "coverage[toml] (>=7)", "exceptiongroup (>=1.2.0)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "pytest-mock (>=3.6.1)", "trustme", "uvloop (>=0.17)"]
+trio = ["trio (>=0.23)"]
+
+[[package]]
+name = "appdirs"
+version = "1.4.4"
+description = "A small Python module for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
+optional = false
+python-versions = "*"
+files = [
+ {file = "appdirs-1.4.4-py2.py3-none-any.whl", hash = "sha256:a841dacd6b99318a741b166adb07e19ee71a274450e68237b4650ca1055ab128"},
+ {file = "appdirs-1.4.4.tar.gz", hash = "sha256:7d5d0167b2b1ba821647616af46a749d1c653740dd0d2415100fe26e27afdf41"},
+]
[[package]]
name = "appnope"
version = "0.1.4"
description = "Disable App Nap on macOS >= 10.9"
-category = "dev"
optional = false
python-versions = ">=3.6"
+files = [
+ {file = "appnope-0.1.4-py2.py3-none-any.whl", hash = "sha256:502575ee11cd7a28c0205f379b525beefebab9d161b7c964670864014ed7213c"},
+ {file = "appnope-0.1.4.tar.gz", hash = "sha256:1de3860566df9caf38f01f86f65e0e13e379af54f9e4bee1e66b48f2efffd1ee"},
+]
+
+[[package]]
+name = "argon2-cffi"
+version = "23.1.0"
+description = "Argon2 for Python"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "argon2_cffi-23.1.0-py3-none-any.whl", hash = "sha256:c670642b78ba29641818ab2e68bd4e6a78ba53b7eff7b4c3815ae16abf91c7ea"},
+ {file = "argon2_cffi-23.1.0.tar.gz", hash = "sha256:879c3e79a2729ce768ebb7d36d4609e3a78a4ca2ec3a9f12286ca057e3d0db08"},
+]
+
+[package.dependencies]
+argon2-cffi-bindings = "*"
+
+[package.extras]
+dev = ["argon2-cffi[tests,typing]", "tox (>4)"]
+docs = ["furo", "myst-parser", "sphinx", "sphinx-copybutton", "sphinx-notfound-page"]
+tests = ["hypothesis", "pytest"]
+typing = ["mypy"]
+
+[[package]]
+name = "argon2-cffi-bindings"
+version = "21.2.0"
+description = "Low-level CFFI bindings for Argon2"
+optional = false
+python-versions = ">=3.6"
+files = [
+ {file = "argon2-cffi-bindings-21.2.0.tar.gz", hash = "sha256:bb89ceffa6c791807d1305ceb77dbfacc5aa499891d2c55661c6459651fc39e3"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-macosx_10_9_x86_64.whl", hash = "sha256:ccb949252cb2ab3a08c02024acb77cfb179492d5701c7cbdbfd776124d4d2367"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9524464572e12979364b7d600abf96181d3541da11e23ddf565a32e70bd4dc0d"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b746dba803a79238e925d9046a63aa26bf86ab2a2fe74ce6b009a1c3f5c8f2ae"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:58ed19212051f49a523abb1dbe954337dc82d947fb6e5a0da60f7c8471a8476c"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:bd46088725ef7f58b5a1ef7ca06647ebaf0eb4baff7d1d0d177c6cc8744abd86"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-musllinux_1_1_i686.whl", hash = "sha256:8cd69c07dd875537a824deec19f978e0f2078fdda07fd5c42ac29668dda5f40f"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:f1152ac548bd5b8bcecfb0b0371f082037e47128653df2e8ba6e914d384f3c3e"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-win32.whl", hash = "sha256:603ca0aba86b1349b147cab91ae970c63118a0f30444d4bc80355937c950c082"},
+ {file = "argon2_cffi_bindings-21.2.0-cp36-abi3-win_amd64.whl", hash = "sha256:b2ef1c30440dbbcba7a5dc3e319408b59676e2e039e2ae11a8775ecf482b192f"},
+ {file = "argon2_cffi_bindings-21.2.0-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:e415e3f62c8d124ee16018e491a009937f8cf7ebf5eb430ffc5de21b900dad93"},
+ {file = "argon2_cffi_bindings-21.2.0-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:3e385d1c39c520c08b53d63300c3ecc28622f076f4c2b0e6d7e796e9f6502194"},
+ {file = "argon2_cffi_bindings-21.2.0-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2c3e3cc67fdb7d82c4718f19b4e7a87123caf8a93fde7e23cf66ac0337d3cb3f"},
+ {file = "argon2_cffi_bindings-21.2.0-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6a22ad9800121b71099d0fb0a65323810a15f2e292f2ba450810a7316e128ee5"},
+ {file = "argon2_cffi_bindings-21.2.0-pp37-pypy37_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f9f8b450ed0547e3d473fdc8612083fd08dd2120d6ac8f73828df9b7d45bb351"},
+ {file = "argon2_cffi_bindings-21.2.0-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:93f9bf70084f97245ba10ee36575f0c3f1e7d7724d67d8e5b08e61787c320ed7"},
+ {file = "argon2_cffi_bindings-21.2.0-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:3b9ef65804859d335dc6b31582cad2c5166f0c3e7975f324d9ffaa34ee7e6583"},
+ {file = "argon2_cffi_bindings-21.2.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d4966ef5848d820776f5f562a7d45fdd70c2f330c961d0d745b784034bd9f48d"},
+ {file = "argon2_cffi_bindings-21.2.0-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:20ef543a89dee4db46a1a6e206cd015360e5a75822f76df533845c3cbaf72670"},
+ {file = "argon2_cffi_bindings-21.2.0-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ed2937d286e2ad0cc79a7087d3c272832865f779430e0cc2b4f3718d3159b0cb"},
+ {file = "argon2_cffi_bindings-21.2.0-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:5e00316dabdaea0b2dd82d141cc66889ced0cdcbfa599e8b471cf22c620c329a"},
+]
+
+[package.dependencies]
+cffi = ">=1.0.1"
+
+[package.extras]
+dev = ["cogapp", "pre-commit", "pytest", "wheel"]
+tests = ["pytest"]
+
+[[package]]
+name = "arrow"
+version = "1.3.0"
+description = "Better dates & times for Python"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "arrow-1.3.0-py3-none-any.whl", hash = "sha256:c728b120ebc00eb84e01882a6f5e7927a53960aa990ce7dd2b10f39005a67f80"},
+ {file = "arrow-1.3.0.tar.gz", hash = "sha256:d4540617648cb5f895730f1ad8c82a65f2dad0166f57b75f3ca54759c4d67a85"},
+]
+
+[package.dependencies]
+python-dateutil = ">=2.7.0"
+types-python-dateutil = ">=2.8.10"
+
+[package.extras]
+doc = ["doc8", "sphinx (>=7.0.0)", "sphinx-autobuild", "sphinx-autodoc-typehints", "sphinx_rtd_theme (>=1.3.0)"]
+test = ["dateparser (==1.*)", "pre-commit", "pytest", "pytest-cov", "pytest-mock", "pytz (==2021.1)", "simplejson (==3.*)"]
[[package]]
name = "asttokens"
version = "2.4.1"
description = "Annotate AST trees with source code positions"
-category = "dev"
optional = false
python-versions = "*"
+files = [
+ {file = "asttokens-2.4.1-py2.py3-none-any.whl", hash = "sha256:051ed49c3dcae8913ea7cd08e46a606dba30b79993209636c4875bc1d637bc24"},
+ {file = "asttokens-2.4.1.tar.gz", hash = "sha256:b03869718ba9a6eb027e134bfdf69f38a236d681c83c160d510768af11254ba0"},
+]
[package.dependencies]
six = ">=1.12.0"
@@ -29,13 +149,30 @@ six = ">=1.12.0"
astroid = ["astroid (>=1,<2)", "astroid (>=2,<4)"]
test = ["astroid (>=1,<2)", "astroid (>=2,<4)", "pytest"]
+[[package]]
+name = "async-lru"
+version = "2.0.4"
+description = "Simple LRU cache for asyncio"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "async-lru-2.0.4.tar.gz", hash = "sha256:b8a59a5df60805ff63220b2a0c5b5393da5521b113cd5465a44eb037d81a5627"},
+ {file = "async_lru-2.0.4-py3-none-any.whl", hash = "sha256:ff02944ce3c288c5be660c42dbcca0742b32c3b279d6dceda655190240b99224"},
+]
+
+[package.dependencies]
+typing-extensions = {version = ">=4.0.0", markers = "python_version < \"3.11\""}
+
[[package]]
name = "attrs"
version = "23.2.0"
description = "Classes Without Boilerplate"
-category = "main"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "attrs-23.2.0-py3-none-any.whl", hash = "sha256:99b87a485a5820b23b879f04c2305b44b951b502fd64be915879d77a7e8fc6f1"},
+ {file = "attrs-23.2.0.tar.gz", hash = "sha256:935dc3b529c262f6cf76e50877d35a4bd3c1de194fd41f47a2b7ae8f19971f30"},
+]
[package.extras]
cov = ["attrs[tests]", "coverage[toml] (>=5.3)"]
@@ -49,60 +186,140 @@ tests-no-zope = ["attrs[tests-mypy]", "cloudpickle", "hypothesis", "pympler", "p
name = "autodocsumm"
version = "0.2.12"
description = "Extended sphinx autodoc including automatic autosummaries"
-category = "dev"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "autodocsumm-0.2.12-py3-none-any.whl", hash = "sha256:b842b53c686c07a4f174721ca4e729b027367703dbf42e2508863a3c6d6c049c"},
+ {file = "autodocsumm-0.2.12.tar.gz", hash = "sha256:848fe8c38df433c6635489499b969cb47cc389ed3d7b6e75c8ccbc94d4b3bf9e"},
+]
[package.dependencies]
Sphinx = ">=2.2,<8.0"
[[package]]
name = "babel"
-version = "2.14.0"
+version = "2.15.0"
description = "Internationalization utilities"
-category = "dev"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+files = [
+ {file = "Babel-2.15.0-py3-none-any.whl", hash = "sha256:08706bdad8d0a3413266ab61bd6c34d0c28d6e1e7badf40a2cebe67644e2e1fb"},
+ {file = "babel-2.15.0.tar.gz", hash = "sha256:8daf0e265d05768bc6c7a314cf1321e9a123afc328cc635c18622a2f30a04413"},
+]
[package.extras]
dev = ["freezegun (>=1.0,<2.0)", "pytest (>=6.0)", "pytest-cov"]
[[package]]
-name = "black"
-version = "22.12.0"
-description = "The uncompromising code formatter."
-category = "dev"
+name = "beautifulsoup4"
+version = "4.12.3"
+description = "Screen-scraping library"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.6.0"
+files = [
+ {file = "beautifulsoup4-4.12.3-py3-none-any.whl", hash = "sha256:b80878c9f40111313e55da8ba20bdba06d8fa3969fc68304167741bbf9e082ed"},
+ {file = "beautifulsoup4-4.12.3.tar.gz", hash = "sha256:74e3d1928edc070d21748185c46e3fb33490f22f52a3addee9aee0f4f7781051"},
+]
+
+[package.dependencies]
+soupsieve = ">1.2"
+
+[package.extras]
+cchardet = ["cchardet"]
+chardet = ["chardet"]
+charset-normalizer = ["charset-normalizer"]
+html5lib = ["html5lib"]
+lxml = ["lxml"]
+
+[[package]]
+name = "bleach"
+version = "6.1.0"
+description = "An easy safelist-based HTML-sanitizing tool."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "bleach-6.1.0-py3-none-any.whl", hash = "sha256:3225f354cfc436b9789c66c4ee030194bee0568fbf9cbdad3bc8b5c26c5f12b6"},
+ {file = "bleach-6.1.0.tar.gz", hash = "sha256:0a31f1837963c41d46bbf1331b8778e1308ea0791db03cc4e7357b97cf42a8fe"},
+]
[package.dependencies]
-click = ">=8.0.0"
-mypy-extensions = ">=0.4.3"
-pathspec = ">=0.9.0"
-platformdirs = ">=2"
-tomli = {version = ">=1.1.0", markers = "python_full_version < \"3.11.0a7\""}
+six = ">=1.9.0"
+webencodings = "*"
[package.extras]
-colorama = ["colorama (>=0.4.3)"]
-d = ["aiohttp (>=3.7.4)"]
-jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"]
-uvloop = ["uvloop (>=0.15.2)"]
+css = ["tinycss2 (>=1.1.0,<1.3)"]
[[package]]
name = "certifi"
-version = "2024.2.2"
+version = "2024.6.2"
description = "Python package for providing Mozilla's CA Bundle."
-category = "main"
optional = false
python-versions = ">=3.6"
+files = [
+ {file = "certifi-2024.6.2-py3-none-any.whl", hash = "sha256:ddc6c8ce995e6987e7faf5e3f1b02b302836a0e5d98ece18392cb1a36c72ad56"},
+ {file = "certifi-2024.6.2.tar.gz", hash = "sha256:3cd43f1c6fa7dedc5899d69d3ad0398fd018ad1a17fba83ddaf78aa46c747516"},
+]
[[package]]
name = "cffi"
version = "1.16.0"
description = "Foreign Function Interface for Python calling C code."
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "cffi-1.16.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6b3d6606d369fc1da4fd8c357d026317fbb9c9b75d36dc16e90e84c26854b088"},
+ {file = "cffi-1.16.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ac0f5edd2360eea2f1daa9e26a41db02dd4b0451b48f7c318e217ee092a213e9"},
+ {file = "cffi-1.16.0-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7e61e3e4fa664a8588aa25c883eab612a188c725755afff6289454d6362b9673"},
+ {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a72e8961a86d19bdb45851d8f1f08b041ea37d2bd8d4fd19903bc3083d80c896"},
+ {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5b50bf3f55561dac5438f8e70bfcdfd74543fd60df5fa5f62d94e5867deca684"},
+ {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7651c50c8c5ef7bdb41108b7b8c5a83013bfaa8a935590c5d74627c047a583c7"},
+ {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4108df7fe9b707191e55f33efbcb2d81928e10cea45527879a4749cbe472614"},
+ {file = "cffi-1.16.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:32c68ef735dbe5857c810328cb2481e24722a59a2003018885514d4c09af9743"},
+ {file = "cffi-1.16.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:673739cb539f8cdaa07d92d02efa93c9ccf87e345b9a0b556e3ecc666718468d"},
+ {file = "cffi-1.16.0-cp310-cp310-win32.whl", hash = "sha256:9f90389693731ff1f659e55c7d1640e2ec43ff725cc61b04b2f9c6d8d017df6a"},
+ {file = "cffi-1.16.0-cp310-cp310-win_amd64.whl", hash = "sha256:e6024675e67af929088fda399b2094574609396b1decb609c55fa58b028a32a1"},
+ {file = "cffi-1.16.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b84834d0cf97e7d27dd5b7f3aca7b6e9263c56308ab9dc8aae9784abb774d404"},
+ {file = "cffi-1.16.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1b8ebc27c014c59692bb2664c7d13ce7a6e9a629be20e54e7271fa696ff2b417"},
+ {file = "cffi-1.16.0-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ee07e47c12890ef248766a6e55bd38ebfb2bb8edd4142d56db91b21ea68b7627"},
+ {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d8a9d3ebe49f084ad71f9269834ceccbf398253c9fac910c4fd7053ff1386936"},
+ {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e70f54f1796669ef691ca07d046cd81a29cb4deb1e5f942003f401c0c4a2695d"},
+ {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5bf44d66cdf9e893637896c7faa22298baebcd18d1ddb6d2626a6e39793a1d56"},
+ {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7b78010e7b97fef4bee1e896df8a4bbb6712b7f05b7ef630f9d1da00f6444d2e"},
+ {file = "cffi-1.16.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c6a164aa47843fb1b01e941d385aab7215563bb8816d80ff3a363a9f8448a8dc"},
+ {file = "cffi-1.16.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e09f3ff613345df5e8c3667da1d918f9149bd623cd9070c983c013792a9a62eb"},
+ {file = "cffi-1.16.0-cp311-cp311-win32.whl", hash = "sha256:2c56b361916f390cd758a57f2e16233eb4f64bcbeee88a4881ea90fca14dc6ab"},
+ {file = "cffi-1.16.0-cp311-cp311-win_amd64.whl", hash = "sha256:db8e577c19c0fda0beb7e0d4e09e0ba74b1e4c092e0e40bfa12fe05b6f6d75ba"},
+ {file = "cffi-1.16.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:fa3a0128b152627161ce47201262d3140edb5a5c3da88d73a1b790a959126956"},
+ {file = "cffi-1.16.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:68e7c44931cc171c54ccb702482e9fc723192e88d25a0e133edd7aff8fcd1f6e"},
+ {file = "cffi-1.16.0-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:abd808f9c129ba2beda4cfc53bde801e5bcf9d6e0f22f095e45327c038bfe68e"},
+ {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:88e2b3c14bdb32e440be531ade29d3c50a1a59cd4e51b1dd8b0865c54ea5d2e2"},
+ {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fcc8eb6d5902bb1cf6dc4f187ee3ea80a1eba0a89aba40a5cb20a5087d961357"},
+ {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b7be2d771cdba2942e13215c4e340bfd76398e9227ad10402a8767ab1865d2e6"},
+ {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e715596e683d2ce000574bae5d07bd522c781a822866c20495e52520564f0969"},
+ {file = "cffi-1.16.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2d92b25dbf6cae33f65005baf472d2c245c050b1ce709cc4588cdcdd5495b520"},
+ {file = "cffi-1.16.0-cp312-cp312-win32.whl", hash = "sha256:b2ca4e77f9f47c55c194982e10f058db063937845bb2b7a86c84a6cfe0aefa8b"},
+ {file = "cffi-1.16.0-cp312-cp312-win_amd64.whl", hash = "sha256:68678abf380b42ce21a5f2abde8efee05c114c2fdb2e9eef2efdb0257fba1235"},
+ {file = "cffi-1.16.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:0c9ef6ff37e974b73c25eecc13952c55bceed9112be2d9d938ded8e856138bcc"},
+ {file = "cffi-1.16.0-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a09582f178759ee8128d9270cd1344154fd473bb77d94ce0aeb2a93ebf0feaf0"},
+ {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e760191dd42581e023a68b758769e2da259b5d52e3103c6060ddc02c9edb8d7b"},
+ {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:80876338e19c951fdfed6198e70bc88f1c9758b94578d5a7c4c91a87af3cf31c"},
+ {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a6a14b17d7e17fa0d207ac08642c8820f84f25ce17a442fd15e27ea18d67c59b"},
+ {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6602bc8dc6f3a9e02b6c22c4fc1e47aa50f8f8e6d3f78a5e16ac33ef5fefa324"},
+ {file = "cffi-1.16.0-cp38-cp38-win32.whl", hash = "sha256:131fd094d1065b19540c3d72594260f118b231090295d8c34e19a7bbcf2e860a"},
+ {file = "cffi-1.16.0-cp38-cp38-win_amd64.whl", hash = "sha256:31d13b0f99e0836b7ff893d37af07366ebc90b678b6664c955b54561fc36ef36"},
+ {file = "cffi-1.16.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:582215a0e9adbe0e379761260553ba11c58943e4bbe9c36430c4ca6ac74b15ed"},
+ {file = "cffi-1.16.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:b29ebffcf550f9da55bec9e02ad430c992a87e5f512cd63388abb76f1036d8d2"},
+ {file = "cffi-1.16.0-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dc9b18bf40cc75f66f40a7379f6a9513244fe33c0e8aa72e2d56b0196a7ef872"},
+ {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9cb4a35b3642fc5c005a6755a5d17c6c8b6bcb6981baf81cea8bfbc8903e8ba8"},
+ {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b86851a328eedc692acf81fb05444bdf1891747c25af7529e39ddafaf68a4f3f"},
+ {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c0f31130ebc2d37cdd8e44605fb5fa7ad59049298b3f745c74fa74c62fbfcfc4"},
+ {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f8e709127c6c77446a8c0a8c8bf3c8ee706a06cd44b1e827c3e6a2ee6b8c098"},
+ {file = "cffi-1.16.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:748dcd1e3d3d7cd5443ef03ce8685043294ad6bd7c02a38d1bd367cfd968e000"},
+ {file = "cffi-1.16.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8895613bcc094d4a1b2dbe179d88d7fb4a15cee43c052e8885783fac397d91fe"},
+ {file = "cffi-1.16.0-cp39-cp39-win32.whl", hash = "sha256:ed86a35631f7bfbb28e108dd96773b9d5a6ce4811cf6ea468bb6a359b256b1e4"},
+ {file = "cffi-1.16.0-cp39-cp39-win_amd64.whl", hash = "sha256:3686dffb02459559c74dd3d81748269ffb0eb027c39a6fc99502de37d501faa8"},
+ {file = "cffi-1.16.0.tar.gz", hash = "sha256:bcb3ef43e58665bbda2fb198698fcae6776483e0c4a631aa5647806c25e02cc0"},
+]
[package.dependencies]
pycparser = "*"
@@ -111,36 +328,167 @@ pycparser = "*"
name = "cfgv"
version = "3.4.0"
description = "Validate configuration and produce human readable error messages."
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "cfgv-3.4.0-py2.py3-none-any.whl", hash = "sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9"},
+ {file = "cfgv-3.4.0.tar.gz", hash = "sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560"},
+]
[[package]]
name = "cftime"
-version = "1.6.3"
+version = "1.6.4"
description = "Time-handling functionality from netcdf4-python"
-category = "main"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "cftime-1.6.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:ee70074df4bae0d9ee98f201cf5f11fd302791cf1cdeb73c34f685d6b632e17d"},
+ {file = "cftime-1.6.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:e5456fd58d4cc6b8d7b4932b749617ee142b62a52bc5d8e3c282ce69ce3a20ba"},
+ {file = "cftime-1.6.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1289e08617be350a6b26c6e4352a0cb088625ac33d25e95110df549c26d6ab8e"},
+ {file = "cftime-1.6.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:18b132d9225b4a109929866200846c72302316db9069e2de3ec8d8ec377f567f"},
+ {file = "cftime-1.6.4-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:ca1a264570e68fbb611bba251641b8efd0cf88c0ad2dcab5fa784df264232b75"},
+ {file = "cftime-1.6.4-cp310-cp310-win_amd64.whl", hash = "sha256:6fc82928cbf477bebf233f41914e64bff7b9e894c7f0c34170784a48250f8da7"},
+ {file = "cftime-1.6.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c1558d9b477bd29626cd8bfc89e736635f72887d1a993e2834ab579bba7abb8c"},
+ {file = "cftime-1.6.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:03494e7b66a2fbb6b04e364ab67185130dee0ced660abac5c1559070571d143d"},
+ {file = "cftime-1.6.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4dcb2a01d4e614437582af33b36db4fb441b7666758482864827a1f037d2b639"},
+ {file = "cftime-1.6.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b47bf25195fb3889bbae34df0e80957eb69c48f66902f5d538c7a8ec34253f6"},
+ {file = "cftime-1.6.4-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:d4f2cc0d5c6ffba9c5b0fd1ecd0c7c1c426d0be7b8de1480e2a9fb857c1905e9"},
+ {file = "cftime-1.6.4-cp311-cp311-win_amd64.whl", hash = "sha256:76b8f1e5d1e424accdf760a43e0a1793a7b640bab83cb067273d5c9dbb336c44"},
+ {file = "cftime-1.6.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c349a91fa7ac9ec50118b04a8746bdea967bd2fc525d87c776003040b8d3392"},
+ {file = "cftime-1.6.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:588d073400798adc24ece759cd1cb24ef730f55d1f70e31a898e7686f9d763d8"},
+ {file = "cftime-1.6.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6e07b91b488570573bbeb6f815656a8974d13d15b2279c82de2927f4f692bbcd"},
+ {file = "cftime-1.6.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f92f2e405eeda47b30ab6231d8b7d136a55f21034d394f93ade322d356948654"},
+ {file = "cftime-1.6.4-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:567574df94d0de1101bb5da76e7fbc6eabfddeeb2eb8cf83286b3599a136bbf7"},
+ {file = "cftime-1.6.4-cp312-cp312-win_amd64.whl", hash = "sha256:5b5ad7559a16bedadb66af8e417b6805f758acb57aa38d2730844dfc63a1e667"},
+ {file = "cftime-1.6.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:c072fe9e09925af66a9473edf5752ca1890ba752e7c1935d1f0245ad48f0977c"},
+ {file = "cftime-1.6.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:c05a71389f53d6340cb365b60f028c08268c72401660b9ef76108dee9f1cb5b2"},
+ {file = "cftime-1.6.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0edeb1cb019d8155b2513cffb96749c0d7d459370e69bdf03077e0bee214aed8"},
+ {file = "cftime-1.6.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a8f05d5d6bb4137f9783fa61ad330030fcea8dcc6946dea69a27774edbe480e7"},
+ {file = "cftime-1.6.4-cp38-cp38-win_amd64.whl", hash = "sha256:b32ac1278a2a111b066d5a1e6e5ce6f38c4c505993a6a3130873b56f99d7b56f"},
+ {file = "cftime-1.6.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:c20f03e12af39534c3450bba376272803bfb850b5ce6433c839bfaa99f8d835a"},
+ {file = "cftime-1.6.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:90609b3c1a31a756a68ecdbc961a4ce0b22c1620f166c8dabfa3a4c337ac8b9e"},
+ {file = "cftime-1.6.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bbe11ad73b2a0ddc79995da21459fc2a3fd6b1593ca73f00a60e4d81c3e230f3"},
+ {file = "cftime-1.6.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:25f043703e785de0bd7cd8222c0a53317e9aeb3dfc062588b05e6f3ebb007468"},
+ {file = "cftime-1.6.4-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:f9acc272df1022f24fe7dbe9de43fa5d8271985161df14549e4d8d28c90dc9ea"},
+ {file = "cftime-1.6.4-cp39-cp39-win_amd64.whl", hash = "sha256:e8467b6fbf8dbfe0be8c04d61180765fdd3b9ab0fe51313a0bbf87e63634a3d8"},
+ {file = "cftime-1.6.4.tar.gz", hash = "sha256:e325406193758a7ed67308deb52e727782a19e384e183378e7ff62098be0aedc"},
+]
[package.dependencies]
-numpy = {version = ">1.13.3", markers = "python_version < \"3.12.0.rc1\""}
+numpy = [
+ {version = ">1.13.3", markers = "python_version < \"3.12.0.rc1\""},
+ {version = ">=1.26.0b1", markers = "python_version >= \"3.12.0.rc1\""},
+]
[[package]]
name = "charset-normalizer"
version = "3.3.2"
description = "The Real First Universal Charset Detector. Open, modern and actively maintained alternative to Chardet."
-category = "dev"
optional = false
python-versions = ">=3.7.0"
+files = [
+ {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"},
+ {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"},
+ {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"},
+ {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"},
+ {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"},
+ {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"},
+ {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"},
+ {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"},
+]
[[package]]
name = "click"
version = "8.1.7"
description = "Composable command line interface toolkit"
-category = "main"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"},
+ {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"},
+]
[package.dependencies]
colorama = {version = "*", markers = "platform_system == \"Windows\""}
@@ -149,25 +497,34 @@ colorama = {version = "*", markers = "platform_system == \"Windows\""}
name = "cloudpickle"
version = "3.0.0"
description = "Pickler class to extend the standard pickle.Pickler functionality"
-category = "main"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "cloudpickle-3.0.0-py3-none-any.whl", hash = "sha256:246ee7d0c295602a036e86369c77fecda4ab17b506496730f2f576d9016fd9c7"},
+ {file = "cloudpickle-3.0.0.tar.gz", hash = "sha256:996d9a482c6fb4f33c1a35335cf8afd065d2a56e973270364840712d9131a882"},
+]
[[package]]
name = "colorama"
version = "0.4.6"
description = "Cross-platform colored terminal text."
-category = "main"
optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+files = [
+ {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
+ {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
+]
[[package]]
name = "comm"
-version = "0.2.1"
+version = "0.2.2"
description = "Jupyter Python Comm implementation, for usage in ipykernel, xeus-python etc."
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "comm-0.2.2-py3-none-any.whl", hash = "sha256:e6fb86cb70ff661ee8c9c14e7d36d6de3b4066f1441be4063df9c5009f0a64d3"},
+ {file = "comm-0.2.2.tar.gz", hash = "sha256:3fd7a84065306e07bea1773df6eb8282de51ba82f77c72f9c85716ab11fe980e"},
+]
[package.dependencies]
traitlets = ">=4"
@@ -177,29 +534,127 @@ test = ["pytest"]
[[package]]
name = "contourpy"
-version = "1.2.0"
+version = "1.2.1"
description = "Python library for calculating contours of 2D quadrilateral grids"
-category = "dev"
optional = false
python-versions = ">=3.9"
+files = [
+ {file = "contourpy-1.2.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:bd7c23df857d488f418439686d3b10ae2fbf9bc256cd045b37a8c16575ea1040"},
+ {file = "contourpy-1.2.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:5b9eb0ca724a241683c9685a484da9d35c872fd42756574a7cfbf58af26677fd"},
+ {file = "contourpy-1.2.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4c75507d0a55378240f781599c30e7776674dbaf883a46d1c90f37e563453480"},
+ {file = "contourpy-1.2.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:11959f0ce4a6f7b76ec578576a0b61a28bdc0696194b6347ba3f1c53827178b9"},
+ {file = "contourpy-1.2.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:eb3315a8a236ee19b6df481fc5f997436e8ade24a9f03dfdc6bd490fea20c6da"},
+ {file = "contourpy-1.2.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:39f3ecaf76cd98e802f094e0d4fbc6dc9c45a8d0c4d185f0f6c2234e14e5f75b"},
+ {file = "contourpy-1.2.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:94b34f32646ca0414237168d68a9157cb3889f06b096612afdd296003fdd32fd"},
+ {file = "contourpy-1.2.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:457499c79fa84593f22454bbd27670227874cd2ff5d6c84e60575c8b50a69619"},
+ {file = "contourpy-1.2.1-cp310-cp310-win32.whl", hash = "sha256:ac58bdee53cbeba2ecad824fa8159493f0bf3b8ea4e93feb06c9a465d6c87da8"},
+ {file = "contourpy-1.2.1-cp310-cp310-win_amd64.whl", hash = "sha256:9cffe0f850e89d7c0012a1fb8730f75edd4320a0a731ed0c183904fe6ecfc3a9"},
+ {file = "contourpy-1.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6022cecf8f44e36af10bd9118ca71f371078b4c168b6e0fab43d4a889985dbb5"},
+ {file = "contourpy-1.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ef5adb9a3b1d0c645ff694f9bca7702ec2c70f4d734f9922ea34de02294fdf72"},
+ {file = "contourpy-1.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6150ffa5c767bc6332df27157d95442c379b7dce3a38dff89c0f39b63275696f"},
+ {file = "contourpy-1.2.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4c863140fafc615c14a4bf4efd0f4425c02230eb8ef02784c9a156461e62c965"},
+ {file = "contourpy-1.2.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:00e5388f71c1a0610e6fe56b5c44ab7ba14165cdd6d695429c5cd94021e390b2"},
+ {file = "contourpy-1.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d4492d82b3bc7fbb7e3610747b159869468079fe149ec5c4d771fa1f614a14df"},
+ {file = "contourpy-1.2.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:49e70d111fee47284d9dd867c9bb9a7058a3c617274900780c43e38d90fe1205"},
+ {file = "contourpy-1.2.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:b59c0ffceff8d4d3996a45f2bb6f4c207f94684a96bf3d9728dbb77428dd8cb8"},
+ {file = "contourpy-1.2.1-cp311-cp311-win32.whl", hash = "sha256:7b4182299f251060996af5249c286bae9361fa8c6a9cda5efc29fe8bfd6062ec"},
+ {file = "contourpy-1.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2855c8b0b55958265e8b5888d6a615ba02883b225f2227461aa9127c578a4922"},
+ {file = "contourpy-1.2.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:62828cada4a2b850dbef89c81f5a33741898b305db244904de418cc957ff05dc"},
+ {file = "contourpy-1.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:309be79c0a354afff9ff7da4aaed7c3257e77edf6c1b448a779329431ee79d7e"},
+ {file = "contourpy-1.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2e785e0f2ef0d567099b9ff92cbfb958d71c2d5b9259981cd9bee81bd194c9a4"},
+ {file = "contourpy-1.2.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1cac0a8f71a041aa587410424ad46dfa6a11f6149ceb219ce7dd48f6b02b87a7"},
+ {file = "contourpy-1.2.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:af3f4485884750dddd9c25cb7e3915d83c2db92488b38ccb77dd594eac84c4a0"},
+ {file = "contourpy-1.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9ce6889abac9a42afd07a562c2d6d4b2b7134f83f18571d859b25624a331c90b"},
+ {file = "contourpy-1.2.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:a1eea9aecf761c661d096d39ed9026574de8adb2ae1c5bd7b33558af884fb2ce"},
+ {file = "contourpy-1.2.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:187fa1d4c6acc06adb0fae5544c59898ad781409e61a926ac7e84b8f276dcef4"},
+ {file = "contourpy-1.2.1-cp312-cp312-win32.whl", hash = "sha256:c2528d60e398c7c4c799d56f907664673a807635b857df18f7ae64d3e6ce2d9f"},
+ {file = "contourpy-1.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:1a07fc092a4088ee952ddae19a2b2a85757b923217b7eed584fdf25f53a6e7ce"},
+ {file = "contourpy-1.2.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:bb6834cbd983b19f06908b45bfc2dad6ac9479ae04abe923a275b5f48f1a186b"},
+ {file = "contourpy-1.2.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:1d59e739ab0e3520e62a26c60707cc3ab0365d2f8fecea74bfe4de72dc56388f"},
+ {file = "contourpy-1.2.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bd3db01f59fdcbce5b22afad19e390260d6d0222f35a1023d9adc5690a889364"},
+ {file = "contourpy-1.2.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a12a813949e5066148712a0626895c26b2578874e4cc63160bb007e6df3436fe"},
+ {file = "contourpy-1.2.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fe0ccca550bb8e5abc22f530ec0466136379c01321fd94f30a22231e8a48d985"},
+ {file = "contourpy-1.2.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e1d59258c3c67c865435d8fbeb35f8c59b8bef3d6f46c1f29f6123556af28445"},
+ {file = "contourpy-1.2.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:f32c38afb74bd98ce26de7cc74a67b40afb7b05aae7b42924ea990d51e4dac02"},
+ {file = "contourpy-1.2.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:d31a63bc6e6d87f77d71e1abbd7387ab817a66733734883d1fc0021ed9bfa083"},
+ {file = "contourpy-1.2.1-cp39-cp39-win32.whl", hash = "sha256:ddcb8581510311e13421b1f544403c16e901c4e8f09083c881fab2be80ee31ba"},
+ {file = "contourpy-1.2.1-cp39-cp39-win_amd64.whl", hash = "sha256:10a37ae557aabf2509c79715cd20b62e4c7c28b8cd62dd7d99e5ed3ce28c3fd9"},
+ {file = "contourpy-1.2.1-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:a31f94983fecbac95e58388210427d68cd30fe8a36927980fab9c20062645609"},
+ {file = "contourpy-1.2.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ef2b055471c0eb466033760a521efb9d8a32b99ab907fc8358481a1dd29e3bd3"},
+ {file = "contourpy-1.2.1-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:b33d2bc4f69caedcd0a275329eb2198f560b325605810895627be5d4b876bf7f"},
+ {file = "contourpy-1.2.1.tar.gz", hash = "sha256:4d8908b3bee1c889e547867ca4cdc54e5ab6be6d3e078556814a22457f49423c"},
+]
[package.dependencies]
-numpy = ">=1.20,<2.0"
+numpy = ">=1.20"
[package.extras]
bokeh = ["bokeh", "selenium"]
docs = ["furo", "sphinx (>=7.2)", "sphinx-copybutton"]
-mypy = ["contourpy[bokeh,docs]", "docutils-stubs", "mypy (==1.6.1)", "types-Pillow"]
+mypy = ["contourpy[bokeh,docs]", "docutils-stubs", "mypy (==1.8.0)", "types-Pillow"]
test = ["Pillow", "contourpy[test-no-images]", "matplotlib"]
test-no-images = ["pytest", "pytest-cov", "pytest-xdist", "wurlitzer"]
[[package]]
name = "coverage"
-version = "7.4.3"
+version = "7.5.4"
description = "Code coverage measurement for Python"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "coverage-7.5.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6cfb5a4f556bb51aba274588200a46e4dd6b505fb1a5f8c5ae408222eb416f99"},
+ {file = "coverage-7.5.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2174e7c23e0a454ffe12267a10732c273243b4f2d50d07544a91198f05c48f47"},
+ {file = "coverage-7.5.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2214ee920787d85db1b6a0bd9da5f8503ccc8fcd5814d90796c2f2493a2f4d2e"},
+ {file = "coverage-7.5.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:1137f46adb28e3813dec8c01fefadcb8c614f33576f672962e323b5128d9a68d"},
+ {file = "coverage-7.5.4-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b385d49609f8e9efc885790a5a0e89f2e3ae042cdf12958b6034cc442de428d3"},
+ {file = "coverage-7.5.4-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:b4a474f799456e0eb46d78ab07303286a84a3140e9700b9e154cfebc8f527016"},
+ {file = "coverage-7.5.4-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:5cd64adedf3be66f8ccee418473c2916492d53cbafbfcff851cbec5a8454b136"},
+ {file = "coverage-7.5.4-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:e564c2cf45d2f44a9da56f4e3a26b2236504a496eb4cb0ca7221cd4cc7a9aca9"},
+ {file = "coverage-7.5.4-cp310-cp310-win32.whl", hash = "sha256:7076b4b3a5f6d2b5d7f1185fde25b1e54eb66e647a1dfef0e2c2bfaf9b4c88c8"},
+ {file = "coverage-7.5.4-cp310-cp310-win_amd64.whl", hash = "sha256:018a12985185038a5b2bcafab04ab833a9a0f2c59995b3cec07e10074c78635f"},
+ {file = "coverage-7.5.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:db14f552ac38f10758ad14dd7b983dbab424e731588d300c7db25b6f89e335b5"},
+ {file = "coverage-7.5.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3257fdd8e574805f27bb5342b77bc65578e98cbc004a92232106344053f319ba"},
+ {file = "coverage-7.5.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3a6612c99081d8d6134005b1354191e103ec9705d7ba2754e848211ac8cacc6b"},
+ {file = "coverage-7.5.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d45d3cbd94159c468b9b8c5a556e3f6b81a8d1af2a92b77320e887c3e7a5d080"},
+ {file = "coverage-7.5.4-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ed550e7442f278af76d9d65af48069f1fb84c9f745ae249c1a183c1e9d1b025c"},
+ {file = "coverage-7.5.4-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:7a892be37ca35eb5019ec85402c3371b0f7cda5ab5056023a7f13da0961e60da"},
+ {file = "coverage-7.5.4-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:8192794d120167e2a64721d88dbd688584675e86e15d0569599257566dec9bf0"},
+ {file = "coverage-7.5.4-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:820bc841faa502e727a48311948e0461132a9c8baa42f6b2b84a29ced24cc078"},
+ {file = "coverage-7.5.4-cp311-cp311-win32.whl", hash = "sha256:6aae5cce399a0f065da65c7bb1e8abd5c7a3043da9dceb429ebe1b289bc07806"},
+ {file = "coverage-7.5.4-cp311-cp311-win_amd64.whl", hash = "sha256:d2e344d6adc8ef81c5a233d3a57b3c7d5181f40e79e05e1c143da143ccb6377d"},
+ {file = "coverage-7.5.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:54317c2b806354cbb2dc7ac27e2b93f97096912cc16b18289c5d4e44fc663233"},
+ {file = "coverage-7.5.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:042183de01f8b6d531e10c197f7f0315a61e8d805ab29c5f7b51a01d62782747"},
+ {file = "coverage-7.5.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a6bb74ed465d5fb204b2ec41d79bcd28afccf817de721e8a807d5141c3426638"},
+ {file = "coverage-7.5.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b3d45ff86efb129c599a3b287ae2e44c1e281ae0f9a9bad0edc202179bcc3a2e"},
+ {file = "coverage-7.5.4-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5013ed890dc917cef2c9f765c4c6a8ae9df983cd60dbb635df8ed9f4ebc9f555"},
+ {file = "coverage-7.5.4-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:1014fbf665fef86cdfd6cb5b7371496ce35e4d2a00cda501cf9f5b9e6fced69f"},
+ {file = "coverage-7.5.4-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:3684bc2ff328f935981847082ba4fdc950d58906a40eafa93510d1b54c08a66c"},
+ {file = "coverage-7.5.4-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:581ea96f92bf71a5ec0974001f900db495488434a6928a2ca7f01eee20c23805"},
+ {file = "coverage-7.5.4-cp312-cp312-win32.whl", hash = "sha256:73ca8fbc5bc622e54627314c1a6f1dfdd8db69788f3443e752c215f29fa87a0b"},
+ {file = "coverage-7.5.4-cp312-cp312-win_amd64.whl", hash = "sha256:cef4649ec906ea7ea5e9e796e68b987f83fa9a718514fe147f538cfeda76d7a7"},
+ {file = "coverage-7.5.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:cdd31315fc20868c194130de9ee6bfd99755cc9565edff98ecc12585b90be882"},
+ {file = "coverage-7.5.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:02ff6e898197cc1e9fa375581382b72498eb2e6d5fc0b53f03e496cfee3fac6d"},
+ {file = "coverage-7.5.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d05c16cf4b4c2fc880cb12ba4c9b526e9e5d5bb1d81313d4d732a5b9fe2b9d53"},
+ {file = "coverage-7.5.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c5986ee7ea0795a4095ac4d113cbb3448601efca7f158ec7f7087a6c705304e4"},
+ {file = "coverage-7.5.4-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5df54843b88901fdc2f598ac06737f03d71168fd1175728054c8f5a2739ac3e4"},
+ {file = "coverage-7.5.4-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:ab73b35e8d109bffbda9a3e91c64e29fe26e03e49addf5b43d85fc426dde11f9"},
+ {file = "coverage-7.5.4-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:aea072a941b033813f5e4814541fc265a5c12ed9720daef11ca516aeacd3bd7f"},
+ {file = "coverage-7.5.4-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:16852febd96acd953b0d55fc842ce2dac1710f26729b31c80b940b9afcd9896f"},
+ {file = "coverage-7.5.4-cp38-cp38-win32.whl", hash = "sha256:8f894208794b164e6bd4bba61fc98bf6b06be4d390cf2daacfa6eca0a6d2bb4f"},
+ {file = "coverage-7.5.4-cp38-cp38-win_amd64.whl", hash = "sha256:e2afe743289273209c992075a5a4913e8d007d569a406ffed0bd080ea02b0633"},
+ {file = "coverage-7.5.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:b95c3a8cb0463ba9f77383d0fa8c9194cf91f64445a63fc26fb2327e1e1eb088"},
+ {file = "coverage-7.5.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:3d7564cc09dd91b5a6001754a5b3c6ecc4aba6323baf33a12bd751036c998be4"},
+ {file = "coverage-7.5.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:44da56a2589b684813f86d07597fdf8a9c6ce77f58976727329272f5a01f99f7"},
+ {file = "coverage-7.5.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e16f3d6b491c48c5ae726308e6ab1e18ee830b4cdd6913f2d7f77354b33f91c8"},
+ {file = "coverage-7.5.4-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dbc5958cb471e5a5af41b0ddaea96a37e74ed289535e8deca404811f6cb0bc3d"},
+ {file = "coverage-7.5.4-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:a04e990a2a41740b02d6182b498ee9796cf60eefe40cf859b016650147908029"},
+ {file = "coverage-7.5.4-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:ddbd2f9713a79e8e7242d7c51f1929611e991d855f414ca9996c20e44a895f7c"},
+ {file = "coverage-7.5.4-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:b1ccf5e728ccf83acd313c89f07c22d70d6c375a9c6f339233dcf792094bcbf7"},
+ {file = "coverage-7.5.4-cp39-cp39-win32.whl", hash = "sha256:56b4eafa21c6c175b3ede004ca12c653a88b6f922494b023aeb1e836df953ace"},
+ {file = "coverage-7.5.4-cp39-cp39-win_amd64.whl", hash = "sha256:65e528e2e921ba8fd67d9055e6b9f9e34b21ebd6768ae1c1723f4ea6ace1234d"},
+ {file = "coverage-7.5.4-pp38.pp39.pp310-none-any.whl", hash = "sha256:79b356f3dd5b26f3ad23b35c75dbdaf1f9e2450b6bcefc6d0825ea0aa3f86ca5"},
+ {file = "coverage-7.5.4.tar.gz", hash = "sha256:a44963520b069e12789d0faea4e9fdb1e410cdc4aab89d94f7f55cbb7fef0353"},
+]
[package.dependencies]
tomli = {version = "*", optional = true, markers = "python_full_version <= \"3.11.0a6\" and extra == \"toml\""}
@@ -211,9 +666,12 @@ toml = ["tomli"]
name = "cycler"
version = "0.12.1"
description = "Composable style cycles"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "cycler-0.12.1-py3-none-any.whl", hash = "sha256:85cef7cff222d8644161529808465972e51340599459b8ac3ccbac5a854e0d30"},
+ {file = "cycler-0.12.1.tar.gz", hash = "sha256:88bb128f02ba341da8ef447245a9e138fae777f6a23943da4540077d3601eb1c"},
+]
[package.extras]
docs = ["ipython", "matplotlib", "numpydoc", "sphinx"]
@@ -223,9 +681,12 @@ tests = ["pytest", "pytest-cov", "pytest-xdist"]
name = "dask"
version = "2023.12.1"
description = "Parallel PyData with Task Scheduling"
-category = "main"
optional = false
python-versions = ">=3.9"
+files = [
+ {file = "dask-2023.12.1-py3-none-any.whl", hash = "sha256:55f316f32da9e68fe995e2c0dc460cb8888cd4a1af32096753788e8af45a8d10"},
+ {file = "dask-2023.12.1.tar.gz", hash = "sha256:0ac3acd5bdbfacb5ad6401ac7663a1135955b3fa051a118e1b8a88e87b6b44a2"},
+]
[package.dependencies]
click = ">=8.1"
@@ -247,51 +708,100 @@ test = ["pandas[test]", "pre-commit", "pytest", "pytest-cov", "pytest-rerunfailu
[[package]]
name = "debugpy"
-version = "1.8.1"
+version = "1.8.2"
description = "An implementation of the Debug Adapter Protocol for Python"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "debugpy-1.8.2-cp310-cp310-macosx_11_0_x86_64.whl", hash = "sha256:7ee2e1afbf44b138c005e4380097d92532e1001580853a7cb40ed84e0ef1c3d2"},
+ {file = "debugpy-1.8.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3f8c3f7c53130a070f0fc845a0f2cee8ed88d220d6b04595897b66605df1edd6"},
+ {file = "debugpy-1.8.2-cp310-cp310-win32.whl", hash = "sha256:f179af1e1bd4c88b0b9f0fa153569b24f6b6f3de33f94703336363ae62f4bf47"},
+ {file = "debugpy-1.8.2-cp310-cp310-win_amd64.whl", hash = "sha256:0600faef1d0b8d0e85c816b8bb0cb90ed94fc611f308d5fde28cb8b3d2ff0fe3"},
+ {file = "debugpy-1.8.2-cp311-cp311-macosx_11_0_universal2.whl", hash = "sha256:8a13417ccd5978a642e91fb79b871baded925d4fadd4dfafec1928196292aa0a"},
+ {file = "debugpy-1.8.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:acdf39855f65c48ac9667b2801234fc64d46778021efac2de7e50907ab90c634"},
+ {file = "debugpy-1.8.2-cp311-cp311-win32.whl", hash = "sha256:2cbd4d9a2fc5e7f583ff9bf11f3b7d78dfda8401e8bb6856ad1ed190be4281ad"},
+ {file = "debugpy-1.8.2-cp311-cp311-win_amd64.whl", hash = "sha256:d3408fddd76414034c02880e891ea434e9a9cf3a69842098ef92f6e809d09afa"},
+ {file = "debugpy-1.8.2-cp312-cp312-macosx_11_0_universal2.whl", hash = "sha256:5d3ccd39e4021f2eb86b8d748a96c766058b39443c1f18b2dc52c10ac2757835"},
+ {file = "debugpy-1.8.2-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:62658aefe289598680193ff655ff3940e2a601765259b123dc7f89c0239b8cd3"},
+ {file = "debugpy-1.8.2-cp312-cp312-win32.whl", hash = "sha256:bd11fe35d6fd3431f1546d94121322c0ac572e1bfb1f6be0e9b8655fb4ea941e"},
+ {file = "debugpy-1.8.2-cp312-cp312-win_amd64.whl", hash = "sha256:15bc2f4b0f5e99bf86c162c91a74c0631dbd9cef3c6a1d1329c946586255e859"},
+ {file = "debugpy-1.8.2-cp38-cp38-macosx_11_0_x86_64.whl", hash = "sha256:5a019d4574afedc6ead1daa22736c530712465c0c4cd44f820d803d937531b2d"},
+ {file = "debugpy-1.8.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:40f062d6877d2e45b112c0bbade9a17aac507445fd638922b1a5434df34aed02"},
+ {file = "debugpy-1.8.2-cp38-cp38-win32.whl", hash = "sha256:c78ba1680f1015c0ca7115671fe347b28b446081dada3fedf54138f44e4ba031"},
+ {file = "debugpy-1.8.2-cp38-cp38-win_amd64.whl", hash = "sha256:cf327316ae0c0e7dd81eb92d24ba8b5e88bb4d1b585b5c0d32929274a66a5210"},
+ {file = "debugpy-1.8.2-cp39-cp39-macosx_11_0_x86_64.whl", hash = "sha256:1523bc551e28e15147815d1397afc150ac99dbd3a8e64641d53425dba57b0ff9"},
+ {file = "debugpy-1.8.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e24ccb0cd6f8bfaec68d577cb49e9c680621c336f347479b3fce060ba7c09ec1"},
+ {file = "debugpy-1.8.2-cp39-cp39-win32.whl", hash = "sha256:7f8d57a98c5a486c5c7824bc0b9f2f11189d08d73635c326abef268f83950326"},
+ {file = "debugpy-1.8.2-cp39-cp39-win_amd64.whl", hash = "sha256:16c8dcab02617b75697a0a925a62943e26a0330da076e2a10437edd9f0bf3755"},
+ {file = "debugpy-1.8.2-py2.py3-none-any.whl", hash = "sha256:16e16df3a98a35c63c3ab1e4d19be4cbc7fdda92d9ddc059294f18910928e0ca"},
+ {file = "debugpy-1.8.2.zip", hash = "sha256:95378ed08ed2089221896b9b3a8d021e642c24edc8fef20e5d4342ca8be65c00"},
+]
[[package]]
name = "decorator"
version = "5.1.1"
description = "Decorators for Humans"
-category = "dev"
optional = false
python-versions = ">=3.5"
+files = [
+ {file = "decorator-5.1.1-py3-none-any.whl", hash = "sha256:b8c3f85900b9dc423225913c5aace94729fe1fa9763b38939a95226f02d37186"},
+ {file = "decorator-5.1.1.tar.gz", hash = "sha256:637996211036b6385ef91435e4fae22989472f9d571faba8927ba8253acbc330"},
+]
[[package]]
-name = "distlib"
-version = "0.3.8"
+name = "defusedxml"
+version = "0.7.1"
+description = "XML bomb protection for Python stdlib modules"
+optional = false
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+files = [
+ {file = "defusedxml-0.7.1-py2.py3-none-any.whl", hash = "sha256:a352e7e428770286cc899e2542b6cdaedb2b4953ff269a210103ec58f6198a61"},
+ {file = "defusedxml-0.7.1.tar.gz", hash = "sha256:1bb3032db185915b62d7c6209c5a8792be6a32ab2fedacc84e01b52c51aa3e69"},
+]
+
+[[package]]
+name = "distlib"
+version = "0.3.8"
description = "Distribution utilities"
-category = "dev"
optional = false
python-versions = "*"
+files = [
+ {file = "distlib-0.3.8-py2.py3-none-any.whl", hash = "sha256:034db59a0b96f8ca18035f36290806a9a6e6bd9d1ff91e45a7f172eb17e51784"},
+ {file = "distlib-0.3.8.tar.gz", hash = "sha256:1530ea13e350031b6312d8580ddb6b27a104275a31106523b8f123787f494f64"},
+]
[[package]]
name = "docutils"
-version = "0.18.1"
+version = "0.20.1"
description = "Docutils -- Python Documentation Utilities"
-category = "dev"
optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+python-versions = ">=3.7"
+files = [
+ {file = "docutils-0.20.1-py3-none-any.whl", hash = "sha256:96f387a2c5562db4476f09f13bbab2192e764cac08ebbf3a34a95d9b1e4a59d6"},
+ {file = "docutils-0.20.1.tar.gz", hash = "sha256:f08a4e276c3a1583a86dce3e34aba3fe04d02bba2dd51ed16106244e8a923e3b"},
+]
[[package]]
name = "dpath"
-version = "2.1.6"
+version = "2.2.0"
description = "Filesystem-like pathing and searching for dictionaries"
-category = "main"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "dpath-2.2.0-py3-none-any.whl", hash = "sha256:b330a375ded0a0d2ed404440f6c6a715deae5313af40bbb01c8a41d891900576"},
+ {file = "dpath-2.2.0.tar.gz", hash = "sha256:34f7e630dc55ea3f219e555726f5da4b4b25f2200319c8e6902c394258dd6a3e"},
+]
[[package]]
name = "exceptiongroup"
-version = "1.2.0"
+version = "1.2.1"
description = "Backport of PEP 654 (exception groups)"
-category = "dev"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "exceptiongroup-1.2.1-py3-none-any.whl", hash = "sha256:5258b9ed329c5bbdd31a309f53cbfb0b155341807f6ff7606a1e801a891b29ad"},
+ {file = "exceptiongroup-1.2.1.tar.gz", hash = "sha256:a4785e48b045528f5bfe627b6ad554ff32def154f42372786903b7abcfe1aa16"},
+]
[package.extras]
test = ["pytest (>=6)"]
@@ -300,69 +810,130 @@ test = ["pytest (>=6)"]
name = "executing"
version = "2.0.1"
description = "Get the currently executing AST node of a frame, and other information"
-category = "dev"
optional = false
python-versions = ">=3.5"
+files = [
+ {file = "executing-2.0.1-py2.py3-none-any.whl", hash = "sha256:eac49ca94516ccc753f9fb5ce82603156e590b27525a8bc32cce8ae302eb61bc"},
+ {file = "executing-2.0.1.tar.gz", hash = "sha256:35afe2ce3affba8ee97f2d69927fa823b08b472b7b994e36a52a964b93d16147"},
+]
[package.extras]
tests = ["asttokens (>=2.1.0)", "coverage", "coverage-enable-subprocess", "ipython", "littleutils", "pytest", "rich"]
[[package]]
name = "fastjsonschema"
-version = "2.19.1"
+version = "2.20.0"
description = "Fastest Python implementation of JSON schema"
-category = "dev"
optional = false
python-versions = "*"
+files = [
+ {file = "fastjsonschema-2.20.0-py3-none-any.whl", hash = "sha256:5875f0b0fa7a0043a91e93a9b8f793bcbbba9691e7fd83dca95c28ba26d21f0a"},
+ {file = "fastjsonschema-2.20.0.tar.gz", hash = "sha256:3d48fc5300ee96f5d116f10fe6f28d938e6008f59a6a025c2649475b87f76a23"},
+]
[package.extras]
devel = ["colorama", "json-spec", "jsonschema", "pylint", "pytest", "pytest-benchmark", "pytest-cache", "validictory"]
[[package]]
name = "filelock"
-version = "3.13.1"
+version = "3.15.4"
description = "A platform independent file lock."
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "filelock-3.15.4-py3-none-any.whl", hash = "sha256:6ca1fffae96225dab4c6eaf1c4f4f28cd2568d3ec2a44e15a08520504de468e7"},
+ {file = "filelock-3.15.4.tar.gz", hash = "sha256:2207938cbc1844345cb01a5a95524dae30f0ce089eba5b00378295a17e3e90cb"},
+]
[package.extras]
-docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.24)"]
-testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"]
+docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"]
+testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8.0.1)", "pytest (>=7.4.3)", "pytest-asyncio (>=0.21)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)", "virtualenv (>=20.26.2)"]
typing = ["typing-extensions (>=4.8)"]
[[package]]
-name = "flake8"
-version = "4.0.1"
-description = "the modular source code checker: pep8 pyflakes and co"
-category = "dev"
+name = "flexcache"
+version = "0.3"
+description = "Saves and loads to the cache a transformed versions of a source object."
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.9"
+files = [
+ {file = "flexcache-0.3-py3-none-any.whl", hash = "sha256:d43c9fea82336af6e0115e308d9d33a185390b8346a017564611f1466dcd2e32"},
+ {file = "flexcache-0.3.tar.gz", hash = "sha256:18743bd5a0621bfe2cf8d519e4c3bfdf57a269c15d1ced3fb4b64e0ff4600656"},
+]
[package.dependencies]
-mccabe = ">=0.6.0,<0.7.0"
-pycodestyle = ">=2.8.0,<2.9.0"
-pyflakes = ">=2.4.0,<2.5.0"
+typing-extensions = "*"
+
+[package.extras]
+test = ["pytest", "pytest-cov", "pytest-mpl", "pytest-subtests"]
[[package]]
-name = "flake8-docstrings"
-version = "1.7.0"
-description = "Extension for flake8 which uses pydocstyle to check docstrings"
-category = "dev"
+name = "flexparser"
+version = "0.3.1"
+description = "Parsing made fun ... using typing."
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.9"
+files = [
+ {file = "flexparser-0.3.1-py3-none-any.whl", hash = "sha256:2e3e2936bec1f9277f777ef77297522087d96adb09624d4fe4240fd56885c013"},
+ {file = "flexparser-0.3.1.tar.gz", hash = "sha256:36f795d82e50f5c9ae2fde1c33f21f88922fdd67b7629550a3cc4d0b40a66856"},
+]
[package.dependencies]
-flake8 = ">=3"
-pydocstyle = ">=2.1"
+typing-extensions = "*"
+
+[package.extras]
+test = ["pytest", "pytest-cov", "pytest-mpl", "pytest-subtests"]
[[package]]
name = "fonttools"
-version = "4.49.0"
+version = "4.53.0"
description = "Tools to manipulate font files"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "fonttools-4.53.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:52a6e0a7a0bf611c19bc8ec8f7592bdae79c8296c70eb05917fd831354699b20"},
+ {file = "fonttools-4.53.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:099634631b9dd271d4a835d2b2a9e042ccc94ecdf7e2dd9f7f34f7daf333358d"},
+ {file = "fonttools-4.53.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e40013572bfb843d6794a3ce076c29ef4efd15937ab833f520117f8eccc84fd6"},
+ {file = "fonttools-4.53.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:715b41c3e231f7334cbe79dfc698213dcb7211520ec7a3bc2ba20c8515e8a3b5"},
+ {file = "fonttools-4.53.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:74ae2441731a05b44d5988d3ac2cf784d3ee0a535dbed257cbfff4be8bb49eb9"},
+ {file = "fonttools-4.53.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:95db0c6581a54b47c30860d013977b8a14febc206c8b5ff562f9fe32738a8aca"},
+ {file = "fonttools-4.53.0-cp310-cp310-win32.whl", hash = "sha256:9cd7a6beec6495d1dffb1033d50a3f82dfece23e9eb3c20cd3c2444d27514068"},
+ {file = "fonttools-4.53.0-cp310-cp310-win_amd64.whl", hash = "sha256:daaef7390e632283051e3cf3e16aff2b68b247e99aea916f64e578c0449c9c68"},
+ {file = "fonttools-4.53.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:a209d2e624ba492df4f3bfad5996d1f76f03069c6133c60cd04f9a9e715595ec"},
+ {file = "fonttools-4.53.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4f520d9ac5b938e6494f58a25c77564beca7d0199ecf726e1bd3d56872c59749"},
+ {file = "fonttools-4.53.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:eceef49f457253000e6a2d0f7bd08ff4e9fe96ec4ffce2dbcb32e34d9c1b8161"},
+ {file = "fonttools-4.53.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa1f3e34373aa16045484b4d9d352d4c6b5f9f77ac77a178252ccbc851e8b2ee"},
+ {file = "fonttools-4.53.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:28d072169fe8275fb1a0d35e3233f6df36a7e8474e56cb790a7258ad822b6fd6"},
+ {file = "fonttools-4.53.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:4a2a6ba400d386e904fd05db81f73bee0008af37799a7586deaa4aef8cd5971e"},
+ {file = "fonttools-4.53.0-cp311-cp311-win32.whl", hash = "sha256:bb7273789f69b565d88e97e9e1da602b4ee7ba733caf35a6c2affd4334d4f005"},
+ {file = "fonttools-4.53.0-cp311-cp311-win_amd64.whl", hash = "sha256:9fe9096a60113e1d755e9e6bda15ef7e03391ee0554d22829aa506cdf946f796"},
+ {file = "fonttools-4.53.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:d8f191a17369bd53a5557a5ee4bab91d5330ca3aefcdf17fab9a497b0e7cff7a"},
+ {file = "fonttools-4.53.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:93156dd7f90ae0a1b0e8871032a07ef3178f553f0c70c386025a808f3a63b1f4"},
+ {file = "fonttools-4.53.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bff98816cb144fb7b85e4b5ba3888a33b56ecef075b0e95b95bcd0a5fbf20f06"},
+ {file = "fonttools-4.53.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:973d030180eca8255b1bce6ffc09ef38a05dcec0e8320cc9b7bcaa65346f341d"},
+ {file = "fonttools-4.53.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:c4ee5a24e281fbd8261c6ab29faa7fd9a87a12e8c0eed485b705236c65999109"},
+ {file = "fonttools-4.53.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:bd5bc124fae781a4422f61b98d1d7faa47985f663a64770b78f13d2c072410c2"},
+ {file = "fonttools-4.53.0-cp312-cp312-win32.whl", hash = "sha256:a239afa1126b6a619130909c8404070e2b473dd2b7fc4aacacd2e763f8597fea"},
+ {file = "fonttools-4.53.0-cp312-cp312-win_amd64.whl", hash = "sha256:45b4afb069039f0366a43a5d454bc54eea942bfb66b3fc3e9a2c07ef4d617380"},
+ {file = "fonttools-4.53.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:93bc9e5aaa06ff928d751dc6be889ff3e7d2aa393ab873bc7f6396a99f6fbb12"},
+ {file = "fonttools-4.53.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:2367d47816cc9783a28645bc1dac07f8ffc93e0f015e8c9fc674a5b76a6da6e4"},
+ {file = "fonttools-4.53.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:907fa0b662dd8fc1d7c661b90782ce81afb510fc4b7aa6ae7304d6c094b27bce"},
+ {file = "fonttools-4.53.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3e0ad3c6ea4bd6a289d958a1eb922767233f00982cf0fe42b177657c86c80a8f"},
+ {file = "fonttools-4.53.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:73121a9b7ff93ada888aaee3985a88495489cc027894458cb1a736660bdfb206"},
+ {file = "fonttools-4.53.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:ee595d7ba9bba130b2bec555a40aafa60c26ce68ed0cf509983e0f12d88674fd"},
+ {file = "fonttools-4.53.0-cp38-cp38-win32.whl", hash = "sha256:fca66d9ff2ac89b03f5aa17e0b21a97c21f3491c46b583bb131eb32c7bab33af"},
+ {file = "fonttools-4.53.0-cp38-cp38-win_amd64.whl", hash = "sha256:31f0e3147375002aae30696dd1dc596636abbd22fca09d2e730ecde0baad1d6b"},
+ {file = "fonttools-4.53.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7d6166192dcd925c78a91d599b48960e0a46fe565391c79fe6de481ac44d20ac"},
+ {file = "fonttools-4.53.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ef50ec31649fbc3acf6afd261ed89d09eb909b97cc289d80476166df8438524d"},
+ {file = "fonttools-4.53.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7f193f060391a455920d61684a70017ef5284ccbe6023bb056e15e5ac3de11d1"},
+ {file = "fonttools-4.53.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba9f09ff17f947392a855e3455a846f9855f6cf6bec33e9a427d3c1d254c712f"},
+ {file = "fonttools-4.53.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:0c555e039d268445172b909b1b6bdcba42ada1cf4a60e367d68702e3f87e5f64"},
+ {file = "fonttools-4.53.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:5a4788036201c908079e89ae3f5399b33bf45b9ea4514913f4dbbe4fac08efe0"},
+ {file = "fonttools-4.53.0-cp39-cp39-win32.whl", hash = "sha256:d1a24f51a3305362b94681120c508758a88f207fa0a681c16b5a4172e9e6c7a9"},
+ {file = "fonttools-4.53.0-cp39-cp39-win_amd64.whl", hash = "sha256:1e677bfb2b4bd0e5e99e0f7283e65e47a9814b0486cb64a41adf9ef110e078f2"},
+ {file = "fonttools-4.53.0-py3-none-any.whl", hash = "sha256:6b4f04b1fbc01a3569d63359f2227c89ab294550de277fd09d8fca6185669fa4"},
+ {file = "fonttools-4.53.0.tar.gz", hash = "sha256:c93ed66d32de1559b6fc348838c7572d5c0ac1e4a258e76763a5caddd8944002"},
+]
[package.extras]
all = ["brotli (>=1.0.1)", "brotlicffi (>=0.8.0)", "fs (>=2.2.0,<3)", "lxml (>=4.0)", "lz4 (>=1.7.4.2)", "matplotlib", "munkres", "pycairo", "scipy", "skia-pathops (>=0.5.0)", "sympy", "uharfbuzz (>=0.23.0)", "unicodedata2 (>=15.1.0)", "xattr", "zopfli (>=0.1.4)"]
@@ -378,20 +949,35 @@ ufo = ["fs (>=2.2.0,<3)"]
unicode = ["unicodedata2 (>=15.1.0)"]
woff = ["brotli (>=1.0.1)", "brotlicffi (>=0.8.0)", "zopfli (>=0.1.4)"]
+[[package]]
+name = "fqdn"
+version = "1.5.1"
+description = "Validates fully-qualified domain names against RFC 1123, so that they are acceptable to modern bowsers"
+optional = false
+python-versions = ">=2.7, !=3.0, !=3.1, !=3.2, !=3.3, !=3.4, <4"
+files = [
+ {file = "fqdn-1.5.1-py3-none-any.whl", hash = "sha256:3a179af3761e4df6eb2e026ff9e1a3033d3587bf980a0b1b2e1e5d08d7358014"},
+ {file = "fqdn-1.5.1.tar.gz", hash = "sha256:105ed3677e767fb5ca086a0c1f4bb66ebc3c100be518f0e0d755d9eae164d89f"},
+]
+
[[package]]
name = "fsspec"
-version = "2024.2.0"
+version = "2024.6.1"
description = "File-system specification"
-category = "main"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "fsspec-2024.6.1-py3-none-any.whl", hash = "sha256:3cb443f8bcd2efb31295a5b9fdb02aee81d8452c80d28f97a6d0959e6cee101e"},
+ {file = "fsspec-2024.6.1.tar.gz", hash = "sha256:fad7d7e209dd4c1208e3bbfda706620e0da5142bebbd9c384afb95b07e798e49"},
+]
[package.extras]
abfs = ["adlfs"]
adl = ["adlfs"]
arrow = ["pyarrow (>=1)"]
dask = ["dask", "distributed"]
-devel = ["pytest", "pytest-cov"]
+dev = ["pre-commit", "ruff"]
+doc = ["numpydoc", "sphinx", "sphinx-design", "sphinx-rtd-theme", "yarl"]
dropbox = ["dropbox", "dropboxdrivefs", "requests"]
full = ["adlfs", "aiohttp (!=4.0.0a0,!=4.0.0a1)", "dask", "distributed", "dropbox", "dropboxdrivefs", "fusepy", "gcsfs", "libarchive-c", "ocifs", "panel", "paramiko", "pyarrow (>=1)", "pygit2", "requests", "s3fs", "smbprotocol", "tqdm"]
fuse = ["fusepy"]
@@ -408,27 +994,148 @@ s3 = ["s3fs"]
sftp = ["paramiko"]
smb = ["smbprotocol"]
ssh = ["paramiko"]
+test = ["aiohttp (!=4.0.0a0,!=4.0.0a1)", "numpy", "pytest", "pytest-asyncio (!=0.22.0)", "pytest-benchmark", "pytest-cov", "pytest-mock", "pytest-recording", "pytest-rerunfailures", "requests"]
+test-downstream = ["aiobotocore (>=2.5.4,<3.0.0)", "dask-expr", "dask[dataframe,test]", "moto[server] (>4,<5)", "pytest-timeout", "xarray"]
+test-full = ["adlfs", "aiohttp (!=4.0.0a0,!=4.0.0a1)", "cloudpickle", "dask", "distributed", "dropbox", "dropboxdrivefs", "fastparquet", "fusepy", "gcsfs", "jinja2", "kerchunk", "libarchive-c", "lz4", "notebook", "numpy", "ocifs", "pandas", "panel", "paramiko", "pyarrow", "pyarrow (>=1)", "pyftpdlib", "pygit2", "pytest", "pytest-asyncio (!=0.22.0)", "pytest-benchmark", "pytest-cov", "pytest-mock", "pytest-recording", "pytest-rerunfailures", "python-snappy", "requests", "smbprotocol", "tqdm", "urllib3", "zarr", "zstandard"]
tqdm = ["tqdm"]
[[package]]
name = "greenlet"
version = "3.0.3"
description = "Lightweight in-process concurrent programming"
-category = "dev"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "greenlet-3.0.3-cp310-cp310-macosx_11_0_universal2.whl", hash = "sha256:9da2bd29ed9e4f15955dd1595ad7bc9320308a3b766ef7f837e23ad4b4aac31a"},
+ {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d353cadd6083fdb056bb46ed07e4340b0869c305c8ca54ef9da3421acbdf6881"},
+ {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dca1e2f3ca00b84a396bc1bce13dd21f680f035314d2379c4160c98153b2059b"},
+ {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3ed7fb269f15dc662787f4119ec300ad0702fa1b19d2135a37c2c4de6fadfd4a"},
+ {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dd4f49ae60e10adbc94b45c0b5e6a179acc1736cf7a90160b404076ee283cf83"},
+ {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:73a411ef564e0e097dbe7e866bb2dda0f027e072b04da387282b02c308807405"},
+ {file = "greenlet-3.0.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:7f362975f2d179f9e26928c5b517524e89dd48530a0202570d55ad6ca5d8a56f"},
+ {file = "greenlet-3.0.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:649dde7de1a5eceb258f9cb00bdf50e978c9db1b996964cd80703614c86495eb"},
+ {file = "greenlet-3.0.3-cp310-cp310-win_amd64.whl", hash = "sha256:68834da854554926fbedd38c76e60c4a2e3198c6fbed520b106a8986445caaf9"},
+ {file = "greenlet-3.0.3-cp311-cp311-macosx_11_0_universal2.whl", hash = "sha256:b1b5667cced97081bf57b8fa1d6bfca67814b0afd38208d52538316e9422fc61"},
+ {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:52f59dd9c96ad2fc0d5724107444f76eb20aaccb675bf825df6435acb7703559"},
+ {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:afaff6cf5200befd5cec055b07d1c0a5a06c040fe5ad148abcd11ba6ab9b114e"},
+ {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fe754d231288e1e64323cfad462fcee8f0288654c10bdf4f603a39ed923bef33"},
+ {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2797aa5aedac23af156bbb5a6aa2cd3427ada2972c828244eb7d1b9255846379"},
+ {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b7f009caad047246ed379e1c4dbcb8b020f0a390667ea74d2387be2998f58a22"},
+ {file = "greenlet-3.0.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:c5e1536de2aad7bf62e27baf79225d0d64360d4168cf2e6becb91baf1ed074f3"},
+ {file = "greenlet-3.0.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:894393ce10ceac937e56ec00bb71c4c2f8209ad516e96033e4b3b1de270e200d"},
+ {file = "greenlet-3.0.3-cp311-cp311-win_amd64.whl", hash = "sha256:1ea188d4f49089fc6fb283845ab18a2518d279c7cd9da1065d7a84e991748728"},
+ {file = "greenlet-3.0.3-cp312-cp312-macosx_11_0_universal2.whl", hash = "sha256:70fb482fdf2c707765ab5f0b6655e9cfcf3780d8d87355a063547b41177599be"},
+ {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d4d1ac74f5c0c0524e4a24335350edad7e5f03b9532da7ea4d3c54d527784f2e"},
+ {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:149e94a2dd82d19838fe4b2259f1b6b9957d5ba1b25640d2380bea9c5df37676"},
+ {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:15d79dd26056573940fcb8c7413d84118086f2ec1a8acdfa854631084393efcc"},
+ {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:881b7db1ebff4ba09aaaeae6aa491daeb226c8150fc20e836ad00041bcb11230"},
+ {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fcd2469d6a2cf298f198f0487e0a5b1a47a42ca0fa4dfd1b6862c999f018ebbf"},
+ {file = "greenlet-3.0.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:1f672519db1796ca0d8753f9e78ec02355e862d0998193038c7073045899f305"},
+ {file = "greenlet-3.0.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2516a9957eed41dd8f1ec0c604f1cdc86758b587d964668b5b196a9db5bfcde6"},
+ {file = "greenlet-3.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:bba5387a6975598857d86de9eac14210a49d554a77eb8261cc68b7d082f78ce2"},
+ {file = "greenlet-3.0.3-cp37-cp37m-macosx_11_0_universal2.whl", hash = "sha256:5b51e85cb5ceda94e79d019ed36b35386e8c37d22f07d6a751cb659b180d5274"},
+ {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:daf3cb43b7cf2ba96d614252ce1684c1bccee6b2183a01328c98d36fcd7d5cb0"},
+ {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:99bf650dc5d69546e076f413a87481ee1d2d09aaaaaca058c9251b6d8c14783f"},
+ {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2dd6e660effd852586b6a8478a1d244b8dc90ab5b1321751d2ea15deb49ed414"},
+ {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e3391d1e16e2a5a1507d83e4a8b100f4ee626e8eca43cf2cadb543de69827c4c"},
+ {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e1f145462f1fa6e4a4ae3c0f782e580ce44d57c8f2c7aae1b6fa88c0b2efdb41"},
+ {file = "greenlet-3.0.3-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:1a7191e42732df52cb5f39d3527217e7ab73cae2cb3694d241e18f53d84ea9a7"},
+ {file = "greenlet-3.0.3-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:0448abc479fab28b00cb472d278828b3ccca164531daab4e970a0458786055d6"},
+ {file = "greenlet-3.0.3-cp37-cp37m-win32.whl", hash = "sha256:b542be2440edc2d48547b5923c408cbe0fc94afb9f18741faa6ae970dbcb9b6d"},
+ {file = "greenlet-3.0.3-cp37-cp37m-win_amd64.whl", hash = "sha256:01bc7ea167cf943b4c802068e178bbf70ae2e8c080467070d01bfa02f337ee67"},
+ {file = "greenlet-3.0.3-cp38-cp38-macosx_11_0_universal2.whl", hash = "sha256:1996cb9306c8595335bb157d133daf5cf9f693ef413e7673cb07e3e5871379ca"},
+ {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3ddc0f794e6ad661e321caa8d2f0a55ce01213c74722587256fb6566049a8b04"},
+ {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c9db1c18f0eaad2f804728c67d6c610778456e3e1cc4ab4bbd5eeb8e6053c6fc"},
+ {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7170375bcc99f1a2fbd9c306f5be8764eaf3ac6b5cb968862cad4c7057756506"},
+ {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6b66c9c1e7ccabad3a7d037b2bcb740122a7b17a53734b7d72a344ce39882a1b"},
+ {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:098d86f528c855ead3479afe84b49242e174ed262456c342d70fc7f972bc13c4"},
+ {file = "greenlet-3.0.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:81bb9c6d52e8321f09c3d165b2a78c680506d9af285bfccbad9fb7ad5a5da3e5"},
+ {file = "greenlet-3.0.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:fd096eb7ffef17c456cfa587523c5f92321ae02427ff955bebe9e3c63bc9f0da"},
+ {file = "greenlet-3.0.3-cp38-cp38-win32.whl", hash = "sha256:d46677c85c5ba00a9cb6f7a00b2bfa6f812192d2c9f7d9c4f6a55b60216712f3"},
+ {file = "greenlet-3.0.3-cp38-cp38-win_amd64.whl", hash = "sha256:419b386f84949bf0e7c73e6032e3457b82a787c1ab4a0e43732898a761cc9dbf"},
+ {file = "greenlet-3.0.3-cp39-cp39-macosx_11_0_universal2.whl", hash = "sha256:da70d4d51c8b306bb7a031d5cff6cc25ad253affe89b70352af5f1cb68e74b53"},
+ {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:086152f8fbc5955df88382e8a75984e2bb1c892ad2e3c80a2508954e52295257"},
+ {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d73a9fe764d77f87f8ec26a0c85144d6a951a6c438dfe50487df5595c6373eac"},
+ {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b7dcbe92cc99f08c8dd11f930de4d99ef756c3591a5377d1d9cd7dd5e896da71"},
+ {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1551a8195c0d4a68fac7a4325efac0d541b48def35feb49d803674ac32582f61"},
+ {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:64d7675ad83578e3fc149b617a444fab8efdafc9385471f868eb5ff83e446b8b"},
+ {file = "greenlet-3.0.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:b37eef18ea55f2ffd8f00ff8fe7c8d3818abd3e25fb73fae2ca3b672e333a7a6"},
+ {file = "greenlet-3.0.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:77457465d89b8263bca14759d7c1684df840b6811b2499838cc5b040a8b5b113"},
+ {file = "greenlet-3.0.3-cp39-cp39-win32.whl", hash = "sha256:57e8974f23e47dac22b83436bdcf23080ade568ce77df33159e019d161ce1d1e"},
+ {file = "greenlet-3.0.3-cp39-cp39-win_amd64.whl", hash = "sha256:c5ee858cfe08f34712f548c3c363e807e7186f03ad7a5039ebadb29e8c6be067"},
+ {file = "greenlet-3.0.3.tar.gz", hash = "sha256:43374442353259554ce33599da8b692d5aa96f8976d567d4badf263371fbe491"},
+]
[package.extras]
docs = ["Sphinx", "furo"]
test = ["objgraph", "psutil"]
+[[package]]
+name = "h11"
+version = "0.14.0"
+description = "A pure-Python, bring-your-own-I/O implementation of HTTP/1.1"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "h11-0.14.0-py3-none-any.whl", hash = "sha256:e3fe4ac4b851c468cc8363d500db52c2ead036020723024a109d37346efaa761"},
+ {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"},
+]
+
+[[package]]
+name = "httpcore"
+version = "1.0.5"
+description = "A minimal low-level HTTP client."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "httpcore-1.0.5-py3-none-any.whl", hash = "sha256:421f18bac248b25d310f3cacd198d55b8e6125c107797b609ff9b7a6ba7991b5"},
+ {file = "httpcore-1.0.5.tar.gz", hash = "sha256:34a38e2f9291467ee3b44e89dd52615370e152954ba21721378a87b2960f7a61"},
+]
+
+[package.dependencies]
+certifi = "*"
+h11 = ">=0.13,<0.15"
+
+[package.extras]
+asyncio = ["anyio (>=4.0,<5.0)"]
+http2 = ["h2 (>=3,<5)"]
+socks = ["socksio (==1.*)"]
+trio = ["trio (>=0.22.0,<0.26.0)"]
+
+[[package]]
+name = "httpx"
+version = "0.27.0"
+description = "The next generation HTTP client."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "httpx-0.27.0-py3-none-any.whl", hash = "sha256:71d5465162c13681bff01ad59b2cc68dd838ea1f10e51574bac27103f00c91a5"},
+ {file = "httpx-0.27.0.tar.gz", hash = "sha256:a0cb88a46f32dc874e04ee956e4c2764aba2aa228f650b06788ba6bda2962ab5"},
+]
+
+[package.dependencies]
+anyio = "*"
+certifi = "*"
+httpcore = "==1.*"
+idna = "*"
+sniffio = "*"
+
+[package.extras]
+brotli = ["brotli", "brotlicffi"]
+cli = ["click (==8.*)", "pygments (==2.*)", "rich (>=10,<14)"]
+http2 = ["h2 (>=3,<5)"]
+socks = ["socksio (==1.*)"]
+
[[package]]
name = "hypothesis"
-version = "6.98.15"
+version = "6.104.1"
description = "A library for property-based testing"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "hypothesis-6.104.1-py3-none-any.whl", hash = "sha256:a0a898fa78ecaefe76ad248901dc274e598f29198c6015b3053f7f7827670e0e"},
+ {file = "hypothesis-6.104.1.tar.gz", hash = "sha256:4033898019a6149823d2feeb8d214921b4ac2d342a05d6b02e40a3ca4be07eea"},
+]
[package.dependencies]
attrs = ">=22.2.0"
@@ -436,9 +1143,10 @@ exceptiongroup = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
sortedcontainers = ">=2.1.0,<3.0.0"
[package.extras]
-all = ["backports.zoneinfo (>=0.2.1)", "black (>=19.10b0)", "click (>=7.0)", "django (>=3.2)", "dpcontracts (>=0.4)", "lark (>=0.10.1)", "libcst (>=0.3.16)", "numpy (>=1.17.3)", "pandas (>=1.1)", "pytest (>=4.6)", "python-dateutil (>=1.4)", "pytz (>=2014.1)", "redis (>=3.0.0)", "rich (>=9.0.0)", "tzdata (>=2024.1)"]
+all = ["backports.zoneinfo (>=0.2.1)", "black (>=19.10b0)", "click (>=7.0)", "crosshair-tool (>=0.0.55)", "django (>=3.2)", "dpcontracts (>=0.4)", "hypothesis-crosshair (>=0.0.4)", "lark (>=0.10.1)", "libcst (>=0.3.16)", "numpy (>=1.17.3)", "pandas (>=1.1)", "pytest (>=4.6)", "python-dateutil (>=1.4)", "pytz (>=2014.1)", "redis (>=3.0.0)", "rich (>=9.0.0)", "tzdata (>=2024.1)"]
cli = ["black (>=19.10b0)", "click (>=7.0)", "rich (>=9.0.0)"]
codemods = ["libcst (>=0.3.16)"]
+crosshair = ["crosshair-tool (>=0.0.55)", "hypothesis-crosshair (>=0.0.4)"]
dateutil = ["python-dateutil (>=1.4)"]
django = ["django (>=3.2)"]
dpcontracts = ["dpcontracts (>=0.4)"]
@@ -453,62 +1161,80 @@ zoneinfo = ["backports.zoneinfo (>=0.2.1)", "tzdata (>=2024.1)"]
[[package]]
name = "identify"
-version = "2.5.35"
+version = "2.5.36"
description = "File identification library for Python"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "identify-2.5.36-py2.py3-none-any.whl", hash = "sha256:37d93f380f4de590500d9dba7db359d0d3da95ffe7f9de1753faa159e71e7dfa"},
+ {file = "identify-2.5.36.tar.gz", hash = "sha256:e5e00f54165f9047fbebeb4a560f9acfb8af4c88232be60a488e9b68d122745d"},
+]
[package.extras]
license = ["ukkonen"]
[[package]]
name = "idna"
-version = "3.6"
+version = "3.7"
description = "Internationalized Domain Names in Applications (IDNA)"
-category = "dev"
optional = false
python-versions = ">=3.5"
+files = [
+ {file = "idna-3.7-py3-none-any.whl", hash = "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0"},
+ {file = "idna-3.7.tar.gz", hash = "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc"},
+]
[[package]]
name = "imagesize"
version = "1.4.1"
description = "Getting image size from png/jpeg/jpeg2000/gif file"
-category = "dev"
optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+files = [
+ {file = "imagesize-1.4.1-py2.py3-none-any.whl", hash = "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b"},
+ {file = "imagesize-1.4.1.tar.gz", hash = "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"},
+]
[[package]]
name = "importlib-metadata"
-version = "7.0.1"
+version = "8.0.0"
description = "Read metadata from Python packages"
-category = "main"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "importlib_metadata-8.0.0-py3-none-any.whl", hash = "sha256:15584cf2b1bf449d98ff8a6ff1abef57bf20f3ac6454f431736cd3e660921b2f"},
+ {file = "importlib_metadata-8.0.0.tar.gz", hash = "sha256:188bd24e4c346d3f0a933f275c2fec67050326a856b9a359881d7c2a697e8812"},
+]
[package.dependencies]
zipp = ">=0.5"
[package.extras]
-docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"]
+doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"]
perf = ["ipython"]
-testing = ["flufl.flake8", "importlib-resources (>=1.3)", "packaging", "pyfakefs", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy (>=0.9.1)", "pytest-perf (>=0.9.2)", "pytest-ruff"]
+test = ["flufl.flake8", "importlib-resources (>=1.3)", "jaraco.test (>=5.4)", "packaging", "pyfakefs", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-mypy", "pytest-perf (>=0.9.2)", "pytest-ruff (>=0.2.1)"]
[[package]]
name = "iniconfig"
version = "2.0.0"
description = "brain-dead simple config-ini parsing"
-category = "dev"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"},
+ {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"},
+]
[[package]]
name = "ipykernel"
-version = "6.29.3"
+version = "6.29.4"
description = "IPython Kernel for Jupyter"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "ipykernel-6.29.4-py3-none-any.whl", hash = "sha256:1181e653d95c6808039c509ef8e67c4126b3b3af7781496c7cbfb5ed938a27da"},
+ {file = "ipykernel-6.29.4.tar.gz", hash = "sha256:3d44070060f9475ac2092b760123fadf105d2e2493c24848b6691a7c4f42af5c"},
+]
[package.dependencies]
appnope = {version = "*", markers = "platform_system == \"Darwin\""}
@@ -516,7 +1242,7 @@ comm = ">=0.1.1"
debugpy = ">=1.6.5"
ipython = ">=7.23.1"
jupyter-client = ">=6.1.12"
-jupyter-core = ">=4.12,<5.0.0 || >=5.1.0"
+jupyter-core = ">=4.12,<5.0.dev0 || >=5.1.dev0"
matplotlib-inline = ">=0.1"
nest-asyncio = "*"
packaging = "*"
@@ -534,11 +1260,14 @@ test = ["flaky", "ipyparallel", "pre-commit", "pytest (>=7.0)", "pytest-asyncio
[[package]]
name = "ipython"
-version = "8.22.1"
+version = "8.26.0"
description = "IPython: Productive Interactive Computing"
-category = "dev"
optional = false
python-versions = ">=3.10"
+files = [
+ {file = "ipython-8.26.0-py3-none-any.whl", hash = "sha256:e6b347c27bdf9c32ee9d31ae85defc525755a1869f14057e900675b9e8d6e6ff"},
+ {file = "ipython-8.26.0.tar.gz", hash = "sha256:1cec0fbba8404af13facebe83d04436a7434c7400e59f47acf467c64abd0956c"},
+]
[package.dependencies]
colorama = {version = "*", markers = "sys_platform == \"win32\""}
@@ -551,27 +1280,46 @@ prompt-toolkit = ">=3.0.41,<3.1.0"
pygments = ">=2.4.0"
stack-data = "*"
traitlets = ">=5.13.0"
+typing-extensions = {version = ">=4.6", markers = "python_version < \"3.12\""}
[package.extras]
-all = ["ipython[black,doc,kernel,nbconvert,nbformat,notebook,parallel,qtconsole,terminal]", "ipython[test,test-extra]"]
+all = ["ipython[black,doc,kernel,matplotlib,nbconvert,nbformat,notebook,parallel,qtconsole]", "ipython[test,test-extra]"]
black = ["black"]
-doc = ["docrepr", "exceptiongroup", "ipykernel", "ipython[test]", "matplotlib", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "sphinxcontrib-jquery", "stack-data", "typing-extensions"]
+doc = ["docrepr", "exceptiongroup", "intersphinx-registry", "ipykernel", "ipython[test]", "matplotlib", "setuptools (>=18.5)", "sphinx (>=1.3)", "sphinx-rtd-theme", "sphinxcontrib-jquery", "tomli", "typing-extensions"]
kernel = ["ipykernel"]
+matplotlib = ["matplotlib"]
nbconvert = ["nbconvert"]
nbformat = ["nbformat"]
notebook = ["ipywidgets", "notebook"]
parallel = ["ipyparallel"]
qtconsole = ["qtconsole"]
-test = ["pickleshare", "pytest (<8)", "pytest-asyncio (<0.22)", "testpath"]
+test = ["packaging", "pickleshare", "pytest", "pytest-asyncio (<0.22)", "testpath"]
test-extra = ["curio", "ipython[test]", "matplotlib (!=3.2.0)", "nbformat", "numpy (>=1.23)", "pandas", "trio"]
+[[package]]
+name = "isoduration"
+version = "20.11.0"
+description = "Operations with ISO 8601 durations"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "isoduration-20.11.0-py3-none-any.whl", hash = "sha256:b2904c2a4228c3d44f409c8ae8e2370eb21a26f7ac2ec5446df141dde3452042"},
+ {file = "isoduration-20.11.0.tar.gz", hash = "sha256:ac2f9015137935279eac671f94f89eb00584f940f5dc49462a0c4ee692ba1bd9"},
+]
+
+[package.dependencies]
+arrow = ">=0.15.0"
+
[[package]]
name = "isort"
version = "5.13.2"
description = "A Python utility / library to sort Python imports."
-category = "dev"
optional = false
python-versions = ">=3.8.0"
+files = [
+ {file = "isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6"},
+ {file = "isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109"},
+]
[package.extras]
colors = ["colorama (>=0.4.6)"]
@@ -580,9 +1328,12 @@ colors = ["colorama (>=0.4.6)"]
name = "jedi"
version = "0.19.1"
description = "An autocompletion tool for Python that can be used for text editors."
-category = "dev"
optional = false
python-versions = ">=3.6"
+files = [
+ {file = "jedi-0.19.1-py2.py3-none-any.whl", hash = "sha256:e983c654fe5c02867aef4cdfce5a2fbb4a50adc0af145f70504238f18ef5e7e0"},
+ {file = "jedi-0.19.1.tar.gz", hash = "sha256:cf0496f3651bc65d7174ac1b7d043eff454892c708a87d1b683e57b569927ffd"},
+]
[package.dependencies]
parso = ">=0.8.3,<0.9.0"
@@ -594,11 +1345,14 @@ testing = ["Django", "attrs", "colorama", "docopt", "pytest (<7.0.0)"]
[[package]]
name = "jinja2"
-version = "3.1.3"
+version = "3.1.4"
description = "A very fast and expressive template engine."
-category = "dev"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "jinja2-3.1.4-py3-none-any.whl", hash = "sha256:bc5dd2abb727a5319567b7a813e6a2e7318c39f4f487cfe6c89c6f9c7d25197d"},
+ {file = "jinja2-3.1.4.tar.gz", hash = "sha256:4a3aee7acbbe7303aede8e9648d13b8bf88a429282aa6122a993f0ac800cb369"},
+]
[package.dependencies]
MarkupSafe = ">=2.0"
@@ -606,19 +1360,52 @@ MarkupSafe = ">=2.0"
[package.extras]
i18n = ["Babel (>=2.7)"]
+[[package]]
+name = "json5"
+version = "0.9.25"
+description = "A Python implementation of the JSON5 data format."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "json5-0.9.25-py3-none-any.whl", hash = "sha256:34ed7d834b1341a86987ed52f3f76cd8ee184394906b6e22a1e0deb9ab294e8f"},
+ {file = "json5-0.9.25.tar.gz", hash = "sha256:548e41b9be043f9426776f05df8635a00fe06104ea51ed24b67f908856e151ae"},
+]
+
+[[package]]
+name = "jsonpointer"
+version = "3.0.0"
+description = "Identify specific nodes in a JSON document (RFC 6901)"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "jsonpointer-3.0.0-py2.py3-none-any.whl", hash = "sha256:13e088adc14fca8b6aa8177c044e12701e6ad4b28ff10e65f2267a90109c9942"},
+ {file = "jsonpointer-3.0.0.tar.gz", hash = "sha256:2b2d729f2091522d61c3b31f82e11870f60b68f43fbc705cb76bf4b832af59ef"},
+]
+
[[package]]
name = "jsonschema"
-version = "4.21.1"
+version = "4.22.0"
description = "An implementation of JSON Schema validation for Python"
-category = "main"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jsonschema-4.22.0-py3-none-any.whl", hash = "sha256:ff4cfd6b1367a40e7bc6411caec72effadd3db0bbe5017de188f2d6108335802"},
+ {file = "jsonschema-4.22.0.tar.gz", hash = "sha256:5b22d434a45935119af990552c862e5d6d564e8f6601206b305a61fdf661a2b7"},
+]
[package.dependencies]
attrs = ">=22.2.0"
+fqdn = {version = "*", optional = true, markers = "extra == \"format-nongpl\""}
+idna = {version = "*", optional = true, markers = "extra == \"format-nongpl\""}
+isoduration = {version = "*", optional = true, markers = "extra == \"format-nongpl\""}
+jsonpointer = {version = ">1.13", optional = true, markers = "extra == \"format-nongpl\""}
jsonschema-specifications = ">=2023.03.6"
referencing = ">=0.28.4"
+rfc3339-validator = {version = "*", optional = true, markers = "extra == \"format-nongpl\""}
+rfc3986-validator = {version = ">0.1.0", optional = true, markers = "extra == \"format-nongpl\""}
rpds-py = ">=0.7.1"
+uri-template = {version = "*", optional = true, markers = "extra == \"format-nongpl\""}
+webcolors = {version = ">=1.11", optional = true, markers = "extra == \"format-nongpl\""}
[package.extras]
format = ["fqdn", "idna", "isoduration", "jsonpointer (>1.13)", "rfc3339-validator", "rfc3987", "uri-template", "webcolors (>=1.11)"]
@@ -628,9 +1415,12 @@ format-nongpl = ["fqdn", "idna", "isoduration", "jsonpointer (>1.13)", "rfc3339-
name = "jsonschema-specifications"
version = "2023.12.1"
description = "The JSON Schema meta-schemas and vocabularies, exposed as a Registry"
-category = "main"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jsonschema_specifications-2023.12.1-py3-none-any.whl", hash = "sha256:87e4fdf3a94858b8a2ba2778d9ba57d8a9cafca7c7489c46ba0d30a8bc6a9c3c"},
+ {file = "jsonschema_specifications-2023.12.1.tar.gz", hash = "sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc"},
+]
[package.dependencies]
referencing = ">=0.31.0"
@@ -639,9 +1429,12 @@ referencing = ">=0.31.0"
name = "jupyter-cache"
version = "1.0.0"
description = "A defined interface for working with a cache of jupyter notebooks."
-category = "dev"
optional = false
python-versions = ">=3.9"
+files = [
+ {file = "jupyter_cache-1.0.0-py3-none-any.whl", hash = "sha256:594b1c4e29b488b36547e12477645f489dbdc62cc939b2408df5679f79245078"},
+ {file = "jupyter_cache-1.0.0.tar.gz", hash = "sha256:d0fa7d7533cd5798198d8889318269a8c1382ed3b22f622c09a9356521f48687"},
+]
[package.dependencies]
attrs = "*"
@@ -661,14 +1454,17 @@ testing = ["coverage", "ipykernel", "jupytext", "matplotlib", "nbdime", "nbforma
[[package]]
name = "jupyter-client"
-version = "8.6.0"
+version = "8.6.2"
description = "Jupyter protocol implementation and client libraries"
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jupyter_client-8.6.2-py3-none-any.whl", hash = "sha256:50cbc5c66fd1b8f65ecb66bc490ab73217993632809b6e505687de18e9dea39f"},
+ {file = "jupyter_client-8.6.2.tar.gz", hash = "sha256:2bda14d55ee5ba58552a8c53ae43d215ad9868853489213f37da060ced54d8df"},
+]
[package.dependencies]
-jupyter-core = ">=4.12,<5.0.0 || >=5.1.0"
+jupyter-core = ">=4.12,<5.0.dev0 || >=5.1.dev0"
python-dateutil = ">=2.8.2"
pyzmq = ">=23.0"
tornado = ">=6.2"
@@ -676,15 +1472,18 @@ traitlets = ">=5.3"
[package.extras]
docs = ["ipykernel", "myst-parser", "pydata-sphinx-theme", "sphinx (>=4)", "sphinx-autodoc-typehints", "sphinxcontrib-github-alt", "sphinxcontrib-spelling"]
-test = ["coverage", "ipykernel (>=6.14)", "mypy", "paramiko", "pre-commit", "pytest", "pytest-cov", "pytest-jupyter[client] (>=0.4.1)", "pytest-timeout"]
+test = ["coverage", "ipykernel (>=6.14)", "mypy", "paramiko", "pre-commit", "pytest (<8.2.0)", "pytest-cov", "pytest-jupyter[client] (>=0.4.1)", "pytest-timeout"]
[[package]]
name = "jupyter-core"
-version = "5.7.1"
+version = "5.7.2"
description = "Jupyter core package. A base package on which Jupyter projects rely."
-category = "dev"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jupyter_core-5.7.2-py3-none-any.whl", hash = "sha256:4f7315d2f6b4bcf2e3e7cb6e46772eba760ae459cd1f59d29eb57b0a01bd7409"},
+ {file = "jupyter_core-5.7.2.tar.gz", hash = "sha256:aa5f8d32bbf6b431ac830496da7392035d6f61b4f54872f15c4bd2a9c3f536d9"},
+]
[package.dependencies]
platformdirs = ">=2.5"
@@ -693,3018 +1492,2852 @@ traitlets = ">=5.3"
[package.extras]
docs = ["myst-parser", "pydata-sphinx-theme", "sphinx-autodoc-typehints", "sphinxcontrib-github-alt", "sphinxcontrib-spelling", "traitlets"]
-test = ["ipykernel", "pre-commit", "pytest", "pytest-cov", "pytest-timeout"]
-
-[[package]]
-name = "kiwisolver"
-version = "1.4.5"
-description = "A fast implementation of the Cassowary constraint solver"
-category = "dev"
-optional = false
-python-versions = ">=3.7"
+test = ["ipykernel", "pre-commit", "pytest (<8)", "pytest-cov", "pytest-timeout"]
[[package]]
-name = "latexcodec"
-version = "2.0.1"
-description = "A lexer and codec to work with LaTeX code in Python."
-category = "dev"
+name = "jupyter-events"
+version = "0.10.0"
+description = "Jupyter Event System library"
optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+python-versions = ">=3.8"
+files = [
+ {file = "jupyter_events-0.10.0-py3-none-any.whl", hash = "sha256:4b72130875e59d57716d327ea70d3ebc3af1944d3717e5a498b8a06c6c159960"},
+ {file = "jupyter_events-0.10.0.tar.gz", hash = "sha256:670b8229d3cc882ec782144ed22e0d29e1c2d639263f92ca8383e66682845e22"},
+]
[package.dependencies]
-six = ">=1.4.1"
+jsonschema = {version = ">=4.18.0", extras = ["format-nongpl"]}
+python-json-logger = ">=2.0.4"
+pyyaml = ">=5.3"
+referencing = "*"
+rfc3339-validator = "*"
+rfc3986-validator = ">=0.1.1"
+traitlets = ">=5.3"
+
+[package.extras]
+cli = ["click", "rich"]
+docs = ["jupyterlite-sphinx", "myst-parser", "pydata-sphinx-theme", "sphinxcontrib-spelling"]
+test = ["click", "pre-commit", "pytest (>=7.0)", "pytest-asyncio (>=0.19.0)", "pytest-console-scripts", "rich"]
[[package]]
-name = "locket"
-version = "1.0.0"
-description = "File-based locks for Python on Linux and Windows"
-category = "main"
+name = "jupyter-lsp"
+version = "2.2.5"
+description = "Multi-Language Server WebSocket proxy for Jupyter Notebook/Lab server"
optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+python-versions = ">=3.8"
+files = [
+ {file = "jupyter-lsp-2.2.5.tar.gz", hash = "sha256:793147a05ad446f809fd53ef1cd19a9f5256fd0a2d6b7ce943a982cb4f545001"},
+ {file = "jupyter_lsp-2.2.5-py3-none-any.whl", hash = "sha256:45fbddbd505f3fbfb0b6cb2f1bc5e15e83ab7c79cd6e89416b248cb3c00c11da"},
+]
+
+[package.dependencies]
+jupyter-server = ">=1.1.2"
[[package]]
-name = "markdown-it-py"
-version = "3.0.0"
-description = "Python port of markdown-it. Markdown parsing, done right!"
-category = "dev"
+name = "jupyter-server"
+version = "2.14.1"
+description = "The backend—i.e. core services, APIs, and REST endpoints—to Jupyter web applications."
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jupyter_server-2.14.1-py3-none-any.whl", hash = "sha256:16f7177c3a4ea8fe37784e2d31271981a812f0b2874af17339031dc3510cc2a5"},
+ {file = "jupyter_server-2.14.1.tar.gz", hash = "sha256:12558d158ec7a0653bf96cc272bc7ad79e0127d503b982ed144399346694f726"},
+]
[package.dependencies]
-mdurl = ">=0.1,<1.0"
+anyio = ">=3.1.0"
+argon2-cffi = ">=21.1"
+jinja2 = ">=3.0.3"
+jupyter-client = ">=7.4.4"
+jupyter-core = ">=4.12,<5.0.dev0 || >=5.1.dev0"
+jupyter-events = ">=0.9.0"
+jupyter-server-terminals = ">=0.4.4"
+nbconvert = ">=6.4.4"
+nbformat = ">=5.3.0"
+overrides = ">=5.0"
+packaging = ">=22.0"
+prometheus-client = ">=0.9"
+pywinpty = {version = ">=2.0.1", markers = "os_name == \"nt\""}
+pyzmq = ">=24"
+send2trash = ">=1.8.2"
+terminado = ">=0.8.3"
+tornado = ">=6.2.0"
+traitlets = ">=5.6.0"
+websocket-client = ">=1.7"
[package.extras]
-benchmarking = ["psutil", "pytest", "pytest-benchmark"]
-code-style = ["pre-commit (>=3.0,<4.0)"]
-compare = ["commonmark (>=0.9,<1.0)", "markdown (>=3.4,<4.0)", "mistletoe (>=1.0,<2.0)", "mistune (>=2.0,<3.0)", "panflute (>=2.3,<3.0)"]
-linkify = ["linkify-it-py (>=1,<3)"]
-plugins = ["mdit-py-plugins"]
-profiling = ["gprof2dot"]
-rtd = ["jupyter_sphinx", "mdit-py-plugins", "myst-parser", "pyyaml", "sphinx", "sphinx-copybutton", "sphinx-design", "sphinx_book_theme"]
-testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"]
+docs = ["ipykernel", "jinja2", "jupyter-client", "myst-parser", "nbformat", "prometheus-client", "pydata-sphinx-theme", "send2trash", "sphinx-autodoc-typehints", "sphinxcontrib-github-alt", "sphinxcontrib-openapi (>=0.8.0)", "sphinxcontrib-spelling", "sphinxemoji", "tornado", "typing-extensions"]
+test = ["flaky", "ipykernel", "pre-commit", "pytest (>=7.0,<9)", "pytest-console-scripts", "pytest-jupyter[server] (>=0.7)", "pytest-timeout", "requests"]
[[package]]
-name = "markupsafe"
-version = "2.1.5"
-description = "Safely add untrusted strings to HTML/XML markup."
-category = "dev"
+name = "jupyter-server-terminals"
+version = "0.5.3"
+description = "A Jupyter Server Extension Providing Terminals."
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+files = [
+ {file = "jupyter_server_terminals-0.5.3-py3-none-any.whl", hash = "sha256:41ee0d7dc0ebf2809c668e0fc726dfaf258fcd3e769568996ca731b6194ae9aa"},
+ {file = "jupyter_server_terminals-0.5.3.tar.gz", hash = "sha256:5ae0295167220e9ace0edcfdb212afd2b01ee8d179fe6f23c899590e9b8a5269"},
+]
+
+[package.dependencies]
+pywinpty = {version = ">=2.0.3", markers = "os_name == \"nt\""}
+terminado = ">=0.8.3"
+
+[package.extras]
+docs = ["jinja2", "jupyter-server", "mistune (<4.0)", "myst-parser", "nbformat", "packaging", "pydata-sphinx-theme", "sphinxcontrib-github-alt", "sphinxcontrib-openapi", "sphinxcontrib-spelling", "sphinxemoji", "tornado"]
+test = ["jupyter-server (>=2.0.0)", "pytest (>=7.0)", "pytest-jupyter[server] (>=0.5.3)", "pytest-timeout"]
[[package]]
-name = "matplotlib"
-version = "3.8.3"
-description = "Python plotting package"
-category = "dev"
+name = "jupyterlab"
+version = "4.2.3"
+description = "JupyterLab computational environment"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.8"
+files = [
+ {file = "jupyterlab-4.2.3-py3-none-any.whl", hash = "sha256:0b59d11808e84bb84105c73364edfa867dd475492429ab34ea388a52f2e2e596"},
+ {file = "jupyterlab-4.2.3.tar.gz", hash = "sha256:df6e46969ea51d66815167f23d92f105423b7f1f06fa604d4f44aeb018c82c7b"},
+]
[package.dependencies]
-contourpy = ">=1.0.1"
-cycler = ">=0.10"
-fonttools = ">=4.22.0"
-kiwisolver = ">=1.3.1"
-numpy = ">=1.21,<2"
-packaging = ">=20.0"
-pillow = ">=8"
-pyparsing = ">=2.3.1"
-python-dateutil = ">=2.7"
+async-lru = ">=1.0.0"
+httpx = ">=0.25.0"
+ipykernel = ">=6.5.0"
+jinja2 = ">=3.0.3"
+jupyter-core = "*"
+jupyter-lsp = ">=2.0.0"
+jupyter-server = ">=2.4.0,<3"
+jupyterlab-server = ">=2.27.1,<3"
+notebook-shim = ">=0.2"
+packaging = "*"
+setuptools = ">=40.1.0"
+tomli = {version = ">=1.2.2", markers = "python_version < \"3.11\""}
+tornado = ">=6.2.0"
+traitlets = "*"
+
+[package.extras]
+dev = ["build", "bump2version", "coverage", "hatch", "pre-commit", "pytest-cov", "ruff (==0.3.5)"]
+docs = ["jsx-lexer", "myst-parser", "pydata-sphinx-theme (>=0.13.0)", "pytest", "pytest-check-links", "pytest-jupyter", "sphinx (>=1.8,<7.3.0)", "sphinx-copybutton"]
+docs-screenshots = ["altair (==5.3.0)", "ipython (==8.16.1)", "ipywidgets (==8.1.2)", "jupyterlab-geojson (==3.4.0)", "jupyterlab-language-pack-zh-cn (==4.1.post2)", "matplotlib (==3.8.3)", "nbconvert (>=7.0.0)", "pandas (==2.2.1)", "scipy (==1.12.0)", "vega-datasets (==0.9.0)"]
+test = ["coverage", "pytest (>=7.0)", "pytest-check-links (>=0.7)", "pytest-console-scripts", "pytest-cov", "pytest-jupyter (>=0.5.3)", "pytest-timeout", "pytest-tornasync", "requests", "requests-cache", "virtualenv"]
+upgrade-extension = ["copier (>=8,<10)", "jinja2-time (<0.3)", "pydantic (<2.0)", "pyyaml-include (<2.0)", "tomli-w (<2.0)"]
[[package]]
-name = "matplotlib-inline"
-version = "0.1.6"
-description = "Inline Matplotlib backend for Jupyter"
-category = "dev"
+name = "jupyterlab-myst"
+version = "2.4.2"
+description = "Use MyST in JupyterLab"
optional = false
-python-versions = ">=3.5"
+python-versions = ">=3.8"
+files = [
+ {file = "jupyterlab_myst-2.4.2-py3-none-any.whl", hash = "sha256:2aa406d4754dcd2ec4fe749b6a2e15f0bc8a6c5c8f6b549419583715d8146230"},
+ {file = "jupyterlab_myst-2.4.2.tar.gz", hash = "sha256:1b06de66d20dc3a865b07d37f54bff8b4ed01501999cc0683f336f0bcb8c6902"},
+]
[package.dependencies]
-traitlets = "*"
+jupyter-server = {version = ">=2.0.1,<3", markers = "platform_system != \"Emscripten\""}
+
+[package.extras]
+test = ["coverage", "pytest", "pytest-asyncio", "pytest-cov", "pytest-jupyter[server] (>=0.6.0)"]
[[package]]
-name = "mccabe"
-version = "0.6.1"
-description = "McCabe checker, plugin for flake8"
-category = "dev"
+name = "jupyterlab-pygments"
+version = "0.3.0"
+description = "Pygments theme using JupyterLab CSS variables"
optional = false
-python-versions = "*"
+python-versions = ">=3.8"
+files = [
+ {file = "jupyterlab_pygments-0.3.0-py3-none-any.whl", hash = "sha256:841a89020971da1d8693f1a99997aefc5dc424bb1b251fd6322462a1b8842780"},
+ {file = "jupyterlab_pygments-0.3.0.tar.gz", hash = "sha256:721aca4d9029252b11cfa9d185e5b5af4d54772bb8072f9b7036f4170054d35d"},
+]
[[package]]
-name = "mdformat"
-version = "0.7.17"
-description = "CommonMark compliant Markdown formatter"
-category = "dev"
+name = "jupyterlab-server"
+version = "2.27.2"
+description = "A set of server components for JupyterLab and JupyterLab like applications."
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jupyterlab_server-2.27.2-py3-none-any.whl", hash = "sha256:54aa2d64fd86383b5438d9f0c032f043c4d8c0264b8af9f60bd061157466ea43"},
+ {file = "jupyterlab_server-2.27.2.tar.gz", hash = "sha256:15cbb349dc45e954e09bacf81b9f9bcb10815ff660fb2034ecd7417db3a7ea27"},
+]
[package.dependencies]
-markdown-it-py = ">=1.0.0,<4.0.0"
-tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
-
-[[package]]
-name = "mdformat-frontmatter"
-version = "0.4.1"
-description = "An mdformat plugin for parsing / ignoring frontmatter."
-category = "dev"
-optional = false
-python-versions = ">=3.6"
-
-[package.dependencies]
-mdformat = ">=0.7.0,<0.8.0"
-mdit-py-plugins = "*"
-"ruamel.yaml" = "*"
-
-[package.extras]
-dev = ["pre-commit"]
-test = ["coverage", "pytest (>=6.0,<7.0)", "pytest-cov"]
-
-[[package]]
-name = "mdformat-tables"
-version = "0.4.1"
-description = "An mdformat plugin for rendering tables."
-category = "dev"
-optional = false
-python-versions = ">=3.6.1"
-
-[package.dependencies]
-mdformat = ">=0.7.5,<0.8.0"
+babel = ">=2.10"
+jinja2 = ">=3.0.3"
+json5 = ">=0.9.0"
+jsonschema = ">=4.18.0"
+jupyter-server = ">=1.21,<3"
+packaging = ">=21.3"
+requests = ">=2.31"
[package.extras]
-test = ["coverage", "pytest (>=6.0,<7.0)", "pytest-cov"]
+docs = ["autodoc-traits", "jinja2 (<3.2.0)", "mistune (<4)", "myst-parser", "pydata-sphinx-theme", "sphinx", "sphinx-copybutton", "sphinxcontrib-openapi (>0.8)"]
+openapi = ["openapi-core (>=0.18.0,<0.19.0)", "ruamel-yaml"]
+test = ["hatch", "ipykernel", "openapi-core (>=0.18.0,<0.19.0)", "openapi-spec-validator (>=0.6.0,<0.8.0)", "pytest (>=7.0,<8)", "pytest-console-scripts", "pytest-cov", "pytest-jupyter[server] (>=0.6.2)", "pytest-timeout", "requests-mock", "ruamel-yaml", "sphinxcontrib-spelling", "strict-rfc3339", "werkzeug"]
[[package]]
-name = "mdit-py-plugins"
-version = "0.4.0"
-description = "Collection of plugins for markdown-it-py"
-category = "dev"
+name = "jupytext"
+version = "1.16.2"
+description = "Jupyter notebooks as Markdown documents, Julia, Python or R scripts"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "jupytext-1.16.2-py3-none-any.whl", hash = "sha256:197a43fef31dca612b68b311e01b8abd54441c7e637810b16b6cb8f2ab66065e"},
+ {file = "jupytext-1.16.2.tar.gz", hash = "sha256:8627dd9becbbebd79cc4a4ed4727d89d78e606b4b464eab72357b3b029023a14"},
+]
[package.dependencies]
-markdown-it-py = ">=1.0.0,<4.0.0"
+markdown-it-py = ">=1.0"
+mdit-py-plugins = "*"
+nbformat = "*"
+packaging = "*"
+pyyaml = "*"
+tomli = {version = "*", markers = "python_version < \"3.11\""}
[package.extras]
-code-style = ["pre-commit"]
-rtd = ["myst-parser", "sphinx-book-theme"]
-testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"]
+dev = ["autopep8", "black", "flake8", "gitpython", "ipykernel", "isort", "jupyter-fs (<0.4.0)", "jupyter-server (!=2.11)", "nbconvert", "pre-commit", "pytest", "pytest-cov (>=2.6.1)", "pytest-randomly", "pytest-xdist", "sphinx-gallery (<0.8)"]
+docs = ["myst-parser", "sphinx", "sphinx-copybutton", "sphinx-rtd-theme"]
+test = ["pytest", "pytest-randomly", "pytest-xdist"]
+test-cov = ["ipykernel", "jupyter-server (!=2.11)", "nbconvert", "pytest", "pytest-cov (>=2.6.1)", "pytest-randomly", "pytest-xdist"]
+test-external = ["autopep8", "black", "flake8", "gitpython", "ipykernel", "isort", "jupyter-fs (<0.4.0)", "jupyter-server (!=2.11)", "nbconvert", "pre-commit", "pytest", "pytest-randomly", "pytest-xdist", "sphinx-gallery (<0.8)"]
+test-functional = ["pytest", "pytest-randomly", "pytest-xdist"]
+test-integration = ["ipykernel", "jupyter-server (!=2.11)", "nbconvert", "pytest", "pytest-randomly", "pytest-xdist"]
+test-ui = ["calysto-bash"]
[[package]]
-name = "mdurl"
-version = "0.1.2"
-description = "Markdown URL utilities"
-category = "dev"
+name = "kiwisolver"
+version = "1.4.5"
+description = "A fast implementation of the Cassowary constraint solver"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "kiwisolver-1.4.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:05703cf211d585109fcd72207a31bb170a0f22144d68298dc5e61b3c946518af"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:146d14bebb7f1dc4d5fbf74f8a6cb15ac42baadee8912eb84ac0b3b2a3dc6ac3"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6ef7afcd2d281494c0a9101d5c571970708ad911d028137cd558f02b851c08b4"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:9eaa8b117dc8337728e834b9c6e2611f10c79e38f65157c4c38e9400286f5cb1"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ec20916e7b4cbfb1f12380e46486ec4bcbaa91a9c448b97023fde0d5bbf9e4ff"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:39b42c68602539407884cf70d6a480a469b93b81b7701378ba5e2328660c847a"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aa12042de0171fad672b6c59df69106d20d5596e4f87b5e8f76df757a7c399aa"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2a40773c71d7ccdd3798f6489aaac9eee213d566850a9533f8d26332d626b82c"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:19df6e621f6d8b4b9c4d45f40a66839294ff2bb235e64d2178f7522d9170ac5b"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:83d78376d0d4fd884e2c114d0621624b73d2aba4e2788182d286309ebdeed770"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:e391b1f0a8a5a10ab3b9bb6afcfd74f2175f24f8975fb87ecae700d1503cdee0"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:852542f9481f4a62dbb5dd99e8ab7aedfeb8fb6342349a181d4036877410f525"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:59edc41b24031bc25108e210c0def6f6c2191210492a972d585a06ff246bb79b"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-win32.whl", hash = "sha256:a6aa6315319a052b4ee378aa171959c898a6183f15c1e541821c5c59beaa0238"},
+ {file = "kiwisolver-1.4.5-cp310-cp310-win_amd64.whl", hash = "sha256:d0ef46024e6a3d79c01ff13801cb19d0cad7fd859b15037aec74315540acc276"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:11863aa14a51fd6ec28688d76f1735f8f69ab1fabf388851a595d0721af042f5"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:8ab3919a9997ab7ef2fbbed0cc99bb28d3c13e6d4b1ad36e97e482558a91be90"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:fcc700eadbbccbf6bc1bcb9dbe0786b4b1cb91ca0dcda336eef5c2beed37b797"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dfdd7c0b105af050eb3d64997809dc21da247cf44e63dc73ff0fd20b96be55a9"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:76c6a5964640638cdeaa0c359382e5703e9293030fe730018ca06bc2010c4437"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bbea0db94288e29afcc4c28afbf3a7ccaf2d7e027489c449cf7e8f83c6346eb9"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ceec1a6bc6cab1d6ff5d06592a91a692f90ec7505d6463a88a52cc0eb58545da"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:040c1aebeda72197ef477a906782b5ab0d387642e93bda547336b8957c61022e"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:f91de7223d4c7b793867797bacd1ee53bfe7359bd70d27b7b58a04efbb9436c8"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:faae4860798c31530dd184046a900e652c95513796ef51a12bc086710c2eec4d"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:b0157420efcb803e71d1b28e2c287518b8808b7cf1ab8af36718fd0a2c453eb0"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:06f54715b7737c2fecdbf140d1afb11a33d59508a47bf11bb38ecf21dc9ab79f"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:fdb7adb641a0d13bdcd4ef48e062363d8a9ad4a182ac7647ec88f695e719ae9f"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-win32.whl", hash = "sha256:bb86433b1cfe686da83ce32a9d3a8dd308e85c76b60896d58f082136f10bffac"},
+ {file = "kiwisolver-1.4.5-cp311-cp311-win_amd64.whl", hash = "sha256:6c08e1312a9cf1074d17b17728d3dfce2a5125b2d791527f33ffbe805200a355"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:32d5cf40c4f7c7b3ca500f8985eb3fb3a7dfc023215e876f207956b5ea26632a"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f846c260f483d1fd217fe5ed7c173fb109efa6b1fc8381c8b7552c5781756192"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5ff5cf3571589b6d13bfbfd6bcd7a3f659e42f96b5fd1c4830c4cf21d4f5ef45"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7269d9e5f1084a653d575c7ec012ff57f0c042258bf5db0954bf551c158466e7"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:da802a19d6e15dffe4b0c24b38b3af68e6c1a68e6e1d8f30148c83864f3881db"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3aba7311af82e335dd1e36ffff68aaca609ca6290c2cb6d821a39aa075d8e3ff"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:763773d53f07244148ccac5b084da5adb90bfaee39c197554f01b286cf869228"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2270953c0d8cdab5d422bee7d2007f043473f9d2999631c86a223c9db56cbd16"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d099e745a512f7e3bbe7249ca835f4d357c586d78d79ae8f1dcd4d8adeb9bda9"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:74db36e14a7d1ce0986fa104f7d5637aea5c82ca6326ed0ec5694280942d1162"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:7e5bab140c309cb3a6ce373a9e71eb7e4873c70c2dda01df6820474f9889d6d4"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:0f114aa76dc1b8f636d077979c0ac22e7cd8f3493abbab152f20eb8d3cda71f3"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:88a2df29d4724b9237fc0c6eaf2a1adae0cdc0b3e9f4d8e7dc54b16812d2d81a"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-win32.whl", hash = "sha256:72d40b33e834371fd330fb1472ca19d9b8327acb79a5821d4008391db8e29f20"},
+ {file = "kiwisolver-1.4.5-cp312-cp312-win_amd64.whl", hash = "sha256:2c5674c4e74d939b9d91dda0fae10597ac7521768fec9e399c70a1f27e2ea2d9"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:3a2b053a0ab7a3960c98725cfb0bf5b48ba82f64ec95fe06f1d06c99b552e130"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3cd32d6c13807e5c66a7cbb79f90b553642f296ae4518a60d8d76243b0ad2898"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:59ec7b7c7e1a61061850d53aaf8e93db63dce0c936db1fda2658b70e4a1be709"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:da4cfb373035def307905d05041c1d06d8936452fe89d464743ae7fb8371078b"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2400873bccc260b6ae184b2b8a4fec0e4082d30648eadb7c3d9a13405d861e89"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:1b04139c4236a0f3aff534479b58f6f849a8b351e1314826c2d230849ed48985"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:4e66e81a5779b65ac21764c295087de82235597a2293d18d943f8e9e32746265"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:7931d8f1f67c4be9ba1dd9c451fb0eeca1a25b89e4d3f89e828fe12a519b782a"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:b3f7e75f3015df442238cca659f8baa5f42ce2a8582727981cbfa15fee0ee205"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:bbf1d63eef84b2e8c89011b7f2235b1e0bf7dacc11cac9431fc6468e99ac77fb"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:4c380469bd3f970ef677bf2bcba2b6b0b4d5c75e7a020fb863ef75084efad66f"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-win32.whl", hash = "sha256:9408acf3270c4b6baad483865191e3e582b638b1654a007c62e3efe96f09a9a3"},
+ {file = "kiwisolver-1.4.5-cp37-cp37m-win_amd64.whl", hash = "sha256:5b94529f9b2591b7af5f3e0e730a4e0a41ea174af35a4fd067775f9bdfeee01a"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:11c7de8f692fc99816e8ac50d1d1aef4f75126eefc33ac79aac02c099fd3db71"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:53abb58632235cd154176ced1ae8f0d29a6657aa1aa9decf50b899b755bc2b93"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:88b9f257ca61b838b6f8094a62418421f87ac2a1069f7e896c36a7d86b5d4c29"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3195782b26fc03aa9c6913d5bad5aeb864bdc372924c093b0f1cebad603dd712"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fc579bf0f502e54926519451b920e875f433aceb4624a3646b3252b5caa9e0b6"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5a580c91d686376f0f7c295357595c5a026e6cbc3d77b7c36e290201e7c11ecb"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:cfe6ab8da05c01ba6fbea630377b5da2cd9bcbc6338510116b01c1bc939a2c18"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:d2e5a98f0ec99beb3c10e13b387f8db39106d53993f498b295f0c914328b1333"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:a51a263952b1429e429ff236d2f5a21c5125437861baeed77f5e1cc2d2c7c6da"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:3edd2fa14e68c9be82c5b16689e8d63d89fe927e56debd6e1dbce7a26a17f81b"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:74d1b44c6cfc897df648cc9fdaa09bc3e7679926e6f96df05775d4fb3946571c"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:76d9289ed3f7501012e05abb8358bbb129149dbd173f1f57a1bf1c22d19ab7cc"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:92dea1ffe3714fa8eb6a314d2b3c773208d865a0e0d35e713ec54eea08a66250"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-win32.whl", hash = "sha256:5c90ae8c8d32e472be041e76f9d2f2dbff4d0b0be8bd4041770eddb18cf49a4e"},
+ {file = "kiwisolver-1.4.5-cp38-cp38-win_amd64.whl", hash = "sha256:c7940c1dc63eb37a67721b10d703247552416f719c4188c54e04334321351ced"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:9407b6a5f0d675e8a827ad8742e1d6b49d9c1a1da5d952a67d50ef5f4170b18d"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:15568384086b6df3c65353820a4473575dbad192e35010f622c6ce3eebd57af9"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0dc9db8e79f0036e8173c466d21ef18e1befc02de8bf8aa8dc0813a6dc8a7046"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:cdc8a402aaee9a798b50d8b827d7ecf75edc5fb35ea0f91f213ff927c15f4ff0"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:6c3bd3cde54cafb87d74d8db50b909705c62b17c2099b8f2e25b461882e544ff"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:955e8513d07a283056b1396e9a57ceddbd272d9252c14f154d450d227606eb54"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:346f5343b9e3f00b8db8ba359350eb124b98c99efd0b408728ac6ebf38173958"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b9098e0049e88c6a24ff64545cdfc50807818ba6c1b739cae221bbbcbc58aad3"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:00bd361b903dc4bbf4eb165f24d1acbee754fce22ded24c3d56eec268658a5cf"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7b8b454bac16428b22560d0a1cf0a09875339cab69df61d7805bf48919415901"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:f1d072c2eb0ad60d4c183f3fb44ac6f73fb7a8f16a2694a91f988275cbf352f9"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:31a82d498054cac9f6d0b53d02bb85811185bcb477d4b60144f915f3b3126342"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:6512cb89e334e4700febbffaaa52761b65b4f5a3cf33f960213d5656cea36a77"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-win32.whl", hash = "sha256:9db8ea4c388fdb0f780fe91346fd438657ea602d58348753d9fb265ce1bca67f"},
+ {file = "kiwisolver-1.4.5-cp39-cp39-win_amd64.whl", hash = "sha256:59415f46a37f7f2efeec758353dd2eae1b07640d8ca0f0c42548ec4125492635"},
+ {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:5c7b3b3a728dc6faf3fc372ef24f21d1e3cee2ac3e9596691d746e5a536de920"},
+ {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:620ced262a86244e2be10a676b646f29c34537d0d9cc8eb26c08f53d98013390"},
+ {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:378a214a1e3bbf5ac4a8708304318b4f890da88c9e6a07699c4ae7174c09a68d"},
+ {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:aaf7be1207676ac608a50cd08f102f6742dbfc70e8d60c4db1c6897f62f71523"},
+ {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:ba55dce0a9b8ff59495ddd050a0225d58bd0983d09f87cfe2b6aec4f2c1234e4"},
+ {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:fd32ea360bcbb92d28933fc05ed09bffcb1704ba3fc7942e81db0fd4f81a7892"},
+ {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5e7139af55d1688f8b960ee9ad5adafc4ac17c1c473fe07133ac092310d76544"},
+ {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:dced8146011d2bc2e883f9bd68618b8247387f4bbec46d7392b3c3b032640126"},
+ {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c9bf3325c47b11b2e51bca0824ea217c7cd84491d8ac4eefd1e409705ef092bd"},
+ {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:5794cf59533bc3f1b1c821f7206a3617999db9fbefc345360aafe2e067514929"},
+ {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e368f200bbc2e4f905b8e71eb38b3c04333bddaa6a2464a6355487b02bb7fb09"},
+ {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e5d706eba36b4c4d5bc6c6377bb6568098765e990cfc21ee16d13963fab7b3e7"},
+ {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85267bd1aa8880a9c88a8cb71e18d3d64d2751a790e6ca6c27b8ccc724bcd5ad"},
+ {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:210ef2c3a1f03272649aff1ef992df2e724748918c4bc2d5a90352849eb40bea"},
+ {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:11d011a7574eb3b82bcc9c1a1d35c1d7075677fdd15de527d91b46bd35e935ee"},
+ {file = "kiwisolver-1.4.5.tar.gz", hash = "sha256:e57e563a57fb22a142da34f38acc2fc1a5c864bc29ca1517a88abc963e60d6ec"},
+]
[[package]]
-name = "mypy"
-version = "1.8.0"
-description = "Optional static typing for Python"
-category = "dev"
-optional = false
-python-versions = ">=3.8"
-
-[package.dependencies]
-mypy-extensions = ">=1.0.0"
-tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
-typing-extensions = ">=4.1.0"
-
-[package.extras]
-dmypy = ["psutil (>=4.0)"]
-install-types = ["pip"]
-mypyc = ["setuptools (>=50)"]
-reports = ["lxml"]
-
-[[package]]
-name = "mypy-extensions"
-version = "1.0.0"
-description = "Type system extensions for programs checked with the mypy type checker."
-category = "dev"
+name = "latexcodec"
+version = "3.0.0"
+description = "A lexer and codec to work with LaTeX code in Python."
optional = false
-python-versions = ">=3.5"
+python-versions = ">=3.7"
+files = [
+ {file = "latexcodec-3.0.0-py3-none-any.whl", hash = "sha256:6f3477ad5e61a0a99bd31a6a370c34e88733a6bad9c921a3ffcfacada12f41a7"},
+ {file = "latexcodec-3.0.0.tar.gz", hash = "sha256:917dc5fe242762cc19d963e6548b42d63a118028cdd3361d62397e3b638b6bc5"},
+]
[[package]]
-name = "myst-nb"
+name = "locket"
version = "1.0.0"
-description = "A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser."
-category = "dev"
+description = "File-based locks for Python on Linux and Windows"
optional = false
-python-versions = ">=3.9"
-
-[package.dependencies]
-importlib_metadata = "*"
-ipykernel = "*"
-ipython = "*"
-jupyter-cache = ">=0.5"
-myst-parser = ">=1.0.0"
-nbclient = "*"
-nbformat = ">=5.0"
-pyyaml = "*"
-sphinx = ">=5"
-typing-extensions = "*"
-
-[package.extras]
-code-style = ["pre-commit"]
-rtd = ["alabaster", "altair", "bokeh", "coconut (>=1.4.3,<3.1.0)", "ipykernel (>=5.5,<7.0)", "ipywidgets", "jupytext (>=1.11.2,<1.16.0)", "matplotlib", "numpy", "pandas", "plotly", "sphinx-book-theme (>=0.3)", "sphinx-copybutton", "sphinx-design (>=0.4.0,<0.5.0)", "sphinxcontrib-bibtex", "sympy"]
-testing = ["beautifulsoup4", "coverage (>=6.4,<8.0)", "ipykernel (>=5.5,<7.0)", "ipython (!=8.1.0,<8.17)", "ipywidgets (>=8)", "jupytext (>=1.11.2,<1.16.0)", "matplotlib (>=3.7.0,<3.8.0)", "nbdime", "numpy", "pandas", "pytest (>=7.1,<8.0)", "pytest-cov (>=3,<5)", "pytest-param-files (>=0.3.3,<0.4.0)", "pytest-regressions", "sympy (>=1.10.1)"]
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+files = [
+ {file = "locket-1.0.0-py2.py3-none-any.whl", hash = "sha256:b6c819a722f7b6bd955b80781788e4a66a55628b858d347536b7e81325a3a5e3"},
+ {file = "locket-1.0.0.tar.gz", hash = "sha256:5c0d4c052a8bbbf750e056a8e65ccd309086f4f0f18a2eac306a8dfa4112a632"},
+]
[[package]]
-name = "myst-parser"
-version = "2.0.0"
-description = "An extended [CommonMark](https://spec.commonmark.org/) compliant parser,"
-category = "dev"
+name = "markdown-it-py"
+version = "3.0.0"
+description = "Python port of markdown-it. Markdown parsing, done right!"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb"},
+ {file = "markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1"},
+]
[package.dependencies]
-docutils = ">=0.16,<0.21"
-jinja2 = "*"
-markdown-it-py = ">=3.0,<4.0"
-mdit-py-plugins = ">=0.4,<1.0"
-pyyaml = "*"
-sphinx = ">=6,<8"
+mdurl = ">=0.1,<1.0"
[package.extras]
+benchmarking = ["psutil", "pytest", "pytest-benchmark"]
code-style = ["pre-commit (>=3.0,<4.0)"]
-linkify = ["linkify-it-py (>=2.0,<3.0)"]
-rtd = ["ipython", "pydata-sphinx-theme (==v0.13.0rc4)", "sphinx-autodoc2 (>=0.4.2,<0.5.0)", "sphinx-book-theme (==1.0.0rc2)", "sphinx-copybutton", "sphinx-design2", "sphinx-pyscript", "sphinx-tippy (>=0.3.1)", "sphinx-togglebutton", "sphinxext-opengraph (>=0.8.2,<0.9.0)", "sphinxext-rediraffe (>=0.2.7,<0.3.0)"]
-testing = ["beautifulsoup4", "coverage[toml]", "pytest (>=7,<8)", "pytest-cov", "pytest-param-files (>=0.3.4,<0.4.0)", "pytest-regressions", "sphinx-pytest"]
-testing-docutils = ["pygments", "pytest (>=7,<8)", "pytest-param-files (>=0.3.4,<0.4.0)"]
-
-[[package]]
-name = "nbclient"
-version = "0.9.0"
-description = "A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor."
-category = "dev"
-optional = false
-python-versions = ">=3.8.0"
-
-[package.dependencies]
-jupyter-client = ">=6.1.12"
-jupyter-core = ">=4.12,<5.0.0 || >=5.1.0"
-nbformat = ">=5.1"
-traitlets = ">=5.4"
-
-[package.extras]
-dev = ["pre-commit"]
-docs = ["autodoc-traits", "mock", "moto", "myst-parser", "nbclient[test]", "sphinx (>=1.7)", "sphinx-book-theme", "sphinxcontrib-spelling"]
-test = ["flaky", "ipykernel (>=6.19.3)", "ipython", "ipywidgets", "nbconvert (>=7.0.0)", "pytest (>=7.0)", "pytest-asyncio", "pytest-cov (>=4.0)", "testpath", "xmltodict"]
+compare = ["commonmark (>=0.9,<1.0)", "markdown (>=3.4,<4.0)", "mistletoe (>=1.0,<2.0)", "mistune (>=2.0,<3.0)", "panflute (>=2.3,<3.0)"]
+linkify = ["linkify-it-py (>=1,<3)"]
+plugins = ["mdit-py-plugins"]
+profiling = ["gprof2dot"]
+rtd = ["jupyter_sphinx", "mdit-py-plugins", "myst-parser", "pyyaml", "sphinx", "sphinx-copybutton", "sphinx-design", "sphinx_book_theme"]
+testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"]
[[package]]
-name = "nbformat"
-version = "5.9.2"
-description = "The Jupyter Notebook format"
-category = "dev"
+name = "markupsafe"
+version = "2.1.5"
+description = "Safely add untrusted strings to HTML/XML markup."
optional = false
-python-versions = ">=3.8"
-
-[package.dependencies]
-fastjsonschema = "*"
-jsonschema = ">=2.6"
-jupyter-core = "*"
-traitlets = ">=5.1"
-
-[package.extras]
-docs = ["myst-parser", "pydata-sphinx-theme", "sphinx", "sphinxcontrib-github-alt", "sphinxcontrib-spelling"]
-test = ["pep440", "pre-commit", "pytest", "testpath"]
-
-[[package]]
-name = "nest-asyncio"
-version = "1.6.0"
-description = "Patch asyncio to allow nested event loops"
-category = "dev"
-optional = false
-python-versions = ">=3.5"
+python-versions = ">=3.7"
+files = [
+ {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"},
+ {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"},
+ {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"},
+ {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"},
+ {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"},
+ {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"},
+ {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"},
+ {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"},
+]
[[package]]
-name = "netcdf4"
-version = "1.6.5"
-description = "Provides an object-oriented python interface to the netCDF version 4 library"
-category = "main"
+name = "matplotlib"
+version = "3.9.0"
+description = "Python plotting package"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.9"
+files = [
+ {file = "matplotlib-3.9.0-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2bcee1dffaf60fe7656183ac2190bd630842ff87b3153afb3e384d966b57fe56"},
+ {file = "matplotlib-3.9.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:3f988bafb0fa39d1074ddd5bacd958c853e11def40800c5824556eb630f94d3b"},
+ {file = "matplotlib-3.9.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fe428e191ea016bb278758c8ee82a8129c51d81d8c4bc0846c09e7e8e9057241"},
+ {file = "matplotlib-3.9.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eaf3978060a106fab40c328778b148f590e27f6fa3cd15a19d6892575bce387d"},
+ {file = "matplotlib-3.9.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:2e7f03e5cbbfacdd48c8ea394d365d91ee8f3cae7e6ec611409927b5ed997ee4"},
+ {file = "matplotlib-3.9.0-cp310-cp310-win_amd64.whl", hash = "sha256:13beb4840317d45ffd4183a778685e215939be7b08616f431c7795276e067463"},
+ {file = "matplotlib-3.9.0-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:063af8587fceeac13b0936c42a2b6c732c2ab1c98d38abc3337e430e1ff75e38"},
+ {file = "matplotlib-3.9.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:9a2fa6d899e17ddca6d6526cf6e7ba677738bf2a6a9590d702c277204a7c6152"},
+ {file = "matplotlib-3.9.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:550cdda3adbd596078cca7d13ed50b77879104e2e46392dcd7c75259d8f00e85"},
+ {file = "matplotlib-3.9.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:76cce0f31b351e3551d1f3779420cf8f6ec0d4a8cf9c0237a3b549fd28eb4abb"},
+ {file = "matplotlib-3.9.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c53aeb514ccbbcbab55a27f912d79ea30ab21ee0531ee2c09f13800efb272674"},
+ {file = "matplotlib-3.9.0-cp311-cp311-win_amd64.whl", hash = "sha256:a5be985db2596d761cdf0c2eaf52396f26e6a64ab46bd8cd810c48972349d1be"},
+ {file = "matplotlib-3.9.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:c79f3a585f1368da6049318bdf1f85568d8d04b2e89fc24b7e02cc9b62017382"},
+ {file = "matplotlib-3.9.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:bdd1ecbe268eb3e7653e04f451635f0fb0f77f07fd070242b44c076c9106da84"},
+ {file = "matplotlib-3.9.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d38e85a1a6d732f645f1403ce5e6727fd9418cd4574521d5803d3d94911038e5"},
+ {file = "matplotlib-3.9.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0a490715b3b9984fa609116481b22178348c1a220a4499cda79132000a79b4db"},
+ {file = "matplotlib-3.9.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8146ce83cbc5dc71c223a74a1996d446cd35cfb6a04b683e1446b7e6c73603b7"},
+ {file = "matplotlib-3.9.0-cp312-cp312-win_amd64.whl", hash = "sha256:d91a4ffc587bacf5c4ce4ecfe4bcd23a4b675e76315f2866e588686cc97fccdf"},
+ {file = "matplotlib-3.9.0-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:616fabf4981a3b3c5a15cd95eba359c8489c4e20e03717aea42866d8d0465956"},
+ {file = "matplotlib-3.9.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:cd53c79fd02f1c1808d2cfc87dd3cf4dbc63c5244a58ee7944497107469c8d8a"},
+ {file = "matplotlib-3.9.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:06a478f0d67636554fa78558cfbcd7b9dba85b51f5c3b5a0c9be49010cf5f321"},
+ {file = "matplotlib-3.9.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:81c40af649d19c85f8073e25e5806926986806fa6d54be506fbf02aef47d5a89"},
+ {file = "matplotlib-3.9.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:52146fc3bd7813cc784562cb93a15788be0b2875c4655e2cc6ea646bfa30344b"},
+ {file = "matplotlib-3.9.0-cp39-cp39-win_amd64.whl", hash = "sha256:0fc51eaa5262553868461c083d9adadb11a6017315f3a757fc45ec6ec5f02888"},
+ {file = "matplotlib-3.9.0-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:bd4f2831168afac55b881db82a7730992aa41c4f007f1913465fb182d6fb20c0"},
+ {file = "matplotlib-3.9.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:290d304e59be2b33ef5c2d768d0237f5bd132986bdcc66f80bc9bcc300066a03"},
+ {file = "matplotlib-3.9.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7ff2e239c26be4f24bfa45860c20ffccd118d270c5b5d081fa4ea409b5469fcd"},
+ {file = "matplotlib-3.9.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:af4001b7cae70f7eaacfb063db605280058246de590fa7874f00f62259f2df7e"},
+ {file = "matplotlib-3.9.0.tar.gz", hash = "sha256:e6d29ea6c19e34b30fb7d88b7081f869a03014f66fe06d62cc77d5a6ea88ed7a"},
+]
[package.dependencies]
-certifi = "*"
-cftime = "*"
-numpy = "*"
+contourpy = ">=1.0.1"
+cycler = ">=0.10"
+fonttools = ">=4.22.0"
+kiwisolver = ">=1.3.1"
+numpy = ">=1.23"
+packaging = ">=20.0"
+pillow = ">=8"
+pyparsing = ">=2.3.1"
+python-dateutil = ">=2.7"
[package.extras]
-tests = ["Cython", "packaging", "pytest"]
+dev = ["meson-python (>=0.13.1)", "numpy (>=1.25)", "pybind11 (>=2.6)", "setuptools (>=64)", "setuptools_scm (>=7)"]
[[package]]
-name = "nodeenv"
-version = "1.8.0"
-description = "Node.js virtual environment builder"
-category = "dev"
+name = "matplotlib-inline"
+version = "0.1.7"
+description = "Inline Matplotlib backend for Jupyter"
optional = false
-python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*"
+python-versions = ">=3.8"
+files = [
+ {file = "matplotlib_inline-0.1.7-py3-none-any.whl", hash = "sha256:df192d39a4ff8f21b1895d72e6a13f5fcc5099f00fa84384e0ea28c2cc0653ca"},
+ {file = "matplotlib_inline-0.1.7.tar.gz", hash = "sha256:8423b23ec666be3d16e16b60bdd8ac4e86e840ebd1dd11a30b9f117f2fa0ab90"},
+]
[package.dependencies]
-setuptools = "*"
+traitlets = "*"
[[package]]
-name = "numpy"
-version = "1.26.4"
-description = "Fundamental package for array computing in Python"
-category = "main"
+name = "mdformat"
+version = "0.7.17"
+description = "CommonMark compliant Markdown formatter"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.8"
+files = [
+ {file = "mdformat-0.7.17-py3-none-any.whl", hash = "sha256:91ffc5e203f5814a6ad17515c77767fd2737fc12ffd8b58b7bb1d8b9aa6effaa"},
+ {file = "mdformat-0.7.17.tar.gz", hash = "sha256:a9dbb1838d43bb1e6f03bd5dca9412c552544a9bc42d6abb5dc32adfe8ae7c0d"},
+]
-[[package]]
-name = "packaging"
-version = "23.2"
-description = "Core utilities for Python packages"
-category = "main"
-optional = false
-python-versions = ">=3.7"
+[package.dependencies]
+markdown-it-py = ">=1.0.0,<4.0.0"
+tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
[[package]]
-name = "pandas"
-version = "2.2.1"
-description = "Powerful data structures for data analysis, time series, and statistics"
-category = "main"
+name = "mdformat-frontmatter"
+version = "0.4.1"
+description = "An mdformat plugin for parsing / ignoring frontmatter."
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.6"
+files = [
+ {file = "mdformat_frontmatter-0.4.1-py3-none-any.whl", hash = "sha256:9c13f6b7a53de7b401af3c95e66735237545bd174e6619392153b296135ffd49"},
+ {file = "mdformat_frontmatter-0.4.1.tar.gz", hash = "sha256:15d3eed1543849d4fe72b1f75b8dffd8b49750c5149186591a1b9617178e2aa2"},
+]
[package.dependencies]
-numpy = [
- {version = ">=1.23.2,<2", markers = "python_version == \"3.11\""},
- {version = ">=1.22.4,<2", markers = "python_version < \"3.11\""},
-]
-python-dateutil = ">=2.8.2"
-pytz = ">=2020.1"
-tzdata = ">=2022.7"
+mdformat = ">=0.7.0,<0.8.0"
+mdit-py-plugins = "*"
+"ruamel.yaml" = "*"
[package.extras]
-all = ["PyQt5 (>=5.15.9)", "SQLAlchemy (>=2.0.0)", "adbc-driver-postgresql (>=0.8.0)", "adbc-driver-sqlite (>=0.8.0)", "beautifulsoup4 (>=4.11.2)", "bottleneck (>=1.3.6)", "dataframe-api-compat (>=0.1.7)", "fastparquet (>=2022.12.0)", "fsspec (>=2022.11.0)", "gcsfs (>=2022.11.0)", "html5lib (>=1.1)", "hypothesis (>=6.46.1)", "jinja2 (>=3.1.2)", "lxml (>=4.9.2)", "matplotlib (>=3.6.3)", "numba (>=0.56.4)", "numexpr (>=2.8.4)", "odfpy (>=1.4.1)", "openpyxl (>=3.1.0)", "pandas-gbq (>=0.19.0)", "psycopg2 (>=2.9.6)", "pyarrow (>=10.0.1)", "pymysql (>=1.0.2)", "pyreadstat (>=1.2.0)", "pytest (>=7.3.2)", "pytest-xdist (>=2.2.0)", "python-calamine (>=0.1.7)", "pyxlsb (>=1.0.10)", "qtpy (>=2.3.0)", "s3fs (>=2022.11.0)", "scipy (>=1.10.0)", "tables (>=3.8.0)", "tabulate (>=0.9.0)", "xarray (>=2022.12.0)", "xlrd (>=2.0.1)", "xlsxwriter (>=3.0.5)", "zstandard (>=0.19.0)"]
-aws = ["s3fs (>=2022.11.0)"]
-clipboard = ["PyQt5 (>=5.15.9)", "qtpy (>=2.3.0)"]
-compression = ["zstandard (>=0.19.0)"]
-computation = ["scipy (>=1.10.0)", "xarray (>=2022.12.0)"]
-consortium-standard = ["dataframe-api-compat (>=0.1.7)"]
-excel = ["odfpy (>=1.4.1)", "openpyxl (>=3.1.0)", "python-calamine (>=0.1.7)", "pyxlsb (>=1.0.10)", "xlrd (>=2.0.1)", "xlsxwriter (>=3.0.5)"]
-feather = ["pyarrow (>=10.0.1)"]
-fss = ["fsspec (>=2022.11.0)"]
-gcp = ["gcsfs (>=2022.11.0)", "pandas-gbq (>=0.19.0)"]
-hdf5 = ["tables (>=3.8.0)"]
-html = ["beautifulsoup4 (>=4.11.2)", "html5lib (>=1.1)", "lxml (>=4.9.2)"]
-mysql = ["SQLAlchemy (>=2.0.0)", "pymysql (>=1.0.2)"]
-output-formatting = ["jinja2 (>=3.1.2)", "tabulate (>=0.9.0)"]
-parquet = ["pyarrow (>=10.0.1)"]
-performance = ["bottleneck (>=1.3.6)", "numba (>=0.56.4)", "numexpr (>=2.8.4)"]
-plot = ["matplotlib (>=3.6.3)"]
-postgresql = ["SQLAlchemy (>=2.0.0)", "adbc-driver-postgresql (>=0.8.0)", "psycopg2 (>=2.9.6)"]
-pyarrow = ["pyarrow (>=10.0.1)"]
-spss = ["pyreadstat (>=1.2.0)"]
-sql-other = ["SQLAlchemy (>=2.0.0)", "adbc-driver-postgresql (>=0.8.0)", "adbc-driver-sqlite (>=0.8.0)"]
-test = ["hypothesis (>=6.46.1)", "pytest (>=7.3.2)", "pytest-xdist (>=2.2.0)"]
-xml = ["lxml (>=4.9.2)"]
+dev = ["pre-commit"]
+test = ["coverage", "pytest (>=6.0,<7.0)", "pytest-cov"]
[[package]]
-name = "parso"
-version = "0.8.3"
-description = "A Python Parser"
-category = "dev"
+name = "mdformat-tables"
+version = "0.4.1"
+description = "An mdformat plugin for rendering tables."
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.6.1"
+files = [
+ {file = "mdformat_tables-0.4.1-py3-none-any.whl", hash = "sha256:981f3dc7350027f78e3fd6a5fe8a16e123eec423af2d140e588d855751501019"},
+ {file = "mdformat_tables-0.4.1.tar.gz", hash = "sha256:3024e88e9d29d7b8bb07fd6b59c9d5dcf14d2060122be29e30e72d27b65d7da9"},
+]
+
+[package.dependencies]
+mdformat = ">=0.7.5,<0.8.0"
[package.extras]
-qa = ["flake8 (==3.8.3)", "mypy (==0.782)"]
-testing = ["docopt", "pytest (<6.0.0)"]
+test = ["coverage", "pytest (>=6.0,<7.0)", "pytest-cov"]
[[package]]
-name = "partd"
-version = "1.4.1"
-description = "Appendable key-value storage"
-category = "main"
+name = "mdit-py-plugins"
+version = "0.4.1"
+description = "Collection of plugins for markdown-it-py"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+files = [
+ {file = "mdit_py_plugins-0.4.1-py3-none-any.whl", hash = "sha256:1020dfe4e6bfc2c79fb49ae4e3f5b297f5ccd20f010187acc52af2921e27dc6a"},
+ {file = "mdit_py_plugins-0.4.1.tar.gz", hash = "sha256:834b8ac23d1cd60cec703646ffd22ae97b7955a6d596eb1d304be1e251ae499c"},
+]
[package.dependencies]
-locket = "*"
-toolz = "*"
+markdown-it-py = ">=1.0.0,<4.0.0"
[package.extras]
-complete = ["blosc", "numpy (>=1.9.0)", "pandas (>=0.19.0)", "pyzmq"]
+code-style = ["pre-commit"]
+rtd = ["myst-parser", "sphinx-book-theme"]
+testing = ["coverage", "pytest", "pytest-cov", "pytest-regressions"]
[[package]]
-name = "pathspec"
-version = "0.12.1"
-description = "Utility library for gitignore style pattern matching of file paths."
-category = "dev"
+name = "mdurl"
+version = "0.1.2"
+description = "Markdown URL utilities"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.7"
+files = [
+ {file = "mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8"},
+ {file = "mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba"},
+]
[[package]]
-name = "pexpect"
-version = "4.9.0"
-description = "Pexpect allows easy control of interactive console applications."
-category = "dev"
+name = "mistune"
+version = "3.0.2"
+description = "A sane and fast Markdown parser with useful plugins and renderers"
optional = false
-python-versions = "*"
-
-[package.dependencies]
-ptyprocess = ">=0.5"
+python-versions = ">=3.7"
+files = [
+ {file = "mistune-3.0.2-py3-none-any.whl", hash = "sha256:71481854c30fdbc938963d3605b72501f5c10a9320ecd412c121c163a1c7d205"},
+ {file = "mistune-3.0.2.tar.gz", hash = "sha256:fc7f93ded930c92394ef2cb6f04a8aabab4117a91449e72dcc8dfa646a508be8"},
+]
[[package]]
-name = "pillow"
-version = "10.2.0"
-description = "Python Imaging Library (Fork)"
-category = "dev"
+name = "mypy"
+version = "1.10.1"
+description = "Optional static typing for Python"
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "mypy-1.10.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e36f229acfe250dc660790840916eb49726c928e8ce10fbdf90715090fe4ae02"},
+ {file = "mypy-1.10.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:51a46974340baaa4145363b9e051812a2446cf583dfaeba124af966fa44593f7"},
+ {file = "mypy-1.10.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:901c89c2d67bba57aaaca91ccdb659aa3a312de67f23b9dfb059727cce2e2e0a"},
+ {file = "mypy-1.10.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:0cd62192a4a32b77ceb31272d9e74d23cd88c8060c34d1d3622db3267679a5d9"},
+ {file = "mypy-1.10.1-cp310-cp310-win_amd64.whl", hash = "sha256:a2cbc68cb9e943ac0814c13e2452d2046c2f2b23ff0278e26599224cf164e78d"},
+ {file = "mypy-1.10.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:bd6f629b67bb43dc0d9211ee98b96d8dabc97b1ad38b9b25f5e4c4d7569a0c6a"},
+ {file = "mypy-1.10.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a1bbb3a6f5ff319d2b9d40b4080d46cd639abe3516d5a62c070cf0114a457d84"},
+ {file = "mypy-1.10.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b8edd4e9bbbc9d7b79502eb9592cab808585516ae1bcc1446eb9122656c6066f"},
+ {file = "mypy-1.10.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:6166a88b15f1759f94a46fa474c7b1b05d134b1b61fca627dd7335454cc9aa6b"},
+ {file = "mypy-1.10.1-cp311-cp311-win_amd64.whl", hash = "sha256:5bb9cd11c01c8606a9d0b83ffa91d0b236a0e91bc4126d9ba9ce62906ada868e"},
+ {file = "mypy-1.10.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:d8681909f7b44d0b7b86e653ca152d6dff0eb5eb41694e163c6092124f8246d7"},
+ {file = "mypy-1.10.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:378c03f53f10bbdd55ca94e46ec3ba255279706a6aacaecac52ad248f98205d3"},
+ {file = "mypy-1.10.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6bacf8f3a3d7d849f40ca6caea5c055122efe70e81480c8328ad29c55c69e93e"},
+ {file = "mypy-1.10.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:701b5f71413f1e9855566a34d6e9d12624e9e0a8818a5704d74d6b0402e66c04"},
+ {file = "mypy-1.10.1-cp312-cp312-win_amd64.whl", hash = "sha256:3c4c2992f6ea46ff7fce0072642cfb62af7a2484efe69017ed8b095f7b39ef31"},
+ {file = "mypy-1.10.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:604282c886497645ffb87b8f35a57ec773a4a2721161e709a4422c1636ddde5c"},
+ {file = "mypy-1.10.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37fd87cab83f09842653f08de066ee68f1182b9b5282e4634cdb4b407266bade"},
+ {file = "mypy-1.10.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8addf6313777dbb92e9564c5d32ec122bf2c6c39d683ea64de6a1fd98b90fe37"},
+ {file = "mypy-1.10.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:5cc3ca0a244eb9a5249c7c583ad9a7e881aa5d7b73c35652296ddcdb33b2b9c7"},
+ {file = "mypy-1.10.1-cp38-cp38-win_amd64.whl", hash = "sha256:1b3a2ffce52cc4dbaeee4df762f20a2905aa171ef157b82192f2e2f368eec05d"},
+ {file = "mypy-1.10.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:fe85ed6836165d52ae8b88f99527d3d1b2362e0cb90b005409b8bed90e9059b3"},
+ {file = "mypy-1.10.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c2ae450d60d7d020d67ab440c6e3fae375809988119817214440033f26ddf7bf"},
+ {file = "mypy-1.10.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6be84c06e6abd72f960ba9a71561c14137a583093ffcf9bbfaf5e613d63fa531"},
+ {file = "mypy-1.10.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:2189ff1e39db399f08205e22a797383613ce1cb0cb3b13d8bcf0170e45b96cc3"},
+ {file = "mypy-1.10.1-cp39-cp39-win_amd64.whl", hash = "sha256:97a131ee36ac37ce9581f4220311247ab6cba896b4395b9c87af0675a13a755f"},
+ {file = "mypy-1.10.1-py3-none-any.whl", hash = "sha256:71d8ac0b906354ebda8ef1673e5fde785936ac1f29ff6987c7483cfbd5a4235a"},
+ {file = "mypy-1.10.1.tar.gz", hash = "sha256:1f8f492d7db9e3593ef42d4f115f04e556130f2819ad33ab84551403e97dd4c0"},
+]
-[package.extras]
-docs = ["furo", "olefile", "sphinx (>=2.4)", "sphinx-copybutton", "sphinx-inline-tabs", "sphinx-removed-in", "sphinxext-opengraph"]
-fpx = ["olefile"]
-mic = ["olefile"]
-tests = ["check-manifest", "coverage", "defusedxml", "markdown2", "olefile", "packaging", "pyroma", "pytest", "pytest-cov", "pytest-timeout"]
-typing = ["typing-extensions"]
-xmp = ["defusedxml"]
-
-[[package]]
-name = "pint"
-version = "0.20.1"
-description = "Physical quantities module"
-category = "main"
-optional = false
-python-versions = ">=3.8"
+[package.dependencies]
+mypy-extensions = ">=1.0.0"
+tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
+typing-extensions = ">=4.1.0"
[package.extras]
-babel = ["babel (<=2.8)"]
-dask = ["dask"]
-numpy = ["numpy (>=1.19.5)"]
-pandas = ["pint-pandas (>=0.3)"]
-test = ["pytest", "pytest-cov", "pytest-mpl", "pytest-subtests"]
-uncertainties = ["uncertainties (>=3.1.6)"]
-xarray = ["xarray"]
+dmypy = ["psutil (>=4.0)"]
+install-types = ["pip"]
+mypyc = ["setuptools (>=50)"]
+reports = ["lxml"]
[[package]]
-name = "platformdirs"
-version = "4.2.0"
-description = "A small Python package for determining appropriate platform-specific dirs, e.g. a \"user data dir\"."
-category = "dev"
+name = "mypy-extensions"
+version = "1.0.0"
+description = "Type system extensions for programs checked with the mypy type checker."
optional = false
-python-versions = ">=3.8"
-
-[package.extras]
-docs = ["furo (>=2023.9.10)", "proselint (>=0.13)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"]
-test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)"]
+python-versions = ">=3.5"
+files = [
+ {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"},
+ {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"},
+]
[[package]]
-name = "pluggy"
-version = "1.4.0"
-description = "plugin and hook calling mechanisms for python"
-category = "dev"
+name = "myst-nb"
+version = "1.1.1"
+description = "A Jupyter Notebook Sphinx reader built on top of the MyST markdown parser."
optional = false
-python-versions = ">=3.8"
-
-[package.extras]
-dev = ["pre-commit", "tox"]
-testing = ["pytest", "pytest-benchmark"]
-
-[[package]]
-name = "pre-commit"
-version = "2.21.0"
-description = "A framework for managing and maintaining multi-language pre-commit hooks."
-category = "dev"
-optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.9"
+files = [
+ {file = "myst_nb-1.1.1-py3-none-any.whl", hash = "sha256:8b8f9085287d948eef46cb3764aafc21915e0e981882b8c742719f5b1a84c36f"},
+ {file = "myst_nb-1.1.1.tar.gz", hash = "sha256:74227c11f76d03494f43b7788659b161b94f4dedef230a2912412bc8c3c9e553"},
+]
[package.dependencies]
-cfgv = ">=2.0.0"
-identify = ">=1.0.0"
-nodeenv = ">=0.11.1"
-pyyaml = ">=5.1"
-virtualenv = ">=20.10.0"
+importlib_metadata = "*"
+ipykernel = "*"
+ipython = "*"
+jupyter-cache = ">=0.5"
+myst-parser = ">=1.0.0"
+nbclient = "*"
+nbformat = ">=5.0"
+pyyaml = "*"
+sphinx = ">=5"
+typing-extensions = "*"
+
+[package.extras]
+code-style = ["pre-commit"]
+rtd = ["alabaster", "altair", "bokeh", "coconut (>=1.4.3,<3.1.0)", "ipykernel (>=5.5,<7.0)", "ipywidgets", "jupytext (>=1.11.2,<1.16.0)", "matplotlib", "numpy", "pandas", "plotly", "sphinx-book-theme (>=0.3)", "sphinx-copybutton", "sphinx-design (>=0.4.0,<0.5.0)", "sphinxcontrib-bibtex", "sympy"]
+testing = ["beautifulsoup4", "coverage (>=6.4,<8.0)", "ipykernel (>=5.5,<7.0)", "ipython (!=8.1.0,<8.17)", "ipywidgets (>=8)", "jupytext (>=1.11.2,<1.16.0)", "matplotlib (==3.7.*)", "nbdime", "numpy", "pandas (==1.5.*)", "pyarrow", "pytest (>=7.1,<8.0)", "pytest-cov (>=3,<5)", "pytest-param-files (>=0.3.3,<0.4.0)", "pytest-regressions", "sympy (>=1.10.1)"]
[[package]]
-name = "prompt-toolkit"
-version = "3.0.43"
-description = "Library for building powerful interactive command lines in Python"
-category = "dev"
+name = "myst-parser"
+version = "3.0.1"
+description = "An extended [CommonMark](https://spec.commonmark.org/) compliant parser,"
optional = false
-python-versions = ">=3.7.0"
+python-versions = ">=3.8"
+files = [
+ {file = "myst_parser-3.0.1-py3-none-any.whl", hash = "sha256:6457aaa33a5d474aca678b8ead9b3dc298e89c68e67012e73146ea6fd54babf1"},
+ {file = "myst_parser-3.0.1.tar.gz", hash = "sha256:88f0cb406cb363b077d176b51c476f62d60604d68a8dcdf4832e080441301a87"},
+]
[package.dependencies]
-wcwidth = "*"
-
-[[package]]
-name = "psutil"
-version = "5.9.8"
-description = "Cross-platform lib for process and system monitoring in Python."
-category = "dev"
-optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*"
+docutils = ">=0.18,<0.22"
+jinja2 = "*"
+markdown-it-py = ">=3.0,<4.0"
+mdit-py-plugins = ">=0.4,<1.0"
+pyyaml = "*"
+sphinx = ">=6,<8"
[package.extras]
-test = ["enum34", "ipaddress", "mock", "pywin32", "wmi"]
+code-style = ["pre-commit (>=3.0,<4.0)"]
+linkify = ["linkify-it-py (>=2.0,<3.0)"]
+rtd = ["ipython", "sphinx (>=7)", "sphinx-autodoc2 (>=0.5.0,<0.6.0)", "sphinx-book-theme (>=1.1,<2.0)", "sphinx-copybutton", "sphinx-design", "sphinx-pyscript", "sphinx-tippy (>=0.4.3)", "sphinx-togglebutton", "sphinxext-opengraph (>=0.9.0,<0.10.0)", "sphinxext-rediraffe (>=0.2.7,<0.3.0)"]
+testing = ["beautifulsoup4", "coverage[toml]", "defusedxml", "pytest (>=8,<9)", "pytest-cov", "pytest-param-files (>=0.6.0,<0.7.0)", "pytest-regressions", "sphinx-pytest"]
+testing-docutils = ["pygments", "pytest (>=8,<9)", "pytest-param-files (>=0.6.0,<0.7.0)"]
[[package]]
-name = "ptyprocess"
-version = "0.7.0"
-description = "Run a subprocess in a pseudo terminal"
-category = "dev"
+name = "nbclient"
+version = "0.10.0"
+description = "A client library for executing notebooks. Formerly nbconvert's ExecutePreprocessor."
optional = false
-python-versions = "*"
+python-versions = ">=3.8.0"
+files = [
+ {file = "nbclient-0.10.0-py3-none-any.whl", hash = "sha256:f13e3529332a1f1f81d82a53210322476a168bb7090a0289c795fe9cc11c9d3f"},
+ {file = "nbclient-0.10.0.tar.gz", hash = "sha256:4b3f1b7dba531e498449c4db4f53da339c91d449dc11e9af3a43b4eb5c5abb09"},
+]
-[[package]]
-name = "pure-eval"
-version = "0.2.2"
-description = "Safely evaluate AST nodes without side effects"
-category = "dev"
-optional = false
-python-versions = "*"
+[package.dependencies]
+jupyter-client = ">=6.1.12"
+jupyter-core = ">=4.12,<5.0.dev0 || >=5.1.dev0"
+nbformat = ">=5.1"
+traitlets = ">=5.4"
[package.extras]
-tests = ["pytest"]
+dev = ["pre-commit"]
+docs = ["autodoc-traits", "mock", "moto", "myst-parser", "nbclient[test]", "sphinx (>=1.7)", "sphinx-book-theme", "sphinxcontrib-spelling"]
+test = ["flaky", "ipykernel (>=6.19.3)", "ipython", "ipywidgets", "nbconvert (>=7.0.0)", "pytest (>=7.0,<8)", "pytest-asyncio", "pytest-cov (>=4.0)", "testpath", "xmltodict"]
[[package]]
-name = "pybtex"
-version = "0.24.0"
-description = "A BibTeX-compatible bibliography processor in Python"
-category = "dev"
+name = "nbconvert"
+version = "7.16.4"
+description = "Converting Jupyter Notebooks (.ipynb files) to other formats. Output formats include asciidoc, html, latex, markdown, pdf, py, rst, script. nbconvert can be used both as a Python library (`import nbconvert`) or as a command line tool (invoked as `jupyter nbconvert ...`)."
optional = false
-python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*"
+python-versions = ">=3.8"
+files = [
+ {file = "nbconvert-7.16.4-py3-none-any.whl", hash = "sha256:05873c620fe520b6322bf8a5ad562692343fe3452abda5765c7a34b7d1aa3eb3"},
+ {file = "nbconvert-7.16.4.tar.gz", hash = "sha256:86ca91ba266b0a448dc96fa6c5b9d98affabde2867b363258703536807f9f7f4"},
+]
[package.dependencies]
-latexcodec = ">=1.0.4"
-PyYAML = ">=3.01"
-six = "*"
+beautifulsoup4 = "*"
+bleach = "!=5.0.0"
+defusedxml = "*"
+jinja2 = ">=3.0"
+jupyter-core = ">=4.7"
+jupyterlab-pygments = "*"
+markupsafe = ">=2.0"
+mistune = ">=2.0.3,<4"
+nbclient = ">=0.5.0"
+nbformat = ">=5.7"
+packaging = "*"
+pandocfilters = ">=1.4.1"
+pygments = ">=2.4.1"
+tinycss2 = "*"
+traitlets = ">=5.1"
[package.extras]
-test = ["pytest"]
+all = ["flaky", "ipykernel", "ipython", "ipywidgets (>=7.5)", "myst-parser", "nbsphinx (>=0.2.12)", "playwright", "pydata-sphinx-theme", "pyqtwebengine (>=5.15)", "pytest (>=7)", "sphinx (==5.0.2)", "sphinxcontrib-spelling", "tornado (>=6.1)"]
+docs = ["ipykernel", "ipython", "myst-parser", "nbsphinx (>=0.2.12)", "pydata-sphinx-theme", "sphinx (==5.0.2)", "sphinxcontrib-spelling"]
+qtpdf = ["pyqtwebengine (>=5.15)"]
+qtpng = ["pyqtwebengine (>=5.15)"]
+serve = ["tornado (>=6.1)"]
+test = ["flaky", "ipykernel", "ipywidgets (>=7.5)", "pytest (>=7)"]
+webpdf = ["playwright"]
[[package]]
-name = "pybtex-docutils"
-version = "1.0.3"
-description = "A docutils backend for pybtex."
-category = "dev"
+name = "nbformat"
+version = "5.10.4"
+description = "The Jupyter Notebook format"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+files = [
+ {file = "nbformat-5.10.4-py3-none-any.whl", hash = "sha256:3b48d6c8fbca4b299bf3982ea7db1af21580e4fec269ad087b9e81588891200b"},
+ {file = "nbformat-5.10.4.tar.gz", hash = "sha256:322168b14f937a5d11362988ecac2a4952d3d8e3a2cbeb2319584631226d5b3a"},
+]
[package.dependencies]
-docutils = ">=0.14"
-pybtex = ">=0.16"
+fastjsonschema = ">=2.15"
+jsonschema = ">=2.6"
+jupyter-core = ">=4.12,<5.0.dev0 || >=5.1.dev0"
+traitlets = ">=5.1"
-[[package]]
-name = "pycodestyle"
-version = "2.8.0"
-description = "Python style guide checker"
-category = "dev"
-optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+[package.extras]
+docs = ["myst-parser", "pydata-sphinx-theme", "sphinx", "sphinxcontrib-github-alt", "sphinxcontrib-spelling"]
+test = ["pep440", "pre-commit", "pytest", "testpath"]
[[package]]
-name = "pycparser"
-version = "2.21"
-description = "C parser in Python"
-category = "dev"
+name = "nest-asyncio"
+version = "1.6.0"
+description = "Patch asyncio to allow nested event loops"
optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+python-versions = ">=3.5"
+files = [
+ {file = "nest_asyncio-1.6.0-py3-none-any.whl", hash = "sha256:87af6efd6b5e897c81050477ef65c62e2b2f35d51703cae01aff2905b1852e1c"},
+ {file = "nest_asyncio-1.6.0.tar.gz", hash = "sha256:6f172d5449aca15afd6c646851f4e31e02c598d553a667e38cafa997cfec55fe"},
+]
[[package]]
-name = "pydocstyle"
-version = "6.3.0"
-description = "Python docstring style checker"
-category = "dev"
+name = "netcdf4"
+version = "1.7.1.post1"
+description = "Provides an object-oriented python interface to the netCDF version 4 library"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.8"
+files = [
+ {file = "netCDF4-1.7.1.post1-cp310-cp310-macosx_11_0_x86_64.whl", hash = "sha256:5abdc8ab27bcb11325547841311717a0ba8f5b73a5fc5e93b933bc23285d0c03"},
+ {file = "netCDF4-1.7.1.post1-cp310-cp310-macosx_14_0_arm64.whl", hash = "sha256:33f5d66ee9cedf43d3932d0e5447eb471f9c53332f93476133b4bfc6b682f790"},
+ {file = "netCDF4-1.7.1.post1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d649fad9d1f63e25a191576c7de158c8c3afa8d4b4001e8683e20da90b49b939"},
+ {file = "netCDF4-1.7.1.post1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:860222bc57bbc714e55705f263162be2c935129dcb700a944bda61aee785ff03"},
+ {file = "netCDF4-1.7.1.post1-cp310-cp310-win_amd64.whl", hash = "sha256:d5420155ca6c768c070922d80acd9f4088a913afd25a9fd2f429e7af626374eb"},
+ {file = "netCDF4-1.7.1.post1-cp311-cp311-macosx_11_0_x86_64.whl", hash = "sha256:a8d3209516aa8c58d70863ab1059af4ec82ef8ecb1c6b8cb4842d7825a6f64da"},
+ {file = "netCDF4-1.7.1.post1-cp311-cp311-macosx_14_0_arm64.whl", hash = "sha256:7a10da9b60d3358876d53a0cd691d2c900c2b39903bf25ad5235fd321d59eb2f"},
+ {file = "netCDF4-1.7.1.post1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:30ac99e03d6e28419b206444fd6dc80a5e21d0ae8e53ff37d756fbc16c5d3775"},
+ {file = "netCDF4-1.7.1.post1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e15f3afa4e6910fc158a318ea73fdc6f9e41058c71bf98a99fd63994334d16b0"},
+ {file = "netCDF4-1.7.1.post1-cp311-cp311-win_amd64.whl", hash = "sha256:115160fc8e09333754542c33d721d42625a7bd62381a74f2f759297e3e38810b"},
+ {file = "netCDF4-1.7.1.post1-cp312-cp312-macosx_11_0_x86_64.whl", hash = "sha256:75bba24ef0354fb6913bc3acdcb3790534e86bf329bbeaaf54122b18e5fd05ea"},
+ {file = "netCDF4-1.7.1.post1-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:ce7f89b98dbb3acd9582db30e6478ce7a7003b2cb70dc20d85fe9506e65ab001"},
+ {file = "netCDF4-1.7.1.post1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac4e30a0d5a8e227d6a890502cfa201388acf606c0c73a5a7594232f3a74e67e"},
+ {file = "netCDF4-1.7.1.post1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:988c45f9122337a12267fb158953c0609e3ea50a557335a3105f104416a4821a"},
+ {file = "netCDF4-1.7.1.post1-cp312-cp312-win_amd64.whl", hash = "sha256:8fb3ed3541fa1b5b46e9d92d7e803734a1a3f37d8f5adf5fdf7957c7750cb20e"},
+ {file = "netCDF4-1.7.1.post1-cp38-cp38-macosx_11_0_x86_64.whl", hash = "sha256:a4d05cc4c3628a7b88d623cb1a02908100a4938335a0289fa79c19016c21d7f9"},
+ {file = "netCDF4-1.7.1.post1-cp38-cp38-macosx_14_0_arm64.whl", hash = "sha256:3a9ba8dc93f3d9019db921e42d40fa6791e7e244f3bb3a874bf2bfb96aea7380"},
+ {file = "netCDF4-1.7.1.post1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fbbca82a822ba74b605254f7a267d258f13d67f8a4156a09e26322bfa002a82d"},
+ {file = "netCDF4-1.7.1.post1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1a09da245f4784421fb4d5740dae0367cdbb270d0a931a33474ec17a9433314d"},
+ {file = "netCDF4-1.7.1.post1-cp39-cp39-macosx_11_0_x86_64.whl", hash = "sha256:fdcec3a3150f9248e76301ad723f51955efc770edf015dfb61a6480cc7c04a70"},
+ {file = "netCDF4-1.7.1.post1-cp39-cp39-macosx_14_0_arm64.whl", hash = "sha256:0fed0eb65a7751a99a0cee08c6df383737d46d17c73cabae81d113f1b4fa3643"},
+ {file = "netCDF4-1.7.1.post1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:daa6169fe6617a4612cb75a8ef61ee14011a012633ad1ace1b629a1ff87bf5cf"},
+ {file = "netCDF4-1.7.1.post1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dcad21e965978cc5530131bd7e73dcabe7dda1f681f9e4ebf940a65a176d25fe"},
+ {file = "netCDF4-1.7.1.post1-cp39-cp39-win_amd64.whl", hash = "sha256:f24027ae19b68cc1274aad8b00d6d81879d506ddca011a080dff2117014398b9"},
+ {file = "netcdf4-1.7.1.post1.tar.gz", hash = "sha256:797f0b25d87827fc6821e415d9e15a2068604b18c3be62563e72682bcba76548"},
+]
[package.dependencies]
-snowballstemmer = ">=2.2.0"
+certifi = "*"
+cftime = "*"
+numpy = "*"
[package.extras]
-toml = ["tomli (>=1.2.3)"]
+tests = ["Cython", "packaging", "pytest"]
[[package]]
-name = "pyflakes"
-version = "2.4.0"
-description = "passive checker of Python programs"
-category = "dev"
+name = "nodeenv"
+version = "1.9.1"
+description = "Node.js virtual environment builder"
optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+files = [
+ {file = "nodeenv-1.9.1-py2.py3-none-any.whl", hash = "sha256:ba11c9782d29c27c70ffbdda2d7415098754709be8a7056d79a737cd901155c9"},
+ {file = "nodeenv-1.9.1.tar.gz", hash = "sha256:6ec12890a2dab7946721edbfbcd91f3319c6ccc9aec47be7c7e6b7011ee6645f"},
+]
[[package]]
-name = "pygments"
-version = "2.17.2"
-description = "Pygments is a syntax highlighting package written in Python."
-category = "dev"
+name = "notebook-shim"
+version = "0.2.4"
+description = "A shim layer for notebook traits and config"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "notebook_shim-0.2.4-py3-none-any.whl", hash = "sha256:411a5be4e9dc882a074ccbcae671eda64cceb068767e9a3419096986560e1cef"},
+ {file = "notebook_shim-0.2.4.tar.gz", hash = "sha256:b4b2cfa1b65d98307ca24361f5b30fe785b53c3fd07b7a47e89acb5e6ac638cb"},
+]
+
+[package.dependencies]
+jupyter-server = ">=1.8,<3"
[package.extras]
-plugins = ["importlib-metadata"]
-windows-terminal = ["colorama (>=0.4.6)"]
+test = ["pytest", "pytest-console-scripts", "pytest-jupyter", "pytest-tornasync"]
[[package]]
-name = "pyparsing"
-version = "3.1.1"
-description = "pyparsing module - Classes and methods to define and execute parsing grammars"
-category = "dev"
+name = "numpy"
+version = "2.0.0"
+description = "Fundamental package for array computing in Python"
optional = false
-python-versions = ">=3.6.8"
+python-versions = ">=3.9"
+files = [
+ {file = "numpy-2.0.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:04494f6ec467ccb5369d1808570ae55f6ed9b5809d7f035059000a37b8d7e86f"},
+ {file = "numpy-2.0.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2635dbd200c2d6faf2ef9a0d04f0ecc6b13b3cad54f7c67c61155138835515d2"},
+ {file = "numpy-2.0.0-cp310-cp310-macosx_14_0_arm64.whl", hash = "sha256:0a43f0974d501842866cc83471bdb0116ba0dffdbaac33ec05e6afed5b615238"},
+ {file = "numpy-2.0.0-cp310-cp310-macosx_14_0_x86_64.whl", hash = "sha256:8d83bb187fb647643bd56e1ae43f273c7f4dbcdf94550d7938cfc32566756514"},
+ {file = "numpy-2.0.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:79e843d186c8fb1b102bef3e2bc35ef81160ffef3194646a7fdd6a73c6b97196"},
+ {file = "numpy-2.0.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6d7696c615765091cc5093f76fd1fa069870304beaccfd58b5dcc69e55ef49c1"},
+ {file = "numpy-2.0.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b4c76e3d4c56f145d41b7b6751255feefae92edbc9a61e1758a98204200f30fc"},
+ {file = "numpy-2.0.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:acd3a644e4807e73b4e1867b769fbf1ce8c5d80e7caaef0d90dcdc640dfc9787"},
+ {file = "numpy-2.0.0-cp310-cp310-win32.whl", hash = "sha256:cee6cc0584f71adefe2c908856ccc98702baf95ff80092e4ca46061538a2ba98"},
+ {file = "numpy-2.0.0-cp310-cp310-win_amd64.whl", hash = "sha256:ed08d2703b5972ec736451b818c2eb9da80d66c3e84aed1deeb0c345fefe461b"},
+ {file = "numpy-2.0.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:ad0c86f3455fbd0de6c31a3056eb822fc939f81b1618f10ff3406971893b62a5"},
+ {file = "numpy-2.0.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e7f387600d424f91576af20518334df3d97bc76a300a755f9a8d6e4f5cadd289"},
+ {file = "numpy-2.0.0-cp311-cp311-macosx_14_0_arm64.whl", hash = "sha256:34f003cb88b1ba38cb9a9a4a3161c1604973d7f9d5552c38bc2f04f829536609"},
+ {file = "numpy-2.0.0-cp311-cp311-macosx_14_0_x86_64.whl", hash = "sha256:b6f6a8f45d0313db07d6d1d37bd0b112f887e1369758a5419c0370ba915b3871"},
+ {file = "numpy-2.0.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5f64641b42b2429f56ee08b4f427a4d2daf916ec59686061de751a55aafa22e4"},
+ {file = "numpy-2.0.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a7039a136017eaa92c1848152827e1424701532ca8e8967fe480fe1569dae581"},
+ {file = "numpy-2.0.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:46e161722e0f619749d1cd892167039015b2c2817296104487cd03ed4a955995"},
+ {file = "numpy-2.0.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:0e50842b2295ba8414c8c1d9d957083d5dfe9e16828b37de883f51fc53c4016f"},
+ {file = "numpy-2.0.0-cp311-cp311-win32.whl", hash = "sha256:2ce46fd0b8a0c947ae047d222f7136fc4d55538741373107574271bc00e20e8f"},
+ {file = "numpy-2.0.0-cp311-cp311-win_amd64.whl", hash = "sha256:fbd6acc766814ea6443628f4e6751d0da6593dae29c08c0b2606164db026970c"},
+ {file = "numpy-2.0.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:354f373279768fa5a584bac997de6a6c9bc535c482592d7a813bb0c09be6c76f"},
+ {file = "numpy-2.0.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:4d2f62e55a4cd9c58c1d9a1c9edaedcd857a73cb6fda875bf79093f9d9086f85"},
+ {file = "numpy-2.0.0-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:1e72728e7501a450288fc8e1f9ebc73d90cfd4671ebbd631f3e7857c39bd16f2"},
+ {file = "numpy-2.0.0-cp312-cp312-macosx_14_0_x86_64.whl", hash = "sha256:84554fc53daa8f6abf8e8a66e076aff6ece62de68523d9f665f32d2fc50fd66e"},
+ {file = "numpy-2.0.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c73aafd1afca80afecb22718f8700b40ac7cab927b8abab3c3e337d70e10e5a2"},
+ {file = "numpy-2.0.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:49d9f7d256fbc804391a7f72d4a617302b1afac1112fac19b6c6cec63fe7fe8a"},
+ {file = "numpy-2.0.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:0ec84b9ba0654f3b962802edc91424331f423dcf5d5f926676e0150789cb3d95"},
+ {file = "numpy-2.0.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:feff59f27338135776f6d4e2ec7aeeac5d5f7a08a83e80869121ef8164b74af9"},
+ {file = "numpy-2.0.0-cp312-cp312-win32.whl", hash = "sha256:c5a59996dc61835133b56a32ebe4ef3740ea5bc19b3983ac60cc32be5a665d54"},
+ {file = "numpy-2.0.0-cp312-cp312-win_amd64.whl", hash = "sha256:a356364941fb0593bb899a1076b92dfa2029f6f5b8ba88a14fd0984aaf76d0df"},
+ {file = "numpy-2.0.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:e61155fae27570692ad1d327e81c6cf27d535a5d7ef97648a17d922224b216de"},
+ {file = "numpy-2.0.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4554eb96f0fd263041baf16cf0881b3f5dafae7a59b1049acb9540c4d57bc8cb"},
+ {file = "numpy-2.0.0-cp39-cp39-macosx_14_0_arm64.whl", hash = "sha256:903703372d46bce88b6920a0cd86c3ad82dae2dbef157b5fc01b70ea1cfc430f"},
+ {file = "numpy-2.0.0-cp39-cp39-macosx_14_0_x86_64.whl", hash = "sha256:3e8e01233d57639b2e30966c63d36fcea099d17c53bf424d77f088b0f4babd86"},
+ {file = "numpy-2.0.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1cde1753efe513705a0c6d28f5884e22bdc30438bf0085c5c486cdaff40cd67a"},
+ {file = "numpy-2.0.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:821eedb7165ead9eebdb569986968b541f9908979c2da8a4967ecac4439bae3d"},
+ {file = "numpy-2.0.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:9a1712c015831da583b21c5bfe15e8684137097969c6d22e8316ba66b5baabe4"},
+ {file = "numpy-2.0.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:9c27f0946a3536403efb0e1c28def1ae6730a72cd0d5878db38824855e3afc44"},
+ {file = "numpy-2.0.0-cp39-cp39-win32.whl", hash = "sha256:63b92c512d9dbcc37f9d81b123dec99fdb318ba38c8059afc78086fe73820275"},
+ {file = "numpy-2.0.0-cp39-cp39-win_amd64.whl", hash = "sha256:3f6bed7f840d44c08ebdb73b1825282b801799e325bcbdfa6bc5c370e5aecc65"},
+ {file = "numpy-2.0.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:9416a5c2e92ace094e9f0082c5fd473502c91651fb896bc17690d6fc475128d6"},
+ {file = "numpy-2.0.0-pp39-pypy39_pp73-macosx_14_0_x86_64.whl", hash = "sha256:17067d097ed036636fa79f6a869ac26df7db1ba22039d962422506640314933a"},
+ {file = "numpy-2.0.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:38ecb5b0582cd125f67a629072fed6f83562d9dd04d7e03256c9829bdec027ad"},
+ {file = "numpy-2.0.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:cef04d068f5fb0518a77857953193b6bb94809a806bd0a14983a8f12ada060c9"},
+ {file = "numpy-2.0.0.tar.gz", hash = "sha256:cf5d1c9e6837f8af9f92b6bd3e86d513cdc11f60fd62185cc49ec7d1aba34864"},
+]
+
+[[package]]
+name = "overrides"
+version = "7.7.0"
+description = "A decorator to automatically detect mismatch when overriding a method."
+optional = false
+python-versions = ">=3.6"
+files = [
+ {file = "overrides-7.7.0-py3-none-any.whl", hash = "sha256:c7ed9d062f78b8e4c1a7b70bd8796b35ead4d9f510227ef9c5dc7626c60d7e49"},
+ {file = "overrides-7.7.0.tar.gz", hash = "sha256:55158fa3d93b98cc75299b1e67078ad9003ca27945c76162c1c0766d6f91820a"},
+]
-[package.extras]
-diagrams = ["jinja2", "railroad-diagrams"]
+[[package]]
+name = "packaging"
+version = "24.1"
+description = "Core utilities for Python packages"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "packaging-24.1-py3-none-any.whl", hash = "sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124"},
+ {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"},
+]
[[package]]
-name = "pytest"
-version = "7.4.4"
-description = "pytest: simple powerful testing with Python"
-category = "dev"
+name = "pandas"
+version = "2.2.2"
+description = "Powerful data structures for data analysis, time series, and statistics"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.9"
+files = [
+ {file = "pandas-2.2.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:90c6fca2acf139569e74e8781709dccb6fe25940488755716d1d354d6bc58bce"},
+ {file = "pandas-2.2.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c7adfc142dac335d8c1e0dcbd37eb8617eac386596eb9e1a1b77791cf2498238"},
+ {file = "pandas-2.2.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4abfe0be0d7221be4f12552995e58723c7422c80a659da13ca382697de830c08"},
+ {file = "pandas-2.2.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8635c16bf3d99040fdf3ca3db669a7250ddf49c55dc4aa8fe0ae0fa8d6dcc1f0"},
+ {file = "pandas-2.2.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:40ae1dffb3967a52203105a077415a86044a2bea011b5f321c6aa64b379a3f51"},
+ {file = "pandas-2.2.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:8e5a0b00e1e56a842f922e7fae8ae4077aee4af0acb5ae3622bd4b4c30aedf99"},
+ {file = "pandas-2.2.2-cp310-cp310-win_amd64.whl", hash = "sha256:ddf818e4e6c7c6f4f7c8a12709696d193976b591cc7dc50588d3d1a6b5dc8772"},
+ {file = "pandas-2.2.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:696039430f7a562b74fa45f540aca068ea85fa34c244d0deee539cb6d70aa288"},
+ {file = "pandas-2.2.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8e90497254aacacbc4ea6ae5e7a8cd75629d6ad2b30025a4a8b09aa4faf55151"},
+ {file = "pandas-2.2.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:58b84b91b0b9f4bafac2a0ac55002280c094dfc6402402332c0913a59654ab2b"},
+ {file = "pandas-2.2.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6d2123dc9ad6a814bcdea0f099885276b31b24f7edf40f6cdbc0912672e22eee"},
+ {file = "pandas-2.2.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:2925720037f06e89af896c70bca73459d7e6a4be96f9de79e2d440bd499fe0db"},
+ {file = "pandas-2.2.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:0cace394b6ea70c01ca1595f839cf193df35d1575986e484ad35c4aeae7266c1"},
+ {file = "pandas-2.2.2-cp311-cp311-win_amd64.whl", hash = "sha256:873d13d177501a28b2756375d59816c365e42ed8417b41665f346289adc68d24"},
+ {file = "pandas-2.2.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:9dfde2a0ddef507a631dc9dc4af6a9489d5e2e740e226ad426a05cabfbd7c8ef"},
+ {file = "pandas-2.2.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:e9b79011ff7a0f4b1d6da6a61aa1aa604fb312d6647de5bad20013682d1429ce"},
+ {file = "pandas-2.2.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1cb51fe389360f3b5a4d57dbd2848a5f033350336ca3b340d1c53a1fad33bcad"},
+ {file = "pandas-2.2.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:eee3a87076c0756de40b05c5e9a6069c035ba43e8dd71c379e68cab2c20f16ad"},
+ {file = "pandas-2.2.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:3e374f59e440d4ab45ca2fffde54b81ac3834cf5ae2cdfa69c90bc03bde04d76"},
+ {file = "pandas-2.2.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:43498c0bdb43d55cb162cdc8c06fac328ccb5d2eabe3cadeb3529ae6f0517c32"},
+ {file = "pandas-2.2.2-cp312-cp312-win_amd64.whl", hash = "sha256:d187d355ecec3629624fccb01d104da7d7f391db0311145817525281e2804d23"},
+ {file = "pandas-2.2.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:0ca6377b8fca51815f382bd0b697a0814c8bda55115678cbc94c30aacbb6eff2"},
+ {file = "pandas-2.2.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:9057e6aa78a584bc93a13f0a9bf7e753a5e9770a30b4d758b8d5f2a62a9433cd"},
+ {file = "pandas-2.2.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:001910ad31abc7bf06f49dcc903755d2f7f3a9186c0c040b827e522e9cef0863"},
+ {file = "pandas-2.2.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:66b479b0bd07204e37583c191535505410daa8df638fd8e75ae1b383851fe921"},
+ {file = "pandas-2.2.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:a77e9d1c386196879aa5eb712e77461aaee433e54c68cf253053a73b7e49c33a"},
+ {file = "pandas-2.2.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:92fd6b027924a7e178ac202cfbe25e53368db90d56872d20ffae94b96c7acc57"},
+ {file = "pandas-2.2.2-cp39-cp39-win_amd64.whl", hash = "sha256:640cef9aa381b60e296db324337a554aeeb883ead99dc8f6c18e81a93942f5f4"},
+ {file = "pandas-2.2.2.tar.gz", hash = "sha256:9e79019aba43cb4fda9e4d983f8e88ca0373adbb697ae9c6c43093218de28b54"},
+]
[package.dependencies]
-colorama = {version = "*", markers = "sys_platform == \"win32\""}
-exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
-iniconfig = "*"
-packaging = "*"
-pluggy = ">=0.12,<2.0"
-tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
+numpy = [
+ {version = ">=1.22.4", markers = "python_version < \"3.11\""},
+ {version = ">=1.23.2", markers = "python_version == \"3.11\""},
+ {version = ">=1.26.0", markers = "python_version >= \"3.12\""},
+]
+python-dateutil = ">=2.8.2"
+pytz = ">=2020.1"
+tzdata = ">=2022.7"
[package.extras]
-testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
+all = ["PyQt5 (>=5.15.9)", "SQLAlchemy (>=2.0.0)", "adbc-driver-postgresql (>=0.8.0)", "adbc-driver-sqlite (>=0.8.0)", "beautifulsoup4 (>=4.11.2)", "bottleneck (>=1.3.6)", "dataframe-api-compat (>=0.1.7)", "fastparquet (>=2022.12.0)", "fsspec (>=2022.11.0)", "gcsfs (>=2022.11.0)", "html5lib (>=1.1)", "hypothesis (>=6.46.1)", "jinja2 (>=3.1.2)", "lxml (>=4.9.2)", "matplotlib (>=3.6.3)", "numba (>=0.56.4)", "numexpr (>=2.8.4)", "odfpy (>=1.4.1)", "openpyxl (>=3.1.0)", "pandas-gbq (>=0.19.0)", "psycopg2 (>=2.9.6)", "pyarrow (>=10.0.1)", "pymysql (>=1.0.2)", "pyreadstat (>=1.2.0)", "pytest (>=7.3.2)", "pytest-xdist (>=2.2.0)", "python-calamine (>=0.1.7)", "pyxlsb (>=1.0.10)", "qtpy (>=2.3.0)", "s3fs (>=2022.11.0)", "scipy (>=1.10.0)", "tables (>=3.8.0)", "tabulate (>=0.9.0)", "xarray (>=2022.12.0)", "xlrd (>=2.0.1)", "xlsxwriter (>=3.0.5)", "zstandard (>=0.19.0)"]
+aws = ["s3fs (>=2022.11.0)"]
+clipboard = ["PyQt5 (>=5.15.9)", "qtpy (>=2.3.0)"]
+compression = ["zstandard (>=0.19.0)"]
+computation = ["scipy (>=1.10.0)", "xarray (>=2022.12.0)"]
+consortium-standard = ["dataframe-api-compat (>=0.1.7)"]
+excel = ["odfpy (>=1.4.1)", "openpyxl (>=3.1.0)", "python-calamine (>=0.1.7)", "pyxlsb (>=1.0.10)", "xlrd (>=2.0.1)", "xlsxwriter (>=3.0.5)"]
+feather = ["pyarrow (>=10.0.1)"]
+fss = ["fsspec (>=2022.11.0)"]
+gcp = ["gcsfs (>=2022.11.0)", "pandas-gbq (>=0.19.0)"]
+hdf5 = ["tables (>=3.8.0)"]
+html = ["beautifulsoup4 (>=4.11.2)", "html5lib (>=1.1)", "lxml (>=4.9.2)"]
+mysql = ["SQLAlchemy (>=2.0.0)", "pymysql (>=1.0.2)"]
+output-formatting = ["jinja2 (>=3.1.2)", "tabulate (>=0.9.0)"]
+parquet = ["pyarrow (>=10.0.1)"]
+performance = ["bottleneck (>=1.3.6)", "numba (>=0.56.4)", "numexpr (>=2.8.4)"]
+plot = ["matplotlib (>=3.6.3)"]
+postgresql = ["SQLAlchemy (>=2.0.0)", "adbc-driver-postgresql (>=0.8.0)", "psycopg2 (>=2.9.6)"]
+pyarrow = ["pyarrow (>=10.0.1)"]
+spss = ["pyreadstat (>=1.2.0)"]
+sql-other = ["SQLAlchemy (>=2.0.0)", "adbc-driver-postgresql (>=0.8.0)", "adbc-driver-sqlite (>=0.8.0)"]
+test = ["hypothesis (>=6.46.1)", "pytest (>=7.3.2)", "pytest-xdist (>=2.2.0)"]
+xml = ["lxml (>=4.9.2)"]
[[package]]
-name = "pytest-cov"
-version = "3.0.0"
-description = "Pytest plugin for measuring coverage."
-category = "dev"
+name = "pandocfilters"
+version = "1.5.1"
+description = "Utilities for writing pandoc filters in python"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*"
+files = [
+ {file = "pandocfilters-1.5.1-py2.py3-none-any.whl", hash = "sha256:93be382804a9cdb0a7267585f157e5d1731bbe5545a85b268d6f5fe6232de2bc"},
+ {file = "pandocfilters-1.5.1.tar.gz", hash = "sha256:002b4a555ee4ebc03f8b66307e287fa492e4a77b4ea14d3f934328297bb4939e"},
+]
-[package.dependencies]
-coverage = {version = ">=5.2.1", extras = ["toml"]}
-pytest = ">=4.6"
+[[package]]
+name = "parso"
+version = "0.8.4"
+description = "A Python Parser"
+optional = false
+python-versions = ">=3.6"
+files = [
+ {file = "parso-0.8.4-py2.py3-none-any.whl", hash = "sha256:a418670a20291dacd2dddc80c377c5c3791378ee1e8d12bffc35420643d43f18"},
+ {file = "parso-0.8.4.tar.gz", hash = "sha256:eb3a7b58240fb99099a345571deecc0f9540ea5f4dd2fe14c2a99d6b281ab92d"},
+]
[package.extras]
-testing = ["fields", "hunter", "process-tests", "pytest-xdist", "six", "virtualenv"]
+qa = ["flake8 (==5.0.4)", "mypy (==0.971)", "types-setuptools (==67.2.0.1)"]
+testing = ["docopt", "pytest"]
[[package]]
-name = "pytest-datadir"
-version = "1.5.0"
-description = "pytest plugin for test data directories and files"
-category = "dev"
+name = "partd"
+version = "1.4.2"
+description = "Appendable key-value storage"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.9"
+files = [
+ {file = "partd-1.4.2-py3-none-any.whl", hash = "sha256:978e4ac767ec4ba5b86c6eaa52e5a2a3bc748a2ca839e8cc798f1cc6ce6efb0f"},
+ {file = "partd-1.4.2.tar.gz", hash = "sha256:d022c33afbdc8405c226621b015e8067888173d85f7f5ecebb3cafed9a20f02c"},
+]
[package.dependencies]
-pytest = ">=5.0"
+locket = "*"
+toolz = "*"
+
+[package.extras]
+complete = ["blosc", "numpy (>=1.20.0)", "pandas (>=1.3)", "pyzmq"]
[[package]]
-name = "pytest-flake8"
-version = "1.1.1"
-description = "pytest plugin to check FLAKE8 requirements"
-category = "dev"
+name = "pexpect"
+version = "4.9.0"
+description = "Pexpect allows easy control of interactive console applications."
optional = false
python-versions = "*"
+files = [
+ {file = "pexpect-4.9.0-py2.py3-none-any.whl", hash = "sha256:7236d1e080e4936be2dc3e326cec0af72acf9212a7e1d060210e70a47e253523"},
+ {file = "pexpect-4.9.0.tar.gz", hash = "sha256:ee7d41123f3c9911050ea2c2dac107568dc43b2d3b0c7557a33212c398ead30f"},
+]
[package.dependencies]
-flake8 = ">=4.0"
-pytest = ">=7.0"
+ptyprocess = ">=0.5"
[[package]]
-name = "pytest-mock"
-version = "3.12.0"
-description = "Thin-wrapper around the mock package for easier use with pytest"
-category = "dev"
+name = "pillow"
+version = "10.3.0"
+description = "Python Imaging Library (Fork)"
optional = false
python-versions = ">=3.8"
-
-[package.dependencies]
-pytest = ">=5.0"
+files = [
+ {file = "pillow-10.3.0-cp310-cp310-macosx_10_10_x86_64.whl", hash = "sha256:90b9e29824800e90c84e4022dd5cc16eb2d9605ee13f05d47641eb183cd73d45"},
+ {file = "pillow-10.3.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:a2c405445c79c3f5a124573a051062300936b0281fee57637e706453e452746c"},
+ {file = "pillow-10.3.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:78618cdbccaa74d3f88d0ad6cb8ac3007f1a6fa5c6f19af64b55ca170bfa1edf"},
+ {file = "pillow-10.3.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:261ddb7ca91fcf71757979534fb4c128448b5b4c55cb6152d280312062f69599"},
+ {file = "pillow-10.3.0-cp310-cp310-manylinux_2_28_aarch64.whl", hash = "sha256:ce49c67f4ea0609933d01c0731b34b8695a7a748d6c8d186f95e7d085d2fe475"},
+ {file = "pillow-10.3.0-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:b14f16f94cbc61215115b9b1236f9c18403c15dd3c52cf629072afa9d54c1cbf"},
+ {file = "pillow-10.3.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:d33891be6df59d93df4d846640f0e46f1a807339f09e79a8040bc887bdcd7ed3"},
+ {file = "pillow-10.3.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:b50811d664d392f02f7761621303eba9d1b056fb1868c8cdf4231279645c25f5"},
+ {file = "pillow-10.3.0-cp310-cp310-win32.whl", hash = "sha256:ca2870d5d10d8726a27396d3ca4cf7976cec0f3cb706debe88e3a5bd4610f7d2"},
+ {file = "pillow-10.3.0-cp310-cp310-win_amd64.whl", hash = "sha256:f0d0591a0aeaefdaf9a5e545e7485f89910c977087e7de2b6c388aec32011e9f"},
+ {file = "pillow-10.3.0-cp310-cp310-win_arm64.whl", hash = "sha256:ccce24b7ad89adb5a1e34a6ba96ac2530046763912806ad4c247356a8f33a67b"},
+ {file = "pillow-10.3.0-cp311-cp311-macosx_10_10_x86_64.whl", hash = "sha256:5f77cf66e96ae734717d341c145c5949c63180842a545c47a0ce7ae52ca83795"},
+ {file = "pillow-10.3.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:e4b878386c4bf293578b48fc570b84ecfe477d3b77ba39a6e87150af77f40c57"},
+ {file = "pillow-10.3.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fdcbb4068117dfd9ce0138d068ac512843c52295ed996ae6dd1faf537b6dbc27"},
+ {file = "pillow-10.3.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9797a6c8fe16f25749b371c02e2ade0efb51155e767a971c61734b1bf6293994"},
+ {file = "pillow-10.3.0-cp311-cp311-manylinux_2_28_aarch64.whl", hash = "sha256:9e91179a242bbc99be65e139e30690e081fe6cb91a8e77faf4c409653de39451"},
+ {file = "pillow-10.3.0-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:1b87bd9d81d179bd8ab871603bd80d8645729939f90b71e62914e816a76fc6bd"},
+ {file = "pillow-10.3.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:81d09caa7b27ef4e61cb7d8fbf1714f5aec1c6b6c5270ee53504981e6e9121ad"},
+ {file = "pillow-10.3.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:048ad577748b9fa4a99a0548c64f2cb8d672d5bf2e643a739ac8faff1164238c"},
+ {file = "pillow-10.3.0-cp311-cp311-win32.whl", hash = "sha256:7161ec49ef0800947dc5570f86568a7bb36fa97dd09e9827dc02b718c5643f09"},
+ {file = "pillow-10.3.0-cp311-cp311-win_amd64.whl", hash = "sha256:8eb0908e954d093b02a543dc963984d6e99ad2b5e36503d8a0aaf040505f747d"},
+ {file = "pillow-10.3.0-cp311-cp311-win_arm64.whl", hash = "sha256:4e6f7d1c414191c1199f8996d3f2282b9ebea0945693fb67392c75a3a320941f"},
+ {file = "pillow-10.3.0-cp312-cp312-macosx_10_10_x86_64.whl", hash = "sha256:e46f38133e5a060d46bd630faa4d9fa0202377495df1f068a8299fd78c84de84"},
+ {file = "pillow-10.3.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:50b8eae8f7334ec826d6eeffaeeb00e36b5e24aa0b9df322c247539714c6df19"},
+ {file = "pillow-10.3.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9d3bea1c75f8c53ee4d505c3e67d8c158ad4df0d83170605b50b64025917f338"},
+ {file = "pillow-10.3.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:19aeb96d43902f0a783946a0a87dbdad5c84c936025b8419da0a0cd7724356b1"},
+ {file = "pillow-10.3.0-cp312-cp312-manylinux_2_28_aarch64.whl", hash = "sha256:74d28c17412d9caa1066f7a31df8403ec23d5268ba46cd0ad2c50fb82ae40462"},
+ {file = "pillow-10.3.0-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:ff61bfd9253c3915e6d41c651d5f962da23eda633cf02262990094a18a55371a"},
+ {file = "pillow-10.3.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d886f5d353333b4771d21267c7ecc75b710f1a73d72d03ca06df49b09015a9ef"},
+ {file = "pillow-10.3.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:4b5ec25d8b17217d635f8935dbc1b9aa5907962fae29dff220f2659487891cd3"},
+ {file = "pillow-10.3.0-cp312-cp312-win32.whl", hash = "sha256:51243f1ed5161b9945011a7360e997729776f6e5d7005ba0c6879267d4c5139d"},
+ {file = "pillow-10.3.0-cp312-cp312-win_amd64.whl", hash = "sha256:412444afb8c4c7a6cc11a47dade32982439925537e483be7c0ae0cf96c4f6a0b"},
+ {file = "pillow-10.3.0-cp312-cp312-win_arm64.whl", hash = "sha256:798232c92e7665fe82ac085f9d8e8ca98826f8e27859d9a96b41d519ecd2e49a"},
+ {file = "pillow-10.3.0-cp38-cp38-macosx_10_10_x86_64.whl", hash = "sha256:4eaa22f0d22b1a7e93ff0a596d57fdede2e550aecffb5a1ef1106aaece48e96b"},
+ {file = "pillow-10.3.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:cd5e14fbf22a87321b24c88669aad3a51ec052eb145315b3da3b7e3cc105b9a2"},
+ {file = "pillow-10.3.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1530e8f3a4b965eb6a7785cf17a426c779333eb62c9a7d1bbcf3ffd5bf77a4aa"},
+ {file = "pillow-10.3.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5d512aafa1d32efa014fa041d38868fda85028e3f930a96f85d49c7d8ddc0383"},
+ {file = "pillow-10.3.0-cp38-cp38-manylinux_2_28_aarch64.whl", hash = "sha256:339894035d0ede518b16073bdc2feef4c991ee991a29774b33e515f1d308e08d"},
+ {file = "pillow-10.3.0-cp38-cp38-manylinux_2_28_x86_64.whl", hash = "sha256:aa7e402ce11f0885305bfb6afb3434b3cd8f53b563ac065452d9d5654c7b86fd"},
+ {file = "pillow-10.3.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:0ea2a783a2bdf2a561808fe4a7a12e9aa3799b701ba305de596bc48b8bdfce9d"},
+ {file = "pillow-10.3.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:c78e1b00a87ce43bb37642c0812315b411e856a905d58d597750eb79802aaaa3"},
+ {file = "pillow-10.3.0-cp38-cp38-win32.whl", hash = "sha256:72d622d262e463dfb7595202d229f5f3ab4b852289a1cd09650362db23b9eb0b"},
+ {file = "pillow-10.3.0-cp38-cp38-win_amd64.whl", hash = "sha256:2034f6759a722da3a3dbd91a81148cf884e91d1b747992ca288ab88c1de15999"},
+ {file = "pillow-10.3.0-cp39-cp39-macosx_10_10_x86_64.whl", hash = "sha256:2ed854e716a89b1afcedea551cd85f2eb2a807613752ab997b9974aaa0d56936"},
+ {file = "pillow-10.3.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:dc1a390a82755a8c26c9964d457d4c9cbec5405896cba94cf51f36ea0d855002"},
+ {file = "pillow-10.3.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4203efca580f0dd6f882ca211f923168548f7ba334c189e9eab1178ab840bf60"},
+ {file = "pillow-10.3.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3102045a10945173d38336f6e71a8dc71bcaeed55c3123ad4af82c52807b9375"},
+ {file = "pillow-10.3.0-cp39-cp39-manylinux_2_28_aarch64.whl", hash = "sha256:6fb1b30043271ec92dc65f6d9f0b7a830c210b8a96423074b15c7bc999975f57"},
+ {file = "pillow-10.3.0-cp39-cp39-manylinux_2_28_x86_64.whl", hash = "sha256:1dfc94946bc60ea375cc39cff0b8da6c7e5f8fcdc1d946beb8da5c216156ddd8"},
+ {file = "pillow-10.3.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:b09b86b27a064c9624d0a6c54da01c1beaf5b6cadfa609cf63789b1d08a797b9"},
+ {file = "pillow-10.3.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:d3b2348a78bc939b4fed6552abfd2e7988e0f81443ef3911a4b8498ca084f6eb"},
+ {file = "pillow-10.3.0-cp39-cp39-win32.whl", hash = "sha256:45ebc7b45406febf07fef35d856f0293a92e7417ae7933207e90bf9090b70572"},
+ {file = "pillow-10.3.0-cp39-cp39-win_amd64.whl", hash = "sha256:0ba26351b137ca4e0db0342d5d00d2e355eb29372c05afd544ebf47c0956ffeb"},
+ {file = "pillow-10.3.0-cp39-cp39-win_arm64.whl", hash = "sha256:50fd3f6b26e3441ae07b7c979309638b72abc1a25da31a81a7fbd9495713ef4f"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-macosx_10_10_x86_64.whl", hash = "sha256:6b02471b72526ab8a18c39cb7967b72d194ec53c1fd0a70b050565a0f366d355"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:8ab74c06ffdab957d7670c2a5a6e1a70181cd10b727cd788c4dd9005b6a8acd9"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:048eeade4c33fdf7e08da40ef402e748df113fd0b4584e32c4af74fe78baaeb2"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9e2ec1e921fd07c7cda7962bad283acc2f2a9ccc1b971ee4b216b75fad6f0463"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:4c8e73e99da7db1b4cad7f8d682cf6abad7844da39834c288fbfa394a47bbced"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:16563993329b79513f59142a6b02055e10514c1a8e86dca8b48a893e33cf91e3"},
+ {file = "pillow-10.3.0-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:dd78700f5788ae180b5ee8902c6aea5a5726bac7c364b202b4b3e3ba2d293170"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-macosx_10_10_x86_64.whl", hash = "sha256:aff76a55a8aa8364d25400a210a65ff59d0168e0b4285ba6bf2bd83cf675ba32"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:b7bc2176354defba3edc2b9a777744462da2f8e921fbaf61e52acb95bafa9828"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:793b4e24db2e8742ca6423d3fde8396db336698c55cd34b660663ee9e45ed37f"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d93480005693d247f8346bc8ee28c72a2191bdf1f6b5db469c096c0c867ac015"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:c83341b89884e2b2e55886e8fbbf37c3fa5efd6c8907124aeb72f285ae5696e5"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:1a1d1915db1a4fdb2754b9de292642a39a7fb28f1736699527bb649484fb966a"},
+ {file = "pillow-10.3.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:a0eaa93d054751ee9964afa21c06247779b90440ca41d184aeb5d410f20ff591"},
+ {file = "pillow-10.3.0.tar.gz", hash = "sha256:9d2455fbf44c914840c793e89aa82d0e1763a14253a000743719ae5946814b2d"},
+]
[package.extras]
-dev = ["pre-commit", "pytest-asyncio", "tox"]
+docs = ["furo", "olefile", "sphinx (>=2.4)", "sphinx-copybutton", "sphinx-inline-tabs", "sphinx-removed-in", "sphinxext-opengraph"]
+fpx = ["olefile"]
+mic = ["olefile"]
+tests = ["check-manifest", "coverage", "defusedxml", "markdown2", "olefile", "packaging", "pyroma", "pytest", "pytest-cov", "pytest-timeout"]
+typing = ["typing-extensions"]
+xmp = ["defusedxml"]
[[package]]
-name = "pytest-mypy"
-version = "0.10.3"
-description = "Mypy static type checker plugin for Pytest"
-category = "dev"
-optional = false
-python-versions = ">=3.6"
+name = "pint"
+version = "0.24.1"
+description = "Physical quantities module"
+optional = false
+python-versions = ">=3.9"
+files = [
+ {file = "Pint-0.24.1-py3-none-any.whl", hash = "sha256:69b05357c4cb2ac8f3346e235aff4477447e2f56805a79a4f59a2b6d5fc32020"},
+ {file = "pint-0.24.1.tar.gz", hash = "sha256:8849fe9d7b8532e5a5dc41e719e9e19268e18eac179d9a5645f21929a2a15caf"},
+]
[package.dependencies]
-attrs = ">=19.0"
-filelock = ">=3.0"
-mypy = [
- {version = ">=0.900", markers = "python_version >= \"3.11\""},
- {version = ">=0.780", markers = "python_version >= \"3.9\" and python_version < \"3.11\""},
-]
-pytest = {version = ">=6.2", markers = "python_version >= \"3.10\""}
+appdirs = ">=1.4.4"
+flexcache = ">=0.3"
+flexparser = ">=0.3"
+typing-extensions = "*"
+
+[package.extras]
+babel = ["babel (<=2.8)"]
+bench = ["pytest", "pytest-codspeed"]
+dask = ["dask"]
+mip = ["mip (>=1.13)"]
+numpy = ["numpy (>=1.23)"]
+pandas = ["pint-pandas (>=0.3)"]
+test = ["pytest", "pytest-benchmark", "pytest-cov", "pytest-mpl", "pytest-subtests"]
+testbase = ["pytest", "pytest-benchmark", "pytest-cov", "pytest-subtests"]
+uncertainties = ["uncertainties (>=3.1.6)"]
+xarray = ["xarray"]
[[package]]
-name = "python-dateutil"
-version = "2.8.2"
-description = "Extensions to the standard Python datetime module"
-category = "main"
+name = "platformdirs"
+version = "4.2.2"
+description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
optional = false
-python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7"
+python-versions = ">=3.8"
+files = [
+ {file = "platformdirs-4.2.2-py3-none-any.whl", hash = "sha256:2d7a1657e36a80ea911db832a8a6ece5ee53d8de21edd5cc5879af6530b1bfee"},
+ {file = "platformdirs-4.2.2.tar.gz", hash = "sha256:38b7b51f512eed9e84a22788b4bce1de17c0adb134d6becb09836e37d8654cd3"},
+]
-[package.dependencies]
-six = ">=1.5"
+[package.extras]
+docs = ["furo (>=2023.9.10)", "proselint (>=0.13)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1.25.2)"]
+test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)"]
+type = ["mypy (>=1.8)"]
[[package]]
-name = "pytz"
-version = "2024.1"
-description = "World timezone definitions, modern and historical"
-category = "main"
+name = "pluggy"
+version = "1.5.0"
+description = "plugin and hook calling mechanisms for python"
optional = false
-python-versions = "*"
+python-versions = ">=3.8"
+files = [
+ {file = "pluggy-1.5.0-py3-none-any.whl", hash = "sha256:44e1ad92c8ca002de6377e165f3e0f1be63266ab4d554740532335b9d75ea669"},
+ {file = "pluggy-1.5.0.tar.gz", hash = "sha256:2cffa88e94fdc978c4c574f15f9e59b7f4201d439195c3715ca9e2486f1d0cf1"},
+]
+
+[package.extras]
+dev = ["pre-commit", "tox"]
+testing = ["pytest", "pytest-benchmark"]
[[package]]
-name = "pywin32"
-version = "306"
-description = "Python for Window Extensions"
-category = "dev"
+name = "pre-commit"
+version = "2.21.0"
+description = "A framework for managing and maintaining multi-language pre-commit hooks."
optional = false
-python-versions = "*"
+python-versions = ">=3.7"
+files = [
+ {file = "pre_commit-2.21.0-py2.py3-none-any.whl", hash = "sha256:e2f91727039fc39a92f58a588a25b87f936de6567eed4f0e673e0507edc75bad"},
+ {file = "pre_commit-2.21.0.tar.gz", hash = "sha256:31ef31af7e474a8d8995027fefdfcf509b5c913ff31f2015b4ec4beb26a6f658"},
+]
+
+[package.dependencies]
+cfgv = ">=2.0.0"
+identify = ">=1.0.0"
+nodeenv = ">=0.11.1"
+pyyaml = ">=5.1"
+virtualenv = ">=20.10.0"
[[package]]
-name = "pyyaml"
-version = "6.0.1"
-description = "YAML parser and emitter for Python"
-category = "main"
+name = "prometheus-client"
+version = "0.20.0"
+description = "Python client for the Prometheus monitoring system."
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.8"
+files = [
+ {file = "prometheus_client-0.20.0-py3-none-any.whl", hash = "sha256:cde524a85bce83ca359cc837f28b8c0db5cac7aa653a588fd7e84ba061c329e7"},
+ {file = "prometheus_client-0.20.0.tar.gz", hash = "sha256:287629d00b147a32dcb2be0b9df905da599b2d82f80377083ec8463309a4bb89"},
+]
+
+[package.extras]
+twisted = ["twisted"]
[[package]]
-name = "pyzmq"
-version = "25.1.2"
-description = "Python bindings for 0MQ"
-category = "dev"
+name = "prompt-toolkit"
+version = "3.0.47"
+description = "Library for building powerful interactive command lines in Python"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.7.0"
+files = [
+ {file = "prompt_toolkit-3.0.47-py3-none-any.whl", hash = "sha256:0d7bfa67001d5e39d02c224b663abc33687405033a8c422d0d675a5a13361d10"},
+ {file = "prompt_toolkit-3.0.47.tar.gz", hash = "sha256:1e1b29cb58080b1e69f207c893a1a7bf16d127a5c30c9d17a25a5d77792e5360"},
+]
[package.dependencies]
-cffi = {version = "*", markers = "implementation_name == \"pypy\""}
+wcwidth = "*"
[[package]]
-name = "referencing"
-version = "0.33.0"
-description = "JSON Referencing + Python"
-category = "main"
+name = "psutil"
+version = "6.0.0"
+description = "Cross-platform lib for process and system monitoring in Python."
optional = false
-python-versions = ">=3.8"
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7"
+files = [
+ {file = "psutil-6.0.0-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:a021da3e881cd935e64a3d0a20983bda0bb4cf80e4f74fa9bfcb1bc5785360c6"},
+ {file = "psutil-6.0.0-cp27-cp27m-manylinux2010_i686.whl", hash = "sha256:1287c2b95f1c0a364d23bc6f2ea2365a8d4d9b726a3be7294296ff7ba97c17f0"},
+ {file = "psutil-6.0.0-cp27-cp27m-manylinux2010_x86_64.whl", hash = "sha256:a9a3dbfb4de4f18174528d87cc352d1f788b7496991cca33c6996f40c9e3c92c"},
+ {file = "psutil-6.0.0-cp27-cp27mu-manylinux2010_i686.whl", hash = "sha256:6ec7588fb3ddaec7344a825afe298db83fe01bfaaab39155fa84cf1c0d6b13c3"},
+ {file = "psutil-6.0.0-cp27-cp27mu-manylinux2010_x86_64.whl", hash = "sha256:1e7c870afcb7d91fdea2b37c24aeb08f98b6d67257a5cb0a8bc3ac68d0f1a68c"},
+ {file = "psutil-6.0.0-cp27-none-win32.whl", hash = "sha256:02b69001f44cc73c1c5279d02b30a817e339ceb258ad75997325e0e6169d8b35"},
+ {file = "psutil-6.0.0-cp27-none-win_amd64.whl", hash = "sha256:21f1fb635deccd510f69f485b87433460a603919b45e2a324ad65b0cc74f8fb1"},
+ {file = "psutil-6.0.0-cp36-abi3-macosx_10_9_x86_64.whl", hash = "sha256:c588a7e9b1173b6e866756dde596fd4cad94f9399daf99ad8c3258b3cb2b47a0"},
+ {file = "psutil-6.0.0-cp36-abi3-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ed2440ada7ef7d0d608f20ad89a04ec47d2d3ab7190896cd62ca5fc4fe08bf0"},
+ {file = "psutil-6.0.0-cp36-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5fd9a97c8e94059b0ef54a7d4baf13b405011176c3b6ff257c247cae0d560ecd"},
+ {file = "psutil-6.0.0-cp36-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e2e8d0054fc88153ca0544f5c4d554d42e33df2e009c4ff42284ac9ebdef4132"},
+ {file = "psutil-6.0.0-cp36-cp36m-win32.whl", hash = "sha256:fc8c9510cde0146432bbdb433322861ee8c3efbf8589865c8bf8d21cb30c4d14"},
+ {file = "psutil-6.0.0-cp36-cp36m-win_amd64.whl", hash = "sha256:34859b8d8f423b86e4385ff3665d3f4d94be3cdf48221fbe476e883514fdb71c"},
+ {file = "psutil-6.0.0-cp37-abi3-win32.whl", hash = "sha256:a495580d6bae27291324fe60cea0b5a7c23fa36a7cd35035a16d93bdcf076b9d"},
+ {file = "psutil-6.0.0-cp37-abi3-win_amd64.whl", hash = "sha256:33ea5e1c975250a720b3a6609c490db40dae5d83a4eb315170c4fe0d8b1f34b3"},
+ {file = "psutil-6.0.0-cp38-abi3-macosx_11_0_arm64.whl", hash = "sha256:ffe7fc9b6b36beadc8c322f84e1caff51e8703b88eee1da46d1e3a6ae11b4fd0"},
+ {file = "psutil-6.0.0.tar.gz", hash = "sha256:8faae4f310b6d969fa26ca0545338b21f73c6b15db7c4a8d934a5482faa818f2"},
+]
-[package.dependencies]
-attrs = ">=22.2.0"
-rpds-py = ">=0.7.0"
+[package.extras]
+test = ["enum34", "ipaddress", "mock", "pywin32", "wmi"]
[[package]]
-name = "requests"
-version = "2.31.0"
-description = "Python HTTP for Humans."
-category = "dev"
+name = "ptyprocess"
+version = "0.7.0"
+description = "Run a subprocess in a pseudo terminal"
optional = false
-python-versions = ">=3.7"
+python-versions = "*"
+files = [
+ {file = "ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35"},
+ {file = "ptyprocess-0.7.0.tar.gz", hash = "sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220"},
+]
-[package.dependencies]
-certifi = ">=2017.4.17"
-charset-normalizer = ">=2,<4"
-idna = ">=2.5,<4"
-urllib3 = ">=1.21.1,<3"
+[[package]]
+name = "pure-eval"
+version = "0.2.2"
+description = "Safely evaluate AST nodes without side effects"
+optional = false
+python-versions = "*"
+files = [
+ {file = "pure_eval-0.2.2-py3-none-any.whl", hash = "sha256:01eaab343580944bc56080ebe0a674b39ec44a945e6d09ba7db3cb8cec289350"},
+ {file = "pure_eval-0.2.2.tar.gz", hash = "sha256:2b45320af6dfaa1750f543d714b6d1c520a1688dec6fd24d339063ce0aaa9ac3"},
+]
[package.extras]
-socks = ["PySocks (>=1.5.6,!=1.5.7)"]
-use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"]
+tests = ["pytest"]
[[package]]
-name = "rpds-py"
-version = "0.18.0"
-description = "Python bindings to Rust's persistent data structures (rpds)"
-category = "main"
+name = "pybtex"
+version = "0.24.0"
+description = "A BibTeX-compatible bibliography processor in Python"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*"
+files = [
+ {file = "pybtex-0.24.0-py2.py3-none-any.whl", hash = "sha256:e1e0c8c69998452fea90e9179aa2a98ab103f3eed894405b7264e517cc2fcc0f"},
+ {file = "pybtex-0.24.0.tar.gz", hash = "sha256:818eae35b61733e5c007c3fcd2cfb75ed1bc8b4173c1f70b56cc4c0802d34755"},
+]
+
+[package.dependencies]
+latexcodec = ">=1.0.4"
+PyYAML = ">=3.01"
+six = "*"
+
+[package.extras]
+test = ["pytest"]
[[package]]
-name = "ruamel-yaml"
-version = "0.18.6"
-description = "ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order"
-category = "dev"
+name = "pybtex-docutils"
+version = "1.0.3"
+description = "A docutils backend for pybtex."
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "pybtex-docutils-1.0.3.tar.gz", hash = "sha256:3a7ebdf92b593e00e8c1c538aa9a20bca5d92d84231124715acc964d51d93c6b"},
+ {file = "pybtex_docutils-1.0.3-py3-none-any.whl", hash = "sha256:8fd290d2ae48e32fcb54d86b0efb8d573198653c7e2447d5bec5847095f430b9"},
+]
[package.dependencies]
-"ruamel.yaml.clib" = {version = ">=0.2.7", markers = "platform_python_implementation == \"CPython\" and python_version < \"3.13\""}
-
-[package.extras]
-docs = ["mercurial (>5.7)", "ryd"]
-jinja2 = ["ruamel.yaml.jinja2 (>=0.2)"]
+docutils = ">=0.14"
+pybtex = ">=0.16"
[[package]]
-name = "ruamel-yaml-clib"
-version = "0.2.8"
-description = "C version of reader, parser and emitter for ruamel.yaml derived from libyaml"
-category = "dev"
+name = "pycparser"
+version = "2.22"
+description = "C parser in Python"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.8"
+files = [
+ {file = "pycparser-2.22-py3-none-any.whl", hash = "sha256:c3702b6d3dd8c7abc1afa565d7e63d53a1d0bd86cdc24edd75470f4de499cfcc"},
+ {file = "pycparser-2.22.tar.gz", hash = "sha256:491c8be9c040f5390f5bf44a5b07752bd07f56edf992381b05c701439eec10f6"},
+]
[[package]]
-name = "scipy"
-version = "1.12.0"
-description = "Fundamental algorithms for scientific computing in Python"
-category = "main"
+name = "pydocstyle"
+version = "6.3.0"
+description = "Python docstring style checker"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.6"
+files = [
+ {file = "pydocstyle-6.3.0-py3-none-any.whl", hash = "sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"},
+ {file = "pydocstyle-6.3.0.tar.gz", hash = "sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"},
+]
[package.dependencies]
-numpy = ">=1.22.4,<1.29.0"
+snowballstemmer = ">=2.2.0"
[package.extras]
-dev = ["click", "cython-lint (>=0.12.2)", "doit (>=0.36.0)", "mypy", "pycodestyle", "pydevtool", "rich-click", "ruff", "types-psutil", "typing_extensions"]
-doc = ["jupytext", "matplotlib (>2)", "myst-nb", "numpydoc", "pooch", "pydata-sphinx-theme (==0.9.0)", "sphinx (!=4.1.0)", "sphinx-design (>=0.2.0)"]
-test = ["asv", "gmpy2", "hypothesis", "mpmath", "pooch", "pytest", "pytest-cov", "pytest-timeout", "pytest-xdist", "scikit-umfpack", "threadpoolctl"]
+toml = ["tomli (>=1.2.3)"]
[[package]]
-name = "setuptools"
-version = "69.1.1"
-description = "Easily download, build, install, upgrade, and uninstall Python packages"
-category = "dev"
+name = "pygments"
+version = "2.18.0"
+description = "Pygments is a syntax highlighting package written in Python."
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "pygments-2.18.0-py3-none-any.whl", hash = "sha256:b8e6aca0523f3ab76fee51799c488e38782ac06eafcf95e7ba832985c8e7b13a"},
+ {file = "pygments-2.18.0.tar.gz", hash = "sha256:786ff802f32e91311bff3889f6e9a86e81505fe99f2735bb6d60ae0c5004f199"},
+]
[package.extras]
-docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier"]
-testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pip (>=19.1)", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff (>=0.2.1)", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"]
-testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"]
+windows-terminal = ["colorama (>=0.4.6)"]
[[package]]
-name = "shapely"
-version = "1.8.5.post1"
-description = "Geometric objects, predicates, and operations"
-category = "main"
+name = "pyparsing"
+version = "3.1.2"
+description = "pyparsing module - Classes and methods to define and execute parsing grammars"
optional = false
-python-versions = ">=3.6"
+python-versions = ">=3.6.8"
+files = [
+ {file = "pyparsing-3.1.2-py3-none-any.whl", hash = "sha256:f9db75911801ed778fe61bb643079ff86601aca99fcae6345aa67292038fb742"},
+ {file = "pyparsing-3.1.2.tar.gz", hash = "sha256:a1bac0ce561155ecc3ed78ca94d3c9378656ad4c94c1270de543f621420f94ad"},
+]
[package.extras]
-all = ["numpy", "pytest", "pytest-cov"]
-test = ["pytest", "pytest-cov"]
-vectorized = ["numpy"]
+diagrams = ["jinja2", "railroad-diagrams"]
[[package]]
-name = "six"
-version = "1.16.0"
-description = "Python 2 and 3 compatibility utilities"
-category = "main"
+name = "pytest"
+version = "7.4.4"
+description = "pytest: simple powerful testing with Python"
optional = false
-python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
+python-versions = ">=3.7"
+files = [
+ {file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"},
+ {file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"},
+]
-[[package]]
-name = "snowballstemmer"
-version = "2.2.0"
-description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms."
-category = "dev"
-optional = false
-python-versions = "*"
+[package.dependencies]
+colorama = {version = "*", markers = "sys_platform == \"win32\""}
+exceptiongroup = {version = ">=1.0.0rc8", markers = "python_version < \"3.11\""}
+iniconfig = "*"
+packaging = "*"
+pluggy = ">=0.12,<2.0"
+tomli = {version = ">=1.0.0", markers = "python_version < \"3.11\""}
-[[package]]
-name = "sortedcontainers"
-version = "2.4.0"
-description = "Sorted Containers -- Sorted List, Sorted Dict, Sorted Set"
-category = "dev"
-optional = false
-python-versions = "*"
+[package.extras]
+testing = ["argcomplete", "attrs (>=19.2.0)", "hypothesis (>=3.56)", "mock", "nose", "pygments (>=2.7.2)", "requests", "setuptools", "xmlschema"]
[[package]]
-name = "sphinx"
-version = "7.2.6"
-description = "Python documentation generator"
-category = "dev"
+name = "pytest-cov"
+version = "3.0.0"
+description = "Pytest plugin for measuring coverage."
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.6"
+files = [
+ {file = "pytest-cov-3.0.0.tar.gz", hash = "sha256:e7f0f5b1617d2210a2cabc266dfe2f4c75a8d32fb89eafb7ad9d06f6d076d470"},
+ {file = "pytest_cov-3.0.0-py3-none-any.whl", hash = "sha256:578d5d15ac4a25e5f961c938b85a05b09fdaae9deef3bb6de9a6e766622ca7a6"},
+]
[package.dependencies]
-alabaster = ">=0.7,<0.8"
-babel = ">=2.9"
-colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""}
-docutils = ">=0.18.1,<0.21"
-imagesize = ">=1.3"
-Jinja2 = ">=3.0"
-packaging = ">=21.0"
-Pygments = ">=2.14"
-requests = ">=2.25.0"
-snowballstemmer = ">=2.0"
-sphinxcontrib-applehelp = "*"
-sphinxcontrib-devhelp = "*"
-sphinxcontrib-htmlhelp = ">=2.0.0"
-sphinxcontrib-jsmath = "*"
-sphinxcontrib-qthelp = "*"
-sphinxcontrib-serializinghtml = ">=1.1.9"
+coverage = {version = ">=5.2.1", extras = ["toml"]}
+pytest = ">=4.6"
[package.extras]
-docs = ["sphinxcontrib-websupport"]
-lint = ["docutils-stubs", "flake8 (>=3.5.0)", "flake8-simplify", "isort", "mypy (>=0.990)", "ruff", "sphinx-lint", "types-requests"]
-test = ["cython (>=3.0)", "filelock", "html5lib", "pytest (>=4.6)", "setuptools (>=67.0)"]
+testing = ["fields", "hunter", "process-tests", "pytest-xdist", "six", "virtualenv"]
[[package]]
-name = "sphinx-rtd-theme"
-version = "1.3.0"
-description = "Read the Docs theme for Sphinx"
-category = "dev"
+name = "pytest-datadir"
+version = "1.5.0"
+description = "pytest plugin for test data directories and files"
optional = false
-python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7"
+python-versions = ">=3.8"
+files = [
+ {file = "pytest-datadir-1.5.0.tar.gz", hash = "sha256:1617ed92f9afda0c877e4eac91904b5f779d24ba8f5e438752e3ae39d8d2ee3f"},
+ {file = "pytest_datadir-1.5.0-py3-none-any.whl", hash = "sha256:34adf361bcc7b37961bbc1dfa8d25a4829e778bab461703c38a5c50ca9c36dc8"},
+]
[package.dependencies]
-docutils = "<0.19"
-sphinx = ">=1.6,<8"
-sphinxcontrib-jquery = ">=4,<5"
-
-[package.extras]
-dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"]
+pytest = ">=5.0"
[[package]]
-name = "sphinxcontrib-applehelp"
-version = "1.0.8"
-description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books"
-category = "dev"
+name = "pytest-mock"
+version = "3.14.0"
+description = "Thin-wrapper around the mock package for easier use with pytest"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.8"
+files = [
+ {file = "pytest-mock-3.14.0.tar.gz", hash = "sha256:2719255a1efeceadbc056d6bf3df3d1c5015530fb40cf347c0f9afac88410bd0"},
+ {file = "pytest_mock-3.14.0-py3-none-any.whl", hash = "sha256:0b72c38033392a5f4621342fe11e9219ac11ec9d375f8e2a0c164539e0d70f6f"},
+]
+
+[package.dependencies]
+pytest = ">=6.2.5"
[package.extras]
-lint = ["docutils-stubs", "flake8", "mypy"]
-standalone = ["Sphinx (>=5)"]
-test = ["pytest"]
+dev = ["pre-commit", "pytest-asyncio", "tox"]
[[package]]
-name = "sphinxcontrib-bibtex"
-version = "2.5.0"
-description = "Sphinx extension for BibTeX style citations."
-category = "dev"
+name = "python-dateutil"
+version = "2.9.0.post0"
+description = "Extensions to the standard Python datetime module"
optional = false
-python-versions = ">=3.6"
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7"
+files = [
+ {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"},
+ {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"},
+]
[package.dependencies]
-docutils = ">=0.8"
-pybtex = ">=0.24"
-pybtex-docutils = ">=1.0.0"
-Sphinx = ">=2.1"
+six = ">=1.5"
[[package]]
-name = "sphinxcontrib-devhelp"
-version = "1.0.6"
-description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents"
-category = "dev"
+name = "python-json-logger"
+version = "2.0.7"
+description = "A python library adding a json log formatter"
optional = false
-python-versions = ">=3.9"
-
-[package.extras]
-lint = ["docutils-stubs", "flake8", "mypy"]
-standalone = ["Sphinx (>=5)"]
-test = ["pytest"]
+python-versions = ">=3.6"
+files = [
+ {file = "python-json-logger-2.0.7.tar.gz", hash = "sha256:23e7ec02d34237c5aa1e29a070193a4ea87583bb4e7f8fd06d3de8264c4b2e1c"},
+ {file = "python_json_logger-2.0.7-py3-none-any.whl", hash = "sha256:f380b826a991ebbe3de4d897aeec42760035ac760345e57b812938dc8b35e2bd"},
+]
[[package]]
-name = "sphinxcontrib-htmlhelp"
-version = "2.0.5"
-description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files"
-category = "dev"
+name = "pytz"
+version = "2024.1"
+description = "World timezone definitions, modern and historical"
optional = false
-python-versions = ">=3.9"
-
-[package.extras]
-lint = ["docutils-stubs", "flake8", "mypy"]
-standalone = ["Sphinx (>=5)"]
-test = ["html5lib", "pytest"]
+python-versions = "*"
+files = [
+ {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"},
+ {file = "pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812"},
+]
[[package]]
-name = "sphinxcontrib-jquery"
-version = "4.1"
-description = "Extension to include jQuery on newer Sphinx releases"
-category = "dev"
+name = "pywin32"
+version = "306"
+description = "Python for Window Extensions"
optional = false
-python-versions = ">=2.7"
-
-[package.dependencies]
-Sphinx = ">=1.8"
+python-versions = "*"
+files = [
+ {file = "pywin32-306-cp310-cp310-win32.whl", hash = "sha256:06d3420a5155ba65f0b72f2699b5bacf3109f36acbe8923765c22938a69dfc8d"},
+ {file = "pywin32-306-cp310-cp310-win_amd64.whl", hash = "sha256:84f4471dbca1887ea3803d8848a1616429ac94a4a8d05f4bc9c5dcfd42ca99c8"},
+ {file = "pywin32-306-cp311-cp311-win32.whl", hash = "sha256:e65028133d15b64d2ed8f06dd9fbc268352478d4f9289e69c190ecd6818b6407"},
+ {file = "pywin32-306-cp311-cp311-win_amd64.whl", hash = "sha256:a7639f51c184c0272e93f244eb24dafca9b1855707d94c192d4a0b4c01e1100e"},
+ {file = "pywin32-306-cp311-cp311-win_arm64.whl", hash = "sha256:70dba0c913d19f942a2db25217d9a1b726c278f483a919f1abfed79c9cf64d3a"},
+ {file = "pywin32-306-cp312-cp312-win32.whl", hash = "sha256:383229d515657f4e3ed1343da8be101000562bf514591ff383ae940cad65458b"},
+ {file = "pywin32-306-cp312-cp312-win_amd64.whl", hash = "sha256:37257794c1ad39ee9be652da0462dc2e394c8159dfd913a8a4e8eb6fd346da0e"},
+ {file = "pywin32-306-cp312-cp312-win_arm64.whl", hash = "sha256:5821ec52f6d321aa59e2db7e0a35b997de60c201943557d108af9d4ae1ec7040"},
+ {file = "pywin32-306-cp37-cp37m-win32.whl", hash = "sha256:1c73ea9a0d2283d889001998059f5eaaba3b6238f767c9cf2833b13e6a685f65"},
+ {file = "pywin32-306-cp37-cp37m-win_amd64.whl", hash = "sha256:72c5f621542d7bdd4fdb716227be0dd3f8565c11b280be6315b06ace35487d36"},
+ {file = "pywin32-306-cp38-cp38-win32.whl", hash = "sha256:e4c092e2589b5cf0d365849e73e02c391c1349958c5ac3e9d5ccb9a28e017b3a"},
+ {file = "pywin32-306-cp38-cp38-win_amd64.whl", hash = "sha256:e8ac1ae3601bee6ca9f7cb4b5363bf1c0badb935ef243c4733ff9a393b1690c0"},
+ {file = "pywin32-306-cp39-cp39-win32.whl", hash = "sha256:e25fd5b485b55ac9c057f67d94bc203f3f6595078d1fb3b458c9c28b7153a802"},
+ {file = "pywin32-306-cp39-cp39-win_amd64.whl", hash = "sha256:39b61c15272833b5c329a2989999dcae836b1eed650252ab1b7bfbe1d59f30f4"},
+]
[[package]]
-name = "sphinxcontrib-jsmath"
-version = "1.0.1"
-description = "A sphinx extension which renders display math in HTML via JavaScript"
-category = "dev"
+name = "pywinpty"
+version = "2.0.13"
+description = "Pseudo terminal support for Windows from Python."
optional = false
-python-versions = ">=3.5"
-
-[package.extras]
-test = ["flake8", "mypy", "pytest"]
+python-versions = ">=3.8"
+files = [
+ {file = "pywinpty-2.0.13-cp310-none-win_amd64.whl", hash = "sha256:697bff211fb5a6508fee2dc6ff174ce03f34a9a233df9d8b5fe9c8ce4d5eaf56"},
+ {file = "pywinpty-2.0.13-cp311-none-win_amd64.whl", hash = "sha256:b96fb14698db1284db84ca38c79f15b4cfdc3172065b5137383910567591fa99"},
+ {file = "pywinpty-2.0.13-cp312-none-win_amd64.whl", hash = "sha256:2fd876b82ca750bb1333236ce98488c1be96b08f4f7647cfdf4129dfad83c2d4"},
+ {file = "pywinpty-2.0.13-cp38-none-win_amd64.whl", hash = "sha256:61d420c2116c0212808d31625611b51caf621fe67f8a6377e2e8b617ea1c1f7d"},
+ {file = "pywinpty-2.0.13-cp39-none-win_amd64.whl", hash = "sha256:71cb613a9ee24174730ac7ae439fd179ca34ccb8c5349e8d7b72ab5dea2c6f4b"},
+ {file = "pywinpty-2.0.13.tar.gz", hash = "sha256:c34e32351a3313ddd0d7da23d27f835c860d32fe4ac814d372a3ea9594f41dde"},
+]
[[package]]
-name = "sphinxcontrib-mermaid"
-version = "0.9.2"
-description = "Mermaid diagrams in yours Sphinx powered docs"
-category = "dev"
+name = "pyyaml"
+version = "6.0.1"
+description = "YAML parser and emitter for Python"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.6"
+files = [
+ {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"},
+ {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"},
+ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"},
+ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"},
+ {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"},
+ {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"},
+ {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"},
+ {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"},
+ {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"},
+ {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"},
+ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"},
+ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"},
+ {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"},
+ {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"},
+ {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"},
+ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"},
+ {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"},
+ {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"},
+ {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"},
+ {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"},
+ {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"},
+ {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"},
+ {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"},
+ {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"},
+ {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"},
+ {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"},
+ {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"},
+ {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"},
+ {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"},
+ {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"},
+ {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"},
+ {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"},
+ {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"},
+ {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"},
+ {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"},
+ {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"},
+ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"},
+ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"},
+ {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"},
+ {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"},
+ {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"},
+ {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"},
+ {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"},
+ {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"},
+ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"},
+ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"},
+ {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"},
+ {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"},
+ {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"},
+ {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"},
+ {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"},
+]
[[package]]
-name = "sphinxcontrib-qthelp"
-version = "1.0.7"
-description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents"
-category = "dev"
+name = "pyzmq"
+version = "26.0.3"
+description = "Python bindings for 0MQ"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.7"
+files = [
+ {file = "pyzmq-26.0.3-cp310-cp310-macosx_10_15_universal2.whl", hash = "sha256:44dd6fc3034f1eaa72ece33588867df9e006a7303725a12d64c3dff92330f625"},
+ {file = "pyzmq-26.0.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:acb704195a71ac5ea5ecf2811c9ee19ecdc62b91878528302dd0be1b9451cc90"},
+ {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5dbb9c997932473a27afa93954bb77a9f9b786b4ccf718d903f35da3232317de"},
+ {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6bcb34f869d431799c3ee7d516554797f7760cb2198ecaa89c3f176f72d062be"},
+ {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:38ece17ec5f20d7d9b442e5174ae9f020365d01ba7c112205a4d59cf19dc38ee"},
+ {file = "pyzmq-26.0.3-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:ba6e5e6588e49139a0979d03a7deb9c734bde647b9a8808f26acf9c547cab1bf"},
+ {file = "pyzmq-26.0.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:3bf8b000a4e2967e6dfdd8656cd0757d18c7e5ce3d16339e550bd462f4857e59"},
+ {file = "pyzmq-26.0.3-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:2136f64fbb86451dbbf70223635a468272dd20075f988a102bf8a3f194a411dc"},
+ {file = "pyzmq-26.0.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:e8918973fbd34e7814f59143c5f600ecd38b8038161239fd1a3d33d5817a38b8"},
+ {file = "pyzmq-26.0.3-cp310-cp310-win32.whl", hash = "sha256:0aaf982e68a7ac284377d051c742610220fd06d330dcd4c4dbb4cdd77c22a537"},
+ {file = "pyzmq-26.0.3-cp310-cp310-win_amd64.whl", hash = "sha256:f1a9b7d00fdf60b4039f4455afd031fe85ee8305b019334b72dcf73c567edc47"},
+ {file = "pyzmq-26.0.3-cp310-cp310-win_arm64.whl", hash = "sha256:80b12f25d805a919d53efc0a5ad7c0c0326f13b4eae981a5d7b7cc343318ebb7"},
+ {file = "pyzmq-26.0.3-cp311-cp311-macosx_10_15_universal2.whl", hash = "sha256:a72a84570f84c374b4c287183debc776dc319d3e8ce6b6a0041ce2e400de3f32"},
+ {file = "pyzmq-26.0.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7ca684ee649b55fd8f378127ac8462fb6c85f251c2fb027eb3c887e8ee347bcd"},
+ {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e222562dc0f38571c8b1ffdae9d7adb866363134299264a1958d077800b193b7"},
+ {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f17cde1db0754c35a91ac00b22b25c11da6eec5746431d6e5092f0cd31a3fea9"},
+ {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4b7c0c0b3244bb2275abe255d4a30c050d541c6cb18b870975553f1fb6f37527"},
+ {file = "pyzmq-26.0.3-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:ac97a21de3712afe6a6c071abfad40a6224fd14fa6ff0ff8d0c6e6cd4e2f807a"},
+ {file = "pyzmq-26.0.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:88b88282e55fa39dd556d7fc04160bcf39dea015f78e0cecec8ff4f06c1fc2b5"},
+ {file = "pyzmq-26.0.3-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:72b67f966b57dbd18dcc7efbc1c7fc9f5f983e572db1877081f075004614fcdd"},
+ {file = "pyzmq-26.0.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f4b6cecbbf3b7380f3b61de3a7b93cb721125dc125c854c14ddc91225ba52f83"},
+ {file = "pyzmq-26.0.3-cp311-cp311-win32.whl", hash = "sha256:eed56b6a39216d31ff8cd2f1d048b5bf1700e4b32a01b14379c3b6dde9ce3aa3"},
+ {file = "pyzmq-26.0.3-cp311-cp311-win_amd64.whl", hash = "sha256:3191d312c73e3cfd0f0afdf51df8405aafeb0bad71e7ed8f68b24b63c4f36500"},
+ {file = "pyzmq-26.0.3-cp311-cp311-win_arm64.whl", hash = "sha256:b6907da3017ef55139cf0e417c5123a84c7332520e73a6902ff1f79046cd3b94"},
+ {file = "pyzmq-26.0.3-cp312-cp312-macosx_10_15_universal2.whl", hash = "sha256:068ca17214038ae986d68f4a7021f97e187ed278ab6dccb79f837d765a54d753"},
+ {file = "pyzmq-26.0.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:7821d44fe07335bea256b9f1f41474a642ca55fa671dfd9f00af8d68a920c2d4"},
+ {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:eeb438a26d87c123bb318e5f2b3d86a36060b01f22fbdffd8cf247d52f7c9a2b"},
+ {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:69ea9d6d9baa25a4dc9cef5e2b77b8537827b122214f210dd925132e34ae9b12"},
+ {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7daa3e1369355766dea11f1d8ef829905c3b9da886ea3152788dc25ee6079e02"},
+ {file = "pyzmq-26.0.3-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:6ca7a9a06b52d0e38ccf6bca1aeff7be178917893f3883f37b75589d42c4ac20"},
+ {file = "pyzmq-26.0.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:1b7d0e124948daa4d9686d421ef5087c0516bc6179fdcf8828b8444f8e461a77"},
+ {file = "pyzmq-26.0.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:e746524418b70f38550f2190eeee834db8850088c834d4c8406fbb9bc1ae10b2"},
+ {file = "pyzmq-26.0.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:6b3146f9ae6af82c47a5282ac8803523d381b3b21caeae0327ed2f7ecb718798"},
+ {file = "pyzmq-26.0.3-cp312-cp312-win32.whl", hash = "sha256:2b291d1230845871c00c8462c50565a9cd6026fe1228e77ca934470bb7d70ea0"},
+ {file = "pyzmq-26.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:926838a535c2c1ea21c903f909a9a54e675c2126728c21381a94ddf37c3cbddf"},
+ {file = "pyzmq-26.0.3-cp312-cp312-win_arm64.whl", hash = "sha256:5bf6c237f8c681dfb91b17f8435b2735951f0d1fad10cc5dfd96db110243370b"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:0c0991f5a96a8e620f7691e61178cd8f457b49e17b7d9cfa2067e2a0a89fc1d5"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:dbf012d8fcb9f2cf0643b65df3b355fdd74fc0035d70bb5c845e9e30a3a4654b"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:01fbfbeb8249a68d257f601deb50c70c929dc2dfe683b754659569e502fbd3aa"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1c8eb19abe87029c18f226d42b8a2c9efdd139d08f8bf6e085dd9075446db450"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:5344b896e79800af86ad643408ca9aa303a017f6ebff8cee5a3163c1e9aec987"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:204e0f176fd1d067671157d049466869b3ae1fc51e354708b0dc41cf94e23a3a"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:a42db008d58530efa3b881eeee4991146de0b790e095f7ae43ba5cc612decbc5"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-win32.whl", hash = "sha256:8d7a498671ca87e32b54cb47c82a92b40130a26c5197d392720a1bce1b3c77cf"},
+ {file = "pyzmq-26.0.3-cp37-cp37m-win_amd64.whl", hash = "sha256:3b4032a96410bdc760061b14ed6a33613ffb7f702181ba999df5d16fb96ba16a"},
+ {file = "pyzmq-26.0.3-cp38-cp38-macosx_10_15_universal2.whl", hash = "sha256:2cc4e280098c1b192c42a849de8de2c8e0f3a84086a76ec5b07bfee29bda7d18"},
+ {file = "pyzmq-26.0.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:5bde86a2ed3ce587fa2b207424ce15b9a83a9fa14422dcc1c5356a13aed3df9d"},
+ {file = "pyzmq-26.0.3-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:34106f68e20e6ff253c9f596ea50397dbd8699828d55e8fa18bd4323d8d966e6"},
+ {file = "pyzmq-26.0.3-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ebbbd0e728af5db9b04e56389e2299a57ea8b9dd15c9759153ee2455b32be6ad"},
+ {file = "pyzmq-26.0.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f6b1d1c631e5940cac5a0b22c5379c86e8df6a4ec277c7a856b714021ab6cfad"},
+ {file = "pyzmq-26.0.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:e891ce81edd463b3b4c3b885c5603c00141151dd9c6936d98a680c8c72fe5c67"},
+ {file = "pyzmq-26.0.3-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:9b273ecfbc590a1b98f014ae41e5cf723932f3b53ba9367cfb676f838038b32c"},
+ {file = "pyzmq-26.0.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b32bff85fb02a75ea0b68f21e2412255b5731f3f389ed9aecc13a6752f58ac97"},
+ {file = "pyzmq-26.0.3-cp38-cp38-win32.whl", hash = "sha256:f6c21c00478a7bea93caaaef9e7629145d4153b15a8653e8bb4609d4bc70dbfc"},
+ {file = "pyzmq-26.0.3-cp38-cp38-win_amd64.whl", hash = "sha256:3401613148d93ef0fd9aabdbddb212de3db7a4475367f49f590c837355343972"},
+ {file = "pyzmq-26.0.3-cp39-cp39-macosx_10_15_universal2.whl", hash = "sha256:2ed8357f4c6e0daa4f3baf31832df8a33334e0fe5b020a61bc8b345a3db7a606"},
+ {file = "pyzmq-26.0.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:c1c8f2a2ca45292084c75bb6d3a25545cff0ed931ed228d3a1810ae3758f975f"},
+ {file = "pyzmq-26.0.3-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:b63731993cdddcc8e087c64e9cf003f909262b359110070183d7f3025d1c56b5"},
+ {file = "pyzmq-26.0.3-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:b3cd31f859b662ac5d7f4226ec7d8bd60384fa037fc02aee6ff0b53ba29a3ba8"},
+ {file = "pyzmq-26.0.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:115f8359402fa527cf47708d6f8a0f8234f0e9ca0cab7c18c9c189c194dbf620"},
+ {file = "pyzmq-26.0.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:715bdf952b9533ba13dfcf1f431a8f49e63cecc31d91d007bc1deb914f47d0e4"},
+ {file = "pyzmq-26.0.3-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:e1258c639e00bf5e8a522fec6c3eaa3e30cf1c23a2f21a586be7e04d50c9acab"},
+ {file = "pyzmq-26.0.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:15c59e780be8f30a60816a9adab900c12a58d79c1ac742b4a8df044ab2a6d920"},
+ {file = "pyzmq-26.0.3-cp39-cp39-win32.whl", hash = "sha256:d0cdde3c78d8ab5b46595054e5def32a755fc028685add5ddc7403e9f6de9879"},
+ {file = "pyzmq-26.0.3-cp39-cp39-win_amd64.whl", hash = "sha256:ce828058d482ef860746bf532822842e0ff484e27f540ef5c813d516dd8896d2"},
+ {file = "pyzmq-26.0.3-cp39-cp39-win_arm64.whl", hash = "sha256:788f15721c64109cf720791714dc14afd0f449d63f3a5487724f024345067381"},
+ {file = "pyzmq-26.0.3-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:2c18645ef6294d99b256806e34653e86236eb266278c8ec8112622b61db255de"},
+ {file = "pyzmq-26.0.3-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7e6bc96ebe49604df3ec2c6389cc3876cabe475e6bfc84ced1bf4e630662cb35"},
+ {file = "pyzmq-26.0.3-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:971e8990c5cc4ddcff26e149398fc7b0f6a042306e82500f5e8db3b10ce69f84"},
+ {file = "pyzmq-26.0.3-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d8416c23161abd94cc7da80c734ad7c9f5dbebdadfdaa77dad78244457448223"},
+ {file = "pyzmq-26.0.3-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:082a2988364b60bb5de809373098361cf1dbb239623e39e46cb18bc035ed9c0c"},
+ {file = "pyzmq-26.0.3-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d57dfbf9737763b3a60d26e6800e02e04284926329aee8fb01049635e957fe81"},
+ {file = "pyzmq-26.0.3-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:77a85dca4c2430ac04dc2a2185c2deb3858a34fe7f403d0a946fa56970cf60a1"},
+ {file = "pyzmq-26.0.3-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:4c82a6d952a1d555bf4be42b6532927d2a5686dd3c3e280e5f63225ab47ac1f5"},
+ {file = "pyzmq-26.0.3-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4496b1282c70c442809fc1b151977c3d967bfb33e4e17cedbf226d97de18f709"},
+ {file = "pyzmq-26.0.3-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:e4946d6bdb7ba972dfda282f9127e5756d4f299028b1566d1245fa0d438847e6"},
+ {file = "pyzmq-26.0.3-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:03c0ae165e700364b266876d712acb1ac02693acd920afa67da2ebb91a0b3c09"},
+ {file = "pyzmq-26.0.3-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:3e3070e680f79887d60feeda051a58d0ac36622e1759f305a41059eff62c6da7"},
+ {file = "pyzmq-26.0.3-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:6ca08b840fe95d1c2bd9ab92dac5685f949fc6f9ae820ec16193e5ddf603c3b2"},
+ {file = "pyzmq-26.0.3-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e76654e9dbfb835b3518f9938e565c7806976c07b37c33526b574cc1a1050480"},
+ {file = "pyzmq-26.0.3-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:871587bdadd1075b112e697173e946a07d722459d20716ceb3d1bd6c64bd08ce"},
+ {file = "pyzmq-26.0.3-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:d0a2d1bd63a4ad79483049b26514e70fa618ce6115220da9efdff63688808b17"},
+ {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0270b49b6847f0d106d64b5086e9ad5dc8a902413b5dbbb15d12b60f9c1747a4"},
+ {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:703c60b9910488d3d0954ca585c34f541e506a091a41930e663a098d3b794c67"},
+ {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:74423631b6be371edfbf7eabb02ab995c2563fee60a80a30829176842e71722a"},
+ {file = "pyzmq-26.0.3-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:4adfbb5451196842a88fda3612e2c0414134874bffb1c2ce83ab4242ec9e027d"},
+ {file = "pyzmq-26.0.3-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:3516119f4f9b8671083a70b6afaa0a070f5683e431ab3dc26e9215620d7ca1ad"},
+ {file = "pyzmq-26.0.3.tar.gz", hash = "sha256:dba7d9f2e047dfa2bca3b01f4f84aa5246725203d6284e3790f2ca15fba6b40a"},
+]
-[package.extras]
-lint = ["docutils-stubs", "flake8", "mypy"]
-standalone = ["Sphinx (>=5)"]
-test = ["pytest"]
+[package.dependencies]
+cffi = {version = "*", markers = "implementation_name == \"pypy\""}
[[package]]
-name = "sphinxcontrib-serializinghtml"
-version = "1.1.10"
-description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)"
-category = "dev"
+name = "referencing"
+version = "0.35.1"
+description = "JSON Referencing + Python"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.8"
+files = [
+ {file = "referencing-0.35.1-py3-none-any.whl", hash = "sha256:eda6d3234d62814d1c64e305c1331c9a3a6132da475ab6382eaa997b21ee75de"},
+ {file = "referencing-0.35.1.tar.gz", hash = "sha256:25b42124a6c8b632a425174f24087783efb348a6f1e0008e63cd4466fedf703c"},
+]
-[package.extras]
-lint = ["docutils-stubs", "flake8", "mypy"]
-standalone = ["Sphinx (>=5)"]
-test = ["pytest"]
+[package.dependencies]
+attrs = ">=22.2.0"
+rpds-py = ">=0.7.0"
[[package]]
-name = "sqlalchemy"
-version = "2.0.27"
-description = "Database Abstraction Library"
-category = "dev"
+name = "requests"
+version = "2.32.3"
+description = "Python HTTP for Humans."
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+files = [
+ {file = "requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6"},
+ {file = "requests-2.32.3.tar.gz", hash = "sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"},
+]
[package.dependencies]
-greenlet = {version = "!=0.4.17", markers = "platform_machine == \"aarch64\" or platform_machine == \"ppc64le\" or platform_machine == \"x86_64\" or platform_machine == \"amd64\" or platform_machine == \"AMD64\" or platform_machine == \"win32\" or platform_machine == \"WIN32\""}
-typing-extensions = ">=4.6.0"
+certifi = ">=2017.4.17"
+charset-normalizer = ">=2,<4"
+idna = ">=2.5,<4"
+urllib3 = ">=1.21.1,<3"
[package.extras]
-aiomysql = ["aiomysql (>=0.2.0)", "greenlet (!=0.4.17)"]
-aioodbc = ["aioodbc", "greenlet (!=0.4.17)"]
-aiosqlite = ["aiosqlite", "greenlet (!=0.4.17)", "typing_extensions (!=3.10.0.1)"]
-asyncio = ["greenlet (!=0.4.17)"]
-asyncmy = ["asyncmy (>=0.2.3,!=0.2.4,!=0.2.6)", "greenlet (!=0.4.17)"]
-mariadb-connector = ["mariadb (>=1.0.1,!=1.1.2,!=1.1.5)"]
-mssql = ["pyodbc"]
-mssql-pymssql = ["pymssql"]
-mssql-pyodbc = ["pyodbc"]
-mypy = ["mypy (>=0.910)"]
-mysql = ["mysqlclient (>=1.4.0)"]
-mysql-connector = ["mysql-connector-python"]
-oracle = ["cx_oracle (>=8)"]
-oracle-oracledb = ["oracledb (>=1.0.1)"]
-postgresql = ["psycopg2 (>=2.7)"]
-postgresql-asyncpg = ["asyncpg", "greenlet (!=0.4.17)"]
-postgresql-pg8000 = ["pg8000 (>=1.29.1)"]
-postgresql-psycopg = ["psycopg (>=3.0.7)"]
-postgresql-psycopg2binary = ["psycopg2-binary"]
-postgresql-psycopg2cffi = ["psycopg2cffi"]
-postgresql-psycopgbinary = ["psycopg[binary] (>=3.0.7)"]
-pymysql = ["pymysql"]
-sqlcipher = ["sqlcipher3_binary"]
+socks = ["PySocks (>=1.5.6,!=1.5.7)"]
+use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"]
[[package]]
-name = "stack-data"
-version = "0.6.3"
-description = "Extract data from python stack frames and tracebacks for informative displays"
-category = "dev"
+name = "rfc3339-validator"
+version = "0.1.4"
+description = "A pure python RFC3339 validator"
optional = false
-python-versions = "*"
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+files = [
+ {file = "rfc3339_validator-0.1.4-py2.py3-none-any.whl", hash = "sha256:24f6ec1eda14ef823da9e36ec7113124b39c04d50a4d3d3a3c2859577e7791fa"},
+ {file = "rfc3339_validator-0.1.4.tar.gz", hash = "sha256:138a2abdf93304ad60530167e51d2dfb9549521a836871b88d7f4695d0022f6b"},
+]
[package.dependencies]
-asttokens = ">=2.1.0"
-executing = ">=1.2.0"
-pure-eval = "*"
-
-[package.extras]
-tests = ["cython", "littleutils", "pygments", "pytest", "typeguard"]
+six = "*"
[[package]]
-name = "tabulate"
-version = "0.9.0"
-description = "Pretty-print tabular data"
-category = "dev"
+name = "rfc3986-validator"
+version = "0.1.1"
+description = "Pure python rfc3986 validator"
optional = false
-python-versions = ">=3.7"
-
-[package.extras]
-widechars = ["wcwidth"]
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*"
+files = [
+ {file = "rfc3986_validator-0.1.1-py2.py3-none-any.whl", hash = "sha256:2f235c432ef459970b4306369336b9d5dbdda31b510ca1e327636e01f528bfa9"},
+ {file = "rfc3986_validator-0.1.1.tar.gz", hash = "sha256:3d44bde7921b3b9ec3ae4e3adca370438eccebc676456449b145d533b240d055"},
+]
[[package]]
-name = "tomli"
-version = "2.0.1"
-description = "A lil' TOML parser"
-category = "main"
+name = "rpds-py"
+version = "0.18.1"
+description = "Python bindings to Rust's persistent data structures (rpds)"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.8"
+files = [
+ {file = "rpds_py-0.18.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:d31dea506d718693b6b2cffc0648a8929bdc51c70a311b2770f09611caa10d53"},
+ {file = "rpds_py-0.18.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:732672fbc449bab754e0b15356c077cc31566df874964d4801ab14f71951ea80"},
+ {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4a98a1f0552b5f227a3d6422dbd61bc6f30db170939bd87ed14f3c339aa6c7c9"},
+ {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:7f1944ce16401aad1e3f7d312247b3d5de7981f634dc9dfe90da72b87d37887d"},
+ {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:38e14fb4e370885c4ecd734f093a2225ee52dc384b86fa55fe3f74638b2cfb09"},
+ {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:08d74b184f9ab6289b87b19fe6a6d1a97fbfea84b8a3e745e87a5de3029bf944"},
+ {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d70129cef4a8d979caa37e7fe957202e7eee8ea02c5e16455bc9808a59c6b2f0"},
+ {file = "rpds_py-0.18.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:ce0bb20e3a11bd04461324a6a798af34d503f8d6f1aa3d2aa8901ceaf039176d"},
+ {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:81c5196a790032e0fc2464c0b4ab95f8610f96f1f2fa3d4deacce6a79852da60"},
+ {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:f3027be483868c99b4985fda802a57a67fdf30c5d9a50338d9db646d590198da"},
+ {file = "rpds_py-0.18.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:d44607f98caa2961bab4fa3c4309724b185b464cdc3ba6f3d7340bac3ec97cc1"},
+ {file = "rpds_py-0.18.1-cp310-none-win32.whl", hash = "sha256:c273e795e7a0f1fddd46e1e3cb8be15634c29ae8ff31c196debb620e1edb9333"},
+ {file = "rpds_py-0.18.1-cp310-none-win_amd64.whl", hash = "sha256:8352f48d511de5f973e4f2f9412736d7dea76c69faa6d36bcf885b50c758ab9a"},
+ {file = "rpds_py-0.18.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:6b5ff7e1d63a8281654b5e2896d7f08799378e594f09cf3674e832ecaf396ce8"},
+ {file = "rpds_py-0.18.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:8927638a4d4137a289e41d0fd631551e89fa346d6dbcfc31ad627557d03ceb6d"},
+ {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:154bf5c93d79558b44e5b50cc354aa0459e518e83677791e6adb0b039b7aa6a7"},
+ {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:07f2139741e5deb2c5154a7b9629bc5aa48c766b643c1a6750d16f865a82c5fc"},
+ {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8c7672e9fba7425f79019db9945b16e308ed8bc89348c23d955c8c0540da0a07"},
+ {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:489bdfe1abd0406eba6b3bb4fdc87c7fa40f1031de073d0cfb744634cc8fa261"},
+ {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3c20f05e8e3d4fc76875fc9cb8cf24b90a63f5a1b4c5b9273f0e8225e169b100"},
+ {file = "rpds_py-0.18.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:967342e045564cef76dfcf1edb700b1e20838d83b1aa02ab313e6a497cf923b8"},
+ {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:2cc7c1a47f3a63282ab0f422d90ddac4aa3034e39fc66a559ab93041e6505da7"},
+ {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:f7afbfee1157e0f9376c00bb232e80a60e59ed716e3211a80cb8506550671e6e"},
+ {file = "rpds_py-0.18.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:9e6934d70dc50f9f8ea47081ceafdec09245fd9f6032669c3b45705dea096b88"},
+ {file = "rpds_py-0.18.1-cp311-none-win32.whl", hash = "sha256:c69882964516dc143083d3795cb508e806b09fc3800fd0d4cddc1df6c36e76bb"},
+ {file = "rpds_py-0.18.1-cp311-none-win_amd64.whl", hash = "sha256:70a838f7754483bcdc830444952fd89645569e7452e3226de4a613a4c1793fb2"},
+ {file = "rpds_py-0.18.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:3dd3cd86e1db5aadd334e011eba4e29d37a104b403e8ca24dcd6703c68ca55b3"},
+ {file = "rpds_py-0.18.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:05f3d615099bd9b13ecf2fc9cf2d839ad3f20239c678f461c753e93755d629ee"},
+ {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:35b2b771b13eee8729a5049c976197ff58a27a3829c018a04341bcf1ae409b2b"},
+ {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ee17cd26b97d537af8f33635ef38be873073d516fd425e80559f4585a7b90c43"},
+ {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b646bf655b135ccf4522ed43d6902af37d3f5dbcf0da66c769a2b3938b9d8184"},
+ {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:19ba472b9606c36716062c023afa2484d1e4220548751bda14f725a7de17b4f6"},
+ {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e30ac5e329098903262dc5bdd7e2086e0256aa762cc8b744f9e7bf2a427d3f8"},
+ {file = "rpds_py-0.18.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d58ad6317d188c43750cb76e9deacf6051d0f884d87dc6518e0280438648a9ac"},
+ {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e1735502458621921cee039c47318cb90b51d532c2766593be6207eec53e5c4c"},
+ {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:f5bab211605d91db0e2995a17b5c6ee5edec1270e46223e513eaa20da20076ac"},
+ {file = "rpds_py-0.18.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:2fc24a329a717f9e2448f8cd1f960f9dac4e45b6224d60734edeb67499bab03a"},
+ {file = "rpds_py-0.18.1-cp312-none-win32.whl", hash = "sha256:1805d5901779662d599d0e2e4159d8a82c0b05faa86ef9222bf974572286b2b6"},
+ {file = "rpds_py-0.18.1-cp312-none-win_amd64.whl", hash = "sha256:720edcb916df872d80f80a1cc5ea9058300b97721efda8651efcd938a9c70a72"},
+ {file = "rpds_py-0.18.1-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:c827576e2fa017a081346dce87d532a5310241648eb3700af9a571a6e9fc7e74"},
+ {file = "rpds_py-0.18.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:aa3679e751408d75a0b4d8d26d6647b6d9326f5e35c00a7ccd82b78ef64f65f8"},
+ {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0abeee75434e2ee2d142d650d1e54ac1f8b01e6e6abdde8ffd6eeac6e9c38e20"},
+ {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ed402d6153c5d519a0faf1bb69898e97fb31613b49da27a84a13935ea9164dfc"},
+ {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:338dee44b0cef8b70fd2ef54b4e09bb1b97fc6c3a58fea5db6cc083fd9fc2724"},
+ {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7750569d9526199c5b97e5a9f8d96a13300950d910cf04a861d96f4273d5b104"},
+ {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:607345bd5912aacc0c5a63d45a1f73fef29e697884f7e861094e443187c02be5"},
+ {file = "rpds_py-0.18.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:207c82978115baa1fd8d706d720b4a4d2b0913df1c78c85ba73fe6c5804505f0"},
+ {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:6d1e42d2735d437e7e80bab4d78eb2e459af48c0a46e686ea35f690b93db792d"},
+ {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:5463c47c08630007dc0fe99fb480ea4f34a89712410592380425a9b4e1611d8e"},
+ {file = "rpds_py-0.18.1-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:06d218939e1bf2ca50e6b0ec700ffe755e5216a8230ab3e87c059ebb4ea06afc"},
+ {file = "rpds_py-0.18.1-cp38-none-win32.whl", hash = "sha256:312fe69b4fe1ffbe76520a7676b1e5ac06ddf7826d764cc10265c3b53f96dbe9"},
+ {file = "rpds_py-0.18.1-cp38-none-win_amd64.whl", hash = "sha256:9437ca26784120a279f3137ee080b0e717012c42921eb07861b412340f85bae2"},
+ {file = "rpds_py-0.18.1-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:19e515b78c3fc1039dd7da0a33c28c3154458f947f4dc198d3c72db2b6b5dc93"},
+ {file = "rpds_py-0.18.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a7b28c5b066bca9a4eb4e2f2663012debe680f097979d880657f00e1c30875a0"},
+ {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:673fdbbf668dd958eff750e500495ef3f611e2ecc209464f661bc82e9838991e"},
+ {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d960de62227635d2e61068f42a6cb6aae91a7fe00fca0e3aeed17667c8a34611"},
+ {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:352a88dc7892f1da66b6027af06a2e7e5d53fe05924cc2cfc56495b586a10b72"},
+ {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4e0ee01ad8260184db21468a6e1c37afa0529acc12c3a697ee498d3c2c4dcaf3"},
+ {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4c39ad2f512b4041343ea3c7894339e4ca7839ac38ca83d68a832fc8b3748ab"},
+ {file = "rpds_py-0.18.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:aaa71ee43a703c321906813bb252f69524f02aa05bf4eec85f0c41d5d62d0f4c"},
+ {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:6cd8098517c64a85e790657e7b1e509b9fe07487fd358e19431cb120f7d96338"},
+ {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:4adec039b8e2928983f885c53b7cc4cda8965b62b6596501a0308d2703f8af1b"},
+ {file = "rpds_py-0.18.1-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:32b7daaa3e9389db3695964ce8e566e3413b0c43e3394c05e4b243a4cd7bef26"},
+ {file = "rpds_py-0.18.1-cp39-none-win32.whl", hash = "sha256:2625f03b105328729f9450c8badda34d5243231eef6535f80064d57035738360"},
+ {file = "rpds_py-0.18.1-cp39-none-win_amd64.whl", hash = "sha256:bf18932d0003c8c4d51a39f244231986ab23ee057d235a12b2684ea26a353590"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:cbfbea39ba64f5e53ae2915de36f130588bba71245b418060ec3330ebf85678e"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:a3d456ff2a6a4d2adcdf3c1c960a36f4fd2fec6e3b4902a42a384d17cf4e7a65"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7700936ef9d006b7ef605dc53aa364da2de5a3aa65516a1f3ce73bf82ecfc7ae"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:51584acc5916212e1bf45edd17f3a6b05fe0cbb40482d25e619f824dccb679de"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:942695a206a58d2575033ff1e42b12b2aece98d6003c6bc739fbf33d1773b12f"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b906b5f58892813e5ba5c6056d6a5ad08f358ba49f046d910ad992196ea61397"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f6f8e3fecca256fefc91bb6765a693d96692459d7d4c644660a9fff32e517843"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:7732770412bab81c5a9f6d20aeb60ae943a9b36dcd990d876a773526468e7163"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:bd1105b50ede37461c1d51b9698c4f4be6e13e69a908ab7751e3807985fc0346"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:618916f5535784960f3ecf8111581f4ad31d347c3de66d02e728de460a46303c"},
+ {file = "rpds_py-0.18.1-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:17c6d2155e2423f7e79e3bb18151c686d40db42d8645e7977442170c360194d4"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:6c4c4c3f878df21faf5fac86eda32671c27889e13570645a9eea0a1abdd50922"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:fab6ce90574645a0d6c58890e9bcaac8d94dff54fb51c69e5522a7358b80ab64"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:531796fb842b53f2695e94dc338929e9f9dbf473b64710c28af5a160b2a8927d"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:740884bc62a5e2bbb31e584f5d23b32320fd75d79f916f15a788d527a5e83644"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:998125738de0158f088aef3cb264a34251908dd2e5d9966774fdab7402edfab7"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e2be6e9dd4111d5b31ba3b74d17da54a8319d8168890fbaea4b9e5c3de630ae5"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d0cee71bc618cd93716f3c1bf56653740d2d13ddbd47673efa8bf41435a60daa"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2c3caec4ec5cd1d18e5dd6ae5194d24ed12785212a90b37f5f7f06b8bedd7139"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:27bba383e8c5231cd559affe169ca0b96ec78d39909ffd817f28b166d7ddd4d8"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_i686.whl", hash = "sha256:a888e8bdb45916234b99da2d859566f1e8a1d2275a801bb8e4a9644e3c7e7909"},
+ {file = "rpds_py-0.18.1-pp38-pypy38_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:6031b25fb1b06327b43d841f33842b383beba399884f8228a6bb3df3088485ff"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:48c2faaa8adfacefcbfdb5f2e2e7bdad081e5ace8d182e5f4ade971f128e6bb3"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:d85164315bd68c0806768dc6bb0429c6f95c354f87485ee3593c4f6b14def2bd"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6afd80f6c79893cfc0574956f78a0add8c76e3696f2d6a15bca2c66c415cf2d4"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa242ac1ff583e4ec7771141606aafc92b361cd90a05c30d93e343a0c2d82a89"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d21be4770ff4e08698e1e8e0bce06edb6ea0626e7c8f560bc08222880aca6a6f"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5c45a639e93a0c5d4b788b2613bd637468edd62f8f95ebc6fcc303d58ab3f0a8"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:910e71711d1055b2768181efa0a17537b2622afeb0424116619817007f8a2b10"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b9bb1f182a97880f6078283b3505a707057c42bf55d8fca604f70dedfdc0772a"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:1d54f74f40b1f7aaa595a02ff42ef38ca654b1469bef7d52867da474243cc633"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:8d2e182c9ee01135e11e9676e9a62dfad791a7a467738f06726872374a83db49"},
+ {file = "rpds_py-0.18.1-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:636a15acc588f70fda1661234761f9ed9ad79ebed3f2125d44be0862708b666e"},
+ {file = "rpds_py-0.18.1.tar.gz", hash = "sha256:dc48b479d540770c811fbd1eb9ba2bb66951863e448efec2e2c102625328e92f"},
+]
[[package]]
-name = "tomli-w"
-version = "1.0.0"
-description = "A lil' TOML writer"
-category = "main"
+name = "ruamel-yaml"
+version = "0.18.6"
+description = "ruamel.yaml is a YAML parser/emitter that supports roundtrip preservation of comments, seq/map flow style, and map key order"
optional = false
python-versions = ">=3.7"
+files = [
+ {file = "ruamel.yaml-0.18.6-py3-none-any.whl", hash = "sha256:57b53ba33def16c4f3d807c0ccbc00f8a6081827e81ba2491691b76882d0c636"},
+ {file = "ruamel.yaml-0.18.6.tar.gz", hash = "sha256:8b27e6a217e786c6fbe5634d8f3f11bc63e0f80f6a5890f28863d9c45aac311b"},
+]
-[[package]]
-name = "toolz"
-version = "0.12.1"
-description = "List processing tools and functional utilities"
-category = "main"
-optional = false
-python-versions = ">=3.7"
+[package.dependencies]
+"ruamel.yaml.clib" = {version = ">=0.2.7", markers = "platform_python_implementation == \"CPython\" and python_version < \"3.13\""}
+
+[package.extras]
+docs = ["mercurial (>5.7)", "ryd"]
+jinja2 = ["ruamel.yaml.jinja2 (>=0.2)"]
[[package]]
-name = "tornado"
-version = "6.4"
-description = "Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed."
-category = "dev"
+name = "ruamel-yaml-clib"
+version = "0.2.8"
+description = "C version of reader, parser and emitter for ruamel.yaml derived from libyaml"
optional = false
-python-versions = ">= 3.8"
+python-versions = ">=3.6"
+files = [
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:b42169467c42b692c19cf539c38d4602069d8c1505e97b86387fcf7afb766e1d"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-macosx_13_0_arm64.whl", hash = "sha256:07238db9cbdf8fc1e9de2489a4f68474e70dffcb32232db7c08fa61ca0c7c462"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_24_x86_64.whl", hash = "sha256:fff3573c2db359f091e1589c3d7c5fc2f86f5bdb6f24252c2d8e539d4e45f412"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-manylinux_2_24_aarch64.whl", hash = "sha256:aa2267c6a303eb483de8d02db2871afb5c5fc15618d894300b88958f729ad74f"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:840f0c7f194986a63d2c2465ca63af8ccbbc90ab1c6001b1978f05119b5e7334"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:024cfe1fc7c7f4e1aff4a81e718109e13409767e4f871443cbff3dba3578203d"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-win32.whl", hash = "sha256:c69212f63169ec1cfc9bb44723bf2917cbbd8f6191a00ef3410f5a7fe300722d"},
+ {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-win_amd64.whl", hash = "sha256:cabddb8d8ead485e255fe80429f833172b4cadf99274db39abc080e068cbcc31"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:bef08cd86169d9eafb3ccb0a39edb11d8e25f3dae2b28f5c52fd997521133069"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-macosx_13_0_arm64.whl", hash = "sha256:b16420e621d26fdfa949a8b4b47ade8810c56002f5389970db4ddda51dbff248"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_24_x86_64.whl", hash = "sha256:25c515e350e5b739842fc3228d662413ef28f295791af5e5110b543cf0b57d9b"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-manylinux_2_24_aarch64.whl", hash = "sha256:1707814f0d9791df063f8c19bb51b0d1278b8e9a2353abbb676c2f685dee6afe"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:46d378daaac94f454b3a0e3d8d78cafd78a026b1d71443f4966c696b48a6d899"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:09b055c05697b38ecacb7ac50bdab2240bfca1a0c4872b0fd309bb07dc9aa3a9"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-win32.whl", hash = "sha256:53a300ed9cea38cf5a2a9b069058137c2ca1ce658a874b79baceb8f892f915a7"},
+ {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-win_amd64.whl", hash = "sha256:c2a72e9109ea74e511e29032f3b670835f8a59bbdc9ce692c5b4ed91ccf1eedb"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:ebc06178e8821efc9692ea7544aa5644217358490145629914d8020042c24aa1"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-macosx_13_0_arm64.whl", hash = "sha256:edaef1c1200c4b4cb914583150dcaa3bc30e592e907c01117c08b13a07255ec2"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d176b57452ab5b7028ac47e7b3cf644bcfdc8cacfecf7e71759f7f51a59e5c92"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-manylinux_2_24_aarch64.whl", hash = "sha256:1dc67314e7e1086c9fdf2680b7b6c2be1c0d8e3a8279f2e993ca2a7545fecf62"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:3213ece08ea033eb159ac52ae052a4899b56ecc124bb80020d9bbceeb50258e9"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:aab7fd643f71d7946f2ee58cc88c9b7bfc97debd71dcc93e03e2d174628e7e2d"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-win32.whl", hash = "sha256:5c365d91c88390c8d0a8545df0b5857172824b1c604e867161e6b3d59a827eaa"},
+ {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-win_amd64.whl", hash = "sha256:1758ce7d8e1a29d23de54a16ae867abd370f01b5a69e1a3ba75223eaa3ca1a1b"},
+ {file = "ruamel.yaml.clib-0.2.8-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:a5aa27bad2bb83670b71683aae140a1f52b0857a2deff56ad3f6c13a017a26ed"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c58ecd827313af6864893e7af0a3bb85fd529f862b6adbefe14643947cfe2942"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-macosx_12_0_arm64.whl", hash = "sha256:f481f16baec5290e45aebdc2a5168ebc6d35189ae6fea7a58787613a25f6e875"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-manylinux_2_24_aarch64.whl", hash = "sha256:77159f5d5b5c14f7c34073862a6b7d34944075d9f93e681638f6d753606c6ce6"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:7f67a1ee819dc4562d444bbafb135832b0b909f81cc90f7aa00260968c9ca1b3"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:4ecbf9c3e19f9562c7fdd462e8d18dd902a47ca046a2e64dba80699f0b6c09b7"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:87ea5ff66d8064301a154b3933ae406b0863402a799b16e4a1d24d9fbbcbe0d3"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-win32.whl", hash = "sha256:75e1ed13e1f9de23c5607fe6bd1aeaae21e523b32d83bb33918245361e9cc51b"},
+ {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-win_amd64.whl", hash = "sha256:3f215c5daf6a9d7bbed4a0a4f760f3113b10e82ff4c5c44bec20a68c8014f675"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1b617618914cb00bf5c34d4357c37aa15183fa229b24767259657746c9077615"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-macosx_12_0_arm64.whl", hash = "sha256:a6a9ffd280b71ad062eae53ac1659ad86a17f59a0fdc7699fd9be40525153337"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-manylinux_2_24_aarch64.whl", hash = "sha256:305889baa4043a09e5b76f8e2a51d4ffba44259f6b4c72dec8ca56207d9c6fe1"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:700e4ebb569e59e16a976857c8798aee258dceac7c7d6b50cab63e080058df91"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:e2b4c44b60eadec492926a7270abb100ef9f72798e18743939bdbf037aab8c28"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:e79e5db08739731b0ce4850bed599235d601701d5694c36570a99a0c5ca41a9d"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-win32.whl", hash = "sha256:955eae71ac26c1ab35924203fda6220f84dce57d6d7884f189743e2abe3a9fbe"},
+ {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-win_amd64.whl", hash = "sha256:56f4252222c067b4ce51ae12cbac231bce32aee1d33fbfc9d17e5b8d6966c312"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:03d1162b6d1df1caa3a4bd27aa51ce17c9afc2046c31b0ad60a0a96ec22f8001"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-macosx_12_0_arm64.whl", hash = "sha256:bba64af9fa9cebe325a62fa398760f5c7206b215201b0ec825005f1b18b9bccf"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-manylinux_2_24_aarch64.whl", hash = "sha256:a1a45e0bb052edf6a1d3a93baef85319733a888363938e1fc9924cb00c8df24c"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:da09ad1c359a728e112d60116f626cc9f29730ff3e0e7db72b9a2dbc2e4beed5"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:184565012b60405d93838167f425713180b949e9d8dd0bbc7b49f074407c5a8b"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:a75879bacf2c987c003368cf14bed0ffe99e8e85acfa6c0bfffc21a090f16880"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-win32.whl", hash = "sha256:84b554931e932c46f94ab306913ad7e11bba988104c5cff26d90d03f68258cd5"},
+ {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-win_amd64.whl", hash = "sha256:25ac8c08322002b06fa1d49d1646181f0b2c72f5cbc15a85e80b4c30a544bb15"},
+ {file = "ruamel.yaml.clib-0.2.8.tar.gz", hash = "sha256:beb2e0404003de9a4cab9753a8805a8fe9320ee6673136ed7f04255fe60bb512"},
+]
[[package]]
-name = "tqdm"
-version = "4.66.2"
-description = "Fast, Extensible Progress Meter"
-category = "main"
+name = "scipy"
+version = "1.14.0"
+description = "Fundamental algorithms for scientific computing in Python"
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.10"
+files = [
+ {file = "scipy-1.14.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7e911933d54ead4d557c02402710c2396529540b81dd554fc1ba270eb7308484"},
+ {file = "scipy-1.14.0-cp310-cp310-macosx_12_0_arm64.whl", hash = "sha256:687af0a35462402dd851726295c1a5ae5f987bd6e9026f52e9505994e2f84ef6"},
+ {file = "scipy-1.14.0-cp310-cp310-macosx_14_0_arm64.whl", hash = "sha256:07e179dc0205a50721022344fb85074f772eadbda1e1b3eecdc483f8033709b7"},
+ {file = "scipy-1.14.0-cp310-cp310-macosx_14_0_x86_64.whl", hash = "sha256:6a9c9a9b226d9a21e0a208bdb024c3982932e43811b62d202aaf1bb59af264b1"},
+ {file = "scipy-1.14.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:076c27284c768b84a45dcf2e914d4000aac537da74236a0d45d82c6fa4b7b3c0"},
+ {file = "scipy-1.14.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42470ea0195336df319741e230626b6225a740fd9dce9642ca13e98f667047c0"},
+ {file = "scipy-1.14.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:176c6f0d0470a32f1b2efaf40c3d37a24876cebf447498a4cefb947a79c21e9d"},
+ {file = "scipy-1.14.0-cp310-cp310-win_amd64.whl", hash = "sha256:ad36af9626d27a4326c8e884917b7ec321d8a1841cd6dacc67d2a9e90c2f0359"},
+ {file = "scipy-1.14.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6d056a8709ccda6cf36cdd2eac597d13bc03dba38360f418560a93050c76a16e"},
+ {file = "scipy-1.14.0-cp311-cp311-macosx_12_0_arm64.whl", hash = "sha256:f0a50da861a7ec4573b7c716b2ebdcdf142b66b756a0d392c236ae568b3a93fb"},
+ {file = "scipy-1.14.0-cp311-cp311-macosx_14_0_arm64.whl", hash = "sha256:94c164a9e2498e68308e6e148646e486d979f7fcdb8b4cf34b5441894bdb9caf"},
+ {file = "scipy-1.14.0-cp311-cp311-macosx_14_0_x86_64.whl", hash = "sha256:a7d46c3e0aea5c064e734c3eac5cf9eb1f8c4ceee756262f2c7327c4c2691c86"},
+ {file = "scipy-1.14.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9eee2989868e274aae26125345584254d97c56194c072ed96cb433f32f692ed8"},
+ {file = "scipy-1.14.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9e3154691b9f7ed73778d746da2df67a19d046a6c8087c8b385bc4cdb2cfca74"},
+ {file = "scipy-1.14.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c40003d880f39c11c1edbae8144e3813904b10514cd3d3d00c277ae996488cdb"},
+ {file = "scipy-1.14.0-cp311-cp311-win_amd64.whl", hash = "sha256:5b083c8940028bb7e0b4172acafda6df762da1927b9091f9611b0bcd8676f2bc"},
+ {file = "scipy-1.14.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:bff2438ea1330e06e53c424893ec0072640dac00f29c6a43a575cbae4c99b2b9"},
+ {file = "scipy-1.14.0-cp312-cp312-macosx_12_0_arm64.whl", hash = "sha256:bbc0471b5f22c11c389075d091d3885693fd3f5e9a54ce051b46308bc787e5d4"},
+ {file = "scipy-1.14.0-cp312-cp312-macosx_14_0_arm64.whl", hash = "sha256:64b2ff514a98cf2bb734a9f90d32dc89dc6ad4a4a36a312cd0d6327170339eb0"},
+ {file = "scipy-1.14.0-cp312-cp312-macosx_14_0_x86_64.whl", hash = "sha256:7d3da42fbbbb860211a811782504f38ae7aaec9de8764a9bef6b262de7a2b50f"},
+ {file = "scipy-1.14.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d91db2c41dd6c20646af280355d41dfa1ec7eead235642178bd57635a3f82209"},
+ {file = "scipy-1.14.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a01cc03bcdc777c9da3cfdcc74b5a75caffb48a6c39c8450a9a05f82c4250a14"},
+ {file = "scipy-1.14.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:65df4da3c12a2bb9ad52b86b4dcf46813e869afb006e58be0f516bc370165159"},
+ {file = "scipy-1.14.0-cp312-cp312-win_amd64.whl", hash = "sha256:4c4161597c75043f7154238ef419c29a64ac4a7c889d588ea77690ac4d0d9b20"},
+ {file = "scipy-1.14.0.tar.gz", hash = "sha256:b5923f48cb840380f9854339176ef21763118a7300a88203ccd0bdd26e58527b"},
+]
[package.dependencies]
-colorama = {version = "*", markers = "platform_system == \"Windows\""}
+numpy = ">=1.23.5,<2.3"
[package.extras]
-dev = ["pytest (>=6)", "pytest-cov", "pytest-timeout", "pytest-xdist"]
-notebook = ["ipywidgets (>=6)"]
-slack = ["slack-sdk"]
-telegram = ["requests"]
+dev = ["cython-lint (>=0.12.2)", "doit (>=0.36.0)", "mypy (==1.10.0)", "pycodestyle", "pydevtool", "rich-click", "ruff (>=0.0.292)", "types-psutil", "typing_extensions"]
+doc = ["jupyterlite-pyodide-kernel", "jupyterlite-sphinx (>=0.13.1)", "jupytext", "matplotlib (>=3.5)", "myst-nb", "numpydoc", "pooch", "pydata-sphinx-theme (>=0.15.2)", "sphinx (>=5.0.0)", "sphinx-design (>=0.4.0)"]
+test = ["Cython", "array-api-strict", "asv", "gmpy2", "hypothesis (>=6.30)", "meson", "mpmath", "ninja", "pooch", "pytest", "pytest-cov", "pytest-timeout", "pytest-xdist", "scikit-umfpack", "threadpoolctl"]
[[package]]
-name = "traitlets"
-version = "5.14.1"
-description = "Traitlets Python configuration system"
-category = "dev"
+name = "send2trash"
+version = "1.8.3"
+description = "Send file to trash natively under Mac OS X, Windows and Linux"
optional = false
-python-versions = ">=3.8"
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7"
+files = [
+ {file = "Send2Trash-1.8.3-py3-none-any.whl", hash = "sha256:0c31227e0bd08961c7665474a3d1ef7193929fedda4233843689baa056be46c9"},
+ {file = "Send2Trash-1.8.3.tar.gz", hash = "sha256:b18e7a3966d99871aefeb00cfbcfdced55ce4871194810fc71f4aa484b953abf"},
+]
[package.extras]
-docs = ["myst-parser", "pydata-sphinx-theme", "sphinx"]
-test = ["argcomplete (>=3.0.3)", "mypy (>=1.7.0)", "pre-commit", "pytest (>=7.0,<7.5)", "pytest-mock", "pytest-mypy-testing"]
+nativelib = ["pyobjc-framework-Cocoa", "pywin32"]
+objc = ["pyobjc-framework-Cocoa"]
+win32 = ["pywin32"]
[[package]]
-name = "types-dataclasses"
-version = "0.6.6"
-description = "Typing stubs for dataclasses"
-category = "dev"
+name = "setuptools"
+version = "70.1.1"
+description = "Easily download, build, install, upgrade, and uninstall Python packages"
optional = false
-python-versions = "*"
+python-versions = ">=3.8"
+files = [
+ {file = "setuptools-70.1.1-py3-none-any.whl", hash = "sha256:a58a8fde0541dab0419750bcc521fbdf8585f6e5cb41909df3a472ef7b81ca95"},
+ {file = "setuptools-70.1.1.tar.gz", hash = "sha256:937a48c7cdb7a21eb53cd7f9b59e525503aa8abaf3584c730dc5f7a5bec3a650"},
+]
+
+[package.extras]
+docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "pyproject-hooks (!=1.1)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier"]
+testing = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "importlib-metadata", "ini2toml[lite] (>=0.14)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "jaraco.test", "mypy (==1.10.0)", "packaging (>=23.2)", "pip (>=19.1)", "pyproject-hooks (!=1.1)", "pytest (>=6,!=8.1.1)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy", "pytest-perf", "pytest-ruff (>=0.3.2)", "pytest-subprocess", "pytest-timeout", "pytest-xdist (>=3)", "tomli", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"]
[[package]]
-name = "types-jsonschema"
-version = "4.21.0.20240118"
-description = "Typing stubs for jsonschema"
-category = "dev"
+name = "shapely"
+version = "2.0.4"
+description = "Manipulation and analysis of geometric objects"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.7"
+files = [
+ {file = "shapely-2.0.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:011b77153906030b795791f2fdfa2d68f1a8d7e40bce78b029782ade3afe4f2f"},
+ {file = "shapely-2.0.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:9831816a5d34d5170aa9ed32a64982c3d6f4332e7ecfe62dc97767e163cb0b17"},
+ {file = "shapely-2.0.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:5c4849916f71dc44e19ed370421518c0d86cf73b26e8656192fcfcda08218fbd"},
+ {file = "shapely-2.0.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:841f93a0e31e4c64d62ea570d81c35de0f6cea224568b2430d832967536308e6"},
+ {file = "shapely-2.0.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b4431f522b277c79c34b65da128029a9955e4481462cbf7ebec23aab61fc58"},
+ {file = "shapely-2.0.4-cp310-cp310-win32.whl", hash = "sha256:92a41d936f7d6743f343be265ace93b7c57f5b231e21b9605716f5a47c2879e7"},
+ {file = "shapely-2.0.4-cp310-cp310-win_amd64.whl", hash = "sha256:30982f79f21bb0ff7d7d4a4e531e3fcaa39b778584c2ce81a147f95be1cd58c9"},
+ {file = "shapely-2.0.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:de0205cb21ad5ddaef607cda9a3191eadd1e7a62a756ea3a356369675230ac35"},
+ {file = "shapely-2.0.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:7d56ce3e2a6a556b59a288771cf9d091470116867e578bebced8bfc4147fbfd7"},
+ {file = "shapely-2.0.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:58b0ecc505bbe49a99551eea3f2e8a9b3b24b3edd2a4de1ac0dc17bc75c9ec07"},
+ {file = "shapely-2.0.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:790a168a808bd00ee42786b8ba883307c0e3684ebb292e0e20009588c426da47"},
+ {file = "shapely-2.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4310b5494271e18580d61022c0857eb85d30510d88606fa3b8314790df7f367d"},
+ {file = "shapely-2.0.4-cp311-cp311-win32.whl", hash = "sha256:63f3a80daf4f867bd80f5c97fbe03314348ac1b3b70fb1c0ad255a69e3749879"},
+ {file = "shapely-2.0.4-cp311-cp311-win_amd64.whl", hash = "sha256:c52ed79f683f721b69a10fb9e3d940a468203f5054927215586c5d49a072de8d"},
+ {file = "shapely-2.0.4-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:5bbd974193e2cc274312da16b189b38f5f128410f3377721cadb76b1e8ca5328"},
+ {file = "shapely-2.0.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:41388321a73ba1a84edd90d86ecc8bfed55e6a1e51882eafb019f45895ec0f65"},
+ {file = "shapely-2.0.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0776c92d584f72f1e584d2e43cfc5542c2f3dd19d53f70df0900fda643f4bae6"},
+ {file = "shapely-2.0.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c75c98380b1ede1cae9a252c6dc247e6279403fae38c77060a5e6186c95073ac"},
+ {file = "shapely-2.0.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c3e700abf4a37b7b8b90532fa6ed5c38a9bfc777098bc9fbae5ec8e618ac8f30"},
+ {file = "shapely-2.0.4-cp312-cp312-win32.whl", hash = "sha256:4f2ab0faf8188b9f99e6a273b24b97662194160cc8ca17cf9d1fb6f18d7fb93f"},
+ {file = "shapely-2.0.4-cp312-cp312-win_amd64.whl", hash = "sha256:03152442d311a5e85ac73b39680dd64a9892fa42bb08fd83b3bab4fe6999bfa0"},
+ {file = "shapely-2.0.4-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:994c244e004bc3cfbea96257b883c90a86e8cbd76e069718eb4c6b222a56f78b"},
+ {file = "shapely-2.0.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:05ffd6491e9e8958b742b0e2e7c346635033d0a5f1a0ea083547fcc854e5d5cf"},
+ {file = "shapely-2.0.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2fbdc1140a7d08faa748256438291394967aa54b40009f54e8d9825e75ef6113"},
+ {file = "shapely-2.0.4-cp37-cp37m-win32.whl", hash = "sha256:5af4cd0d8cf2912bd95f33586600cac9c4b7c5053a036422b97cfe4728d2eb53"},
+ {file = "shapely-2.0.4-cp37-cp37m-win_amd64.whl", hash = "sha256:464157509ce4efa5ff285c646a38b49f8c5ef8d4b340f722685b09bb033c5ccf"},
+ {file = "shapely-2.0.4-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:489c19152ec1f0e5c5e525356bcbf7e532f311bff630c9b6bc2db6f04da6a8b9"},
+ {file = "shapely-2.0.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:b79bbd648664aa6f44ef018474ff958b6b296fed5c2d42db60078de3cffbc8aa"},
+ {file = "shapely-2.0.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:674d7baf0015a6037d5758496d550fc1946f34bfc89c1bf247cabdc415d7747e"},
+ {file = "shapely-2.0.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6cd4ccecc5ea5abd06deeaab52fcdba372f649728050c6143cc405ee0c166679"},
+ {file = "shapely-2.0.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fb5cdcbbe3080181498931b52a91a21a781a35dcb859da741c0345c6402bf00c"},
+ {file = "shapely-2.0.4-cp38-cp38-win32.whl", hash = "sha256:55a38dcd1cee2f298d8c2ebc60fc7d39f3b4535684a1e9e2f39a80ae88b0cea7"},
+ {file = "shapely-2.0.4-cp38-cp38-win_amd64.whl", hash = "sha256:ec555c9d0db12d7fd777ba3f8b75044c73e576c720a851667432fabb7057da6c"},
+ {file = "shapely-2.0.4-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:3f9103abd1678cb1b5f7e8e1af565a652e036844166c91ec031eeb25c5ca8af0"},
+ {file = "shapely-2.0.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:263bcf0c24d7a57c80991e64ab57cba7a3906e31d2e21b455f493d4aab534aaa"},
+ {file = "shapely-2.0.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ddf4a9bfaac643e62702ed662afc36f6abed2a88a21270e891038f9a19bc08fc"},
+ {file = "shapely-2.0.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:485246fcdb93336105c29a5cfbff8a226949db37b7473c89caa26c9bae52a242"},
+ {file = "shapely-2.0.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8de4578e838a9409b5b134a18ee820730e507b2d21700c14b71a2b0757396acc"},
+ {file = "shapely-2.0.4-cp39-cp39-win32.whl", hash = "sha256:9dab4c98acfb5fb85f5a20548b5c0abe9b163ad3525ee28822ffecb5c40e724c"},
+ {file = "shapely-2.0.4-cp39-cp39-win_amd64.whl", hash = "sha256:31c19a668b5a1eadab82ff070b5a260478ac6ddad3a5b62295095174a8d26398"},
+ {file = "shapely-2.0.4.tar.gz", hash = "sha256:5dc736127fac70009b8d309a0eeb74f3e08979e530cf7017f2f507ef62e6cfb8"},
+]
[package.dependencies]
-referencing = "*"
+numpy = ">=1.14,<3"
+
+[package.extras]
+docs = ["matplotlib", "numpydoc (==1.1.*)", "sphinx", "sphinx-book-theme", "sphinx-remove-toctrees"]
+test = ["pytest", "pytest-cov"]
[[package]]
-name = "types-tqdm"
-version = "4.66.0.20240106"
-description = "Typing stubs for tqdm"
-category = "dev"
+name = "six"
+version = "1.16.0"
+description = "Python 2 and 3 compatibility utilities"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*"
+files = [
+ {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
+ {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
+]
[[package]]
-name = "typing-extensions"
-version = "4.10.0"
-description = "Backported and Experimental Type Hints for Python 3.8+"
-category = "dev"
+name = "sniffio"
+version = "1.3.1"
+description = "Sniff out which async library your code is running under"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.7"
+files = [
+ {file = "sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2"},
+ {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"},
+]
[[package]]
-name = "tzdata"
-version = "2024.1"
-description = "Provider of IANA time zone data"
-category = "main"
+name = "snowballstemmer"
+version = "2.2.0"
+description = "This package provides 29 stemmers for 28 languages generated from Snowball algorithms."
optional = false
-python-versions = ">=2"
+python-versions = "*"
+files = [
+ {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"},
+ {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"},
+]
[[package]]
-name = "urllib3"
-version = "2.2.1"
-description = "HTTP library with thread-safe connection pooling, file post, and more."
-category = "dev"
+name = "sortedcontainers"
+version = "2.4.0"
+description = "Sorted Containers -- Sorted List, Sorted Dict, Sorted Set"
+optional = false
+python-versions = "*"
+files = [
+ {file = "sortedcontainers-2.4.0-py2.py3-none-any.whl", hash = "sha256:a163dcaede0f1c021485e957a39245190e74249897e2ae4b2aa38595db237ee0"},
+ {file = "sortedcontainers-2.4.0.tar.gz", hash = "sha256:25caa5a06cc30b6b83d11423433f65d1f9d76c4c6a0c90e3379eaa43b9bfdb88"},
+]
+
+[[package]]
+name = "soupsieve"
+version = "2.5"
+description = "A modern CSS selector implementation for Beautiful Soup."
optional = false
python-versions = ">=3.8"
+files = [
+ {file = "soupsieve-2.5-py3-none-any.whl", hash = "sha256:eaa337ff55a1579b6549dc679565eac1e3d000563bcb1c8ab0d0fefbc0c2cdc7"},
+ {file = "soupsieve-2.5.tar.gz", hash = "sha256:5663d5a7b3bfaeee0bc4372e7fc48f9cff4940b3eec54a6451cc5299f1097690"},
+]
+
+[[package]]
+name = "sphinx"
+version = "7.3.7"
+description = "Python documentation generator"
+optional = false
+python-versions = ">=3.9"
+files = [
+ {file = "sphinx-7.3.7-py3-none-any.whl", hash = "sha256:413f75440be4cacf328f580b4274ada4565fb2187d696a84970c23f77b64d8c3"},
+ {file = "sphinx-7.3.7.tar.gz", hash = "sha256:a4a7db75ed37531c05002d56ed6948d4c42f473a36f46e1382b0bd76ca9627bc"},
+]
+
+[package.dependencies]
+alabaster = ">=0.7.14,<0.8.0"
+babel = ">=2.9"
+colorama = {version = ">=0.4.5", markers = "sys_platform == \"win32\""}
+docutils = ">=0.18.1,<0.22"
+imagesize = ">=1.3"
+Jinja2 = ">=3.0"
+packaging = ">=21.0"
+Pygments = ">=2.14"
+requests = ">=2.25.0"
+snowballstemmer = ">=2.0"
+sphinxcontrib-applehelp = "*"
+sphinxcontrib-devhelp = "*"
+sphinxcontrib-htmlhelp = ">=2.0.0"
+sphinxcontrib-jsmath = "*"
+sphinxcontrib-qthelp = "*"
+sphinxcontrib-serializinghtml = ">=1.1.9"
+tomli = {version = ">=2", markers = "python_version < \"3.11\""}
[package.extras]
-brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"]
-h2 = ["h2 (>=4,<5)"]
-socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"]
-zstd = ["zstandard (>=0.18.0)"]
+docs = ["sphinxcontrib-websupport"]
+lint = ["flake8 (>=3.5.0)", "importlib_metadata", "mypy (==1.9.0)", "pytest (>=6.0)", "ruff (==0.3.7)", "sphinx-lint", "tomli", "types-docutils", "types-requests"]
+test = ["cython (>=3.0)", "defusedxml (>=0.7.1)", "pytest (>=6.0)", "setuptools (>=67.0)"]
[[package]]
-name = "virtualenv"
-version = "20.25.1"
-description = "Virtual Python Environment builder"
-category = "dev"
+name = "sphinx-design"
+version = "0.6.0"
+description = "A sphinx extension for designing beautiful, view size responsive web components."
optional = false
-python-versions = ">=3.7"
+python-versions = ">=3.9"
+files = [
+ {file = "sphinx_design-0.6.0-py3-none-any.whl", hash = "sha256:e9bd07eecec82eb07ff72cb50fc3624e186b04f5661270bc7b62db86c7546e95"},
+ {file = "sphinx_design-0.6.0.tar.gz", hash = "sha256:ec8e3c5c59fed4049b3a5a2e209360feab31829346b5f6a0c7c342b894082192"},
+]
[package.dependencies]
-distlib = ">=0.3.7,<1"
-filelock = ">=3.12.2,<4"
-platformdirs = ">=3.9.1,<5"
+sphinx = ">=5,<8"
[package.extras]
-docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
-test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"]
+code-style = ["pre-commit (>=3,<4)"]
+rtd = ["myst-parser (>=1,<3)"]
+testing = ["defusedxml", "myst-parser (>=1,<3)", "pytest (>=7.1,<8.0)", "pytest-cov", "pytest-regressions"]
+theme-furo = ["furo (>=2024.5.4,<2024.6.0)"]
+theme-im = ["sphinx-immaterial (>=0.11.11,<0.12.0)"]
+theme-pydata = ["pydata-sphinx-theme (>=0.15.2,<0.16.0)"]
+theme-rtd = ["sphinx-rtd-theme (>=2.0,<3.0)"]
+theme-sbt = ["sphinx-book-theme (>=1.1,<2.0)"]
[[package]]
-name = "wcwidth"
-version = "0.2.13"
-description = "Measures the displayed width of unicode strings in a terminal"
-category = "dev"
+name = "sphinx-external-toc"
+version = "1.0.1"
+description = "A sphinx extension that allows the site-map to be defined in a single YAML file."
optional = false
-python-versions = "*"
+python-versions = ">=3.9"
+files = [
+ {file = "sphinx_external_toc-1.0.1-py3-none-any.whl", hash = "sha256:d9e02d50731dee9697c1887e4f8b361e7b86d38241f0e66bd5a9f4096779646f"},
+ {file = "sphinx_external_toc-1.0.1.tar.gz", hash = "sha256:a7d2c63cc47ec688546443b28bc4ef466121827ef3dc7bb509de354bad4ea2e0"},
+]
+
+[package.dependencies]
+click = ">=7.1"
+pyyaml = "*"
+sphinx = ">=5"
+
+[package.extras]
+code-style = ["pre-commit (>=2.12)"]
+rtd = ["myst-parser (>=1.0.0)", "sphinx-book-theme (>=1.0.0)"]
+testing = ["coverage", "pytest (>=7.1)", "pytest-cov", "pytest-regressions"]
[[package]]
-name = "xarray"
-version = "2024.2.0"
-description = "N-D labeled arrays and datasets in Python"
-category = "main"
+name = "sphinx-rtd-theme"
+version = "2.0.0"
+description = "Read the Docs theme for Sphinx"
optional = false
-python-versions = ">=3.9"
+python-versions = ">=3.6"
+files = [
+ {file = "sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl", hash = "sha256:ec93d0856dc280cf3aee9a4c9807c60e027c7f7b461b77aeffed682e68f0e586"},
+ {file = "sphinx_rtd_theme-2.0.0.tar.gz", hash = "sha256:bd5d7b80622406762073a04ef8fadc5f9151261563d47027de09910ce03afe6b"},
+]
[package.dependencies]
-numpy = ">=1.23"
-packaging = ">=22"
-pandas = ">=1.5"
+docutils = "<0.21"
+sphinx = ">=5,<8"
+sphinxcontrib-jquery = ">=4,<5"
[package.extras]
-accel = ["bottleneck", "flox", "numbagg", "opt-einsum", "scipy"]
-complete = ["xarray[accel,dev,io,parallel,viz]"]
-dev = ["hypothesis", "pre-commit", "pytest", "pytest-cov", "pytest-env", "pytest-timeout", "pytest-xdist", "ruff", "xarray[complete]"]
-io = ["cftime", "fsspec", "h5netcdf", "netCDF4", "pooch", "pydap", "scipy", "zarr"]
-parallel = ["dask[complete]"]
-viz = ["matplotlib", "nc-time-axis", "seaborn"]
+dev = ["bump2version", "sphinxcontrib-httpdomain", "transifex-client", "wheel"]
[[package]]
-name = "zipp"
-version = "3.17.0"
-description = "Backport of pathlib-compatible object wrapper for zip files"
-category = "main"
+name = "sphinxcontrib-applehelp"
+version = "1.0.8"
+description = "sphinxcontrib-applehelp is a Sphinx extension which outputs Apple help books"
optional = false
-python-versions = ">=3.8"
+python-versions = ">=3.9"
+files = [
+ {file = "sphinxcontrib_applehelp-1.0.8-py3-none-any.whl", hash = "sha256:cb61eb0ec1b61f349e5cc36b2028e9e7ca765be05e49641c97241274753067b4"},
+ {file = "sphinxcontrib_applehelp-1.0.8.tar.gz", hash = "sha256:c40a4f96f3776c4393d933412053962fac2b84f4c99a7982ba42e09576a70619"},
+]
[package.extras]
-docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-lint"]
-testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy (>=0.9.1)", "pytest-ruff"]
+lint = ["docutils-stubs", "flake8", "mypy"]
+standalone = ["Sphinx (>=5)"]
+test = ["pytest"]
-[metadata]
-lock-version = "1.1"
-python-versions = ">=3.10,<3.12"
-content-hash = "ac929c98037c449a08757e7fa22a83f399b536e9fc307b294c8e9553d1f61577"
+[[package]]
+name = "sphinxcontrib-bibtex"
+version = "2.6.2"
+description = "Sphinx extension for BibTeX style citations."
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "sphinxcontrib-bibtex-2.6.2.tar.gz", hash = "sha256:f487af694336f28bfb7d6a17070953a7d264bec43000a2379724274f5f8d70ae"},
+ {file = "sphinxcontrib_bibtex-2.6.2-py3-none-any.whl", hash = "sha256:10d45ebbb19207c5665396c9446f8012a79b8a538cb729f895b5910ab2d0b2da"},
+]
-[metadata.files]
-alabaster = [
- {file = "alabaster-0.7.16-py3-none-any.whl", hash = "sha256:b46733c07dce03ae4e150330b975c75737fa60f0a7c591b6c8bf4928a28e2c92"},
- {file = "alabaster-0.7.16.tar.gz", hash = "sha256:75a8b99c28a5dad50dd7f8ccdd447a121ddb3892da9e53d1ca5cca3106d58d65"},
+[package.dependencies]
+docutils = ">=0.8,<0.18.dev0 || >=0.20.dev0"
+pybtex = ">=0.24"
+pybtex-docutils = ">=1.0.0"
+Sphinx = ">=3.5"
+
+[[package]]
+name = "sphinxcontrib-devhelp"
+version = "1.0.6"
+description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp documents"
+optional = false
+python-versions = ">=3.9"
+files = [
+ {file = "sphinxcontrib_devhelp-1.0.6-py3-none-any.whl", hash = "sha256:6485d09629944511c893fa11355bda18b742b83a2b181f9a009f7e500595c90f"},
+ {file = "sphinxcontrib_devhelp-1.0.6.tar.gz", hash = "sha256:9893fd3f90506bc4b97bdb977ceb8fbd823989f4316b28c3841ec128544372d3"},
]
-appnope = [
- {file = "appnope-0.1.4-py2.py3-none-any.whl", hash = "sha256:502575ee11cd7a28c0205f379b525beefebab9d161b7c964670864014ed7213c"},
- {file = "appnope-0.1.4.tar.gz", hash = "sha256:1de3860566df9caf38f01f86f65e0e13e379af54f9e4bee1e66b48f2efffd1ee"},
+
+[package.extras]
+lint = ["docutils-stubs", "flake8", "mypy"]
+standalone = ["Sphinx (>=5)"]
+test = ["pytest"]
+
+[[package]]
+name = "sphinxcontrib-htmlhelp"
+version = "2.0.5"
+description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files"
+optional = false
+python-versions = ">=3.9"
+files = [
+ {file = "sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl", hash = "sha256:393f04f112b4d2f53d93448d4bce35842f62b307ccdc549ec1585e950bc35e04"},
+ {file = "sphinxcontrib_htmlhelp-2.0.5.tar.gz", hash = "sha256:0dc87637d5de53dd5eec3a6a01753b1ccf99494bd756aafecd74b4fa9e729015"},
]
-asttokens = [
- {file = "asttokens-2.4.1-py2.py3-none-any.whl", hash = "sha256:051ed49c3dcae8913ea7cd08e46a606dba30b79993209636c4875bc1d637bc24"},
- {file = "asttokens-2.4.1.tar.gz", hash = "sha256:b03869718ba9a6eb027e134bfdf69f38a236d681c83c160d510768af11254ba0"},
+
+[package.extras]
+lint = ["docutils-stubs", "flake8", "mypy"]
+standalone = ["Sphinx (>=5)"]
+test = ["html5lib", "pytest"]
+
+[[package]]
+name = "sphinxcontrib-jquery"
+version = "4.1"
+description = "Extension to include jQuery on newer Sphinx releases"
+optional = false
+python-versions = ">=2.7"
+files = [
+ {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"},
+ {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"},
]
-attrs = [
- {file = "attrs-23.2.0-py3-none-any.whl", hash = "sha256:99b87a485a5820b23b879f04c2305b44b951b502fd64be915879d77a7e8fc6f1"},
- {file = "attrs-23.2.0.tar.gz", hash = "sha256:935dc3b529c262f6cf76e50877d35a4bd3c1de194fd41f47a2b7ae8f19971f30"},
-]
-autodocsumm = [
- {file = "autodocsumm-0.2.12-py3-none-any.whl", hash = "sha256:b842b53c686c07a4f174721ca4e729b027367703dbf42e2508863a3c6d6c049c"},
- {file = "autodocsumm-0.2.12.tar.gz", hash = "sha256:848fe8c38df433c6635489499b969cb47cc389ed3d7b6e75c8ccbc94d4b3bf9e"},
-]
-babel = [
- {file = "Babel-2.14.0-py3-none-any.whl", hash = "sha256:efb1a25b7118e67ce3a259bed20545c29cb68be8ad2c784c83689981b7a57287"},
- {file = "Babel-2.14.0.tar.gz", hash = "sha256:6919867db036398ba21eb5c7a0f6b28ab8cbc3ae7a73a44ebe34ae74a4e7d363"},
-]
-black = [
- {file = "black-22.12.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9eedd20838bd5d75b80c9f5487dbcb06836a43833a37846cf1d8c1cc01cef59d"},
- {file = "black-22.12.0-cp310-cp310-win_amd64.whl", hash = "sha256:159a46a4947f73387b4d83e87ea006dbb2337eab6c879620a3ba52699b1f4351"},
- {file = "black-22.12.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d30b212bffeb1e252b31dd269dfae69dd17e06d92b87ad26e23890f3efea366f"},
- {file = "black-22.12.0-cp311-cp311-win_amd64.whl", hash = "sha256:7412e75863aa5c5411886804678b7d083c7c28421210180d67dfd8cf1221e1f4"},
- {file = "black-22.12.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c116eed0efb9ff870ded8b62fe9f28dd61ef6e9ddd28d83d7d264a38417dcee2"},
- {file = "black-22.12.0-cp37-cp37m-win_amd64.whl", hash = "sha256:1f58cbe16dfe8c12b7434e50ff889fa479072096d79f0a7f25e4ab8e94cd8350"},
- {file = "black-22.12.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:77d86c9f3db9b1bf6761244bc0b3572a546f5fe37917a044e02f3166d5aafa7d"},
- {file = "black-22.12.0-cp38-cp38-win_amd64.whl", hash = "sha256:82d9fe8fee3401e02e79767016b4907820a7dc28d70d137eb397b92ef3cc5bfc"},
- {file = "black-22.12.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:101c69b23df9b44247bd88e1d7e90154336ac4992502d4197bdac35dd7ee3320"},
- {file = "black-22.12.0-cp39-cp39-win_amd64.whl", hash = "sha256:559c7a1ba9a006226f09e4916060982fd27334ae1998e7a38b3f33a37f7a2148"},
- {file = "black-22.12.0-py3-none-any.whl", hash = "sha256:436cc9167dd28040ad90d3b404aec22cedf24a6e4d7de221bec2730ec0c97bcf"},
- {file = "black-22.12.0.tar.gz", hash = "sha256:229351e5a18ca30f447bf724d007f890f97e13af070bb6ad4c0a441cd7596a2f"},
-]
-certifi = [
- {file = "certifi-2024.2.2-py3-none-any.whl", hash = "sha256:dc383c07b76109f368f6106eee2b593b04a011ea4d55f652c6ca24a754d1cdd1"},
- {file = "certifi-2024.2.2.tar.gz", hash = "sha256:0569859f95fc761b18b45ef421b1290a0f65f147e92a1e5eb3e635f9a5e4e66f"},
-]
-cffi = [
- {file = "cffi-1.16.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6b3d6606d369fc1da4fd8c357d026317fbb9c9b75d36dc16e90e84c26854b088"},
- {file = "cffi-1.16.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ac0f5edd2360eea2f1daa9e26a41db02dd4b0451b48f7c318e217ee092a213e9"},
- {file = "cffi-1.16.0-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7e61e3e4fa664a8588aa25c883eab612a188c725755afff6289454d6362b9673"},
- {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a72e8961a86d19bdb45851d8f1f08b041ea37d2bd8d4fd19903bc3083d80c896"},
- {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5b50bf3f55561dac5438f8e70bfcdfd74543fd60df5fa5f62d94e5867deca684"},
- {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7651c50c8c5ef7bdb41108b7b8c5a83013bfaa8a935590c5d74627c047a583c7"},
- {file = "cffi-1.16.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e4108df7fe9b707191e55f33efbcb2d81928e10cea45527879a4749cbe472614"},
- {file = "cffi-1.16.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:32c68ef735dbe5857c810328cb2481e24722a59a2003018885514d4c09af9743"},
- {file = "cffi-1.16.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:673739cb539f8cdaa07d92d02efa93c9ccf87e345b9a0b556e3ecc666718468d"},
- {file = "cffi-1.16.0-cp310-cp310-win32.whl", hash = "sha256:9f90389693731ff1f659e55c7d1640e2ec43ff725cc61b04b2f9c6d8d017df6a"},
- {file = "cffi-1.16.0-cp310-cp310-win_amd64.whl", hash = "sha256:e6024675e67af929088fda399b2094574609396b1decb609c55fa58b028a32a1"},
- {file = "cffi-1.16.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b84834d0cf97e7d27dd5b7f3aca7b6e9263c56308ab9dc8aae9784abb774d404"},
- {file = "cffi-1.16.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:1b8ebc27c014c59692bb2664c7d13ce7a6e9a629be20e54e7271fa696ff2b417"},
- {file = "cffi-1.16.0-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ee07e47c12890ef248766a6e55bd38ebfb2bb8edd4142d56db91b21ea68b7627"},
- {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d8a9d3ebe49f084ad71f9269834ceccbf398253c9fac910c4fd7053ff1386936"},
- {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e70f54f1796669ef691ca07d046cd81a29cb4deb1e5f942003f401c0c4a2695d"},
- {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5bf44d66cdf9e893637896c7faa22298baebcd18d1ddb6d2626a6e39793a1d56"},
- {file = "cffi-1.16.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7b78010e7b97fef4bee1e896df8a4bbb6712b7f05b7ef630f9d1da00f6444d2e"},
- {file = "cffi-1.16.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c6a164aa47843fb1b01e941d385aab7215563bb8816d80ff3a363a9f8448a8dc"},
- {file = "cffi-1.16.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e09f3ff613345df5e8c3667da1d918f9149bd623cd9070c983c013792a9a62eb"},
- {file = "cffi-1.16.0-cp311-cp311-win32.whl", hash = "sha256:2c56b361916f390cd758a57f2e16233eb4f64bcbeee88a4881ea90fca14dc6ab"},
- {file = "cffi-1.16.0-cp311-cp311-win_amd64.whl", hash = "sha256:db8e577c19c0fda0beb7e0d4e09e0ba74b1e4c092e0e40bfa12fe05b6f6d75ba"},
- {file = "cffi-1.16.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:fa3a0128b152627161ce47201262d3140edb5a5c3da88d73a1b790a959126956"},
- {file = "cffi-1.16.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:68e7c44931cc171c54ccb702482e9fc723192e88d25a0e133edd7aff8fcd1f6e"},
- {file = "cffi-1.16.0-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:abd808f9c129ba2beda4cfc53bde801e5bcf9d6e0f22f095e45327c038bfe68e"},
- {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:88e2b3c14bdb32e440be531ade29d3c50a1a59cd4e51b1dd8b0865c54ea5d2e2"},
- {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fcc8eb6d5902bb1cf6dc4f187ee3ea80a1eba0a89aba40a5cb20a5087d961357"},
- {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b7be2d771cdba2942e13215c4e340bfd76398e9227ad10402a8767ab1865d2e6"},
- {file = "cffi-1.16.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e715596e683d2ce000574bae5d07bd522c781a822866c20495e52520564f0969"},
- {file = "cffi-1.16.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2d92b25dbf6cae33f65005baf472d2c245c050b1ce709cc4588cdcdd5495b520"},
- {file = "cffi-1.16.0-cp312-cp312-win32.whl", hash = "sha256:b2ca4e77f9f47c55c194982e10f058db063937845bb2b7a86c84a6cfe0aefa8b"},
- {file = "cffi-1.16.0-cp312-cp312-win_amd64.whl", hash = "sha256:68678abf380b42ce21a5f2abde8efee05c114c2fdb2e9eef2efdb0257fba1235"},
- {file = "cffi-1.16.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:0c9ef6ff37e974b73c25eecc13952c55bceed9112be2d9d938ded8e856138bcc"},
- {file = "cffi-1.16.0-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a09582f178759ee8128d9270cd1344154fd473bb77d94ce0aeb2a93ebf0feaf0"},
- {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e760191dd42581e023a68b758769e2da259b5d52e3103c6060ddc02c9edb8d7b"},
- {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:80876338e19c951fdfed6198e70bc88f1c9758b94578d5a7c4c91a87af3cf31c"},
- {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a6a14b17d7e17fa0d207ac08642c8820f84f25ce17a442fd15e27ea18d67c59b"},
- {file = "cffi-1.16.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6602bc8dc6f3a9e02b6c22c4fc1e47aa50f8f8e6d3f78a5e16ac33ef5fefa324"},
- {file = "cffi-1.16.0-cp38-cp38-win32.whl", hash = "sha256:131fd094d1065b19540c3d72594260f118b231090295d8c34e19a7bbcf2e860a"},
- {file = "cffi-1.16.0-cp38-cp38-win_amd64.whl", hash = "sha256:31d13b0f99e0836b7ff893d37af07366ebc90b678b6664c955b54561fc36ef36"},
- {file = "cffi-1.16.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:582215a0e9adbe0e379761260553ba11c58943e4bbe9c36430c4ca6ac74b15ed"},
- {file = "cffi-1.16.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:b29ebffcf550f9da55bec9e02ad430c992a87e5f512cd63388abb76f1036d8d2"},
- {file = "cffi-1.16.0-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dc9b18bf40cc75f66f40a7379f6a9513244fe33c0e8aa72e2d56b0196a7ef872"},
- {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9cb4a35b3642fc5c005a6755a5d17c6c8b6bcb6981baf81cea8bfbc8903e8ba8"},
- {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b86851a328eedc692acf81fb05444bdf1891747c25af7529e39ddafaf68a4f3f"},
- {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c0f31130ebc2d37cdd8e44605fb5fa7ad59049298b3f745c74fa74c62fbfcfc4"},
- {file = "cffi-1.16.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8f8e709127c6c77446a8c0a8c8bf3c8ee706a06cd44b1e827c3e6a2ee6b8c098"},
- {file = "cffi-1.16.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:748dcd1e3d3d7cd5443ef03ce8685043294ad6bd7c02a38d1bd367cfd968e000"},
- {file = "cffi-1.16.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8895613bcc094d4a1b2dbe179d88d7fb4a15cee43c052e8885783fac397d91fe"},
- {file = "cffi-1.16.0-cp39-cp39-win32.whl", hash = "sha256:ed86a35631f7bfbb28e108dd96773b9d5a6ce4811cf6ea468bb6a359b256b1e4"},
- {file = "cffi-1.16.0-cp39-cp39-win_amd64.whl", hash = "sha256:3686dffb02459559c74dd3d81748269ffb0eb027c39a6fc99502de37d501faa8"},
- {file = "cffi-1.16.0.tar.gz", hash = "sha256:bcb3ef43e58665bbda2fb198698fcae6776483e0c4a631aa5647806c25e02cc0"},
-]
-cfgv = [
- {file = "cfgv-3.4.0-py2.py3-none-any.whl", hash = "sha256:b7265b1f29fd3316bfcd2b330d63d024f2bfd8bcb8b0272f8e19a504856c48f9"},
- {file = "cfgv-3.4.0.tar.gz", hash = "sha256:e52591d4c5f5dead8e0f673fb16db7949d2cfb3f7da4582893288f0ded8fe560"},
-]
-cftime = [
- {file = "cftime-1.6.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:b62d42546fa5c914dfea5b15a9aaed2087ea1211cc36d08c374502ef95892038"},
- {file = "cftime-1.6.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:eb6dd70b2ccabfe1a14b7fbb0bbdce0418e71697094373c0d573c880790fa291"},
- {file = "cftime-1.6.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f9878bfd8c1c3f24184ecbd528f739ba46ebaceaf1c8a24d348d7befb117a285"},
- {file = "cftime-1.6.3-cp310-cp310-win_amd64.whl", hash = "sha256:3cf6e216a4c06f9a628cdf8e9c9d5e8097fb3eb02dd087dd14ab3b18478a7271"},
- {file = "cftime-1.6.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:8d2c01456d9d7b46aa710a41d1c711a50d5ea259aff4a987d0e973d1093bc922"},
- {file = "cftime-1.6.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:80eb1170ce1639016f55760847f4aadd04b0312496c5bac2797e930914bba48d"},
- {file = "cftime-1.6.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d87dadd0824262bdd7493babd2a44447da0a22175ded8ae9e060a3aebec7c5d7"},
- {file = "cftime-1.6.3-cp311-cp311-win_amd64.whl", hash = "sha256:0a38eb9f5c733a23e1714bd3ef2762ed5acee34f127670f8fb4ad6464946f6b3"},
- {file = "cftime-1.6.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:2d113a01ab924445e61d65c26bbd95bc08e4a22878d3b947064bba056c884c4a"},
- {file = "cftime-1.6.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5f11685663a6af97418908060492a07663c16d42519c139ca03c2ffb1377fd25"},
- {file = "cftime-1.6.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a98abb1d46d118e52b0611ce668a0b714b407be26177ef0581ecf5e95f894725"},
- {file = "cftime-1.6.3-cp312-cp312-win_amd64.whl", hash = "sha256:4d6fbd5f41b322cfa7b0ac3aaadeceb4450100a164b5bccbbb9e7c5048489a88"},
- {file = "cftime-1.6.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:bedb577bc8b8f3f10f5336c0792e5dae88605781890f50f36b45bb46907968e8"},
- {file = "cftime-1.6.3-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:022dabf1610cdd04a693e730fa8f71d307059717f29dba921e7486e553412bb4"},
- {file = "cftime-1.6.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bbf782ab4ac0605bdec2b941952c897595613203942b7f8c2fccd17efa5147df"},
- {file = "cftime-1.6.3-cp38-cp38-win_amd64.whl", hash = "sha256:9eb177a02db7cd84aa6962278e4bd2d3106a545de82e6aacd9404f1e153661db"},
- {file = "cftime-1.6.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3b86be8c2f254147be4ba88f12099466dde457a4a3a21de6c69d52a7224c13ae"},
- {file = "cftime-1.6.3-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:523b9a6bf03f5e36407979e248381d0fcab2d225b915bbde77d00c6dde192b90"},
- {file = "cftime-1.6.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8a14d2c7d22fd2a6dfa6ad563283b6d6679f1df95e0ed8d14b8f284dad402887"},
- {file = "cftime-1.6.3-cp39-cp39-win_amd64.whl", hash = "sha256:d9b00c2844c7a1701d8ede5336b6321dfee256ceab81a34a1aff0483d56891a6"},
- {file = "cftime-1.6.3.tar.gz", hash = "sha256:d0a6b29f72a13f08e008b9becff247cc75c84acb213332ede18879c5b6aa4dfd"},
-]
-charset-normalizer = [
- {file = "charset-normalizer-3.3.2.tar.gz", hash = "sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-win32.whl", hash = "sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73"},
- {file = "charset_normalizer-3.3.2-cp310-cp310-win_amd64.whl", hash = "sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-win32.whl", hash = "sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab"},
- {file = "charset_normalizer-3.3.2-cp311-cp311-win_amd64.whl", hash = "sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-win32.whl", hash = "sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7"},
- {file = "charset_normalizer-3.3.2-cp312-cp312-win_amd64.whl", hash = "sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-win32.whl", hash = "sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4"},
- {file = "charset_normalizer-3.3.2-cp37-cp37m-win_amd64.whl", hash = "sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-win32.whl", hash = "sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25"},
- {file = "charset_normalizer-3.3.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-win32.whl", hash = "sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f"},
- {file = "charset_normalizer-3.3.2-cp39-cp39-win_amd64.whl", hash = "sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d"},
- {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"},
-]
-click = [
- {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"},
- {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"},
-]
-cloudpickle = [
- {file = "cloudpickle-3.0.0-py3-none-any.whl", hash = "sha256:246ee7d0c295602a036e86369c77fecda4ab17b506496730f2f576d9016fd9c7"},
- {file = "cloudpickle-3.0.0.tar.gz", hash = "sha256:996d9a482c6fb4f33c1a35335cf8afd065d2a56e973270364840712d9131a882"},
-]
-colorama = [
- {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
- {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
-]
-comm = [
- {file = "comm-0.2.1-py3-none-any.whl", hash = "sha256:87928485c0dfc0e7976fd89fc1e187023cf587e7c353e4a9b417555b44adf021"},
- {file = "comm-0.2.1.tar.gz", hash = "sha256:0bc91edae1344d39d3661dcbc36937181fdaddb304790458f8b044dbc064b89a"},
-]
-contourpy = [
- {file = "contourpy-1.2.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:0274c1cb63625972c0c007ab14dd9ba9e199c36ae1a231ce45d725cbcbfd10a8"},
- {file = "contourpy-1.2.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:ab459a1cbbf18e8698399c595a01f6dcc5c138220ca3ea9e7e6126232d102bb4"},
- {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fdd887f17c2f4572ce548461e4f96396681212d858cae7bd52ba3310bc6f00f"},
- {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5d16edfc3fc09968e09ddffada434b3bf989bf4911535e04eada58469873e28e"},
- {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1c203f617abc0dde5792beb586f827021069fb6d403d7f4d5c2b543d87edceb9"},
- {file = "contourpy-1.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b69303ceb2e4d4f146bf82fda78891ef7bcd80c41bf16bfca3d0d7eb545448aa"},
- {file = "contourpy-1.2.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:884c3f9d42d7218304bc74a8a7693d172685c84bd7ab2bab1ee567b769696df9"},
- {file = "contourpy-1.2.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:4a1b1208102be6e851f20066bf0e7a96b7d48a07c9b0cfe6d0d4545c2f6cadab"},
- {file = "contourpy-1.2.0-cp310-cp310-win32.whl", hash = "sha256:34b9071c040d6fe45d9826cbbe3727d20d83f1b6110d219b83eb0e2a01d79488"},
- {file = "contourpy-1.2.0-cp310-cp310-win_amd64.whl", hash = "sha256:bd2f1ae63998da104f16a8b788f685e55d65760cd1929518fd94cd682bf03e41"},
- {file = "contourpy-1.2.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:dd10c26b4eadae44783c45ad6655220426f971c61d9b239e6f7b16d5cdaaa727"},
- {file = "contourpy-1.2.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5c6b28956b7b232ae801406e529ad7b350d3f09a4fde958dfdf3c0520cdde0dd"},
- {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ebeac59e9e1eb4b84940d076d9f9a6cec0064e241818bcb6e32124cc5c3e377a"},
- {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:139d8d2e1c1dd52d78682f505e980f592ba53c9f73bd6be102233e358b401063"},
- {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1e9dc350fb4c58adc64df3e0703ab076f60aac06e67d48b3848c23647ae4310e"},
- {file = "contourpy-1.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:18fc2b4ed8e4a8fe849d18dce4bd3c7ea637758c6343a1f2bae1e9bd4c9f4686"},
- {file = "contourpy-1.2.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:16a7380e943a6d52472096cb7ad5264ecee36ed60888e2a3d3814991a0107286"},
- {file = "contourpy-1.2.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:8d8faf05be5ec8e02a4d86f616fc2a0322ff4a4ce26c0f09d9f7fb5330a35c95"},
- {file = "contourpy-1.2.0-cp311-cp311-win32.whl", hash = "sha256:67b7f17679fa62ec82b7e3e611c43a016b887bd64fb933b3ae8638583006c6d6"},
- {file = "contourpy-1.2.0-cp311-cp311-win_amd64.whl", hash = "sha256:99ad97258985328b4f207a5e777c1b44a83bfe7cf1f87b99f9c11d4ee477c4de"},
- {file = "contourpy-1.2.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:575bcaf957a25d1194903a10bc9f316c136c19f24e0985a2b9b5608bdf5dbfe0"},
- {file = "contourpy-1.2.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:9e6c93b5b2dbcedad20a2f18ec22cae47da0d705d454308063421a3b290d9ea4"},
- {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:464b423bc2a009088f19bdf1f232299e8b6917963e2b7e1d277da5041f33a779"},
- {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:68ce4788b7d93e47f84edd3f1f95acdcd142ae60bc0e5493bfd120683d2d4316"},
- {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3d7d1f8871998cdff5d2ff6a087e5e1780139abe2838e85b0b46b7ae6cc25399"},
- {file = "contourpy-1.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e739530c662a8d6d42c37c2ed52a6f0932c2d4a3e8c1f90692ad0ce1274abe0"},
- {file = "contourpy-1.2.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:247b9d16535acaa766d03037d8e8fb20866d054d3c7fbf6fd1f993f11fc60ca0"},
- {file = "contourpy-1.2.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:461e3ae84cd90b30f8d533f07d87c00379644205b1d33a5ea03381edc4b69431"},
- {file = "contourpy-1.2.0-cp312-cp312-win32.whl", hash = "sha256:1c2559d6cffc94890b0529ea7eeecc20d6fadc1539273aa27faf503eb4656d8f"},
- {file = "contourpy-1.2.0-cp312-cp312-win_amd64.whl", hash = "sha256:491b1917afdd8638a05b611a56d46587d5a632cabead889a5440f7c638bc6ed9"},
- {file = "contourpy-1.2.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5fd1810973a375ca0e097dee059c407913ba35723b111df75671a1976efa04bc"},
- {file = "contourpy-1.2.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:999c71939aad2780f003979b25ac5b8f2df651dac7b38fb8ce6c46ba5abe6ae9"},
- {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b7caf9b241464c404613512d5594a6e2ff0cc9cb5615c9475cc1d9b514218ae8"},
- {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:266270c6f6608340f6c9836a0fb9b367be61dde0c9a9a18d5ece97774105ff3e"},
- {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dbd50d0a0539ae2e96e537553aff6d02c10ed165ef40c65b0e27e744a0f10af8"},
- {file = "contourpy-1.2.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:11f8d2554e52f459918f7b8e6aa20ec2a3bce35ce95c1f0ef4ba36fbda306df5"},
- {file = "contourpy-1.2.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:ce96dd400486e80ac7d195b2d800b03e3e6a787e2a522bfb83755938465a819e"},
- {file = "contourpy-1.2.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:6d3364b999c62f539cd403f8123ae426da946e142312a514162adb2addd8d808"},
- {file = "contourpy-1.2.0-cp39-cp39-win32.whl", hash = "sha256:1c88dfb9e0c77612febebb6ac69d44a8d81e3dc60f993215425b62c1161353f4"},
- {file = "contourpy-1.2.0-cp39-cp39-win_amd64.whl", hash = "sha256:78e6ad33cf2e2e80c5dfaaa0beec3d61face0fb650557100ee36db808bfa6843"},
- {file = "contourpy-1.2.0-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:be16975d94c320432657ad2402f6760990cb640c161ae6da1363051805fa8108"},
- {file = "contourpy-1.2.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b95a225d4948b26a28c08307a60ac00fb8671b14f2047fc5476613252a129776"},
- {file = "contourpy-1.2.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:0d7e03c0f9a4f90dc18d4e77e9ef4ec7b7bbb437f7f675be8e530d65ae6ef956"},
- {file = "contourpy-1.2.0.tar.gz", hash = "sha256:171f311cb758de7da13fc53af221ae47a5877be5a0843a9fe150818c51ed276a"},
-]
-coverage = [
- {file = "coverage-7.4.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:8580b827d4746d47294c0e0b92854c85a92c2227927433998f0d3320ae8a71b6"},
- {file = "coverage-7.4.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:718187eeb9849fc6cc23e0d9b092bc2348821c5e1a901c9f8975df0bc785bfd4"},
- {file = "coverage-7.4.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:767b35c3a246bcb55b8044fd3a43b8cd553dd1f9f2c1eeb87a302b1f8daa0524"},
- {file = "coverage-7.4.3-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae7f19afe0cce50039e2c782bff379c7e347cba335429678450b8fe81c4ef96d"},
- {file = "coverage-7.4.3-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba3a8aaed13770e970b3df46980cb068d1c24af1a1968b7818b69af8c4347efb"},
- {file = "coverage-7.4.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:ee866acc0861caebb4f2ab79f0b94dbfbdbfadc19f82e6e9c93930f74e11d7a0"},
- {file = "coverage-7.4.3-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:506edb1dd49e13a2d4cac6a5173317b82a23c9d6e8df63efb4f0380de0fbccbc"},
- {file = "coverage-7.4.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fd6545d97c98a192c5ac995d21c894b581f1fd14cf389be90724d21808b657e2"},
- {file = "coverage-7.4.3-cp310-cp310-win32.whl", hash = "sha256:f6a09b360d67e589236a44f0c39218a8efba2593b6abdccc300a8862cffc2f94"},
- {file = "coverage-7.4.3-cp310-cp310-win_amd64.whl", hash = "sha256:18d90523ce7553dd0b7e23cbb28865db23cddfd683a38fb224115f7826de78d0"},
- {file = "coverage-7.4.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:cbbe5e739d45a52f3200a771c6d2c7acf89eb2524890a4a3aa1a7fa0695d2a47"},
- {file = "coverage-7.4.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:489763b2d037b164846ebac0cbd368b8a4ca56385c4090807ff9fad817de4113"},
- {file = "coverage-7.4.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:451f433ad901b3bb00184d83fd83d135fb682d780b38af7944c9faeecb1e0bfe"},
- {file = "coverage-7.4.3-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fcc66e222cf4c719fe7722a403888b1f5e1682d1679bd780e2b26c18bb648cdc"},
- {file = "coverage-7.4.3-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b3ec74cfef2d985e145baae90d9b1b32f85e1741b04cd967aaf9cfa84c1334f3"},
- {file = "coverage-7.4.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:abbbd8093c5229c72d4c2926afaee0e6e3140de69d5dcd918b2921f2f0c8baba"},
- {file = "coverage-7.4.3-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:35eb581efdacf7b7422af677b92170da4ef34500467381e805944a3201df2079"},
- {file = "coverage-7.4.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:8249b1c7334be8f8c3abcaaa996e1e4927b0e5a23b65f5bf6cfe3180d8ca7840"},
- {file = "coverage-7.4.3-cp311-cp311-win32.whl", hash = "sha256:cf30900aa1ba595312ae41978b95e256e419d8a823af79ce670835409fc02ad3"},
- {file = "coverage-7.4.3-cp311-cp311-win_amd64.whl", hash = "sha256:18c7320695c949de11a351742ee001849912fd57e62a706d83dfc1581897fa2e"},
- {file = "coverage-7.4.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b51bfc348925e92a9bd9b2e48dad13431b57011fd1038f08316e6bf1df107d10"},
- {file = "coverage-7.4.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d6cdecaedea1ea9e033d8adf6a0ab11107b49571bbb9737175444cea6eb72328"},
- {file = "coverage-7.4.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3b2eccb883368f9e972e216c7b4c7c06cabda925b5f06dde0650281cb7666a30"},
- {file = "coverage-7.4.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6c00cdc8fa4e50e1cc1f941a7f2e3e0f26cb2a1233c9696f26963ff58445bac7"},
- {file = "coverage-7.4.3-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b9a4a8dd3dcf4cbd3165737358e4d7dfbd9d59902ad11e3b15eebb6393b0446e"},
- {file = "coverage-7.4.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:062b0a75d9261e2f9c6d071753f7eef0fc9caf3a2c82d36d76667ba7b6470003"},
- {file = "coverage-7.4.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:ebe7c9e67a2d15fa97b77ea6571ce5e1e1f6b0db71d1d5e96f8d2bf134303c1d"},
- {file = "coverage-7.4.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:c0a120238dd71c68484f02562f6d446d736adcc6ca0993712289b102705a9a3a"},
- {file = "coverage-7.4.3-cp312-cp312-win32.whl", hash = "sha256:37389611ba54fd6d278fde86eb2c013c8e50232e38f5c68235d09d0a3f8aa352"},
- {file = "coverage-7.4.3-cp312-cp312-win_amd64.whl", hash = "sha256:d25b937a5d9ffa857d41be042b4238dd61db888533b53bc76dc082cb5a15e914"},
- {file = "coverage-7.4.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:28ca2098939eabab044ad68850aac8f8db6bf0b29bc7f2887d05889b17346454"},
- {file = "coverage-7.4.3-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:280459f0a03cecbe8800786cdc23067a8fc64c0bd51dc614008d9c36e1659d7e"},
- {file = "coverage-7.4.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6c0cdedd3500e0511eac1517bf560149764b7d8e65cb800d8bf1c63ebf39edd2"},
- {file = "coverage-7.4.3-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9a9babb9466fe1da12417a4aed923e90124a534736de6201794a3aea9d98484e"},
- {file = "coverage-7.4.3-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dec9de46a33cf2dd87a5254af095a409ea3bf952d85ad339751e7de6d962cde6"},
- {file = "coverage-7.4.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:16bae383a9cc5abab9bb05c10a3e5a52e0a788325dc9ba8499e821885928968c"},
- {file = "coverage-7.4.3-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:2c854ce44e1ee31bda4e318af1dbcfc929026d12c5ed030095ad98197eeeaed0"},
- {file = "coverage-7.4.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:ce8c50520f57ec57aa21a63ea4f325c7b657386b3f02ccaedeccf9ebe27686e1"},
- {file = "coverage-7.4.3-cp38-cp38-win32.whl", hash = "sha256:708a3369dcf055c00ddeeaa2b20f0dd1ce664eeabde6623e516c5228b753654f"},
- {file = "coverage-7.4.3-cp38-cp38-win_amd64.whl", hash = "sha256:1bf25fbca0c8d121a3e92a2a0555c7e5bc981aee5c3fdaf4bb7809f410f696b9"},
- {file = "coverage-7.4.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:3b253094dbe1b431d3a4ac2f053b6d7ede2664ac559705a704f621742e034f1f"},
- {file = "coverage-7.4.3-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:77fbfc5720cceac9c200054b9fab50cb2a7d79660609200ab83f5db96162d20c"},
- {file = "coverage-7.4.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6679060424faa9c11808598504c3ab472de4531c571ab2befa32f4971835788e"},
- {file = "coverage-7.4.3-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4af154d617c875b52651dd8dd17a31270c495082f3d55f6128e7629658d63765"},
- {file = "coverage-7.4.3-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8640f1fde5e1b8e3439fe482cdc2b0bb6c329f4bb161927c28d2e8879c6029ee"},
- {file = "coverage-7.4.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:69b9f6f66c0af29642e73a520b6fed25ff9fd69a25975ebe6acb297234eda501"},
- {file = "coverage-7.4.3-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:0842571634f39016a6c03e9d4aba502be652a6e4455fadb73cd3a3a49173e38f"},
- {file = "coverage-7.4.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:a78ed23b08e8ab524551f52953a8a05d61c3a760781762aac49f8de6eede8c45"},
- {file = "coverage-7.4.3-cp39-cp39-win32.whl", hash = "sha256:c0524de3ff096e15fcbfe8f056fdb4ea0bf497d584454f344d59fce069d3e6e9"},
- {file = "coverage-7.4.3-cp39-cp39-win_amd64.whl", hash = "sha256:0209a6369ccce576b43bb227dc8322d8ef9e323d089c6f3f26a597b09cb4d2aa"},
- {file = "coverage-7.4.3-pp38.pp39.pp310-none-any.whl", hash = "sha256:7cbde573904625509a3f37b6fecea974e363460b556a627c60dc2f47e2fffa51"},
- {file = "coverage-7.4.3.tar.gz", hash = "sha256:276f6077a5c61447a48d133ed13e759c09e62aff0dc84274a68dc18660104d52"},
-]
-cycler = [
- {file = "cycler-0.12.1-py3-none-any.whl", hash = "sha256:85cef7cff222d8644161529808465972e51340599459b8ac3ccbac5a854e0d30"},
- {file = "cycler-0.12.1.tar.gz", hash = "sha256:88bb128f02ba341da8ef447245a9e138fae777f6a23943da4540077d3601eb1c"},
-]
-dask = [
- {file = "dask-2023.12.1-py3-none-any.whl", hash = "sha256:55f316f32da9e68fe995e2c0dc460cb8888cd4a1af32096753788e8af45a8d10"},
- {file = "dask-2023.12.1.tar.gz", hash = "sha256:0ac3acd5bdbfacb5ad6401ac7663a1135955b3fa051a118e1b8a88e87b6b44a2"},
-]
-debugpy = [
- {file = "debugpy-1.8.1-cp310-cp310-macosx_11_0_x86_64.whl", hash = "sha256:3bda0f1e943d386cc7a0e71bfa59f4137909e2ed947fb3946c506e113000f741"},
- {file = "debugpy-1.8.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dda73bf69ea479c8577a0448f8c707691152e6c4de7f0c4dec5a4bc11dee516e"},
- {file = "debugpy-1.8.1-cp310-cp310-win32.whl", hash = "sha256:3a79c6f62adef994b2dbe9fc2cc9cc3864a23575b6e387339ab739873bea53d0"},
- {file = "debugpy-1.8.1-cp310-cp310-win_amd64.whl", hash = "sha256:7eb7bd2b56ea3bedb009616d9e2f64aab8fc7000d481faec3cd26c98a964bcdd"},
- {file = "debugpy-1.8.1-cp311-cp311-macosx_11_0_universal2.whl", hash = "sha256:016a9fcfc2c6b57f939673c874310d8581d51a0fe0858e7fac4e240c5eb743cb"},
- {file = "debugpy-1.8.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fd97ed11a4c7f6d042d320ce03d83b20c3fb40da892f994bc041bbc415d7a099"},
- {file = "debugpy-1.8.1-cp311-cp311-win32.whl", hash = "sha256:0de56aba8249c28a300bdb0672a9b94785074eb82eb672db66c8144fff673146"},
- {file = "debugpy-1.8.1-cp311-cp311-win_amd64.whl", hash = "sha256:1a9fe0829c2b854757b4fd0a338d93bc17249a3bf69ecf765c61d4c522bb92a8"},
- {file = "debugpy-1.8.1-cp312-cp312-macosx_11_0_universal2.whl", hash = "sha256:3ebb70ba1a6524d19fa7bb122f44b74170c447d5746a503e36adc244a20ac539"},
- {file = "debugpy-1.8.1-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a2e658a9630f27534e63922ebf655a6ab60c370f4d2fc5c02a5b19baf4410ace"},
- {file = "debugpy-1.8.1-cp312-cp312-win32.whl", hash = "sha256:caad2846e21188797a1f17fc09c31b84c7c3c23baf2516fed5b40b378515bbf0"},
- {file = "debugpy-1.8.1-cp312-cp312-win_amd64.whl", hash = "sha256:edcc9f58ec0fd121a25bc950d4578df47428d72e1a0d66c07403b04eb93bcf98"},
- {file = "debugpy-1.8.1-cp38-cp38-macosx_11_0_x86_64.whl", hash = "sha256:7a3afa222f6fd3d9dfecd52729bc2e12c93e22a7491405a0ecbf9e1d32d45b39"},
- {file = "debugpy-1.8.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d915a18f0597ef685e88bb35e5d7ab968964b7befefe1aaea1eb5b2640b586c7"},
- {file = "debugpy-1.8.1-cp38-cp38-win32.whl", hash = "sha256:92116039b5500633cc8d44ecc187abe2dfa9b90f7a82bbf81d079fcdd506bae9"},
- {file = "debugpy-1.8.1-cp38-cp38-win_amd64.whl", hash = "sha256:e38beb7992b5afd9d5244e96ad5fa9135e94993b0c551ceebf3fe1a5d9beb234"},
- {file = "debugpy-1.8.1-cp39-cp39-macosx_11_0_x86_64.whl", hash = "sha256:bfb20cb57486c8e4793d41996652e5a6a885b4d9175dd369045dad59eaacea42"},
- {file = "debugpy-1.8.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:efd3fdd3f67a7e576dd869c184c5dd71d9aaa36ded271939da352880c012e703"},
- {file = "debugpy-1.8.1-cp39-cp39-win32.whl", hash = "sha256:58911e8521ca0c785ac7a0539f1e77e0ce2df753f786188f382229278b4cdf23"},
- {file = "debugpy-1.8.1-cp39-cp39-win_amd64.whl", hash = "sha256:6df9aa9599eb05ca179fb0b810282255202a66835c6efb1d112d21ecb830ddd3"},
- {file = "debugpy-1.8.1-py2.py3-none-any.whl", hash = "sha256:28acbe2241222b87e255260c76741e1fbf04fdc3b6d094fcf57b6c6f75ce1242"},
- {file = "debugpy-1.8.1.zip", hash = "sha256:f696d6be15be87aef621917585f9bb94b1dc9e8aced570db1b8a6fc14e8f9b42"},
-]
-decorator = [
- {file = "decorator-5.1.1-py3-none-any.whl", hash = "sha256:b8c3f85900b9dc423225913c5aace94729fe1fa9763b38939a95226f02d37186"},
- {file = "decorator-5.1.1.tar.gz", hash = "sha256:637996211036b6385ef91435e4fae22989472f9d571faba8927ba8253acbc330"},
-]
-distlib = [
- {file = "distlib-0.3.8-py2.py3-none-any.whl", hash = "sha256:034db59a0b96f8ca18035f36290806a9a6e6bd9d1ff91e45a7f172eb17e51784"},
- {file = "distlib-0.3.8.tar.gz", hash = "sha256:1530ea13e350031b6312d8580ddb6b27a104275a31106523b8f123787f494f64"},
-]
-docutils = [
- {file = "docutils-0.18.1-py2.py3-none-any.whl", hash = "sha256:23010f129180089fbcd3bc08cfefccb3b890b0050e1ca00c867036e9d161b98c"},
- {file = "docutils-0.18.1.tar.gz", hash = "sha256:679987caf361a7539d76e584cbeddc311e3aee937877c87346f31debc63e9d06"},
-]
-dpath = [
- {file = "dpath-2.1.6-py3-none-any.whl", hash = "sha256:31407395b177ab63ef72e2f6ae268c15e938f2990a8ecf6510f5686c02b6db73"},
- {file = "dpath-2.1.6.tar.gz", hash = "sha256:f1e07c72e8605c6a9e80b64bc8f42714de08a789c7de417e49c3f87a19692e47"},
-]
-exceptiongroup = [
- {file = "exceptiongroup-1.2.0-py3-none-any.whl", hash = "sha256:4bfd3996ac73b41e9b9628b04e079f193850720ea5945fc96a08633c66912f14"},
- {file = "exceptiongroup-1.2.0.tar.gz", hash = "sha256:91f5c769735f051a4290d52edd0858999b57e5876e9f85937691bd4c9fa3ed68"},
-]
-executing = [
- {file = "executing-2.0.1-py2.py3-none-any.whl", hash = "sha256:eac49ca94516ccc753f9fb5ce82603156e590b27525a8bc32cce8ae302eb61bc"},
- {file = "executing-2.0.1.tar.gz", hash = "sha256:35afe2ce3affba8ee97f2d69927fa823b08b472b7b994e36a52a964b93d16147"},
-]
-fastjsonschema = [
- {file = "fastjsonschema-2.19.1-py3-none-any.whl", hash = "sha256:3672b47bc94178c9f23dbb654bf47440155d4db9df5f7bc47643315f9c405cd0"},
- {file = "fastjsonschema-2.19.1.tar.gz", hash = "sha256:e3126a94bdc4623d3de4485f8d468a12f02a67921315ddc87836d6e456dc789d"},
-]
-filelock = [
- {file = "filelock-3.13.1-py3-none-any.whl", hash = "sha256:57dbda9b35157b05fb3e58ee91448612eb674172fab98ee235ccb0b5bee19a1c"},
- {file = "filelock-3.13.1.tar.gz", hash = "sha256:521f5f56c50f8426f5e03ad3b281b490a87ef15bc6c526f168290f0c7148d44e"},
-]
-flake8 = [
- {file = "flake8-4.0.1-py2.py3-none-any.whl", hash = "sha256:479b1304f72536a55948cb40a32dce8bb0ffe3501e26eaf292c7e60eb5e0428d"},
- {file = "flake8-4.0.1.tar.gz", hash = "sha256:806e034dda44114815e23c16ef92f95c91e4c71100ff52813adf7132a6ad870d"},
-]
-flake8-docstrings = [
- {file = "flake8_docstrings-1.7.0-py2.py3-none-any.whl", hash = "sha256:51f2344026da083fc084166a9353f5082b01f72901df422f74b4d953ae88ac75"},
- {file = "flake8_docstrings-1.7.0.tar.gz", hash = "sha256:4c8cc748dc16e6869728699e5d0d685da9a10b0ea718e090b1ba088e67a941af"},
-]
-fonttools = [
- {file = "fonttools-4.49.0-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d970ecca0aac90d399e458f0b7a8a597e08f95de021f17785fb68e2dc0b99717"},
- {file = "fonttools-4.49.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:ac9a745b7609f489faa65e1dc842168c18530874a5f5b742ac3dd79e26bca8bc"},
- {file = "fonttools-4.49.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0ba0e00620ca28d4ca11fc700806fd69144b463aa3275e1b36e56c7c09915559"},
- {file = "fonttools-4.49.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cdee3ab220283057e7840d5fb768ad4c2ebe65bdba6f75d5d7bf47f4e0ed7d29"},
- {file = "fonttools-4.49.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:ce7033cb61f2bb65d8849658d3786188afd80f53dad8366a7232654804529532"},
- {file = "fonttools-4.49.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:07bc5ea02bb7bc3aa40a1eb0481ce20e8d9b9642a9536cde0218290dd6085828"},
- {file = "fonttools-4.49.0-cp310-cp310-win32.whl", hash = "sha256:86eef6aab7fd7c6c8545f3ebd00fd1d6729ca1f63b0cb4d621bccb7d1d1c852b"},
- {file = "fonttools-4.49.0-cp310-cp310-win_amd64.whl", hash = "sha256:1fac1b7eebfce75ea663e860e7c5b4a8831b858c17acd68263bc156125201abf"},
- {file = "fonttools-4.49.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:edc0cce355984bb3c1d1e89d6a661934d39586bb32191ebff98c600f8957c63e"},
- {file = "fonttools-4.49.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:83a0d9336de2cba86d886507dd6e0153df333ac787377325a39a2797ec529814"},
- {file = "fonttools-4.49.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:36c8865bdb5cfeec88f5028e7e592370a0657b676c6f1d84a2108e0564f90e22"},
- {file = "fonttools-4.49.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:33037d9e56e2562c710c8954d0f20d25b8386b397250d65581e544edc9d6b942"},
- {file = "fonttools-4.49.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:8fb022d799b96df3eaa27263e9eea306bd3d437cc9aa981820850281a02b6c9a"},
- {file = "fonttools-4.49.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:33c584c0ef7dc54f5dd4f84082eabd8d09d1871a3d8ca2986b0c0c98165f8e86"},
- {file = "fonttools-4.49.0-cp311-cp311-win32.whl", hash = "sha256:cbe61b158deb09cffdd8540dc4a948d6e8f4d5b4f3bf5cd7db09bd6a61fee64e"},
- {file = "fonttools-4.49.0-cp311-cp311-win_amd64.whl", hash = "sha256:fc11e5114f3f978d0cea7e9853627935b30d451742eeb4239a81a677bdee6bf6"},
- {file = "fonttools-4.49.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:d647a0e697e5daa98c87993726da8281c7233d9d4ffe410812a4896c7c57c075"},
- {file = "fonttools-4.49.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f3bbe672df03563d1f3a691ae531f2e31f84061724c319652039e5a70927167e"},
- {file = "fonttools-4.49.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bebd91041dda0d511b0d303180ed36e31f4f54b106b1259b69fade68413aa7ff"},
- {file = "fonttools-4.49.0-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4145f91531fd43c50f9eb893faa08399816bb0b13c425667c48475c9f3a2b9b5"},
- {file = "fonttools-4.49.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:ea329dafb9670ffbdf4dbc3b0e5c264104abcd8441d56de77f06967f032943cb"},
- {file = "fonttools-4.49.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:c076a9e548521ecc13d944b1d261ff3d7825048c338722a4bd126d22316087b7"},
- {file = "fonttools-4.49.0-cp312-cp312-win32.whl", hash = "sha256:b607ea1e96768d13be26d2b400d10d3ebd1456343eb5eaddd2f47d1c4bd00880"},
- {file = "fonttools-4.49.0-cp312-cp312-win_amd64.whl", hash = "sha256:a974c49a981e187381b9cc2c07c6b902d0079b88ff01aed34695ec5360767034"},
- {file = "fonttools-4.49.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:b85ec0bdd7bdaa5c1946398cbb541e90a6dfc51df76dfa88e0aaa41b335940cb"},
- {file = "fonttools-4.49.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:af20acbe198a8a790618ee42db192eb128afcdcc4e96d99993aca0b60d1faeb4"},
- {file = "fonttools-4.49.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4d418b1fee41a1d14931f7ab4b92dc0bc323b490e41d7a333eec82c9f1780c75"},
- {file = "fonttools-4.49.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b44a52b8e6244b6548851b03b2b377a9702b88ddc21dcaf56a15a0393d425cb9"},
- {file = "fonttools-4.49.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:7c7125068e04a70739dad11857a4d47626f2b0bd54de39e8622e89701836eabd"},
- {file = "fonttools-4.49.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:29e89d0e1a7f18bc30f197cfadcbef5a13d99806447c7e245f5667579a808036"},
- {file = "fonttools-4.49.0-cp38-cp38-win32.whl", hash = "sha256:9d95fa0d22bf4f12d2fb7b07a46070cdfc19ef5a7b1c98bc172bfab5bf0d6844"},
- {file = "fonttools-4.49.0-cp38-cp38-win_amd64.whl", hash = "sha256:768947008b4dc552d02772e5ebd49e71430a466e2373008ce905f953afea755a"},
- {file = "fonttools-4.49.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:08877e355d3dde1c11973bb58d4acad1981e6d1140711230a4bfb40b2b937ccc"},
- {file = "fonttools-4.49.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:fdb54b076f25d6b0f0298dc706acee5052de20c83530fa165b60d1f2e9cbe3cb"},
- {file = "fonttools-4.49.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0af65c720520710cc01c293f9c70bd69684365c6015cc3671db2b7d807fe51f2"},
- {file = "fonttools-4.49.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1f255ce8ed7556658f6d23f6afd22a6d9bbc3edb9b96c96682124dc487e1bf42"},
- {file = "fonttools-4.49.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:d00af0884c0e65f60dfaf9340e26658836b935052fdd0439952ae42e44fdd2be"},
- {file = "fonttools-4.49.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:263832fae27481d48dfafcc43174644b6706639661e242902ceb30553557e16c"},
- {file = "fonttools-4.49.0-cp39-cp39-win32.whl", hash = "sha256:0404faea044577a01bb82d47a8fa4bc7a54067fa7e324785dd65d200d6dd1133"},
- {file = "fonttools-4.49.0-cp39-cp39-win_amd64.whl", hash = "sha256:b050d362df50fc6e38ae3954d8c29bf2da52be384649ee8245fdb5186b620836"},
- {file = "fonttools-4.49.0-py3-none-any.whl", hash = "sha256:af281525e5dd7fa0b39fb1667b8d5ca0e2a9079967e14c4bfe90fd1cd13e0f18"},
- {file = "fonttools-4.49.0.tar.gz", hash = "sha256:ebf46e7f01b7af7861310417d7c49591a85d99146fc23a5ba82fdb28af156321"},
-]
-fsspec = [
- {file = "fsspec-2024.2.0-py3-none-any.whl", hash = "sha256:817f969556fa5916bc682e02ca2045f96ff7f586d45110fcb76022063ad2c7d8"},
- {file = "fsspec-2024.2.0.tar.gz", hash = "sha256:b6ad1a679f760dda52b1168c859d01b7b80648ea6f7f7c7f5a8a91dc3f3ecb84"},
-]
-greenlet = [
- {file = "greenlet-3.0.3-cp310-cp310-macosx_11_0_universal2.whl", hash = "sha256:9da2bd29ed9e4f15955dd1595ad7bc9320308a3b766ef7f837e23ad4b4aac31a"},
- {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d353cadd6083fdb056bb46ed07e4340b0869c305c8ca54ef9da3421acbdf6881"},
- {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dca1e2f3ca00b84a396bc1bce13dd21f680f035314d2379c4160c98153b2059b"},
- {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3ed7fb269f15dc662787f4119ec300ad0702fa1b19d2135a37c2c4de6fadfd4a"},
- {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:dd4f49ae60e10adbc94b45c0b5e6a179acc1736cf7a90160b404076ee283cf83"},
- {file = "greenlet-3.0.3-cp310-cp310-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:73a411ef564e0e097dbe7e866bb2dda0f027e072b04da387282b02c308807405"},
- {file = "greenlet-3.0.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:7f362975f2d179f9e26928c5b517524e89dd48530a0202570d55ad6ca5d8a56f"},
- {file = "greenlet-3.0.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:649dde7de1a5eceb258f9cb00bdf50e978c9db1b996964cd80703614c86495eb"},
- {file = "greenlet-3.0.3-cp310-cp310-win_amd64.whl", hash = "sha256:68834da854554926fbedd38c76e60c4a2e3198c6fbed520b106a8986445caaf9"},
- {file = "greenlet-3.0.3-cp311-cp311-macosx_11_0_universal2.whl", hash = "sha256:b1b5667cced97081bf57b8fa1d6bfca67814b0afd38208d52538316e9422fc61"},
- {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:52f59dd9c96ad2fc0d5724107444f76eb20aaccb675bf825df6435acb7703559"},
- {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:afaff6cf5200befd5cec055b07d1c0a5a06c040fe5ad148abcd11ba6ab9b114e"},
- {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fe754d231288e1e64323cfad462fcee8f0288654c10bdf4f603a39ed923bef33"},
- {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2797aa5aedac23af156bbb5a6aa2cd3427ada2972c828244eb7d1b9255846379"},
- {file = "greenlet-3.0.3-cp311-cp311-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b7f009caad047246ed379e1c4dbcb8b020f0a390667ea74d2387be2998f58a22"},
- {file = "greenlet-3.0.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:c5e1536de2aad7bf62e27baf79225d0d64360d4168cf2e6becb91baf1ed074f3"},
- {file = "greenlet-3.0.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:894393ce10ceac937e56ec00bb71c4c2f8209ad516e96033e4b3b1de270e200d"},
- {file = "greenlet-3.0.3-cp311-cp311-win_amd64.whl", hash = "sha256:1ea188d4f49089fc6fb283845ab18a2518d279c7cd9da1065d7a84e991748728"},
- {file = "greenlet-3.0.3-cp312-cp312-macosx_11_0_universal2.whl", hash = "sha256:70fb482fdf2c707765ab5f0b6655e9cfcf3780d8d87355a063547b41177599be"},
- {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d4d1ac74f5c0c0524e4a24335350edad7e5f03b9532da7ea4d3c54d527784f2e"},
- {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:149e94a2dd82d19838fe4b2259f1b6b9957d5ba1b25640d2380bea9c5df37676"},
- {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:15d79dd26056573940fcb8c7413d84118086f2ec1a8acdfa854631084393efcc"},
- {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:881b7db1ebff4ba09aaaeae6aa491daeb226c8150fc20e836ad00041bcb11230"},
- {file = "greenlet-3.0.3-cp312-cp312-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:fcd2469d6a2cf298f198f0487e0a5b1a47a42ca0fa4dfd1b6862c999f018ebbf"},
- {file = "greenlet-3.0.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:1f672519db1796ca0d8753f9e78ec02355e862d0998193038c7073045899f305"},
- {file = "greenlet-3.0.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:2516a9957eed41dd8f1ec0c604f1cdc86758b587d964668b5b196a9db5bfcde6"},
- {file = "greenlet-3.0.3-cp312-cp312-win_amd64.whl", hash = "sha256:bba5387a6975598857d86de9eac14210a49d554a77eb8261cc68b7d082f78ce2"},
- {file = "greenlet-3.0.3-cp37-cp37m-macosx_11_0_universal2.whl", hash = "sha256:5b51e85cb5ceda94e79d019ed36b35386e8c37d22f07d6a751cb659b180d5274"},
- {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:daf3cb43b7cf2ba96d614252ce1684c1bccee6b2183a01328c98d36fcd7d5cb0"},
- {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:99bf650dc5d69546e076f413a87481ee1d2d09aaaaaca058c9251b6d8c14783f"},
- {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2dd6e660effd852586b6a8478a1d244b8dc90ab5b1321751d2ea15deb49ed414"},
- {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e3391d1e16e2a5a1507d83e4a8b100f4ee626e8eca43cf2cadb543de69827c4c"},
- {file = "greenlet-3.0.3-cp37-cp37m-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:e1f145462f1fa6e4a4ae3c0f782e580ce44d57c8f2c7aae1b6fa88c0b2efdb41"},
- {file = "greenlet-3.0.3-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:1a7191e42732df52cb5f39d3527217e7ab73cae2cb3694d241e18f53d84ea9a7"},
- {file = "greenlet-3.0.3-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:0448abc479fab28b00cb472d278828b3ccca164531daab4e970a0458786055d6"},
- {file = "greenlet-3.0.3-cp37-cp37m-win32.whl", hash = "sha256:b542be2440edc2d48547b5923c408cbe0fc94afb9f18741faa6ae970dbcb9b6d"},
- {file = "greenlet-3.0.3-cp37-cp37m-win_amd64.whl", hash = "sha256:01bc7ea167cf943b4c802068e178bbf70ae2e8c080467070d01bfa02f337ee67"},
- {file = "greenlet-3.0.3-cp38-cp38-macosx_11_0_universal2.whl", hash = "sha256:1996cb9306c8595335bb157d133daf5cf9f693ef413e7673cb07e3e5871379ca"},
- {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3ddc0f794e6ad661e321caa8d2f0a55ce01213c74722587256fb6566049a8b04"},
- {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c9db1c18f0eaad2f804728c67d6c610778456e3e1cc4ab4bbd5eeb8e6053c6fc"},
- {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7170375bcc99f1a2fbd9c306f5be8764eaf3ac6b5cb968862cad4c7057756506"},
- {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6b66c9c1e7ccabad3a7d037b2bcb740122a7b17a53734b7d72a344ce39882a1b"},
- {file = "greenlet-3.0.3-cp38-cp38-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:098d86f528c855ead3479afe84b49242e174ed262456c342d70fc7f972bc13c4"},
- {file = "greenlet-3.0.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:81bb9c6d52e8321f09c3d165b2a78c680506d9af285bfccbad9fb7ad5a5da3e5"},
- {file = "greenlet-3.0.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:fd096eb7ffef17c456cfa587523c5f92321ae02427ff955bebe9e3c63bc9f0da"},
- {file = "greenlet-3.0.3-cp38-cp38-win32.whl", hash = "sha256:d46677c85c5ba00a9cb6f7a00b2bfa6f812192d2c9f7d9c4f6a55b60216712f3"},
- {file = "greenlet-3.0.3-cp38-cp38-win_amd64.whl", hash = "sha256:419b386f84949bf0e7c73e6032e3457b82a787c1ab4a0e43732898a761cc9dbf"},
- {file = "greenlet-3.0.3-cp39-cp39-macosx_11_0_universal2.whl", hash = "sha256:da70d4d51c8b306bb7a031d5cff6cc25ad253affe89b70352af5f1cb68e74b53"},
- {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:086152f8fbc5955df88382e8a75984e2bb1c892ad2e3c80a2508954e52295257"},
- {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d73a9fe764d77f87f8ec26a0c85144d6a951a6c438dfe50487df5595c6373eac"},
- {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b7dcbe92cc99f08c8dd11f930de4d99ef756c3591a5377d1d9cd7dd5e896da71"},
- {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1551a8195c0d4a68fac7a4325efac0d541b48def35feb49d803674ac32582f61"},
- {file = "greenlet-3.0.3-cp39-cp39-manylinux_2_24_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:64d7675ad83578e3fc149b617a444fab8efdafc9385471f868eb5ff83e446b8b"},
- {file = "greenlet-3.0.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:b37eef18ea55f2ffd8f00ff8fe7c8d3818abd3e25fb73fae2ca3b672e333a7a6"},
- {file = "greenlet-3.0.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:77457465d89b8263bca14759d7c1684df840b6811b2499838cc5b040a8b5b113"},
- {file = "greenlet-3.0.3-cp39-cp39-win32.whl", hash = "sha256:57e8974f23e47dac22b83436bdcf23080ade568ce77df33159e019d161ce1d1e"},
- {file = "greenlet-3.0.3-cp39-cp39-win_amd64.whl", hash = "sha256:c5ee858cfe08f34712f548c3c363e807e7186f03ad7a5039ebadb29e8c6be067"},
- {file = "greenlet-3.0.3.tar.gz", hash = "sha256:43374442353259554ce33599da8b692d5aa96f8976d567d4badf263371fbe491"},
-]
-hypothesis = [
- {file = "hypothesis-6.98.15-py3-none-any.whl", hash = "sha256:5b40fd81fce9e0b35f0a47e10eb41f375a6b9e8551d0e1084c83b8b0d0d1bb6b"},
- {file = "hypothesis-6.98.15.tar.gz", hash = "sha256:1e31210951511b24ce8b3b6e04d791c466385a30ac3af571bf2223954b025d77"},
-]
-identify = [
- {file = "identify-2.5.35-py2.py3-none-any.whl", hash = "sha256:c4de0081837b211594f8e877a6b4fad7ca32bbfc1a9307fdd61c28bfe923f13e"},
- {file = "identify-2.5.35.tar.gz", hash = "sha256:10a7ca245cfcd756a554a7288159f72ff105ad233c7c4b9c6f0f4d108f5f6791"},
-]
-idna = [
- {file = "idna-3.6-py3-none-any.whl", hash = "sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f"},
- {file = "idna-3.6.tar.gz", hash = "sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca"},
-]
-imagesize = [
- {file = "imagesize-1.4.1-py2.py3-none-any.whl", hash = "sha256:0d8d18d08f840c19d0ee7ca1fd82490fdc3729b7ac93f49870406ddde8ef8d8b"},
- {file = "imagesize-1.4.1.tar.gz", hash = "sha256:69150444affb9cb0d5cc5a92b3676f0b2fb7cd9ae39e947a5e11a36b4497cd4a"},
-]
-importlib-metadata = [
- {file = "importlib_metadata-7.0.1-py3-none-any.whl", hash = "sha256:4805911c3a4ec7c3966410053e9ec6a1fecd629117df5adee56dfc9432a1081e"},
- {file = "importlib_metadata-7.0.1.tar.gz", hash = "sha256:f238736bb06590ae52ac1fab06a3a9ef1d8dce2b7a35b5ab329371d6c8f5d2cc"},
-]
-iniconfig = [
- {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"},
- {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"},
-]
-ipykernel = [
- {file = "ipykernel-6.29.3-py3-none-any.whl", hash = "sha256:5aa086a4175b0229d4eca211e181fb473ea78ffd9869af36ba7694c947302a21"},
- {file = "ipykernel-6.29.3.tar.gz", hash = "sha256:e14c250d1f9ea3989490225cc1a542781b095a18a19447fcf2b5eaf7d0ac5bd2"},
-]
-ipython = [
- {file = "ipython-8.22.1-py3-none-any.whl", hash = "sha256:869335e8cded62ffb6fac8928e5287a05433d6462e3ebaac25f4216474dd6bc4"},
- {file = "ipython-8.22.1.tar.gz", hash = "sha256:39c6f9efc079fb19bfb0f17eee903978fe9a290b1b82d68196c641cecb76ea22"},
-]
-isort = [
- {file = "isort-5.13.2-py3-none-any.whl", hash = "sha256:8ca5e72a8d85860d5a3fa69b8745237f2939afe12dbf656afbcb47fe72d947a6"},
- {file = "isort-5.13.2.tar.gz", hash = "sha256:48fdfcb9face5d58a4f6dde2e72a1fb8dcaf8ab26f95ab49fab84c2ddefb0109"},
-]
-jedi = [
- {file = "jedi-0.19.1-py2.py3-none-any.whl", hash = "sha256:e983c654fe5c02867aef4cdfce5a2fbb4a50adc0af145f70504238f18ef5e7e0"},
- {file = "jedi-0.19.1.tar.gz", hash = "sha256:cf0496f3651bc65d7174ac1b7d043eff454892c708a87d1b683e57b569927ffd"},
-]
-jinja2 = [
- {file = "Jinja2-3.1.3-py3-none-any.whl", hash = "sha256:7d6d50dd97d52cbc355597bd845fabfbac3f551e1f99619e39a35ce8c370b5fa"},
- {file = "Jinja2-3.1.3.tar.gz", hash = "sha256:ac8bd6544d4bb2c9792bf3a159e80bba8fda7f07e81bc3aed565432d5925ba90"},
-]
-jsonschema = [
- {file = "jsonschema-4.21.1-py3-none-any.whl", hash = "sha256:7996507afae316306f9e2290407761157c6f78002dcf7419acb99822143d1c6f"},
- {file = "jsonschema-4.21.1.tar.gz", hash = "sha256:85727c00279f5fa6bedbe6238d2aa6403bedd8b4864ab11207d07df3cc1b2ee5"},
-]
-jsonschema-specifications = [
- {file = "jsonschema_specifications-2023.12.1-py3-none-any.whl", hash = "sha256:87e4fdf3a94858b8a2ba2778d9ba57d8a9cafca7c7489c46ba0d30a8bc6a9c3c"},
- {file = "jsonschema_specifications-2023.12.1.tar.gz", hash = "sha256:48a76787b3e70f5ed53f1160d2b81f586e4ca6d1548c5de7085d1682674764cc"},
-]
-jupyter-cache = [
- {file = "jupyter_cache-1.0.0-py3-none-any.whl", hash = "sha256:594b1c4e29b488b36547e12477645f489dbdc62cc939b2408df5679f79245078"},
- {file = "jupyter_cache-1.0.0.tar.gz", hash = "sha256:d0fa7d7533cd5798198d8889318269a8c1382ed3b22f622c09a9356521f48687"},
-]
-jupyter-client = [
- {file = "jupyter_client-8.6.0-py3-none-any.whl", hash = "sha256:909c474dbe62582ae62b758bca86d6518c85234bdee2d908c778db6d72f39d99"},
- {file = "jupyter_client-8.6.0.tar.gz", hash = "sha256:0642244bb83b4764ae60d07e010e15f0e2d275ec4e918a8f7b80fbbef3ca60c7"},
-]
-jupyter-core = [
- {file = "jupyter_core-5.7.1-py3-none-any.whl", hash = "sha256:c65c82126453a723a2804aa52409930434598fd9d35091d63dfb919d2b765bb7"},
- {file = "jupyter_core-5.7.1.tar.gz", hash = "sha256:de61a9d7fc71240f688b2fb5ab659fbb56979458dc66a71decd098e03c79e218"},
-]
-kiwisolver = [
- {file = "kiwisolver-1.4.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:05703cf211d585109fcd72207a31bb170a0f22144d68298dc5e61b3c946518af"},
- {file = "kiwisolver-1.4.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:146d14bebb7f1dc4d5fbf74f8a6cb15ac42baadee8912eb84ac0b3b2a3dc6ac3"},
- {file = "kiwisolver-1.4.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:6ef7afcd2d281494c0a9101d5c571970708ad911d028137cd558f02b851c08b4"},
- {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:9eaa8b117dc8337728e834b9c6e2611f10c79e38f65157c4c38e9400286f5cb1"},
- {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ec20916e7b4cbfb1f12380e46486ec4bcbaa91a9c448b97023fde0d5bbf9e4ff"},
- {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:39b42c68602539407884cf70d6a480a469b93b81b7701378ba5e2328660c847a"},
- {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:aa12042de0171fad672b6c59df69106d20d5596e4f87b5e8f76df757a7c399aa"},
- {file = "kiwisolver-1.4.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2a40773c71d7ccdd3798f6489aaac9eee213d566850a9533f8d26332d626b82c"},
- {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:19df6e621f6d8b4b9c4d45f40a66839294ff2bb235e64d2178f7522d9170ac5b"},
- {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:83d78376d0d4fd884e2c114d0621624b73d2aba4e2788182d286309ebdeed770"},
- {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:e391b1f0a8a5a10ab3b9bb6afcfd74f2175f24f8975fb87ecae700d1503cdee0"},
- {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:852542f9481f4a62dbb5dd99e8ab7aedfeb8fb6342349a181d4036877410f525"},
- {file = "kiwisolver-1.4.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:59edc41b24031bc25108e210c0def6f6c2191210492a972d585a06ff246bb79b"},
- {file = "kiwisolver-1.4.5-cp310-cp310-win32.whl", hash = "sha256:a6aa6315319a052b4ee378aa171959c898a6183f15c1e541821c5c59beaa0238"},
- {file = "kiwisolver-1.4.5-cp310-cp310-win_amd64.whl", hash = "sha256:d0ef46024e6a3d79c01ff13801cb19d0cad7fd859b15037aec74315540acc276"},
- {file = "kiwisolver-1.4.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:11863aa14a51fd6ec28688d76f1735f8f69ab1fabf388851a595d0721af042f5"},
- {file = "kiwisolver-1.4.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:8ab3919a9997ab7ef2fbbed0cc99bb28d3c13e6d4b1ad36e97e482558a91be90"},
- {file = "kiwisolver-1.4.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:fcc700eadbbccbf6bc1bcb9dbe0786b4b1cb91ca0dcda336eef5c2beed37b797"},
- {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:dfdd7c0b105af050eb3d64997809dc21da247cf44e63dc73ff0fd20b96be55a9"},
- {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:76c6a5964640638cdeaa0c359382e5703e9293030fe730018ca06bc2010c4437"},
- {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bbea0db94288e29afcc4c28afbf3a7ccaf2d7e027489c449cf7e8f83c6346eb9"},
- {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ceec1a6bc6cab1d6ff5d06592a91a692f90ec7505d6463a88a52cc0eb58545da"},
- {file = "kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:040c1aebeda72197ef477a906782b5ab0d387642e93bda547336b8957c61022e"},
- {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:f91de7223d4c7b793867797bacd1ee53bfe7359bd70d27b7b58a04efbb9436c8"},
- {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:faae4860798c31530dd184046a900e652c95513796ef51a12bc086710c2eec4d"},
- {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:b0157420efcb803e71d1b28e2c287518b8808b7cf1ab8af36718fd0a2c453eb0"},
- {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:06f54715b7737c2fecdbf140d1afb11a33d59508a47bf11bb38ecf21dc9ab79f"},
- {file = "kiwisolver-1.4.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:fdb7adb641a0d13bdcd4ef48e062363d8a9ad4a182ac7647ec88f695e719ae9f"},
- {file = "kiwisolver-1.4.5-cp311-cp311-win32.whl", hash = "sha256:bb86433b1cfe686da83ce32a9d3a8dd308e85c76b60896d58f082136f10bffac"},
- {file = "kiwisolver-1.4.5-cp311-cp311-win_amd64.whl", hash = "sha256:6c08e1312a9cf1074d17b17728d3dfce2a5125b2d791527f33ffbe805200a355"},
- {file = "kiwisolver-1.4.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:32d5cf40c4f7c7b3ca500f8985eb3fb3a7dfc023215e876f207956b5ea26632a"},
- {file = "kiwisolver-1.4.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:f846c260f483d1fd217fe5ed7c173fb109efa6b1fc8381c8b7552c5781756192"},
- {file = "kiwisolver-1.4.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5ff5cf3571589b6d13bfbfd6bcd7a3f659e42f96b5fd1c4830c4cf21d4f5ef45"},
- {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7269d9e5f1084a653d575c7ec012ff57f0c042258bf5db0954bf551c158466e7"},
- {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:da802a19d6e15dffe4b0c24b38b3af68e6c1a68e6e1d8f30148c83864f3881db"},
- {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3aba7311af82e335dd1e36ffff68aaca609ca6290c2cb6d821a39aa075d8e3ff"},
- {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:763773d53f07244148ccac5b084da5adb90bfaee39c197554f01b286cf869228"},
- {file = "kiwisolver-1.4.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2270953c0d8cdab5d422bee7d2007f043473f9d2999631c86a223c9db56cbd16"},
- {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d099e745a512f7e3bbe7249ca835f4d357c586d78d79ae8f1dcd4d8adeb9bda9"},
- {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:74db36e14a7d1ce0986fa104f7d5637aea5c82ca6326ed0ec5694280942d1162"},
- {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:7e5bab140c309cb3a6ce373a9e71eb7e4873c70c2dda01df6820474f9889d6d4"},
- {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:0f114aa76dc1b8f636d077979c0ac22e7cd8f3493abbab152f20eb8d3cda71f3"},
- {file = "kiwisolver-1.4.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:88a2df29d4724b9237fc0c6eaf2a1adae0cdc0b3e9f4d8e7dc54b16812d2d81a"},
- {file = "kiwisolver-1.4.5-cp312-cp312-win32.whl", hash = "sha256:72d40b33e834371fd330fb1472ca19d9b8327acb79a5821d4008391db8e29f20"},
- {file = "kiwisolver-1.4.5-cp312-cp312-win_amd64.whl", hash = "sha256:2c5674c4e74d939b9d91dda0fae10597ac7521768fec9e399c70a1f27e2ea2d9"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:3a2b053a0ab7a3960c98725cfb0bf5b48ba82f64ec95fe06f1d06c99b552e130"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3cd32d6c13807e5c66a7cbb79f90b553642f296ae4518a60d8d76243b0ad2898"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:59ec7b7c7e1a61061850d53aaf8e93db63dce0c936db1fda2658b70e4a1be709"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:da4cfb373035def307905d05041c1d06d8936452fe89d464743ae7fb8371078b"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2400873bccc260b6ae184b2b8a4fec0e4082d30648eadb7c3d9a13405d861e89"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:1b04139c4236a0f3aff534479b58f6f849a8b351e1314826c2d230849ed48985"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:4e66e81a5779b65ac21764c295087de82235597a2293d18d943f8e9e32746265"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:7931d8f1f67c4be9ba1dd9c451fb0eeca1a25b89e4d3f89e828fe12a519b782a"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:b3f7e75f3015df442238cca659f8baa5f42ce2a8582727981cbfa15fee0ee205"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:bbf1d63eef84b2e8c89011b7f2235b1e0bf7dacc11cac9431fc6468e99ac77fb"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:4c380469bd3f970ef677bf2bcba2b6b0b4d5c75e7a020fb863ef75084efad66f"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-win32.whl", hash = "sha256:9408acf3270c4b6baad483865191e3e582b638b1654a007c62e3efe96f09a9a3"},
- {file = "kiwisolver-1.4.5-cp37-cp37m-win_amd64.whl", hash = "sha256:5b94529f9b2591b7af5f3e0e730a4e0a41ea174af35a4fd067775f9bdfeee01a"},
- {file = "kiwisolver-1.4.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:11c7de8f692fc99816e8ac50d1d1aef4f75126eefc33ac79aac02c099fd3db71"},
- {file = "kiwisolver-1.4.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:53abb58632235cd154176ced1ae8f0d29a6657aa1aa9decf50b899b755bc2b93"},
- {file = "kiwisolver-1.4.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:88b9f257ca61b838b6f8094a62418421f87ac2a1069f7e896c36a7d86b5d4c29"},
- {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3195782b26fc03aa9c6913d5bad5aeb864bdc372924c093b0f1cebad603dd712"},
- {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:fc579bf0f502e54926519451b920e875f433aceb4624a3646b3252b5caa9e0b6"},
- {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5a580c91d686376f0f7c295357595c5a026e6cbc3d77b7c36e290201e7c11ecb"},
- {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:cfe6ab8da05c01ba6fbea630377b5da2cd9bcbc6338510116b01c1bc939a2c18"},
- {file = "kiwisolver-1.4.5-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:d2e5a98f0ec99beb3c10e13b387f8db39106d53993f498b295f0c914328b1333"},
- {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:a51a263952b1429e429ff236d2f5a21c5125437861baeed77f5e1cc2d2c7c6da"},
- {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:3edd2fa14e68c9be82c5b16689e8d63d89fe927e56debd6e1dbce7a26a17f81b"},
- {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:74d1b44c6cfc897df648cc9fdaa09bc3e7679926e6f96df05775d4fb3946571c"},
- {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:76d9289ed3f7501012e05abb8358bbb129149dbd173f1f57a1bf1c22d19ab7cc"},
- {file = "kiwisolver-1.4.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:92dea1ffe3714fa8eb6a314d2b3c773208d865a0e0d35e713ec54eea08a66250"},
- {file = "kiwisolver-1.4.5-cp38-cp38-win32.whl", hash = "sha256:5c90ae8c8d32e472be041e76f9d2f2dbff4d0b0be8bd4041770eddb18cf49a4e"},
- {file = "kiwisolver-1.4.5-cp38-cp38-win_amd64.whl", hash = "sha256:c7940c1dc63eb37a67721b10d703247552416f719c4188c54e04334321351ced"},
- {file = "kiwisolver-1.4.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:9407b6a5f0d675e8a827ad8742e1d6b49d9c1a1da5d952a67d50ef5f4170b18d"},
- {file = "kiwisolver-1.4.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:15568384086b6df3c65353820a4473575dbad192e35010f622c6ce3eebd57af9"},
- {file = "kiwisolver-1.4.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:0dc9db8e79f0036e8173c466d21ef18e1befc02de8bf8aa8dc0813a6dc8a7046"},
- {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:cdc8a402aaee9a798b50d8b827d7ecf75edc5fb35ea0f91f213ff927c15f4ff0"},
- {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:6c3bd3cde54cafb87d74d8db50b909705c62b17c2099b8f2e25b461882e544ff"},
- {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:955e8513d07a283056b1396e9a57ceddbd272d9252c14f154d450d227606eb54"},
- {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:346f5343b9e3f00b8db8ba359350eb124b98c99efd0b408728ac6ebf38173958"},
- {file = "kiwisolver-1.4.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b9098e0049e88c6a24ff64545cdfc50807818ba6c1b739cae221bbbcbc58aad3"},
- {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:00bd361b903dc4bbf4eb165f24d1acbee754fce22ded24c3d56eec268658a5cf"},
- {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7b8b454bac16428b22560d0a1cf0a09875339cab69df61d7805bf48919415901"},
- {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:f1d072c2eb0ad60d4c183f3fb44ac6f73fb7a8f16a2694a91f988275cbf352f9"},
- {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:31a82d498054cac9f6d0b53d02bb85811185bcb477d4b60144f915f3b3126342"},
- {file = "kiwisolver-1.4.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:6512cb89e334e4700febbffaaa52761b65b4f5a3cf33f960213d5656cea36a77"},
- {file = "kiwisolver-1.4.5-cp39-cp39-win32.whl", hash = "sha256:9db8ea4c388fdb0f780fe91346fd438657ea602d58348753d9fb265ce1bca67f"},
- {file = "kiwisolver-1.4.5-cp39-cp39-win_amd64.whl", hash = "sha256:59415f46a37f7f2efeec758353dd2eae1b07640d8ca0f0c42548ec4125492635"},
- {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:5c7b3b3a728dc6faf3fc372ef24f21d1e3cee2ac3e9596691d746e5a536de920"},
- {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:620ced262a86244e2be10a676b646f29c34537d0d9cc8eb26c08f53d98013390"},
- {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:378a214a1e3bbf5ac4a8708304318b4f890da88c9e6a07699c4ae7174c09a68d"},
- {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:aaf7be1207676ac608a50cd08f102f6742dbfc70e8d60c4db1c6897f62f71523"},
- {file = "kiwisolver-1.4.5-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:ba55dce0a9b8ff59495ddd050a0225d58bd0983d09f87cfe2b6aec4f2c1234e4"},
- {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:fd32ea360bcbb92d28933fc05ed09bffcb1704ba3fc7942e81db0fd4f81a7892"},
- {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:5e7139af55d1688f8b960ee9ad5adafc4ac17c1c473fe07133ac092310d76544"},
- {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:dced8146011d2bc2e883f9bd68618b8247387f4bbec46d7392b3c3b032640126"},
- {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c9bf3325c47b11b2e51bca0824ea217c7cd84491d8ac4eefd1e409705ef092bd"},
- {file = "kiwisolver-1.4.5-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:5794cf59533bc3f1b1c821f7206a3617999db9fbefc345360aafe2e067514929"},
- {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:e368f200bbc2e4f905b8e71eb38b3c04333bddaa6a2464a6355487b02bb7fb09"},
- {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e5d706eba36b4c4d5bc6c6377bb6568098765e990cfc21ee16d13963fab7b3e7"},
- {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85267bd1aa8880a9c88a8cb71e18d3d64d2751a790e6ca6c27b8ccc724bcd5ad"},
- {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:210ef2c3a1f03272649aff1ef992df2e724748918c4bc2d5a90352849eb40bea"},
- {file = "kiwisolver-1.4.5-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:11d011a7574eb3b82bcc9c1a1d35c1d7075677fdd15de527d91b46bd35e935ee"},
- {file = "kiwisolver-1.4.5.tar.gz", hash = "sha256:e57e563a57fb22a142da34f38acc2fc1a5c864bc29ca1517a88abc963e60d6ec"},
-]
-latexcodec = [
- {file = "latexcodec-2.0.1-py2.py3-none-any.whl", hash = "sha256:c277a193638dc7683c4c30f6684e3db728a06efb0dc9cf346db8bd0aa6c5d271"},
- {file = "latexcodec-2.0.1.tar.gz", hash = "sha256:2aa2551c373261cefe2ad3a8953a6d6533e68238d180eb4bb91d7964adb3fe9a"},
-]
-locket = [
- {file = "locket-1.0.0-py2.py3-none-any.whl", hash = "sha256:b6c819a722f7b6bd955b80781788e4a66a55628b858d347536b7e81325a3a5e3"},
- {file = "locket-1.0.0.tar.gz", hash = "sha256:5c0d4c052a8bbbf750e056a8e65ccd309086f4f0f18a2eac306a8dfa4112a632"},
-]
-markdown-it-py = [
- {file = "markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb"},
- {file = "markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1"},
-]
-markupsafe = [
- {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a17a92de5231666cfbe003f0e4b9b3a7ae3afb1ec2845aadc2bacc93ff85febc"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:72b6be590cc35924b02c78ef34b467da4ba07e4e0f0454a2c5907f473fc50ce5"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e61659ba32cf2cf1481e575d0462554625196a1f2fc06a1c777d3f48e8865d46"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2174c595a0d73a3080ca3257b40096db99799265e1c27cc5a610743acd86d62f"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ae2ad8ae6ebee9d2d94b17fb62763125f3f374c25618198f40cbb8b525411900"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:075202fa5b72c86ad32dc7d0b56024ebdbcf2048c0ba09f1cde31bfdd57bcfff"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:598e3276b64aff0e7b3451b72e94fa3c238d452e7ddcd893c3ab324717456bad"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:fce659a462a1be54d2ffcacea5e3ba2d74daa74f30f5f143fe0c58636e355fdd"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-win32.whl", hash = "sha256:d9fad5155d72433c921b782e58892377c44bd6252b5af2f67f16b194987338a4"},
- {file = "MarkupSafe-2.1.5-cp310-cp310-win_amd64.whl", hash = "sha256:bf50cd79a75d181c9181df03572cdce0fbb75cc353bc350712073108cba98de5"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:629ddd2ca402ae6dbedfceeba9c46d5f7b2a61d9749597d4307f943ef198fc1f"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5b7b716f97b52c5a14bffdf688f971b2d5ef4029127f1ad7a513973cfd818df2"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6ec585f69cec0aa07d945b20805be741395e28ac1627333b1c5b0105962ffced"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b91c037585eba9095565a3556f611e3cbfaa42ca1e865f7b8015fe5c7336d5a5"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7502934a33b54030eaf1194c21c692a534196063db72176b0c4028e140f8f32c"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:0e397ac966fdf721b2c528cf028494e86172b4feba51d65f81ffd65c63798f3f"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:c061bb86a71b42465156a3ee7bd58c8c2ceacdbeb95d05a99893e08b8467359a"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3a57fdd7ce31c7ff06cdfbf31dafa96cc533c21e443d57f5b1ecc6cdc668ec7f"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-win32.whl", hash = "sha256:397081c1a0bfb5124355710fe79478cdbeb39626492b15d399526ae53422b906"},
- {file = "MarkupSafe-2.1.5-cp311-cp311-win_amd64.whl", hash = "sha256:2b7c57a4dfc4f16f7142221afe5ba4e093e09e728ca65c51f5620c9aaeb9a617"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:8dec4936e9c3100156f8a2dc89c4b88d5c435175ff03413b443469c7c8c5f4d1"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3c6b973f22eb18a789b1460b4b91bf04ae3f0c4234a0a6aa6b0a92f6f7b951d4"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac07bad82163452a6884fe8fa0963fb98c2346ba78d779ec06bd7a6262132aee"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f5dfb42c4604dddc8e4305050aa6deb084540643ed5804d7455b5df8fe16f5e5"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ea3d8a3d18833cf4304cd2fc9cbb1efe188ca9b5efef2bdac7adc20594a0e46b"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:d050b3361367a06d752db6ead6e7edeb0009be66bc3bae0ee9d97fb326badc2a"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:bec0a414d016ac1a18862a519e54b2fd0fc8bbfd6890376898a6c0891dd82e9f"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:58c98fee265677f63a4385256a6d7683ab1832f3ddd1e66fe948d5880c21a169"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-win32.whl", hash = "sha256:8590b4ae07a35970728874632fed7bd57b26b0102df2d2b233b6d9d82f6c62ad"},
- {file = "MarkupSafe-2.1.5-cp312-cp312-win_amd64.whl", hash = "sha256:823b65d8706e32ad2df51ed89496147a42a2a6e01c13cfb6ffb8b1e92bc910bb"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c8b29db45f8fe46ad280a7294f5c3ec36dbac9491f2d1c17345be8e69cc5928f"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ec6a563cff360b50eed26f13adc43e61bc0c04d94b8be985e6fb24b81f6dcfdf"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a549b9c31bec33820e885335b451286e2969a2d9e24879f83fe904a5ce59d70a"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4f11aa001c540f62c6166c7726f71f7573b52c68c31f014c25cc7901deea0b52"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:7b2e5a267c855eea6b4283940daa6e88a285f5f2a67f2220203786dfa59b37e9"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:2d2d793e36e230fd32babe143b04cec8a8b3eb8a3122d2aceb4a371e6b09b8df"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ce409136744f6521e39fd8e2a24c53fa18ad67aa5bc7c2cf83645cce5b5c4e50"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-win32.whl", hash = "sha256:4096e9de5c6fdf43fb4f04c26fb114f61ef0bf2e5604b6ee3019d51b69e8c371"},
- {file = "MarkupSafe-2.1.5-cp37-cp37m-win_amd64.whl", hash = "sha256:4275d846e41ecefa46e2015117a9f491e57a71ddd59bbead77e904dc02b1bed2"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:656f7526c69fac7f600bd1f400991cc282b417d17539a1b228617081106feb4a"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:97cafb1f3cbcd3fd2b6fbfb99ae11cdb14deea0736fc2b0952ee177f2b813a46"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1f3fbcb7ef1f16e48246f704ab79d79da8a46891e2da03f8783a5b6fa41a9532"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fa9db3f79de01457b03d4f01b34cf91bc0048eb2c3846ff26f66687c2f6d16ab"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ffee1f21e5ef0d712f9033568f8344d5da8cc2869dbd08d87c84656e6a2d2f68"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5dedb4db619ba5a2787a94d877bc8ffc0566f92a01c0ef214865e54ecc9ee5e0"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:30b600cf0a7ac9234b2638fbc0fb6158ba5bdcdf46aeb631ead21248b9affbc4"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8dd717634f5a044f860435c1d8c16a270ddf0ef8588d4887037c5028b859b0c3"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-win32.whl", hash = "sha256:daa4ee5a243f0f20d528d939d06670a298dd39b1ad5f8a72a4275124a7819eff"},
- {file = "MarkupSafe-2.1.5-cp38-cp38-win_amd64.whl", hash = "sha256:619bc166c4f2de5caa5a633b8b7326fbe98e0ccbfacabd87268a2b15ff73a029"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:7a68b554d356a91cce1236aa7682dc01df0edba8d043fd1ce607c49dd3c1edcf"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:db0b55e0f3cc0be60c1f19efdde9a637c32740486004f20d1cff53c3c0ece4d2"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3e53af139f8579a6d5f7b76549125f0d94d7e630761a2111bc431fd820e163b8"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:17b950fccb810b3293638215058e432159d2b71005c74371d784862b7e4683f3"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4c31f53cdae6ecfa91a77820e8b151dba54ab528ba65dfd235c80b086d68a465"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:bff1b4290a66b490a2f4719358c0cdcd9bafb6b8f061e45c7a2460866bf50c2e"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bc1667f8b83f48511b94671e0e441401371dfd0f0a795c7daa4a3cd1dde55bea"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5049256f536511ee3f7e1b3f87d1d1209d327e818e6ae1365e8653d7e3abb6a6"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-win32.whl", hash = "sha256:00e046b6dd71aa03a41079792f8473dc494d564611a8f89bbbd7cb93295ebdcf"},
- {file = "MarkupSafe-2.1.5-cp39-cp39-win_amd64.whl", hash = "sha256:fa173ec60341d6bb97a89f5ea19c85c5643c1e7dedebc22f5181eb73573142c5"},
- {file = "MarkupSafe-2.1.5.tar.gz", hash = "sha256:d283d37a890ba4c1ae73ffadf8046435c76e7bc2247bbb63c00bd1a709c6544b"},
-]
-matplotlib = [
- {file = "matplotlib-3.8.3-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:cf60138ccc8004f117ab2a2bad513cc4d122e55864b4fe7adf4db20ca68a078f"},
- {file = "matplotlib-3.8.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:5f557156f7116be3340cdeef7f128fa99b0d5d287d5f41a16e169819dcf22357"},
- {file = "matplotlib-3.8.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f386cf162b059809ecfac3bcc491a9ea17da69fa35c8ded8ad154cd4b933d5ec"},
- {file = "matplotlib-3.8.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b3c5f96f57b0369c288bf6f9b5274ba45787f7e0589a34d24bdbaf6d3344632f"},
- {file = "matplotlib-3.8.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:83e0f72e2c116ca7e571c57aa29b0fe697d4c6425c4e87c6e994159e0c008635"},
- {file = "matplotlib-3.8.3-cp310-cp310-win_amd64.whl", hash = "sha256:1c5c8290074ba31a41db1dc332dc2b62def469ff33766cbe325d32a3ee291aea"},
- {file = "matplotlib-3.8.3-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:5184e07c7e1d6d1481862ee361905b7059f7fe065fc837f7c3dc11eeb3f2f900"},
- {file = "matplotlib-3.8.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:d7e7e0993d0758933b1a241a432b42c2db22dfa37d4108342ab4afb9557cbe3e"},
- {file = "matplotlib-3.8.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:04b36ad07eac9740fc76c2aa16edf94e50b297d6eb4c081e3add863de4bb19a7"},
- {file = "matplotlib-3.8.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7c42dae72a62f14982f1474f7e5c9959fc4bc70c9de11cc5244c6e766200ba65"},
- {file = "matplotlib-3.8.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:bf5932eee0d428192c40b7eac1399d608f5d995f975cdb9d1e6b48539a5ad8d0"},
- {file = "matplotlib-3.8.3-cp311-cp311-win_amd64.whl", hash = "sha256:40321634e3a05ed02abf7c7b47a50be50b53ef3eaa3a573847431a545585b407"},
- {file = "matplotlib-3.8.3-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:09074f8057917d17ab52c242fdf4916f30e99959c1908958b1fc6032e2d0f6d4"},
- {file = "matplotlib-3.8.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:5745f6d0fb5acfabbb2790318db03809a253096e98c91b9a31969df28ee604aa"},
- {file = "matplotlib-3.8.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b97653d869a71721b639714b42d87cda4cfee0ee74b47c569e4874c7590c55c5"},
- {file = "matplotlib-3.8.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:242489efdb75b690c9c2e70bb5c6550727058c8a614e4c7716f363c27e10bba1"},
- {file = "matplotlib-3.8.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:83c0653c64b73926730bd9ea14aa0f50f202ba187c307a881673bad4985967b7"},
- {file = "matplotlib-3.8.3-cp312-cp312-win_amd64.whl", hash = "sha256:ef6c1025a570354297d6c15f7d0f296d95f88bd3850066b7f1e7b4f2f4c13a39"},
- {file = "matplotlib-3.8.3-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:c4af3f7317f8a1009bbb2d0bf23dfaba859eb7dd4ccbd604eba146dccaaaf0a4"},
- {file = "matplotlib-3.8.3-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4c6e00a65d017d26009bac6808f637b75ceade3e1ff91a138576f6b3065eeeba"},
- {file = "matplotlib-3.8.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e7b49ab49a3bea17802df6872f8d44f664ba8f9be0632a60c99b20b6db2165b7"},
- {file = "matplotlib-3.8.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6728dde0a3997396b053602dbd907a9bd64ec7d5cf99e728b404083698d3ca01"},
- {file = "matplotlib-3.8.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:813925d08fb86aba139f2d31864928d67511f64e5945ca909ad5bc09a96189bb"},
- {file = "matplotlib-3.8.3-cp39-cp39-win_amd64.whl", hash = "sha256:cd3a0c2be76f4e7be03d34a14d49ded6acf22ef61f88da600a18a5cd8b3c5f3c"},
- {file = "matplotlib-3.8.3-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:fa93695d5c08544f4a0dfd0965f378e7afc410d8672816aff1e81be1f45dbf2e"},
- {file = "matplotlib-3.8.3-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e9764df0e8778f06414b9d281a75235c1e85071f64bb5d71564b97c1306a2afc"},
- {file = "matplotlib-3.8.3-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:5e431a09e6fab4012b01fc155db0ce6dccacdbabe8198197f523a4ef4805eb26"},
- {file = "matplotlib-3.8.3.tar.gz", hash = "sha256:7b416239e9ae38be54b028abbf9048aff5054a9aba5416bef0bd17f9162ce161"},
-]
-matplotlib-inline = [
- {file = "matplotlib-inline-0.1.6.tar.gz", hash = "sha256:f887e5f10ba98e8d2b150ddcf4702c1e5f8b3a20005eb0f74bfdbd360ee6f304"},
- {file = "matplotlib_inline-0.1.6-py3-none-any.whl", hash = "sha256:f1f41aab5328aa5aaea9b16d083b128102f8712542f819fe7e6a420ff581b311"},
-]
-mccabe = [
- {file = "mccabe-0.6.1-py2.py3-none-any.whl", hash = "sha256:ab8a6258860da4b6677da4bd2fe5dc2c659cff31b3ee4f7f5d64e79735b80d42"},
- {file = "mccabe-0.6.1.tar.gz", hash = "sha256:dd8d182285a0fe56bace7f45b5e7d1a6ebcbf524e8f3bd87eb0f125271b8831f"},
-]
-mdformat = [
- {file = "mdformat-0.7.17-py3-none-any.whl", hash = "sha256:91ffc5e203f5814a6ad17515c77767fd2737fc12ffd8b58b7bb1d8b9aa6effaa"},
- {file = "mdformat-0.7.17.tar.gz", hash = "sha256:a9dbb1838d43bb1e6f03bd5dca9412c552544a9bc42d6abb5dc32adfe8ae7c0d"},
-]
-mdformat-frontmatter = [
- {file = "mdformat_frontmatter-0.4.1-py3-none-any.whl", hash = "sha256:9c13f6b7a53de7b401af3c95e66735237545bd174e6619392153b296135ffd49"},
- {file = "mdformat_frontmatter-0.4.1.tar.gz", hash = "sha256:15d3eed1543849d4fe72b1f75b8dffd8b49750c5149186591a1b9617178e2aa2"},
-]
-mdformat-tables = [
- {file = "mdformat_tables-0.4.1-py3-none-any.whl", hash = "sha256:981f3dc7350027f78e3fd6a5fe8a16e123eec423af2d140e588d855751501019"},
- {file = "mdformat_tables-0.4.1.tar.gz", hash = "sha256:3024e88e9d29d7b8bb07fd6b59c9d5dcf14d2060122be29e30e72d27b65d7da9"},
-]
-mdit-py-plugins = [
- {file = "mdit_py_plugins-0.4.0-py3-none-any.whl", hash = "sha256:b51b3bb70691f57f974e257e367107857a93b36f322a9e6d44ca5bf28ec2def9"},
- {file = "mdit_py_plugins-0.4.0.tar.gz", hash = "sha256:d8ab27e9aed6c38aa716819fedfde15ca275715955f8a185a8e1cf90fb1d2c1b"},
-]
-mdurl = [
- {file = "mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8"},
- {file = "mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba"},
-]
-mypy = [
- {file = "mypy-1.8.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:485a8942f671120f76afffff70f259e1cd0f0cfe08f81c05d8816d958d4577d3"},
- {file = "mypy-1.8.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:df9824ac11deaf007443e7ed2a4a26bebff98d2bc43c6da21b2b64185da011c4"},
- {file = "mypy-1.8.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2afecd6354bbfb6e0160f4e4ad9ba6e4e003b767dd80d85516e71f2e955ab50d"},
- {file = "mypy-1.8.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:8963b83d53ee733a6e4196954502b33567ad07dfd74851f32be18eb932fb1cb9"},
- {file = "mypy-1.8.0-cp310-cp310-win_amd64.whl", hash = "sha256:e46f44b54ebddbeedbd3d5b289a893219065ef805d95094d16a0af6630f5d410"},
- {file = "mypy-1.8.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:855fe27b80375e5c5878492f0729540db47b186509c98dae341254c8f45f42ae"},
- {file = "mypy-1.8.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:4c886c6cce2d070bd7df4ec4a05a13ee20c0aa60cb587e8d1265b6c03cf91da3"},
- {file = "mypy-1.8.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d19c413b3c07cbecf1f991e2221746b0d2a9410b59cb3f4fb9557f0365a1a817"},
- {file = "mypy-1.8.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:9261ed810972061388918c83c3f5cd46079d875026ba97380f3e3978a72f503d"},
- {file = "mypy-1.8.0-cp311-cp311-win_amd64.whl", hash = "sha256:51720c776d148bad2372ca21ca29256ed483aa9a4cdefefcef49006dff2a6835"},
- {file = "mypy-1.8.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:52825b01f5c4c1c4eb0db253ec09c7aa17e1a7304d247c48b6f3599ef40db8bd"},
- {file = "mypy-1.8.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f5ac9a4eeb1ec0f1ccdc6f326bcdb464de5f80eb07fb38b5ddd7b0de6bc61e55"},
- {file = "mypy-1.8.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afe3fe972c645b4632c563d3f3eff1cdca2fa058f730df2b93a35e3b0c538218"},
- {file = "mypy-1.8.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:42c6680d256ab35637ef88891c6bd02514ccb7e1122133ac96055ff458f93fc3"},
- {file = "mypy-1.8.0-cp312-cp312-win_amd64.whl", hash = "sha256:720a5ca70e136b675af3af63db533c1c8c9181314d207568bbe79051f122669e"},
- {file = "mypy-1.8.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:028cf9f2cae89e202d7b6593cd98db6759379f17a319b5faf4f9978d7084cdc6"},
- {file = "mypy-1.8.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:4e6d97288757e1ddba10dd9549ac27982e3e74a49d8d0179fc14d4365c7add66"},
- {file = "mypy-1.8.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7f1478736fcebb90f97e40aff11a5f253af890c845ee0c850fe80aa060a267c6"},
- {file = "mypy-1.8.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:42419861b43e6962a649068a61f4a4839205a3ef525b858377a960b9e2de6e0d"},
- {file = "mypy-1.8.0-cp38-cp38-win_amd64.whl", hash = "sha256:2b5b6c721bd4aabaadead3a5e6fa85c11c6c795e0c81a7215776ef8afc66de02"},
- {file = "mypy-1.8.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5c1538c38584029352878a0466f03a8ee7547d7bd9f641f57a0f3017a7c905b8"},
- {file = "mypy-1.8.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4ef4be7baf08a203170f29e89d79064463b7fc7a0908b9d0d5114e8009c3a259"},
- {file = "mypy-1.8.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7178def594014aa6c35a8ff411cf37d682f428b3b5617ca79029d8ae72f5402b"},
- {file = "mypy-1.8.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ab3c84fa13c04aeeeabb2a7f67a25ef5d77ac9d6486ff33ded762ef353aa5592"},
- {file = "mypy-1.8.0-cp39-cp39-win_amd64.whl", hash = "sha256:99b00bc72855812a60d253420d8a2eae839b0afa4938f09f4d2aa9bb4654263a"},
- {file = "mypy-1.8.0-py3-none-any.whl", hash = "sha256:538fd81bb5e430cc1381a443971c0475582ff9f434c16cd46d2c66763ce85d9d"},
- {file = "mypy-1.8.0.tar.gz", hash = "sha256:6ff8b244d7085a0b425b56d327b480c3b29cafbd2eff27316a004f9a7391ae07"},
-]
-mypy-extensions = [
- {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"},
- {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"},
-]
-myst-nb = [
- {file = "myst_nb-1.0.0-py3-none-any.whl", hash = "sha256:ee8febc6dd7d9e32bede0c66a9b962b2e2fdab697428ee9fbfd4919d82380911"},
- {file = "myst_nb-1.0.0.tar.gz", hash = "sha256:9077e42a1c6b441ea55078506f83555dda5d6c816ef4930841d71d239e3e0c5e"},
-]
-myst-parser = [
- {file = "myst_parser-2.0.0-py3-none-any.whl", hash = "sha256:7c36344ae39c8e740dad7fdabf5aa6fc4897a813083c6cc9990044eb93656b14"},
- {file = "myst_parser-2.0.0.tar.gz", hash = "sha256:ea929a67a6a0b1683cdbe19b8d2e724cd7643f8aa3e7bb18dd65beac3483bead"},
-]
-nbclient = [
- {file = "nbclient-0.9.0-py3-none-any.whl", hash = "sha256:a3a1ddfb34d4a9d17fc744d655962714a866639acd30130e9be84191cd97cd15"},
- {file = "nbclient-0.9.0.tar.gz", hash = "sha256:4b28c207877cf33ef3a9838cdc7a54c5ceff981194a82eac59d558f05487295e"},
-]
-nbformat = [
- {file = "nbformat-5.9.2-py3-none-any.whl", hash = "sha256:1c5172d786a41b82bcfd0c23f9e6b6f072e8fb49c39250219e4acfff1efe89e9"},
- {file = "nbformat-5.9.2.tar.gz", hash = "sha256:5f98b5ba1997dff175e77e0c17d5c10a96eaed2cbd1de3533d1fc35d5e111192"},
-]
-nest-asyncio = [
- {file = "nest_asyncio-1.6.0-py3-none-any.whl", hash = "sha256:87af6efd6b5e897c81050477ef65c62e2b2f35d51703cae01aff2905b1852e1c"},
- {file = "nest_asyncio-1.6.0.tar.gz", hash = "sha256:6f172d5449aca15afd6c646851f4e31e02c598d553a667e38cafa997cfec55fe"},
-]
-netcdf4 = [
- {file = "netCDF4-1.6.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d23b97cbde2bf413fadc4697c5c255a0436511c02f811e127e0fb12f5b882a4c"},
- {file = "netCDF4-1.6.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9e5edfed673005f47f8d2fbea9c72c382b085dd358ac3c20ca743a563ed7b90e"},
- {file = "netCDF4-1.6.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:10d2ac9ae1308ca837d86c6dc304ec455a85bdba0f2175e222844a54589168dc"},
- {file = "netCDF4-1.6.5-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9a63a2be2f80977ac23bb0aa736c565011fd4639097ce0922e01b0dc38015df2"},
- {file = "netCDF4-1.6.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3aaceea2097d292bad398d9f9b4fe403efa7b1568fcfa6faba9b67b1630027f9"},
- {file = "netCDF4-1.6.5-cp310-cp310-win_amd64.whl", hash = "sha256:111357d9e12eb79e8d58bfd91bc6b230d35b17a0ebd8c546d17416e8ceebea49"},
- {file = "netCDF4-1.6.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:1c5fede0b34c0a02a1b9e84116bfb3fcd2f80124a651d4836e72b785d10e2f15"},
- {file = "netCDF4-1.6.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3de5512b9270aa6472e4f3aa2bf895a7364c1d4f8667ce3b82e8232197d4fec8"},
- {file = "netCDF4-1.6.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b20971a164431f6eca1d24df8aa153db15c2c1b9630e83ccc5cf004e8ac8151d"},
- {file = "netCDF4-1.6.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ad1101d538077152b866782e44458356981526bf2ea9cc07930bf28b589c82a7"},
- {file = "netCDF4-1.6.5-cp311-cp311-win_amd64.whl", hash = "sha256:de4dc973fae9e2bbdf42e094125e423a4c25393172a61958314969b055a38889"},
- {file = "netCDF4-1.6.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:19e16c63cdd7c0dbffe284a4a65f226ba1026f476f35cbedd099b4792b395f69"},
- {file = "netCDF4-1.6.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:b994afce2ca4073f6b757385a6c0ffec25ecaae2b8821535b303c7cdbf6de42b"},
- {file = "netCDF4-1.6.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0187646e3348e7a8cd654617dda65517df138042c94c2fcc6682ff7c8c6654dc"},
- {file = "netCDF4-1.6.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a1ab5dabac27d25fcc82c52dc29a74a6585e865208cce35f4e285df83d3df0b2"},
- {file = "netCDF4-1.6.5-cp312-cp312-win_amd64.whl", hash = "sha256:081e9043ac6160989f60570928eabe803c88ce7df1d3f79f2345dc48f68ef752"},
- {file = "netCDF4-1.6.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:9b47b22dda5b25ba6291f97634d7ac67b0a843f8ae5c9d9d5813c15364f66d0a"},
- {file = "netCDF4-1.6.5-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4609dd62d14798c9524327287091875449d68588c128abb768fc0c76c4a28165"},
- {file = "netCDF4-1.6.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2455e9d35fde067e6a6bdc24aa9d44962235a071cec49904d1589e298c23dcd3"},
- {file = "netCDF4-1.6.5-cp38-cp38-win_amd64.whl", hash = "sha256:2c210794d96431d92b5992e46ad8a9f97237bf6d6956f8816978a03dc0fa18c3"},
- {file = "netCDF4-1.6.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:18255b8b283d32d3900092f29c67e53aa25bd8f0dfe7adde59fe782d865a381c"},
- {file = "netCDF4-1.6.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:53050562bac84738bbd121fbbee9593d074579f5d6fdaafcb981abeb5c964225"},
- {file = "netCDF4-1.6.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:938c062382406bca9198b16adddd87c09b00521766b138cdfd11c95546eefeb8"},
- {file = "netCDF4-1.6.5-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:4a8300451d7542d3c4ff1dcccf5fb1c7d44bdd1dc08ec77dab04416caf13cb1f"},
- {file = "netCDF4-1.6.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a27db2701feef31201c9b20b04a9579196edc20dfc339ca423c7b81e462d6e14"},
- {file = "netCDF4-1.6.5-cp39-cp39-win_amd64.whl", hash = "sha256:574d7742ab321e5f9f33b5b1296c4ad4e5c469152c17d4fc453d5070e413e596"},
- {file = "netCDF4-1.6.5.tar.gz", hash = "sha256:824881d0aacfde5bd982d6adedd8574259c85553781e7b83e0ce82b890bfa0ef"},
-]
-nodeenv = [
- {file = "nodeenv-1.8.0-py2.py3-none-any.whl", hash = "sha256:df865724bb3c3adc86b3876fa209771517b0cfe596beff01a92700e0e8be4cec"},
- {file = "nodeenv-1.8.0.tar.gz", hash = "sha256:d51e0c37e64fbf47d017feac3145cdbb58836d7eee8c6f6d3b6880c5456227d2"},
-]
-numpy = [
- {file = "numpy-1.26.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:9ff0f4f29c51e2803569d7a51c2304de5554655a60c5d776e35b4a41413830d0"},
- {file = "numpy-1.26.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:2e4ee3380d6de9c9ec04745830fd9e2eccb3e6cf790d39d7b98ffd19b0dd754a"},
- {file = "numpy-1.26.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d209d8969599b27ad20994c8e41936ee0964e6da07478d6c35016bc386b66ad4"},
- {file = "numpy-1.26.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ffa75af20b44f8dba823498024771d5ac50620e6915abac414251bd971b4529f"},
- {file = "numpy-1.26.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:62b8e4b1e28009ef2846b4c7852046736bab361f7aeadeb6a5b89ebec3c7055a"},
- {file = "numpy-1.26.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a4abb4f9001ad2858e7ac189089c42178fcce737e4169dc61321660f1a96c7d2"},
- {file = "numpy-1.26.4-cp310-cp310-win32.whl", hash = "sha256:bfe25acf8b437eb2a8b2d49d443800a5f18508cd811fea3181723922a8a82b07"},
- {file = "numpy-1.26.4-cp310-cp310-win_amd64.whl", hash = "sha256:b97fe8060236edf3662adfc2c633f56a08ae30560c56310562cb4f95500022d5"},
- {file = "numpy-1.26.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4c66707fabe114439db9068ee468c26bbdf909cac0fb58686a42a24de1760c71"},
- {file = "numpy-1.26.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:edd8b5fe47dab091176d21bb6de568acdd906d1887a4584a15a9a96a1dca06ef"},
- {file = "numpy-1.26.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7ab55401287bfec946ced39700c053796e7cc0e3acbef09993a9ad2adba6ca6e"},
- {file = "numpy-1.26.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:666dbfb6ec68962c033a450943ded891bed2d54e6755e35e5835d63f4f6931d5"},
- {file = "numpy-1.26.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:96ff0b2ad353d8f990b63294c8986f1ec3cb19d749234014f4e7eb0112ceba5a"},
- {file = "numpy-1.26.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:60dedbb91afcbfdc9bc0b1f3f402804070deed7392c23eb7a7f07fa857868e8a"},
- {file = "numpy-1.26.4-cp311-cp311-win32.whl", hash = "sha256:1af303d6b2210eb850fcf03064d364652b7120803a0b872f5211f5234b399f20"},
- {file = "numpy-1.26.4-cp311-cp311-win_amd64.whl", hash = "sha256:cd25bcecc4974d09257ffcd1f098ee778f7834c3ad767fe5db785be9a4aa9cb2"},
- {file = "numpy-1.26.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:b3ce300f3644fb06443ee2222c2201dd3a89ea6040541412b8fa189341847218"},
- {file = "numpy-1.26.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:03a8c78d01d9781b28a6989f6fa1bb2c4f2d51201cf99d3dd875df6fbd96b23b"},
- {file = "numpy-1.26.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9fad7dcb1aac3c7f0584a5a8133e3a43eeb2fe127f47e3632d43d677c66c102b"},
- {file = "numpy-1.26.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:675d61ffbfa78604709862923189bad94014bef562cc35cf61d3a07bba02a7ed"},
- {file = "numpy-1.26.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:ab47dbe5cc8210f55aa58e4805fe224dac469cde56b9f731a4c098b91917159a"},
- {file = "numpy-1.26.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:1dda2e7b4ec9dd512f84935c5f126c8bd8b9f2fc001e9f54af255e8c5f16b0e0"},
- {file = "numpy-1.26.4-cp312-cp312-win32.whl", hash = "sha256:50193e430acfc1346175fcbdaa28ffec49947a06918b7b92130744e81e640110"},
- {file = "numpy-1.26.4-cp312-cp312-win_amd64.whl", hash = "sha256:08beddf13648eb95f8d867350f6a018a4be2e5ad54c8d8caed89ebca558b2818"},
- {file = "numpy-1.26.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:7349ab0fa0c429c82442a27a9673fc802ffdb7c7775fad780226cb234965e53c"},
- {file = "numpy-1.26.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:52b8b60467cd7dd1e9ed082188b4e6bb35aa5cdd01777621a1658910745b90be"},
- {file = "numpy-1.26.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d5241e0a80d808d70546c697135da2c613f30e28251ff8307eb72ba696945764"},
- {file = "numpy-1.26.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f870204a840a60da0b12273ef34f7051e98c3b5961b61b0c2c1be6dfd64fbcd3"},
- {file = "numpy-1.26.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:679b0076f67ecc0138fd2ede3a8fd196dddc2ad3254069bcb9faf9a79b1cebcd"},
- {file = "numpy-1.26.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:47711010ad8555514b434df65f7d7b076bb8261df1ca9bb78f53d3b2db02e95c"},
- {file = "numpy-1.26.4-cp39-cp39-win32.whl", hash = "sha256:a354325ee03388678242a4d7ebcd08b5c727033fcff3b2f536aea978e15ee9e6"},
- {file = "numpy-1.26.4-cp39-cp39-win_amd64.whl", hash = "sha256:3373d5d70a5fe74a2c1bb6d2cfd9609ecf686d47a2d7b1d37a8f3b6bf6003aea"},
- {file = "numpy-1.26.4-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:afedb719a9dcfc7eaf2287b839d8198e06dcd4cb5d276a3df279231138e83d30"},
- {file = "numpy-1.26.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:95a7476c59002f2f6c590b9b7b998306fba6a5aa646b1e22ddfeaf8f78c3a29c"},
- {file = "numpy-1.26.4-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7e50d0a0cc3189f9cb0aeb3a6a6af18c16f59f004b866cd2be1c14b36134a4a0"},
- {file = "numpy-1.26.4.tar.gz", hash = "sha256:2a02aba9ed12e4ac4eb3ea9421c420301a0c6460d9830d74a9df87efa4912010"},
-]
-packaging = [
- {file = "packaging-23.2-py3-none-any.whl", hash = "sha256:8c491190033a9af7e1d931d0b5dacc2ef47509b34dd0de67ed209b5203fc88c7"},
- {file = "packaging-23.2.tar.gz", hash = "sha256:048fb0e9405036518eaaf48a55953c750c11e1a1b68e0dd1a9d62ed0c092cfc5"},
-]
-pandas = [
- {file = "pandas-2.2.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:8df8612be9cd1c7797c93e1c5df861b2ddda0b48b08f2c3eaa0702cf88fb5f88"},
- {file = "pandas-2.2.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:0f573ab277252ed9aaf38240f3b54cfc90fff8e5cab70411ee1d03f5d51f3944"},
- {file = "pandas-2.2.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f02a3a6c83df4026e55b63c1f06476c9aa3ed6af3d89b4f04ea656ccdaaaa359"},
- {file = "pandas-2.2.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c38ce92cb22a4bea4e3929429aa1067a454dcc9c335799af93ba9be21b6beb51"},
- {file = "pandas-2.2.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:c2ce852e1cf2509a69e98358e8458775f89599566ac3775e70419b98615f4b06"},
- {file = "pandas-2.2.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:53680dc9b2519cbf609c62db3ed7c0b499077c7fefda564e330286e619ff0dd9"},
- {file = "pandas-2.2.1-cp310-cp310-win_amd64.whl", hash = "sha256:94e714a1cca63e4f5939cdce5f29ba8d415d85166be3441165edd427dc9f6bc0"},
- {file = "pandas-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f821213d48f4ab353d20ebc24e4faf94ba40d76680642fb7ce2ea31a3ad94f9b"},
- {file = "pandas-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:c70e00c2d894cb230e5c15e4b1e1e6b2b478e09cf27cc593a11ef955b9ecc81a"},
- {file = "pandas-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e97fbb5387c69209f134893abc788a6486dbf2f9e511070ca05eed4b930b1b02"},
- {file = "pandas-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:101d0eb9c5361aa0146f500773395a03839a5e6ecde4d4b6ced88b7e5a1a6403"},
- {file = "pandas-2.2.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:7d2ed41c319c9fb4fd454fe25372028dfa417aacb9790f68171b2e3f06eae8cd"},
- {file = "pandas-2.2.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:af5d3c00557d657c8773ef9ee702c61dd13b9d7426794c9dfeb1dc4a0bf0ebc7"},
- {file = "pandas-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:06cf591dbaefb6da9de8472535b185cba556d0ce2e6ed28e21d919704fef1a9e"},
- {file = "pandas-2.2.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:88ecb5c01bb9ca927ebc4098136038519aa5d66b44671861ffab754cae75102c"},
- {file = "pandas-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:04f6ec3baec203c13e3f8b139fb0f9f86cd8c0b94603ae3ae8ce9a422e9f5bee"},
- {file = "pandas-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a935a90a76c44fe170d01e90a3594beef9e9a6220021acfb26053d01426f7dc2"},
- {file = "pandas-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c391f594aae2fd9f679d419e9a4d5ba4bce5bb13f6a989195656e7dc4b95c8f0"},
- {file = "pandas-2.2.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:9d1265545f579edf3f8f0cb6f89f234f5e44ba725a34d86535b1a1d38decbccc"},
- {file = "pandas-2.2.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:11940e9e3056576ac3244baef2fedade891977bcc1cb7e5cc8f8cc7d603edc89"},
- {file = "pandas-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:4acf681325ee1c7f950d058b05a820441075b0dd9a2adf5c4835b9bc056bf4fb"},
- {file = "pandas-2.2.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9bd8a40f47080825af4317d0340c656744f2bfdb6819f818e6ba3cd24c0e1397"},
- {file = "pandas-2.2.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:df0c37ebd19e11d089ceba66eba59a168242fc6b7155cba4ffffa6eccdfb8f16"},
- {file = "pandas-2.2.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:739cc70eaf17d57608639e74d63387b0d8594ce02f69e7a0b046f117974b3019"},
- {file = "pandas-2.2.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f9d3558d263073ed95e46f4650becff0c5e1ffe0fc3a015de3c79283dfbdb3df"},
- {file = "pandas-2.2.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:4aa1d8707812a658debf03824016bf5ea0d516afdea29b7dc14cf687bc4d4ec6"},
- {file = "pandas-2.2.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:76f27a809cda87e07f192f001d11adc2b930e93a2b0c4a236fde5429527423be"},
- {file = "pandas-2.2.1-cp39-cp39-win_amd64.whl", hash = "sha256:1ba21b1d5c0e43416218db63037dbe1a01fc101dc6e6024bcad08123e48004ab"},
- {file = "pandas-2.2.1.tar.gz", hash = "sha256:0ab90f87093c13f3e8fa45b48ba9f39181046e8f3317d3aadb2fffbb1b978572"},
-]
-parso = [
- {file = "parso-0.8.3-py2.py3-none-any.whl", hash = "sha256:c001d4636cd3aecdaf33cbb40aebb59b094be2a74c556778ef5576c175e19e75"},
- {file = "parso-0.8.3.tar.gz", hash = "sha256:8c07be290bb59f03588915921e29e8a50002acaf2cdc5fa0e0114f91709fafa0"},
-]
-partd = [
- {file = "partd-1.4.1-py3-none-any.whl", hash = "sha256:27e766663d36c161e2827aa3e28541c992f0b9527d3cca047e13fb3acdb989e6"},
- {file = "partd-1.4.1.tar.gz", hash = "sha256:56c25dd49e6fea5727e731203c466c6e092f308d8f0024e199d02f6aa2167f67"},
-]
-pathspec = [
- {file = "pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08"},
- {file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"},
-]
-pexpect = [
- {file = "pexpect-4.9.0-py2.py3-none-any.whl", hash = "sha256:7236d1e080e4936be2dc3e326cec0af72acf9212a7e1d060210e70a47e253523"},
- {file = "pexpect-4.9.0.tar.gz", hash = "sha256:ee7d41123f3c9911050ea2c2dac107568dc43b2d3b0c7557a33212c398ead30f"},
-]
-pillow = [
- {file = "pillow-10.2.0-cp310-cp310-macosx_10_10_x86_64.whl", hash = "sha256:7823bdd049099efa16e4246bdf15e5a13dbb18a51b68fa06d6c1d4d8b99a796e"},
- {file = "pillow-10.2.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:83b2021f2ade7d1ed556bc50a399127d7fb245e725aa0113ebd05cfe88aaf588"},
- {file = "pillow-10.2.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6fad5ff2f13d69b7e74ce5b4ecd12cc0ec530fcee76356cac6742785ff71c452"},
- {file = "pillow-10.2.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:da2b52b37dad6d9ec64e653637a096905b258d2fc2b984c41ae7d08b938a67e4"},
- {file = "pillow-10.2.0-cp310-cp310-manylinux_2_28_aarch64.whl", hash = "sha256:47c0995fc4e7f79b5cfcab1fc437ff2890b770440f7696a3ba065ee0fd496563"},
- {file = "pillow-10.2.0-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:322bdf3c9b556e9ffb18f93462e5f749d3444ce081290352c6070d014c93feb2"},
- {file = "pillow-10.2.0-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:51f1a1bffc50e2e9492e87d8e09a17c5eea8409cda8d3f277eb6edc82813c17c"},
- {file = "pillow-10.2.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:69ffdd6120a4737710a9eee73e1d2e37db89b620f702754b8f6e62594471dee0"},
- {file = "pillow-10.2.0-cp310-cp310-win32.whl", hash = "sha256:c6dafac9e0f2b3c78df97e79af707cdc5ef8e88208d686a4847bab8266870023"},
- {file = "pillow-10.2.0-cp310-cp310-win_amd64.whl", hash = "sha256:aebb6044806f2e16ecc07b2a2637ee1ef67a11840a66752751714a0d924adf72"},
- {file = "pillow-10.2.0-cp310-cp310-win_arm64.whl", hash = "sha256:7049e301399273a0136ff39b84c3678e314f2158f50f517bc50285fb5ec847ad"},
- {file = "pillow-10.2.0-cp311-cp311-macosx_10_10_x86_64.whl", hash = "sha256:35bb52c37f256f662abdfa49d2dfa6ce5d93281d323a9af377a120e89a9eafb5"},
- {file = "pillow-10.2.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:9c23f307202661071d94b5e384e1e1dc7dfb972a28a2310e4ee16103e66ddb67"},
- {file = "pillow-10.2.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:773efe0603db30c281521a7c0214cad7836c03b8ccff897beae9b47c0b657d61"},
- {file = "pillow-10.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:11fa2e5984b949b0dd6d7a94d967743d87c577ff0b83392f17cb3990d0d2fd6e"},
- {file = "pillow-10.2.0-cp311-cp311-manylinux_2_28_aarch64.whl", hash = "sha256:716d30ed977be8b37d3ef185fecb9e5a1d62d110dfbdcd1e2a122ab46fddb03f"},
- {file = "pillow-10.2.0-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:a086c2af425c5f62a65e12fbf385f7c9fcb8f107d0849dba5839461a129cf311"},
- {file = "pillow-10.2.0-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:c8de2789052ed501dd829e9cae8d3dcce7acb4777ea4a479c14521c942d395b1"},
- {file = "pillow-10.2.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:609448742444d9290fd687940ac0b57fb35e6fd92bdb65386e08e99af60bf757"},
- {file = "pillow-10.2.0-cp311-cp311-win32.whl", hash = "sha256:823ef7a27cf86df6597fa0671066c1b596f69eba53efa3d1e1cb8b30f3533068"},
- {file = "pillow-10.2.0-cp311-cp311-win_amd64.whl", hash = "sha256:1da3b2703afd040cf65ec97efea81cfba59cdbed9c11d8efc5ab09df9509fc56"},
- {file = "pillow-10.2.0-cp311-cp311-win_arm64.whl", hash = "sha256:edca80cbfb2b68d7b56930b84a0e45ae1694aeba0541f798e908a49d66b837f1"},
- {file = "pillow-10.2.0-cp312-cp312-macosx_10_10_x86_64.whl", hash = "sha256:1b5e1b74d1bd1b78bc3477528919414874748dd363e6272efd5abf7654e68bef"},
- {file = "pillow-10.2.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:0eae2073305f451d8ecacb5474997c08569fb4eb4ac231ffa4ad7d342fdc25ac"},
- {file = "pillow-10.2.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b7c2286c23cd350b80d2fc9d424fc797575fb16f854b831d16fd47ceec078f2c"},
- {file = "pillow-10.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1e23412b5c41e58cec602f1135c57dfcf15482013ce6e5f093a86db69646a5aa"},
- {file = "pillow-10.2.0-cp312-cp312-manylinux_2_28_aarch64.whl", hash = "sha256:52a50aa3fb3acb9cf7213573ef55d31d6eca37f5709c69e6858fe3bc04a5c2a2"},
- {file = "pillow-10.2.0-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:127cee571038f252a552760076407f9cff79761c3d436a12af6000cd182a9d04"},
- {file = "pillow-10.2.0-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:8d12251f02d69d8310b046e82572ed486685c38f02176bd08baf216746eb947f"},
- {file = "pillow-10.2.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:54f1852cd531aa981bc0965b7d609f5f6cc8ce8c41b1139f6ed6b3c54ab82bfb"},
- {file = "pillow-10.2.0-cp312-cp312-win32.whl", hash = "sha256:257d8788df5ca62c980314053197f4d46eefedf4e6175bc9412f14412ec4ea2f"},
- {file = "pillow-10.2.0-cp312-cp312-win_amd64.whl", hash = "sha256:154e939c5f0053a383de4fd3d3da48d9427a7e985f58af8e94d0b3c9fcfcf4f9"},
- {file = "pillow-10.2.0-cp312-cp312-win_arm64.whl", hash = "sha256:f379abd2f1e3dddb2b61bc67977a6b5a0a3f7485538bcc6f39ec76163891ee48"},
- {file = "pillow-10.2.0-cp38-cp38-macosx_10_10_x86_64.whl", hash = "sha256:8373c6c251f7ef8bda6675dd6d2b3a0fcc31edf1201266b5cf608b62a37407f9"},
- {file = "pillow-10.2.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:870ea1ada0899fd0b79643990809323b389d4d1d46c192f97342eeb6ee0b8483"},
- {file = "pillow-10.2.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b4b6b1e20608493548b1f32bce8cca185bf0480983890403d3b8753e44077129"},
- {file = "pillow-10.2.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3031709084b6e7852d00479fd1d310b07d0ba82765f973b543c8af5061cf990e"},
- {file = "pillow-10.2.0-cp38-cp38-manylinux_2_28_aarch64.whl", hash = "sha256:3ff074fc97dd4e80543a3e91f69d58889baf2002b6be64347ea8cf5533188213"},
- {file = "pillow-10.2.0-cp38-cp38-manylinux_2_28_x86_64.whl", hash = "sha256:cb4c38abeef13c61d6916f264d4845fab99d7b711be96c326b84df9e3e0ff62d"},
- {file = "pillow-10.2.0-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:b1b3020d90c2d8e1dae29cf3ce54f8094f7938460fb5ce8bc5c01450b01fbaf6"},
- {file = "pillow-10.2.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:170aeb00224ab3dc54230c797f8404507240dd868cf52066f66a41b33169bdbe"},
- {file = "pillow-10.2.0-cp38-cp38-win32.whl", hash = "sha256:c4225f5220f46b2fde568c74fca27ae9771536c2e29d7c04f4fb62c83275ac4e"},
- {file = "pillow-10.2.0-cp38-cp38-win_amd64.whl", hash = "sha256:0689b5a8c5288bc0504d9fcee48f61a6a586b9b98514d7d29b840143d6734f39"},
- {file = "pillow-10.2.0-cp39-cp39-macosx_10_10_x86_64.whl", hash = "sha256:b792a349405fbc0163190fde0dc7b3fef3c9268292586cf5645598b48e63dc67"},
- {file = "pillow-10.2.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c570f24be1e468e3f0ce7ef56a89a60f0e05b30a3669a459e419c6eac2c35364"},
- {file = "pillow-10.2.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d8ecd059fdaf60c1963c58ceb8997b32e9dc1b911f5da5307aab614f1ce5c2fb"},
- {file = "pillow-10.2.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c365fd1703040de1ec284b176d6af5abe21b427cb3a5ff68e0759e1e313a5e7e"},
- {file = "pillow-10.2.0-cp39-cp39-manylinux_2_28_aarch64.whl", hash = "sha256:70c61d4c475835a19b3a5aa42492409878bbca7438554a1f89d20d58a7c75c01"},
- {file = "pillow-10.2.0-cp39-cp39-manylinux_2_28_x86_64.whl", hash = "sha256:b6f491cdf80ae540738859d9766783e3b3c8e5bd37f5dfa0b76abdecc5081f13"},
- {file = "pillow-10.2.0-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:9d189550615b4948f45252d7f005e53c2040cea1af5b60d6f79491a6e147eef7"},
- {file = "pillow-10.2.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:49d9ba1ed0ef3e061088cd1e7538a0759aab559e2e0a80a36f9fd9d8c0c21591"},
- {file = "pillow-10.2.0-cp39-cp39-win32.whl", hash = "sha256:babf5acfede515f176833ed6028754cbcd0d206f7f614ea3447d67c33be12516"},
- {file = "pillow-10.2.0-cp39-cp39-win_amd64.whl", hash = "sha256:0304004f8067386b477d20a518b50f3fa658a28d44e4116970abfcd94fac34a8"},
- {file = "pillow-10.2.0-cp39-cp39-win_arm64.whl", hash = "sha256:0fb3e7fc88a14eacd303e90481ad983fd5b69c761e9e6ef94c983f91025da869"},
- {file = "pillow-10.2.0-pp310-pypy310_pp73-macosx_10_10_x86_64.whl", hash = "sha256:322209c642aabdd6207517e9739c704dc9f9db943015535783239022002f054a"},
- {file = "pillow-10.2.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3eedd52442c0a5ff4f887fab0c1c0bb164d8635b32c894bc1faf4c618dd89df2"},
- {file = "pillow-10.2.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cb28c753fd5eb3dd859b4ee95de66cc62af91bcff5db5f2571d32a520baf1f04"},
- {file = "pillow-10.2.0-pp310-pypy310_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:33870dc4653c5017bf4c8873e5488d8f8d5f8935e2f1fb9a2208c47cdd66efd2"},
- {file = "pillow-10.2.0-pp310-pypy310_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:3c31822339516fb3c82d03f30e22b1d038da87ef27b6a78c9549888f8ceda39a"},
- {file = "pillow-10.2.0-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:a2b56ba36e05f973d450582fb015594aaa78834fefe8dfb8fcd79b93e64ba4c6"},
- {file = "pillow-10.2.0-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:d8e6aeb9201e655354b3ad049cb77d19813ad4ece0df1249d3c793de3774f8c7"},
- {file = "pillow-10.2.0-pp39-pypy39_pp73-macosx_10_10_x86_64.whl", hash = "sha256:2247178effb34a77c11c0e8ac355c7a741ceca0a732b27bf11e747bbc950722f"},
- {file = "pillow-10.2.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:15587643b9e5eb26c48e49a7b33659790d28f190fc514a322d55da2fb5c2950e"},
- {file = "pillow-10.2.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:753cd8f2086b2b80180d9b3010dd4ed147efc167c90d3bf593fe2af21265e5a5"},
- {file = "pillow-10.2.0-pp39-pypy39_pp73-manylinux_2_28_aarch64.whl", hash = "sha256:7c8f97e8e7a9009bcacbe3766a36175056c12f9a44e6e6f2d5caad06dcfbf03b"},
- {file = "pillow-10.2.0-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:d1b35bcd6c5543b9cb547dee3150c93008f8dd0f1fef78fc0cd2b141c5baf58a"},
- {file = "pillow-10.2.0-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:fe4c15f6c9285dc54ce6553a3ce908ed37c8f3825b5a51a15c91442bb955b868"},
- {file = "pillow-10.2.0.tar.gz", hash = "sha256:e87f0b2c78157e12d7686b27d63c070fd65d994e8ddae6f328e0dcf4a0cd007e"},
-]
-pint = [
- {file = "Pint-0.20.1-py3-none-any.whl", hash = "sha256:68afe65665542ee3ec99f69f043b1d39bfe7c6d61b786940157138fd08b838fb"},
- {file = "Pint-0.20.1.tar.gz", hash = "sha256:387cf04078dc7dfe4a708033baad54ab61d82ab06c4ee3d4922b1e45d5626067"},
-]
-platformdirs = [
- {file = "platformdirs-4.2.0-py3-none-any.whl", hash = "sha256:0614df2a2f37e1a662acbd8e2b25b92ccf8632929bc6d43467e17fe89c75e068"},
- {file = "platformdirs-4.2.0.tar.gz", hash = "sha256:ef0cc731df711022c174543cb70a9b5bd22e5a9337c8624ef2c2ceb8ddad8768"},
-]
-pluggy = [
- {file = "pluggy-1.4.0-py3-none-any.whl", hash = "sha256:7db9f7b503d67d1c5b95f59773ebb58a8c1c288129a88665838012cfb07b8981"},
- {file = "pluggy-1.4.0.tar.gz", hash = "sha256:8c85c2876142a764e5b7548e7d9a0e0ddb46f5185161049a79b7e974454223be"},
-]
-pre-commit = [
- {file = "pre_commit-2.21.0-py2.py3-none-any.whl", hash = "sha256:e2f91727039fc39a92f58a588a25b87f936de6567eed4f0e673e0507edc75bad"},
- {file = "pre_commit-2.21.0.tar.gz", hash = "sha256:31ef31af7e474a8d8995027fefdfcf509b5c913ff31f2015b4ec4beb26a6f658"},
-]
-prompt-toolkit = [
- {file = "prompt_toolkit-3.0.43-py3-none-any.whl", hash = "sha256:a11a29cb3bf0a28a387fe5122cdb649816a957cd9261dcedf8c9f1fef33eacf6"},
- {file = "prompt_toolkit-3.0.43.tar.gz", hash = "sha256:3527b7af26106cbc65a040bcc84839a3566ec1b051bb0bfe953631e704b0ff7d"},
-]
-psutil = [
- {file = "psutil-5.9.8-cp27-cp27m-macosx_10_9_x86_64.whl", hash = "sha256:26bd09967ae00920df88e0352a91cff1a78f8d69b3ecabbfe733610c0af486c8"},
- {file = "psutil-5.9.8-cp27-cp27m-manylinux2010_i686.whl", hash = "sha256:05806de88103b25903dff19bb6692bd2e714ccf9e668d050d144012055cbca73"},
- {file = "psutil-5.9.8-cp27-cp27m-manylinux2010_x86_64.whl", hash = "sha256:611052c4bc70432ec770d5d54f64206aa7203a101ec273a0cd82418c86503bb7"},
- {file = "psutil-5.9.8-cp27-cp27mu-manylinux2010_i686.whl", hash = "sha256:50187900d73c1381ba1454cf40308c2bf6f34268518b3f36a9b663ca87e65e36"},
- {file = "psutil-5.9.8-cp27-cp27mu-manylinux2010_x86_64.whl", hash = "sha256:02615ed8c5ea222323408ceba16c60e99c3f91639b07da6373fb7e6539abc56d"},
- {file = "psutil-5.9.8-cp27-none-win32.whl", hash = "sha256:36f435891adb138ed3c9e58c6af3e2e6ca9ac2f365efe1f9cfef2794e6c93b4e"},
- {file = "psutil-5.9.8-cp27-none-win_amd64.whl", hash = "sha256:bd1184ceb3f87651a67b2708d4c3338e9b10c5df903f2e3776b62303b26cb631"},
- {file = "psutil-5.9.8-cp36-abi3-macosx_10_9_x86_64.whl", hash = "sha256:aee678c8720623dc456fa20659af736241f575d79429a0e5e9cf88ae0605cc81"},
- {file = "psutil-5.9.8-cp36-abi3-manylinux_2_12_i686.manylinux2010_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8cb6403ce6d8e047495a701dc7c5bd788add903f8986d523e3e20b98b733e421"},
- {file = "psutil-5.9.8-cp36-abi3-manylinux_2_12_x86_64.manylinux2010_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d06016f7f8625a1825ba3732081d77c94589dca78b7a3fc072194851e88461a4"},
- {file = "psutil-5.9.8-cp36-cp36m-win32.whl", hash = "sha256:7d79560ad97af658a0f6adfef8b834b53f64746d45b403f225b85c5c2c140eee"},
- {file = "psutil-5.9.8-cp36-cp36m-win_amd64.whl", hash = "sha256:27cc40c3493bb10de1be4b3f07cae4c010ce715290a5be22b98493509c6299e2"},
- {file = "psutil-5.9.8-cp37-abi3-win32.whl", hash = "sha256:bc56c2a1b0d15aa3eaa5a60c9f3f8e3e565303b465dbf57a1b730e7a2b9844e0"},
- {file = "psutil-5.9.8-cp37-abi3-win_amd64.whl", hash = "sha256:8db4c1b57507eef143a15a6884ca10f7c73876cdf5d51e713151c1236a0e68cf"},
- {file = "psutil-5.9.8-cp38-abi3-macosx_11_0_arm64.whl", hash = "sha256:d16bbddf0693323b8c6123dd804100241da461e41d6e332fb0ba6058f630f8c8"},
- {file = "psutil-5.9.8.tar.gz", hash = "sha256:6be126e3225486dff286a8fb9a06246a5253f4c7c53b475ea5f5ac934e64194c"},
-]
-ptyprocess = [
- {file = "ptyprocess-0.7.0-py2.py3-none-any.whl", hash = "sha256:4b41f3967fce3af57cc7e94b888626c18bf37a083e3651ca8feeb66d492fef35"},
- {file = "ptyprocess-0.7.0.tar.gz", hash = "sha256:5c5d0a3b48ceee0b48485e0c26037c0acd7d29765ca3fbb5cb3831d347423220"},
-]
-pure-eval = [
- {file = "pure_eval-0.2.2-py3-none-any.whl", hash = "sha256:01eaab343580944bc56080ebe0a674b39ec44a945e6d09ba7db3cb8cec289350"},
- {file = "pure_eval-0.2.2.tar.gz", hash = "sha256:2b45320af6dfaa1750f543d714b6d1c520a1688dec6fd24d339063ce0aaa9ac3"},
-]
-pybtex = [
- {file = "pybtex-0.24.0-py2.py3-none-any.whl", hash = "sha256:e1e0c8c69998452fea90e9179aa2a98ab103f3eed894405b7264e517cc2fcc0f"},
- {file = "pybtex-0.24.0.tar.gz", hash = "sha256:818eae35b61733e5c007c3fcd2cfb75ed1bc8b4173c1f70b56cc4c0802d34755"},
-]
-pybtex-docutils = [
- {file = "pybtex-docutils-1.0.3.tar.gz", hash = "sha256:3a7ebdf92b593e00e8c1c538aa9a20bca5d92d84231124715acc964d51d93c6b"},
- {file = "pybtex_docutils-1.0.3-py3-none-any.whl", hash = "sha256:8fd290d2ae48e32fcb54d86b0efb8d573198653c7e2447d5bec5847095f430b9"},
-]
-pycodestyle = [
- {file = "pycodestyle-2.8.0-py2.py3-none-any.whl", hash = "sha256:720f8b39dde8b293825e7ff02c475f3077124006db4f440dcbc9a20b76548a20"},
- {file = "pycodestyle-2.8.0.tar.gz", hash = "sha256:eddd5847ef438ea1c7870ca7eb78a9d47ce0cdb4851a5523949f2601d0cbbe7f"},
-]
-pycparser = [
- {file = "pycparser-2.21-py2.py3-none-any.whl", hash = "sha256:8ee45429555515e1f6b185e78100aea234072576aa43ab53aefcae078162fca9"},
- {file = "pycparser-2.21.tar.gz", hash = "sha256:e644fdec12f7872f86c58ff790da456218b10f863970249516d60a5eaca77206"},
-]
-pydocstyle = [
- {file = "pydocstyle-6.3.0-py3-none-any.whl", hash = "sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"},
- {file = "pydocstyle-6.3.0.tar.gz", hash = "sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"},
-]
-pyflakes = [
- {file = "pyflakes-2.4.0-py2.py3-none-any.whl", hash = "sha256:3bb3a3f256f4b7968c9c788781e4ff07dce46bdf12339dcda61053375426ee2e"},
- {file = "pyflakes-2.4.0.tar.gz", hash = "sha256:05a85c2872edf37a4ed30b0cce2f6093e1d0581f8c19d7393122da7e25b2b24c"},
-]
-pygments = [
- {file = "pygments-2.17.2-py3-none-any.whl", hash = "sha256:b27c2826c47d0f3219f29554824c30c5e8945175d888647acd804ddd04af846c"},
- {file = "pygments-2.17.2.tar.gz", hash = "sha256:da46cec9fd2de5be3a8a784f434e4c4ab670b4ff54d605c4c2717e9d49c4c367"},
-]
-pyparsing = [
- {file = "pyparsing-3.1.1-py3-none-any.whl", hash = "sha256:32c7c0b711493c72ff18a981d24f28aaf9c1fb7ed5e9667c9e84e3db623bdbfb"},
- {file = "pyparsing-3.1.1.tar.gz", hash = "sha256:ede28a1a32462f5a9705e07aea48001a08f7cf81a021585011deba701581a0db"},
-]
-pytest = [
- {file = "pytest-7.4.4-py3-none-any.whl", hash = "sha256:b090cdf5ed60bf4c45261be03239c2c1c22df034fbffe691abe93cd80cea01d8"},
- {file = "pytest-7.4.4.tar.gz", hash = "sha256:2cf0005922c6ace4a3e2ec8b4080eb0d9753fdc93107415332f50ce9e7994280"},
-]
-pytest-cov = [
- {file = "pytest-cov-3.0.0.tar.gz", hash = "sha256:e7f0f5b1617d2210a2cabc266dfe2f4c75a8d32fb89eafb7ad9d06f6d076d470"},
- {file = "pytest_cov-3.0.0-py3-none-any.whl", hash = "sha256:578d5d15ac4a25e5f961c938b85a05b09fdaae9deef3bb6de9a6e766622ca7a6"},
-]
-pytest-datadir = [
- {file = "pytest-datadir-1.5.0.tar.gz", hash = "sha256:1617ed92f9afda0c877e4eac91904b5f779d24ba8f5e438752e3ae39d8d2ee3f"},
- {file = "pytest_datadir-1.5.0-py3-none-any.whl", hash = "sha256:34adf361bcc7b37961bbc1dfa8d25a4829e778bab461703c38a5c50ca9c36dc8"},
-]
-pytest-flake8 = [
- {file = "pytest-flake8-1.1.1.tar.gz", hash = "sha256:ba4f243de3cb4c2486ed9e70752c80dd4b636f7ccb27d4eba763c35ed0cd316e"},
- {file = "pytest_flake8-1.1.1-py2.py3-none-any.whl", hash = "sha256:e0661a786f8cbf976c185f706fdaf5d6df0b1667c3bcff8e823ba263618627e7"},
-]
-pytest-mock = [
- {file = "pytest-mock-3.12.0.tar.gz", hash = "sha256:31a40f038c22cad32287bb43932054451ff5583ff094bca6f675df2f8bc1a6e9"},
- {file = "pytest_mock-3.12.0-py3-none-any.whl", hash = "sha256:0972719a7263072da3a21c7f4773069bcc7486027d7e8e1f81d98a47e701bc4f"},
-]
-pytest-mypy = [
- {file = "pytest-mypy-0.10.3.tar.gz", hash = "sha256:f8458f642323f13a2ca3e2e61509f7767966b527b4d8adccd5032c3e7b4fd3db"},
- {file = "pytest_mypy-0.10.3-py3-none-any.whl", hash = "sha256:7638d0d3906848fc1810cb2f5cc7fceb4cc5c98524aafcac58f28620e3102053"},
-]
-python-dateutil = [
- {file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"},
- {file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"},
-]
-pytz = [
- {file = "pytz-2024.1-py2.py3-none-any.whl", hash = "sha256:328171f4e3623139da4983451950b28e95ac706e13f3f2630a879749e7a8b319"},
- {file = "pytz-2024.1.tar.gz", hash = "sha256:2a29735ea9c18baf14b448846bde5a48030ed267578472d8955cd0e7443a9812"},
-]
-pywin32 = [
- {file = "pywin32-306-cp310-cp310-win32.whl", hash = "sha256:06d3420a5155ba65f0b72f2699b5bacf3109f36acbe8923765c22938a69dfc8d"},
- {file = "pywin32-306-cp310-cp310-win_amd64.whl", hash = "sha256:84f4471dbca1887ea3803d8848a1616429ac94a4a8d05f4bc9c5dcfd42ca99c8"},
- {file = "pywin32-306-cp311-cp311-win32.whl", hash = "sha256:e65028133d15b64d2ed8f06dd9fbc268352478d4f9289e69c190ecd6818b6407"},
- {file = "pywin32-306-cp311-cp311-win_amd64.whl", hash = "sha256:a7639f51c184c0272e93f244eb24dafca9b1855707d94c192d4a0b4c01e1100e"},
- {file = "pywin32-306-cp311-cp311-win_arm64.whl", hash = "sha256:70dba0c913d19f942a2db25217d9a1b726c278f483a919f1abfed79c9cf64d3a"},
- {file = "pywin32-306-cp312-cp312-win32.whl", hash = "sha256:383229d515657f4e3ed1343da8be101000562bf514591ff383ae940cad65458b"},
- {file = "pywin32-306-cp312-cp312-win_amd64.whl", hash = "sha256:37257794c1ad39ee9be652da0462dc2e394c8159dfd913a8a4e8eb6fd346da0e"},
- {file = "pywin32-306-cp312-cp312-win_arm64.whl", hash = "sha256:5821ec52f6d321aa59e2db7e0a35b997de60c201943557d108af9d4ae1ec7040"},
- {file = "pywin32-306-cp37-cp37m-win32.whl", hash = "sha256:1c73ea9a0d2283d889001998059f5eaaba3b6238f767c9cf2833b13e6a685f65"},
- {file = "pywin32-306-cp37-cp37m-win_amd64.whl", hash = "sha256:72c5f621542d7bdd4fdb716227be0dd3f8565c11b280be6315b06ace35487d36"},
- {file = "pywin32-306-cp38-cp38-win32.whl", hash = "sha256:e4c092e2589b5cf0d365849e73e02c391c1349958c5ac3e9d5ccb9a28e017b3a"},
- {file = "pywin32-306-cp38-cp38-win_amd64.whl", hash = "sha256:e8ac1ae3601bee6ca9f7cb4b5363bf1c0badb935ef243c4733ff9a393b1690c0"},
- {file = "pywin32-306-cp39-cp39-win32.whl", hash = "sha256:e25fd5b485b55ac9c057f67d94bc203f3f6595078d1fb3b458c9c28b7153a802"},
- {file = "pywin32-306-cp39-cp39-win_amd64.whl", hash = "sha256:39b61c15272833b5c329a2989999dcae836b1eed650252ab1b7bfbe1d59f30f4"},
-]
-pyyaml = [
- {file = "PyYAML-6.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d858aa552c999bc8a8d57426ed01e40bef403cd8ccdd0fc5f6f04a00414cac2a"},
- {file = "PyYAML-6.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fd66fc5d0da6d9815ba2cebeb4205f95818ff4b79c3ebe268e75d961704af52f"},
- {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:69b023b2b4daa7548bcfbd4aa3da05b3a74b772db9e23b982788168117739938"},
- {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:81e0b275a9ecc9c0c0c07b4b90ba548307583c125f54d5b6946cfee6360c733d"},
- {file = "PyYAML-6.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ba336e390cd8e4d1739f42dfe9bb83a3cc2e80f567d8805e11b46f4a943f5515"},
- {file = "PyYAML-6.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:326c013efe8048858a6d312ddd31d56e468118ad4cdeda36c719bf5bb6192290"},
- {file = "PyYAML-6.0.1-cp310-cp310-win32.whl", hash = "sha256:bd4af7373a854424dabd882decdc5579653d7868b8fb26dc7d0e99f823aa5924"},
- {file = "PyYAML-6.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:fd1592b3fdf65fff2ad0004b5e363300ef59ced41c2e6b3a99d4089fa8c5435d"},
- {file = "PyYAML-6.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6965a7bc3cf88e5a1c3bd2e0b5c22f8d677dc88a455344035f03399034eb3007"},
- {file = "PyYAML-6.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f003ed9ad21d6a4713f0a9b5a7a0a79e08dd0f221aff4525a2be4c346ee60aab"},
- {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:42f8152b8dbc4fe7d96729ec2b99c7097d656dc1213a3229ca5383f973a5ed6d"},
- {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:062582fca9fabdd2c8b54a3ef1c978d786e0f6b3a1510e0ac93ef59e0ddae2bc"},
- {file = "PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d2b04aac4d386b172d5b9692e2d2da8de7bfb6c387fa4f801fbf6fb2e6ba4673"},
- {file = "PyYAML-6.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e7d73685e87afe9f3b36c799222440d6cf362062f78be1013661b00c5c6f678b"},
- {file = "PyYAML-6.0.1-cp311-cp311-win32.whl", hash = "sha256:1635fd110e8d85d55237ab316b5b011de701ea0f29d07611174a1b42f1444741"},
- {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"},
- {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"},
- {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"},
- {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"},
- {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"},
- {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"},
- {file = "PyYAML-6.0.1-cp312-cp312-win_amd64.whl", hash = "sha256:0d3304d8c0adc42be59c5f8a4d9e3d7379e6955ad754aa9d6ab7a398b59dd1df"},
- {file = "PyYAML-6.0.1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:50550eb667afee136e9a77d6dc71ae76a44df8b3e51e41b77f6de2932bfe0f47"},
- {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fe35611261b29bd1de0070f0b2f47cb6ff71fa6595c077e42bd0c419fa27b98"},
- {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:704219a11b772aea0d8ecd7058d0082713c3562b4e271b849ad7dc4a5c90c13c"},
- {file = "PyYAML-6.0.1-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:afd7e57eddb1a54f0f1a974bc4391af8bcce0b444685d936840f125cf046d5bd"},
- {file = "PyYAML-6.0.1-cp36-cp36m-win32.whl", hash = "sha256:fca0e3a251908a499833aa292323f32437106001d436eca0e6e7833256674585"},
- {file = "PyYAML-6.0.1-cp36-cp36m-win_amd64.whl", hash = "sha256:f22ac1c3cac4dbc50079e965eba2c1058622631e526bd9afd45fedd49ba781fa"},
- {file = "PyYAML-6.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b1275ad35a5d18c62a7220633c913e1b42d44b46ee12554e5fd39c70a243d6a3"},
- {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:18aeb1bf9a78867dc38b259769503436b7c72f7a1f1f4c93ff9a17de54319b27"},
- {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:596106435fa6ad000c2991a98fa58eeb8656ef2325d7e158344fb33864ed87e3"},
- {file = "PyYAML-6.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:baa90d3f661d43131ca170712d903e6295d1f7a0f595074f151c0aed377c9b9c"},
- {file = "PyYAML-6.0.1-cp37-cp37m-win32.whl", hash = "sha256:9046c58c4395dff28dd494285c82ba00b546adfc7ef001486fbf0324bc174fba"},
- {file = "PyYAML-6.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:4fb147e7a67ef577a588a0e2c17b6db51dda102c71de36f8549b6816a96e1867"},
- {file = "PyYAML-6.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1d4c7e777c441b20e32f52bd377e0c409713e8bb1386e1099c2415f26e479595"},
- {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a0cd17c15d3bb3fa06978b4e8958dcdc6e0174ccea823003a106c7d4d7899ac5"},
- {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:28c119d996beec18c05208a8bd78cbe4007878c6dd15091efb73a30e90539696"},
- {file = "PyYAML-6.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7e07cbde391ba96ab58e532ff4803f79c4129397514e1413a7dc761ccd755735"},
- {file = "PyYAML-6.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:49a183be227561de579b4a36efbb21b3eab9651dd81b1858589f796549873dd6"},
- {file = "PyYAML-6.0.1-cp38-cp38-win32.whl", hash = "sha256:184c5108a2aca3c5b3d3bf9395d50893a7ab82a38004c8f61c258d4428e80206"},
- {file = "PyYAML-6.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:1e2722cc9fbb45d9b87631ac70924c11d3a401b2d7f410cc0e3bbf249f2dca62"},
- {file = "PyYAML-6.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9eb6caa9a297fc2c2fb8862bc5370d0303ddba53ba97e71f08023b6cd73d16a8"},
- {file = "PyYAML-6.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c8098ddcc2a85b61647b2590f825f3db38891662cfc2fc776415143f599bb859"},
- {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5773183b6446b2c99bb77e77595dd486303b4faab2b086e7b17bc6bef28865f6"},
- {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b786eecbdf8499b9ca1d697215862083bd6d2a99965554781d0d8d1ad31e13a0"},
- {file = "PyYAML-6.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bc1bf2925a1ecd43da378f4db9e4f799775d6367bdb94671027b73b393a7c42c"},
- {file = "PyYAML-6.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:04ac92ad1925b2cff1db0cfebffb6ffc43457495c9b3c39d3fcae417d7125dc5"},
- {file = "PyYAML-6.0.1-cp39-cp39-win32.whl", hash = "sha256:faca3bdcf85b2fc05d06ff3fbc1f83e1391b3e724afa3feba7d13eeab355484c"},
- {file = "PyYAML-6.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:510c9deebc5c0225e8c96813043e62b680ba2f9c50a08d3724c7f28a747d1486"},
- {file = "PyYAML-6.0.1.tar.gz", hash = "sha256:bfdf460b1736c775f2ba9f6a92bca30bc2095067b8a9d77876d1fad6cc3b4a43"},
-]
-pyzmq = [
- {file = "pyzmq-25.1.2-cp310-cp310-macosx_10_15_universal2.whl", hash = "sha256:e624c789359f1a16f83f35e2c705d07663ff2b4d4479bad35621178d8f0f6ea4"},
- {file = "pyzmq-25.1.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:49151b0efece79f6a79d41a461d78535356136ee70084a1c22532fc6383f4ad0"},
- {file = "pyzmq-25.1.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d9a5f194cf730f2b24d6af1f833c14c10f41023da46a7f736f48b6d35061e76e"},
- {file = "pyzmq-25.1.2-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:faf79a302f834d9e8304fafdc11d0d042266667ac45209afa57e5efc998e3872"},
- {file = "pyzmq-25.1.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7f51a7b4ead28d3fca8dda53216314a553b0f7a91ee8fc46a72b402a78c3e43d"},
- {file = "pyzmq-25.1.2-cp310-cp310-manylinux_2_28_x86_64.whl", hash = "sha256:0ddd6d71d4ef17ba5a87becf7ddf01b371eaba553c603477679ae817a8d84d75"},
- {file = "pyzmq-25.1.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:246747b88917e4867e2367b005fc8eefbb4a54b7db363d6c92f89d69abfff4b6"},
- {file = "pyzmq-25.1.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:00c48ae2fd81e2a50c3485de1b9d5c7c57cd85dc8ec55683eac16846e57ac979"},
- {file = "pyzmq-25.1.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:5a68d491fc20762b630e5db2191dd07ff89834086740f70e978bb2ef2668be08"},
- {file = "pyzmq-25.1.2-cp310-cp310-win32.whl", hash = "sha256:09dfe949e83087da88c4a76767df04b22304a682d6154de2c572625c62ad6886"},
- {file = "pyzmq-25.1.2-cp310-cp310-win_amd64.whl", hash = "sha256:fa99973d2ed20417744fca0073390ad65ce225b546febb0580358e36aa90dba6"},
- {file = "pyzmq-25.1.2-cp311-cp311-macosx_10_15_universal2.whl", hash = "sha256:82544e0e2d0c1811482d37eef297020a040c32e0687c1f6fc23a75b75db8062c"},
- {file = "pyzmq-25.1.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:01171fc48542348cd1a360a4b6c3e7d8f46cdcf53a8d40f84db6707a6768acc1"},
- {file = "pyzmq-25.1.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bc69c96735ab501419c432110016329bf0dea8898ce16fab97c6d9106dc0b348"},
- {file = "pyzmq-25.1.2-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3e124e6b1dd3dfbeb695435dff0e383256655bb18082e094a8dd1f6293114642"},
- {file = "pyzmq-25.1.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7598d2ba821caa37a0f9d54c25164a4fa351ce019d64d0b44b45540950458840"},
- {file = "pyzmq-25.1.2-cp311-cp311-manylinux_2_28_x86_64.whl", hash = "sha256:d1299d7e964c13607efd148ca1f07dcbf27c3ab9e125d1d0ae1d580a1682399d"},
- {file = "pyzmq-25.1.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:4e6f689880d5ad87918430957297c975203a082d9a036cc426648fcbedae769b"},
- {file = "pyzmq-25.1.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:cc69949484171cc961e6ecd4a8911b9ce7a0d1f738fcae717177c231bf77437b"},
- {file = "pyzmq-25.1.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:9880078f683466b7f567b8624bfc16cad65077be046b6e8abb53bed4eeb82dd3"},
- {file = "pyzmq-25.1.2-cp311-cp311-win32.whl", hash = "sha256:4e5837af3e5aaa99a091302df5ee001149baff06ad22b722d34e30df5f0d9097"},
- {file = "pyzmq-25.1.2-cp311-cp311-win_amd64.whl", hash = "sha256:25c2dbb97d38b5ac9fd15586e048ec5eb1e38f3d47fe7d92167b0c77bb3584e9"},
- {file = "pyzmq-25.1.2-cp312-cp312-macosx_10_15_universal2.whl", hash = "sha256:11e70516688190e9c2db14fcf93c04192b02d457b582a1f6190b154691b4c93a"},
- {file = "pyzmq-25.1.2-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:313c3794d650d1fccaaab2df942af9f2c01d6217c846177cfcbc693c7410839e"},
- {file = "pyzmq-25.1.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1b3cbba2f47062b85fe0ef9de5b987612140a9ba3a9c6d2543c6dec9f7c2ab27"},
- {file = "pyzmq-25.1.2-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fc31baa0c32a2ca660784d5af3b9487e13b61b3032cb01a115fce6588e1bed30"},
- {file = "pyzmq-25.1.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:02c9087b109070c5ab0b383079fa1b5f797f8d43e9a66c07a4b8b8bdecfd88ee"},
- {file = "pyzmq-25.1.2-cp312-cp312-manylinux_2_28_x86_64.whl", hash = "sha256:f8429b17cbb746c3e043cb986328da023657e79d5ed258b711c06a70c2ea7537"},
- {file = "pyzmq-25.1.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:5074adeacede5f810b7ef39607ee59d94e948b4fd954495bdb072f8c54558181"},
- {file = "pyzmq-25.1.2-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:7ae8f354b895cbd85212da245f1a5ad8159e7840e37d78b476bb4f4c3f32a9fe"},
- {file = "pyzmq-25.1.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:b264bf2cc96b5bc43ce0e852be995e400376bd87ceb363822e2cb1964fcdc737"},
- {file = "pyzmq-25.1.2-cp312-cp312-win32.whl", hash = "sha256:02bbc1a87b76e04fd780b45e7f695471ae6de747769e540da909173d50ff8e2d"},
- {file = "pyzmq-25.1.2-cp312-cp312-win_amd64.whl", hash = "sha256:ced111c2e81506abd1dc142e6cd7b68dd53747b3b7ae5edbea4578c5eeff96b7"},
- {file = "pyzmq-25.1.2-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:7b6d09a8962a91151f0976008eb7b29b433a560fde056ec7a3db9ec8f1075438"},
- {file = "pyzmq-25.1.2-cp36-cp36m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:967668420f36878a3c9ecb5ab33c9d0ff8d054f9c0233d995a6d25b0e95e1b6b"},
- {file = "pyzmq-25.1.2-cp36-cp36m-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5edac3f57c7ddaacdb4d40f6ef2f9e299471fc38d112f4bc6d60ab9365445fb0"},
- {file = "pyzmq-25.1.2-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:0dabfb10ef897f3b7e101cacba1437bd3a5032ee667b7ead32bbcdd1a8422fe7"},
- {file = "pyzmq-25.1.2-cp36-cp36m-musllinux_1_1_aarch64.whl", hash = "sha256:2c6441e0398c2baacfe5ba30c937d274cfc2dc5b55e82e3749e333aabffde561"},
- {file = "pyzmq-25.1.2-cp36-cp36m-musllinux_1_1_i686.whl", hash = "sha256:16b726c1f6c2e7625706549f9dbe9b06004dfbec30dbed4bf50cbdfc73e5b32a"},
- {file = "pyzmq-25.1.2-cp36-cp36m-musllinux_1_1_x86_64.whl", hash = "sha256:a86c2dd76ef71a773e70551a07318b8e52379f58dafa7ae1e0a4be78efd1ff16"},
- {file = "pyzmq-25.1.2-cp36-cp36m-win32.whl", hash = "sha256:359f7f74b5d3c65dae137f33eb2bcfa7ad9ebefd1cab85c935f063f1dbb245cc"},
- {file = "pyzmq-25.1.2-cp36-cp36m-win_amd64.whl", hash = "sha256:55875492f820d0eb3417b51d96fea549cde77893ae3790fd25491c5754ea2f68"},
- {file = "pyzmq-25.1.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:b8c8a419dfb02e91b453615c69568442e897aaf77561ee0064d789705ff37a92"},
- {file = "pyzmq-25.1.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8807c87fa893527ae8a524c15fc505d9950d5e856f03dae5921b5e9aa3b8783b"},
- {file = "pyzmq-25.1.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5e319ed7d6b8f5fad9b76daa0a68497bc6f129858ad956331a5835785761e003"},
- {file = "pyzmq-25.1.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:3c53687dde4d9d473c587ae80cc328e5b102b517447456184b485587ebd18b62"},
- {file = "pyzmq-25.1.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:9add2e5b33d2cd765ad96d5eb734a5e795a0755f7fc49aa04f76d7ddda73fd70"},
- {file = "pyzmq-25.1.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:e690145a8c0c273c28d3b89d6fb32c45e0d9605b2293c10e650265bf5c11cfec"},
- {file = "pyzmq-25.1.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:00a06faa7165634f0cac1abb27e54d7a0b3b44eb9994530b8ec73cf52e15353b"},
- {file = "pyzmq-25.1.2-cp37-cp37m-win32.whl", hash = "sha256:0f97bc2f1f13cb16905a5f3e1fbdf100e712d841482b2237484360f8bc4cb3d7"},
- {file = "pyzmq-25.1.2-cp37-cp37m-win_amd64.whl", hash = "sha256:6cc0020b74b2e410287e5942e1e10886ff81ac77789eb20bec13f7ae681f0fdd"},
- {file = "pyzmq-25.1.2-cp38-cp38-macosx_10_15_universal2.whl", hash = "sha256:bef02cfcbded83473bdd86dd8d3729cd82b2e569b75844fb4ea08fee3c26ae41"},
- {file = "pyzmq-25.1.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:e10a4b5a4b1192d74853cc71a5e9fd022594573926c2a3a4802020360aa719d8"},
- {file = "pyzmq-25.1.2-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:8c5f80e578427d4695adac6fdf4370c14a2feafdc8cb35549c219b90652536ae"},
- {file = "pyzmq-25.1.2-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:5dde6751e857910c1339890f3524de74007958557593b9e7e8c5f01cd919f8a7"},
- {file = "pyzmq-25.1.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ea1608dd169da230a0ad602d5b1ebd39807ac96cae1845c3ceed39af08a5c6df"},
- {file = "pyzmq-25.1.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:0f513130c4c361201da9bc69df25a086487250e16b5571ead521b31ff6b02220"},
- {file = "pyzmq-25.1.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:019744b99da30330798bb37df33549d59d380c78e516e3bab9c9b84f87a9592f"},
- {file = "pyzmq-25.1.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:2e2713ef44be5d52dd8b8e2023d706bf66cb22072e97fc71b168e01d25192755"},
- {file = "pyzmq-25.1.2-cp38-cp38-win32.whl", hash = "sha256:07cd61a20a535524906595e09344505a9bd46f1da7a07e504b315d41cd42eb07"},
- {file = "pyzmq-25.1.2-cp38-cp38-win_amd64.whl", hash = "sha256:eb7e49a17fb8c77d3119d41a4523e432eb0c6932187c37deb6fbb00cc3028088"},
- {file = "pyzmq-25.1.2-cp39-cp39-macosx_10_15_universal2.whl", hash = "sha256:94504ff66f278ab4b7e03e4cba7e7e400cb73bfa9d3d71f58d8972a8dc67e7a6"},
- {file = "pyzmq-25.1.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:6dd0d50bbf9dca1d0bdea219ae6b40f713a3fb477c06ca3714f208fd69e16fd8"},
- {file = "pyzmq-25.1.2-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:004ff469d21e86f0ef0369717351073e0e577428e514c47c8480770d5e24a565"},
- {file = "pyzmq-25.1.2-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:c0b5ca88a8928147b7b1e2dfa09f3b6c256bc1135a1338536cbc9ea13d3b7add"},
- {file = "pyzmq-25.1.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2c9a79f1d2495b167119d02be7448bfba57fad2a4207c4f68abc0bab4b92925b"},
- {file = "pyzmq-25.1.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:518efd91c3d8ac9f9b4f7dd0e2b7b8bf1a4fe82a308009016b07eaa48681af82"},
- {file = "pyzmq-25.1.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:1ec23bd7b3a893ae676d0e54ad47d18064e6c5ae1fadc2f195143fb27373f7f6"},
- {file = "pyzmq-25.1.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:db36c27baed588a5a8346b971477b718fdc66cf5b80cbfbd914b4d6d355e44e2"},
- {file = "pyzmq-25.1.2-cp39-cp39-win32.whl", hash = "sha256:39b1067f13aba39d794a24761e385e2eddc26295826530a8c7b6c6c341584289"},
- {file = "pyzmq-25.1.2-cp39-cp39-win_amd64.whl", hash = "sha256:8e9f3fabc445d0ce320ea2c59a75fe3ea591fdbdeebec5db6de530dd4b09412e"},
- {file = "pyzmq-25.1.2-pp310-pypy310_pp73-macosx_10_9_x86_64.whl", hash = "sha256:a8c1d566344aee826b74e472e16edae0a02e2a044f14f7c24e123002dcff1c05"},
- {file = "pyzmq-25.1.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:759cfd391a0996345ba94b6a5110fca9c557ad4166d86a6e81ea526c376a01e8"},
- {file = "pyzmq-25.1.2-pp310-pypy310_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7c61e346ac34b74028ede1c6b4bcecf649d69b707b3ff9dc0fab453821b04d1e"},
- {file = "pyzmq-25.1.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4cb8fc1f8d69b411b8ec0b5f1ffbcaf14c1db95b6bccea21d83610987435f1a4"},
- {file = "pyzmq-25.1.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:3c00c9b7d1ca8165c610437ca0c92e7b5607b2f9076f4eb4b095c85d6e680a1d"},
- {file = "pyzmq-25.1.2-pp37-pypy37_pp73-macosx_10_9_x86_64.whl", hash = "sha256:df0c7a16ebb94452d2909b9a7b3337940e9a87a824c4fc1c7c36bb4404cb0cde"},
- {file = "pyzmq-25.1.2-pp37-pypy37_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:45999e7f7ed5c390f2e87ece7f6c56bf979fb213550229e711e45ecc7d42ccb8"},
- {file = "pyzmq-25.1.2-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ac170e9e048b40c605358667aca3d94e98f604a18c44bdb4c102e67070f3ac9b"},
- {file = "pyzmq-25.1.2-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d1b604734bec94f05f81b360a272fc824334267426ae9905ff32dc2be433ab96"},
- {file = "pyzmq-25.1.2-pp37-pypy37_pp73-win_amd64.whl", hash = "sha256:a793ac733e3d895d96f865f1806f160696422554e46d30105807fdc9841b9f7d"},
- {file = "pyzmq-25.1.2-pp38-pypy38_pp73-macosx_10_9_x86_64.whl", hash = "sha256:0806175f2ae5ad4b835ecd87f5f85583316b69f17e97786f7443baaf54b9bb98"},
- {file = "pyzmq-25.1.2-pp38-pypy38_pp73-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:ef12e259e7bc317c7597d4f6ef59b97b913e162d83b421dd0db3d6410f17a244"},
- {file = "pyzmq-25.1.2-pp38-pypy38_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ea253b368eb41116011add00f8d5726762320b1bda892f744c91997b65754d73"},
- {file = "pyzmq-25.1.2-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1b9b1f2ad6498445a941d9a4fee096d387fee436e45cc660e72e768d3d8ee611"},
- {file = "pyzmq-25.1.2-pp38-pypy38_pp73-win_amd64.whl", hash = "sha256:8b14c75979ce932c53b79976a395cb2a8cd3aaf14aef75e8c2cb55a330b9b49d"},
- {file = "pyzmq-25.1.2-pp39-pypy39_pp73-macosx_10_9_x86_64.whl", hash = "sha256:889370d5174a741a62566c003ee8ddba4b04c3f09a97b8000092b7ca83ec9c49"},
- {file = "pyzmq-25.1.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9a18fff090441a40ffda8a7f4f18f03dc56ae73f148f1832e109f9bffa85df15"},
- {file = "pyzmq-25.1.2-pp39-pypy39_pp73-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:99a6b36f95c98839ad98f8c553d8507644c880cf1e0a57fe5e3a3f3969040882"},
- {file = "pyzmq-25.1.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4345c9a27f4310afbb9c01750e9461ff33d6fb74cd2456b107525bbeebcb5be3"},
- {file = "pyzmq-25.1.2-pp39-pypy39_pp73-manylinux_2_28_x86_64.whl", hash = "sha256:3516e0b6224cf6e43e341d56da15fd33bdc37fa0c06af4f029f7d7dfceceabbc"},
- {file = "pyzmq-25.1.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:146b9b1f29ead41255387fb07be56dc29639262c0f7344f570eecdcd8d683314"},
- {file = "pyzmq-25.1.2.tar.gz", hash = "sha256:93f1aa311e8bb912e34f004cf186407a4e90eec4f0ecc0efd26056bf7eda0226"},
-]
-referencing = [
- {file = "referencing-0.33.0-py3-none-any.whl", hash = "sha256:39240f2ecc770258f28b642dd47fd74bc8b02484de54e1882b74b35ebd779bd5"},
- {file = "referencing-0.33.0.tar.gz", hash = "sha256:c775fedf74bc0f9189c2a3be1c12fd03e8c23f4d371dce795df44e06c5b412f7"},
-]
-requests = [
- {file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"},
- {file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"},
-]
-rpds-py = [
- {file = "rpds_py-0.18.0-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:5b4e7d8d6c9b2e8ee2d55c90b59c707ca59bc30058269b3db7b1f8df5763557e"},
- {file = "rpds_py-0.18.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c463ed05f9dfb9baebef68048aed8dcdc94411e4bf3d33a39ba97e271624f8f7"},
- {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:01e36a39af54a30f28b73096dd39b6802eddd04c90dbe161c1b8dbe22353189f"},
- {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d62dec4976954a23d7f91f2f4530852b0c7608116c257833922a896101336c51"},
- {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dd18772815d5f008fa03d2b9a681ae38d5ae9f0e599f7dda233c439fcaa00d40"},
- {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:923d39efa3cfb7279a0327e337a7958bff00cc447fd07a25cddb0a1cc9a6d2da"},
- {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:39514da80f971362f9267c600b6d459bfbbc549cffc2cef8e47474fddc9b45b1"},
- {file = "rpds_py-0.18.0-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:a34d557a42aa28bd5c48a023c570219ba2593bcbbb8dc1b98d8cf5d529ab1434"},
- {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:93df1de2f7f7239dc9cc5a4a12408ee1598725036bd2dedadc14d94525192fc3"},
- {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:34b18ba135c687f4dac449aa5157d36e2cbb7c03cbea4ddbd88604e076aa836e"},
- {file = "rpds_py-0.18.0-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:c0b5dcf9193625afd8ecc92312d6ed78781c46ecbf39af9ad4681fc9f464af88"},
- {file = "rpds_py-0.18.0-cp310-none-win32.whl", hash = "sha256:c4325ff0442a12113a6379af66978c3fe562f846763287ef66bdc1d57925d337"},
- {file = "rpds_py-0.18.0-cp310-none-win_amd64.whl", hash = "sha256:7223a2a5fe0d217e60a60cdae28d6949140dde9c3bcc714063c5b463065e3d66"},
- {file = "rpds_py-0.18.0-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:3a96e0c6a41dcdba3a0a581bbf6c44bb863f27c541547fb4b9711fd8cf0ffad4"},
- {file = "rpds_py-0.18.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:30f43887bbae0d49113cbaab729a112251a940e9b274536613097ab8b4899cf6"},
- {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:fcb25daa9219b4cf3a0ab24b0eb9a5cc8949ed4dc72acb8fa16b7e1681aa3c58"},
- {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d68c93e381010662ab873fea609bf6c0f428b6d0bb00f2c6939782e0818d37bf"},
- {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b34b7aa8b261c1dbf7720b5d6f01f38243e9b9daf7e6b8bc1fd4657000062f2c"},
- {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2e6d75ab12b0bbab7215e5d40f1e5b738aa539598db27ef83b2ec46747df90e1"},
- {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b8612cd233543a3781bc659c731b9d607de65890085098986dfd573fc2befe5"},
- {file = "rpds_py-0.18.0-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:aec493917dd45e3c69d00a8874e7cbed844efd935595ef78a0f25f14312e33c6"},
- {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:661d25cbffaf8cc42e971dd570d87cb29a665f49f4abe1f9e76be9a5182c4688"},
- {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:1df3659d26f539ac74fb3b0c481cdf9d725386e3552c6fa2974f4d33d78e544b"},
- {file = "rpds_py-0.18.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:a1ce3ba137ed54f83e56fb983a5859a27d43a40188ba798993812fed73c70836"},
- {file = "rpds_py-0.18.0-cp311-none-win32.whl", hash = "sha256:69e64831e22a6b377772e7fb337533c365085b31619005802a79242fee620bc1"},
- {file = "rpds_py-0.18.0-cp311-none-win_amd64.whl", hash = "sha256:998e33ad22dc7ec7e030b3df701c43630b5bc0d8fbc2267653577e3fec279afa"},
- {file = "rpds_py-0.18.0-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:7f2facbd386dd60cbbf1a794181e6aa0bd429bd78bfdf775436020172e2a23f0"},
- {file = "rpds_py-0.18.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:1d9a5be316c15ffb2b3c405c4ff14448c36b4435be062a7f578ccd8b01f0c4d8"},
- {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cd5bf1af8efe569654bbef5a3e0a56eca45f87cfcffab31dd8dde70da5982475"},
- {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5417558f6887e9b6b65b4527232553c139b57ec42c64570569b155262ac0754f"},
- {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:56a737287efecafc16f6d067c2ea0117abadcd078d58721f967952db329a3e5c"},
- {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8f03bccbd8586e9dd37219bce4d4e0d3ab492e6b3b533e973fa08a112cb2ffc9"},
- {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4457a94da0d5c53dc4b3e4de1158bdab077db23c53232f37a3cb7afdb053a4e3"},
- {file = "rpds_py-0.18.0-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:0ab39c1ba9023914297dd88ec3b3b3c3f33671baeb6acf82ad7ce883f6e8e157"},
- {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:9d54553c1136b50fd12cc17e5b11ad07374c316df307e4cfd6441bea5fb68496"},
- {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:0af039631b6de0397ab2ba16eaf2872e9f8fca391b44d3d8cac317860a700a3f"},
- {file = "rpds_py-0.18.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:84ffab12db93b5f6bad84c712c92060a2d321b35c3c9960b43d08d0f639d60d7"},
- {file = "rpds_py-0.18.0-cp312-none-win32.whl", hash = "sha256:685537e07897f173abcf67258bee3c05c374fa6fff89d4c7e42fb391b0605e98"},
- {file = "rpds_py-0.18.0-cp312-none-win_amd64.whl", hash = "sha256:e003b002ec72c8d5a3e3da2989c7d6065b47d9eaa70cd8808b5384fbb970f4ec"},
- {file = "rpds_py-0.18.0-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:08f9ad53c3f31dfb4baa00da22f1e862900f45908383c062c27628754af2e88e"},
- {file = "rpds_py-0.18.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:c0013fe6b46aa496a6749c77e00a3eb07952832ad6166bd481c74bda0dcb6d58"},
- {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e32a92116d4f2a80b629778280103d2a510a5b3f6314ceccd6e38006b5e92dcb"},
- {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e541ec6f2ec456934fd279a3120f856cd0aedd209fc3852eca563f81738f6861"},
- {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bed88b9a458e354014d662d47e7a5baafd7ff81c780fd91584a10d6ec842cb73"},
- {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2644e47de560eb7bd55c20fc59f6daa04682655c58d08185a9b95c1970fa1e07"},
- {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8e8916ae4c720529e18afa0b879473049e95949bf97042e938530e072fde061d"},
- {file = "rpds_py-0.18.0-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:465a3eb5659338cf2a9243e50ad9b2296fa15061736d6e26240e713522b6235c"},
- {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:ea7d4a99f3b38c37eac212dbd6ec42b7a5ec51e2c74b5d3223e43c811609e65f"},
- {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:67071a6171e92b6da534b8ae326505f7c18022c6f19072a81dcf40db2638767c"},
- {file = "rpds_py-0.18.0-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:41ef53e7c58aa4ef281da975f62c258950f54b76ec8e45941e93a3d1d8580594"},
- {file = "rpds_py-0.18.0-cp38-none-win32.whl", hash = "sha256:fdea4952db2793c4ad0bdccd27c1d8fdd1423a92f04598bc39425bcc2b8ee46e"},
- {file = "rpds_py-0.18.0-cp38-none-win_amd64.whl", hash = "sha256:7cd863afe7336c62ec78d7d1349a2f34c007a3cc6c2369d667c65aeec412a5b1"},
- {file = "rpds_py-0.18.0-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:5307def11a35f5ae4581a0b658b0af8178c65c530e94893345bebf41cc139d33"},
- {file = "rpds_py-0.18.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:77f195baa60a54ef9d2de16fbbfd3ff8b04edc0c0140a761b56c267ac11aa467"},
- {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:39f5441553f1c2aed4de4377178ad8ff8f9d733723d6c66d983d75341de265ab"},
- {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:9a00312dea9310d4cb7dbd7787e722d2e86a95c2db92fbd7d0155f97127bcb40"},
- {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8f2fc11e8fe034ee3c34d316d0ad8808f45bc3b9ce5857ff29d513f3ff2923a1"},
- {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:586f8204935b9ec884500498ccc91aa869fc652c40c093bd9e1471fbcc25c022"},
- {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ddc2f4dfd396c7bfa18e6ce371cba60e4cf9d2e5cdb71376aa2da264605b60b9"},
- {file = "rpds_py-0.18.0-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:5ddcba87675b6d509139d1b521e0c8250e967e63b5909a7e8f8944d0f90ff36f"},
- {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:7bd339195d84439cbe5771546fe8a4e8a7a045417d8f9de9a368c434e42a721e"},
- {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:d7c36232a90d4755b720fbd76739d8891732b18cf240a9c645d75f00639a9024"},
- {file = "rpds_py-0.18.0-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:6b0817e34942b2ca527b0e9298373e7cc75f429e8da2055607f4931fded23e20"},
- {file = "rpds_py-0.18.0-cp39-none-win32.whl", hash = "sha256:99f70b740dc04d09e6b2699b675874367885217a2e9f782bdf5395632ac663b7"},
- {file = "rpds_py-0.18.0-cp39-none-win_amd64.whl", hash = "sha256:6ef687afab047554a2d366e112dd187b62d261d49eb79b77e386f94644363294"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:ad36cfb355e24f1bd37cac88c112cd7730873f20fb0bdaf8ba59eedf8216079f"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:36b3ee798c58ace201289024b52788161e1ea133e4ac93fba7d49da5fec0ef9e"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f8a2f084546cc59ea99fda8e070be2fd140c3092dc11524a71aa8f0f3d5a55ca"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e4461d0f003a0aa9be2bdd1b798a041f177189c1a0f7619fe8c95ad08d9a45d7"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8db715ebe3bb7d86d77ac1826f7d67ec11a70dbd2376b7cc214199360517b641"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:793968759cd0d96cac1e367afd70c235867831983f876a53389ad869b043c948"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:66e6a3af5a75363d2c9a48b07cb27c4ea542938b1a2e93b15a503cdfa8490795"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6ef0befbb5d79cf32d0266f5cff01545602344eda89480e1dd88aca964260b18"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:1d4acf42190d449d5e89654d5c1ed3a4f17925eec71f05e2a41414689cda02d1"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_i686.whl", hash = "sha256:a5f446dd5055667aabaee78487f2b5ab72e244f9bc0b2ffebfeec79051679984"},
- {file = "rpds_py-0.18.0-pp310-pypy310_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:9dbbeb27f4e70bfd9eec1be5477517365afe05a9b2c441a0b21929ee61048124"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-macosx_10_12_x86_64.whl", hash = "sha256:22806714311a69fd0af9b35b7be97c18a0fc2826e6827dbb3a8c94eac6cf7eeb"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-macosx_11_0_arm64.whl", hash = "sha256:b34ae4636dfc4e76a438ab826a0d1eed2589ca7d9a1b2d5bb546978ac6485461"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c8370641f1a7f0e0669ddccca22f1da893cef7628396431eb445d46d893e5cd"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c8362467a0fdeccd47935f22c256bec5e6abe543bf0d66e3d3d57a8fb5731863"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:11a8c85ef4a07a7638180bf04fe189d12757c696eb41f310d2426895356dcf05"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b316144e85316da2723f9d8dc75bada12fa58489a527091fa1d5a612643d1a0e"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cf1ea2e34868f6fbf070e1af291c8180480310173de0b0c43fc38a02929fc0e3"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:e546e768d08ad55b20b11dbb78a745151acbd938f8f00d0cfbabe8b0199b9880"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:4901165d170a5fde6f589acb90a6b33629ad1ec976d4529e769c6f3d885e3e80"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_i686.whl", hash = "sha256:618a3d6cae6ef8ec88bb76dd80b83cfe415ad4f1d942ca2a903bf6b6ff97a2da"},
- {file = "rpds_py-0.18.0-pp38-pypy38_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:ed4eb745efbff0a8e9587d22a84be94a5eb7d2d99c02dacf7bd0911713ed14dd"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:6c81e5f372cd0dc5dc4809553d34f832f60a46034a5f187756d9b90586c2c307"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:43fbac5f22e25bee1d482c97474f930a353542855f05c1161fd804c9dc74a09d"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6d7faa6f14017c0b1e69f5e2c357b998731ea75a442ab3841c0dbbbfe902d2c4"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:08231ac30a842bd04daabc4d71fddd7e6d26189406d5a69535638e4dcb88fe76"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:044a3e61a7c2dafacae99d1e722cc2d4c05280790ec5a05031b3876809d89a5c"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3f26b5bd1079acdb0c7a5645e350fe54d16b17bfc5e71f371c449383d3342e17"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:482103aed1dfe2f3b71a58eff35ba105289b8d862551ea576bd15479aba01f66"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:1374f4129f9bcca53a1bba0bb86bf78325a0374577cf7e9e4cd046b1e6f20e24"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_aarch64.whl", hash = "sha256:635dc434ff724b178cb192c70016cc0ad25a275228f749ee0daf0eddbc8183b1"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_i686.whl", hash = "sha256:bc362ee4e314870a70f4ae88772d72d877246537d9f8cb8f7eacf10884862432"},
- {file = "rpds_py-0.18.0-pp39-pypy39_pp73-musllinux_1_2_x86_64.whl", hash = "sha256:4832d7d380477521a8c1644bbab6588dfedea5e30a7d967b5fb75977c45fd77f"},
- {file = "rpds_py-0.18.0.tar.gz", hash = "sha256:42821446ee7a76f5d9f71f9e33a4fb2ffd724bb3e7f93386150b61a43115788d"},
-]
-ruamel-yaml = [
- {file = "ruamel.yaml-0.18.6-py3-none-any.whl", hash = "sha256:57b53ba33def16c4f3d807c0ccbc00f8a6081827e81ba2491691b76882d0c636"},
- {file = "ruamel.yaml-0.18.6.tar.gz", hash = "sha256:8b27e6a217e786c6fbe5634d8f3f11bc63e0f80f6a5890f28863d9c45aac311b"},
-]
-ruamel-yaml-clib = [
- {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:b42169467c42b692c19cf539c38d4602069d8c1505e97b86387fcf7afb766e1d"},
- {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-macosx_13_0_arm64.whl", hash = "sha256:07238db9cbdf8fc1e9de2489a4f68474e70dffcb32232db7c08fa61ca0c7c462"},
- {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_24_x86_64.whl", hash = "sha256:fff3573c2db359f091e1589c3d7c5fc2f86f5bdb6f24252c2d8e539d4e45f412"},
- {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-win32.whl", hash = "sha256:c69212f63169ec1cfc9bb44723bf2917cbbd8f6191a00ef3410f5a7fe300722d"},
- {file = "ruamel.yaml.clib-0.2.8-cp310-cp310-win_amd64.whl", hash = "sha256:cabddb8d8ead485e255fe80429f833172b4cadf99274db39abc080e068cbcc31"},
- {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:bef08cd86169d9eafb3ccb0a39edb11d8e25f3dae2b28f5c52fd997521133069"},
- {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-macosx_13_0_arm64.whl", hash = "sha256:b16420e621d26fdfa949a8b4b47ade8810c56002f5389970db4ddda51dbff248"},
- {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_24_x86_64.whl", hash = "sha256:25c515e350e5b739842fc3228d662413ef28f295791af5e5110b543cf0b57d9b"},
- {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-win32.whl", hash = "sha256:53a300ed9cea38cf5a2a9b069058137c2ca1ce658a874b79baceb8f892f915a7"},
- {file = "ruamel.yaml.clib-0.2.8-cp311-cp311-win_amd64.whl", hash = "sha256:c2a72e9109ea74e511e29032f3b670835f8a59bbdc9ce692c5b4ed91ccf1eedb"},
- {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:ebc06178e8821efc9692ea7544aa5644217358490145629914d8020042c24aa1"},
- {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-macosx_13_0_arm64.whl", hash = "sha256:edaef1c1200c4b4cb914583150dcaa3bc30e592e907c01117c08b13a07255ec2"},
- {file = "ruamel.yaml.clib-0.2.8-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d176b57452ab5b7028ac47e7b3cf644bcfdc8cacfecf7e71759f7f51a59e5c92"},
- {file = "ruamel.yaml.clib-0.2.8-cp36-cp36m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:a5aa27bad2bb83670b71683aae140a1f52b0857a2deff56ad3f6c13a017a26ed"},
- {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:c58ecd827313af6864893e7af0a3bb85fd529f862b6adbefe14643947cfe2942"},
- {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-macosx_12_0_arm64.whl", hash = "sha256:f481f16baec5290e45aebdc2a5168ebc6d35189ae6fea7a58787613a25f6e875"},
- {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:7f67a1ee819dc4562d444bbafb135832b0b909f81cc90f7aa00260968c9ca1b3"},
- {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-win32.whl", hash = "sha256:75e1ed13e1f9de23c5607fe6bd1aeaae21e523b32d83bb33918245361e9cc51b"},
- {file = "ruamel.yaml.clib-0.2.8-cp37-cp37m-win_amd64.whl", hash = "sha256:3f215c5daf6a9d7bbed4a0a4f760f3113b10e82ff4c5c44bec20a68c8014f675"},
- {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1b617618914cb00bf5c34d4357c37aa15183fa229b24767259657746c9077615"},
- {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-macosx_12_0_arm64.whl", hash = "sha256:a6a9ffd280b71ad062eae53ac1659ad86a17f59a0fdc7699fd9be40525153337"},
- {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:700e4ebb569e59e16a976857c8798aee258dceac7c7d6b50cab63e080058df91"},
- {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-win32.whl", hash = "sha256:955eae71ac26c1ab35924203fda6220f84dce57d6d7884f189743e2abe3a9fbe"},
- {file = "ruamel.yaml.clib-0.2.8-cp38-cp38-win_amd64.whl", hash = "sha256:56f4252222c067b4ce51ae12cbac231bce32aee1d33fbfc9d17e5b8d6966c312"},
- {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:03d1162b6d1df1caa3a4bd27aa51ce17c9afc2046c31b0ad60a0a96ec22f8001"},
- {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-macosx_12_0_arm64.whl", hash = "sha256:bba64af9fa9cebe325a62fa398760f5c7206b215201b0ec825005f1b18b9bccf"},
- {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.whl", hash = "sha256:da09ad1c359a728e112d60116f626cc9f29730ff3e0e7db72b9a2dbc2e4beed5"},
- {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-win32.whl", hash = "sha256:84b554931e932c46f94ab306913ad7e11bba988104c5cff26d90d03f68258cd5"},
- {file = "ruamel.yaml.clib-0.2.8-cp39-cp39-win_amd64.whl", hash = "sha256:25ac8c08322002b06fa1d49d1646181f0b2c72f5cbc15a85e80b4c30a544bb15"},
- {file = "ruamel.yaml.clib-0.2.8.tar.gz", hash = "sha256:beb2e0404003de9a4cab9753a8805a8fe9320ee6673136ed7f04255fe60bb512"},
-]
-scipy = [
- {file = "scipy-1.12.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:78e4402e140879387187f7f25d91cc592b3501a2e51dfb320f48dfb73565f10b"},
- {file = "scipy-1.12.0-cp310-cp310-macosx_12_0_arm64.whl", hash = "sha256:f5f00ebaf8de24d14b8449981a2842d404152774c1a1d880c901bf454cb8e2a1"},
- {file = "scipy-1.12.0-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e53958531a7c695ff66c2e7bb7b79560ffdc562e2051644c5576c39ff8efb563"},
- {file = "scipy-1.12.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5e32847e08da8d895ce09d108a494d9eb78974cf6de23063f93306a3e419960c"},
- {file = "scipy-1.12.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:4c1020cad92772bf44b8e4cdabc1df5d87376cb219742549ef69fc9fd86282dd"},
- {file = "scipy-1.12.0-cp310-cp310-win_amd64.whl", hash = "sha256:75ea2a144096b5e39402e2ff53a36fecfd3b960d786b7efd3c180e29c39e53f2"},
- {file = "scipy-1.12.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:408c68423f9de16cb9e602528be4ce0d6312b05001f3de61fe9ec8b1263cad08"},
- {file = "scipy-1.12.0-cp311-cp311-macosx_12_0_arm64.whl", hash = "sha256:5adfad5dbf0163397beb4aca679187d24aec085343755fcdbdeb32b3679f254c"},
- {file = "scipy-1.12.0-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c3003652496f6e7c387b1cf63f4bb720951cfa18907e998ea551e6de51a04467"},
- {file = "scipy-1.12.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8b8066bce124ee5531d12a74b617d9ac0ea59245246410e19bca549656d9a40a"},
- {file = "scipy-1.12.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:8bee4993817e204d761dba10dbab0774ba5a8612e57e81319ea04d84945375ba"},
- {file = "scipy-1.12.0-cp311-cp311-win_amd64.whl", hash = "sha256:a24024d45ce9a675c1fb8494e8e5244efea1c7a09c60beb1eeb80373d0fecc70"},
- {file = "scipy-1.12.0-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:e7e76cc48638228212c747ada851ef355c2bb5e7f939e10952bc504c11f4e372"},
- {file = "scipy-1.12.0-cp312-cp312-macosx_12_0_arm64.whl", hash = "sha256:f7ce148dffcd64ade37b2df9315541f9adad6efcaa86866ee7dd5db0c8f041c3"},
- {file = "scipy-1.12.0-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:9c39f92041f490422924dfdb782527a4abddf4707616e07b021de33467f917bc"},
- {file = "scipy-1.12.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a7ebda398f86e56178c2fa94cad15bf457a218a54a35c2a7b4490b9f9cb2676c"},
- {file = "scipy-1.12.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:95e5c750d55cf518c398a8240571b0e0782c2d5a703250872f36eaf737751338"},
- {file = "scipy-1.12.0-cp312-cp312-win_amd64.whl", hash = "sha256:e646d8571804a304e1da01040d21577685ce8e2db08ac58e543eaca063453e1c"},
- {file = "scipy-1.12.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:913d6e7956c3a671de3b05ccb66b11bc293f56bfdef040583a7221d9e22a2e35"},
- {file = "scipy-1.12.0-cp39-cp39-macosx_12_0_arm64.whl", hash = "sha256:bba1b0c7256ad75401c73e4b3cf09d1f176e9bd4248f0d3112170fb2ec4db067"},
- {file = "scipy-1.12.0-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:730badef9b827b368f351eacae2e82da414e13cf8bd5051b4bdfd720271a5371"},
- {file = "scipy-1.12.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6546dc2c11a9df6926afcbdd8a3edec28566e4e785b915e849348c6dd9f3f490"},
- {file = "scipy-1.12.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:196ebad3a4882081f62a5bf4aeb7326aa34b110e533aab23e4374fcccb0890dc"},
- {file = "scipy-1.12.0-cp39-cp39-win_amd64.whl", hash = "sha256:b360f1b6b2f742781299514e99ff560d1fe9bd1bff2712894b52abe528d1fd1e"},
- {file = "scipy-1.12.0.tar.gz", hash = "sha256:4bf5abab8a36d20193c698b0f1fc282c1d083c94723902c447e5d2f1780936a3"},
-]
-setuptools = [
- {file = "setuptools-69.1.1-py3-none-any.whl", hash = "sha256:02fa291a0471b3a18b2b2481ed902af520c69e8ae0919c13da936542754b4c56"},
- {file = "setuptools-69.1.1.tar.gz", hash = "sha256:5c0806c7d9af348e6dd3777b4f4dbb42c7ad85b190104837488eab9a7c945cf8"},
-]
-shapely = [
- {file = "Shapely-1.8.5.post1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:d048f93e42ba578b82758c15d8ae037d08e69d91d9872bca5a1895b118f4e2b0"},
- {file = "Shapely-1.8.5.post1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:99ab0ddc05e44acabdbe657c599fdb9b2d82e86c5493bdae216c0c4018a82dee"},
- {file = "Shapely-1.8.5.post1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:99a2f0da0109e81e0c101a2b4cd8412f73f5f299e7b5b2deaf64cd2a100ac118"},
- {file = "Shapely-1.8.5.post1-cp310-cp310-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:6fe855e7d45685926b6ba00aaeb5eba5862611f7465775dacd527e081a8ced6d"},
- {file = "Shapely-1.8.5.post1-cp310-cp310-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:ec14ceca36f67cb48b34d02d7f65a9acae15cd72b48e303531893ba4a960f3ea"},
- {file = "Shapely-1.8.5.post1-cp310-cp310-win32.whl", hash = "sha256:21776184516a16bf82a0c3d6d6a312b3cd15a4cabafc61ee01cf2714a82e8396"},
- {file = "Shapely-1.8.5.post1-cp310-cp310-win_amd64.whl", hash = "sha256:a354199219c8d836f280b88f2c5102c81bb044ccea45bd361dc38a79f3873714"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:783bad5f48e2708a0e2f695a34ed382e4162c795cb2f0368b39528ac1d6db7ed"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:a23ef3882d6aa203dd3623a3d55d698f59bfbd9f8a3bfed52c2da05a7f0f8640"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ab38f7b5196ace05725e407cb8cab9ff66edb8e6f7bb36a398e8f73f52a7aaa2"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8d086591f744be483b34628b391d741e46f2645fe37594319e0a673cc2c26bcf"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4728666fff8cccc65a07448cae72c75a8773fea061c3f4f139c44adc429b18c3"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-win32.whl", hash = "sha256:84010db15eb364a52b74ea8804ef92a6a930dfc1981d17a369444b6ddec66efd"},
- {file = "Shapely-1.8.5.post1-cp311-cp311-win_amd64.whl", hash = "sha256:48dcfffb9e225c0481120f4bdf622131c8c95f342b00b158cdbe220edbbe20b6"},
- {file = "Shapely-1.8.5.post1-cp36-cp36m-macosx_10_9_x86_64.whl", hash = "sha256:2fd15397638df291c427a53d641d3e6fd60458128029c8c4f487190473a69a91"},
- {file = "Shapely-1.8.5.post1-cp36-cp36m-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:a74631e511153366c6dbe3229fa93f877e3c87ea8369cd00f1d38c76b0ed9ace"},
- {file = "Shapely-1.8.5.post1-cp36-cp36m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:66bdac74fbd1d3458fa787191a90fa0ae610f09e2a5ec398c36f968cc0ed743f"},
- {file = "Shapely-1.8.5.post1-cp36-cp36m-win32.whl", hash = "sha256:6d388c0c1bd878ed1af4583695690aa52234b02ed35f93a1c8486ff52a555838"},
- {file = "Shapely-1.8.5.post1-cp36-cp36m-win_amd64.whl", hash = "sha256:be9423d5a3577ac2e92c7e758bd8a2b205f5e51a012177a590bc46fc51eb4834"},
- {file = "Shapely-1.8.5.post1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:5d7f85c2d35d39ff53c9216bc76b7641c52326f7e09aaad1789a3611a0f812f2"},
- {file = "Shapely-1.8.5.post1-cp37-cp37m-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:adcf8a11b98af9375e32bff91de184f33a68dc48b9cb9becad4f132fa25cfa3c"},
- {file = "Shapely-1.8.5.post1-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:753ed0e21ab108bd4282405b9b659f2e985e8502b1a72b978eaa51d3496dee19"},
- {file = "Shapely-1.8.5.post1-cp37-cp37m-win32.whl", hash = "sha256:65b21243d8f6bcd421210daf1fabb9de84de2c04353c5b026173b88d17c1a581"},
- {file = "Shapely-1.8.5.post1-cp37-cp37m-win_amd64.whl", hash = "sha256:370b574c78dc5af3a198a6da5d9b3d7c04654bd2ef7e80e80a3a0992dfb2d9cd"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:532a55ee2a6c52d23d6f7d1567c8f0473635f3b270262c44e1b0c88096827e22"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:3480657460e939f45a7d359ef0e172a081f249312557fe9aa78c4fd3a362d993"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:b65f5d530ba91e49ffc7c589255e878d2506a8b96ffce69d3b7c4500a9a9eaf8"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:147066da0be41b147a61f8eb805dea3b13709dbc873a431ccd7306e24d712bc0"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:c2822111ddc5bcfb116e6c663e403579d0fe3f147d2a97426011a191c43a7458"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-win32.whl", hash = "sha256:2e0a8c2e55f1be1312b51c92b06462ea89e6bb703fab4b114e7a846d941cfc40"},
- {file = "Shapely-1.8.5.post1-cp38-cp38-win_amd64.whl", hash = "sha256:0d885cb0cf670c1c834df3f371de8726efdf711f18e2a75da5cfa82843a7ab65"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:0b4ee3132ee90f07d63db3aea316c4c065ed7a26231458dda0874414a09d6ba3"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:02dd5d7dc6e46515d88874134dc8fcdc65826bca93c3eecee59d1910c42c1b17"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c6a9a4a31cd6e86d0fbe8473ceed83d4fe760b19d949fb557ef668defafea0f6"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-manylinux_2_12_i686.manylinux2010_i686.whl", hash = "sha256:38f0fbbcb8ca20c16451c966c1f527cc43968e121c8a048af19ed3e339a921cd"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl", hash = "sha256:78fb9d929b8ee15cfd424b6c10879ce1907f24e05fb83310fc47d2cd27088e40"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-win32.whl", hash = "sha256:8e59817b0fe63d34baedaabba8c393c0090f061917d18fc0bcc2f621937a8f73"},
- {file = "Shapely-1.8.5.post1-cp39-cp39-win_amd64.whl", hash = "sha256:e9c30b311de2513555ab02464ebb76115d242842b29c412f5a9aa0cac57be9f6"},
- {file = "Shapely-1.8.5.post1.tar.gz", hash = "sha256:ef3be705c3eac282a28058e6c6e5503419b250f482320df2172abcbea642c831"},
-]
-six = [
- {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"},
- {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"},
-]
-snowballstemmer = [
- {file = "snowballstemmer-2.2.0-py2.py3-none-any.whl", hash = "sha256:c8e1716e83cc398ae16824e5572ae04e0d9fc2c6b985fb0f900f5f0c96ecba1a"},
- {file = "snowballstemmer-2.2.0.tar.gz", hash = "sha256:09b16deb8547d3412ad7b590689584cd0fe25ec8db3be37788be3810cbf19cb1"},
-]
-sortedcontainers = [
- {file = "sortedcontainers-2.4.0-py2.py3-none-any.whl", hash = "sha256:a163dcaede0f1c021485e957a39245190e74249897e2ae4b2aa38595db237ee0"},
- {file = "sortedcontainers-2.4.0.tar.gz", hash = "sha256:25caa5a06cc30b6b83d11423433f65d1f9d76c4c6a0c90e3379eaa43b9bfdb88"},
-]
-sphinx = [
- {file = "sphinx-7.2.6-py3-none-any.whl", hash = "sha256:1e09160a40b956dc623c910118fa636da93bd3ca0b9876a7b3df90f07d691560"},
- {file = "sphinx-7.2.6.tar.gz", hash = "sha256:9a5160e1ea90688d5963ba09a2dcd8bdd526620edbb65c328728f1b2228d5ab5"},
-]
-sphinx-rtd-theme = [
- {file = "sphinx_rtd_theme-1.3.0-py2.py3-none-any.whl", hash = "sha256:46ddef89cc2416a81ecfbeaceab1881948c014b1b6e4450b815311a89fb977b0"},
- {file = "sphinx_rtd_theme-1.3.0.tar.gz", hash = "sha256:590b030c7abb9cf038ec053b95e5380b5c70d61591eb0b552063fbe7c41f0931"},
-]
-sphinxcontrib-applehelp = [
- {file = "sphinxcontrib_applehelp-1.0.8-py3-none-any.whl", hash = "sha256:cb61eb0ec1b61f349e5cc36b2028e9e7ca765be05e49641c97241274753067b4"},
- {file = "sphinxcontrib_applehelp-1.0.8.tar.gz", hash = "sha256:c40a4f96f3776c4393d933412053962fac2b84f4c99a7982ba42e09576a70619"},
-]
-sphinxcontrib-bibtex = [
- {file = "sphinxcontrib-bibtex-2.5.0.tar.gz", hash = "sha256:71b42e5db0e2e284f243875326bf9936aa9a763282277d75048826fef5b00eaa"},
- {file = "sphinxcontrib_bibtex-2.5.0-py3-none-any.whl", hash = "sha256:748f726eaca6efff7731012103417ef130ecdcc09501b4d0c54283bf5f059f76"},
-]
-sphinxcontrib-devhelp = [
- {file = "sphinxcontrib_devhelp-1.0.6-py3-none-any.whl", hash = "sha256:6485d09629944511c893fa11355bda18b742b83a2b181f9a009f7e500595c90f"},
- {file = "sphinxcontrib_devhelp-1.0.6.tar.gz", hash = "sha256:9893fd3f90506bc4b97bdb977ceb8fbd823989f4316b28c3841ec128544372d3"},
-]
-sphinxcontrib-htmlhelp = [
- {file = "sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl", hash = "sha256:393f04f112b4d2f53d93448d4bce35842f62b307ccdc549ec1585e950bc35e04"},
- {file = "sphinxcontrib_htmlhelp-2.0.5.tar.gz", hash = "sha256:0dc87637d5de53dd5eec3a6a01753b1ccf99494bd756aafecd74b4fa9e729015"},
-]
-sphinxcontrib-jquery = [
- {file = "sphinxcontrib-jquery-4.1.tar.gz", hash = "sha256:1620739f04e36a2c779f1a131a2dfd49b2fd07351bf1968ced074365933abc7a"},
- {file = "sphinxcontrib_jquery-4.1-py2.py3-none-any.whl", hash = "sha256:f936030d7d0147dd026a4f2b5a57343d233f1fc7b363f68b3d4f1cb0993878ae"},
-]
-sphinxcontrib-jsmath = [
+
+[package.dependencies]
+Sphinx = ">=1.8"
+
+[[package]]
+name = "sphinxcontrib-jsmath"
+version = "1.0.1"
+description = "A sphinx extension which renders display math in HTML via JavaScript"
+optional = false
+python-versions = ">=3.5"
+files = [
{file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"},
{file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"},
]
-sphinxcontrib-mermaid = [
+
+[package.extras]
+test = ["flake8", "mypy", "pytest"]
+
+[[package]]
+name = "sphinxcontrib-mermaid"
+version = "0.9.2"
+description = "Mermaid diagrams in yours Sphinx powered docs"
+optional = false
+python-versions = ">=3.7"
+files = [
{file = "sphinxcontrib-mermaid-0.9.2.tar.gz", hash = "sha256:252ef13dd23164b28f16d8b0205cf184b9d8e2b714a302274d9f59eb708e77af"},
{file = "sphinxcontrib_mermaid-0.9.2-py3-none-any.whl", hash = "sha256:6795a72037ca55e65663d2a2c1a043d636dc3d30d418e56dd6087d1459d98a5d"},
]
-sphinxcontrib-qthelp = [
+
+[[package]]
+name = "sphinxcontrib-qthelp"
+version = "1.0.7"
+description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp documents"
+optional = false
+python-versions = ">=3.9"
+files = [
{file = "sphinxcontrib_qthelp-1.0.7-py3-none-any.whl", hash = "sha256:e2ae3b5c492d58fcbd73281fbd27e34b8393ec34a073c792642cd8e529288182"},
{file = "sphinxcontrib_qthelp-1.0.7.tar.gz", hash = "sha256:053dedc38823a80a7209a80860b16b722e9e0209e32fea98c90e4e6624588ed6"},
]
-sphinxcontrib-serializinghtml = [
+
+[package.extras]
+lint = ["docutils-stubs", "flake8", "mypy"]
+standalone = ["Sphinx (>=5)"]
+test = ["pytest"]
+
+[[package]]
+name = "sphinxcontrib-serializinghtml"
+version = "1.1.10"
+description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)"
+optional = false
+python-versions = ">=3.9"
+files = [
{file = "sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl", hash = "sha256:326369b8df80a7d2d8d7f99aa5ac577f51ea51556ed974e7716cfd4fca3f6cb7"},
{file = "sphinxcontrib_serializinghtml-1.1.10.tar.gz", hash = "sha256:93f3f5dc458b91b192fe10c397e324f262cf163d79f3282c158e8436a2c4511f"},
]
-sqlalchemy = [
- {file = "SQLAlchemy-2.0.27-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:d04e579e911562f1055d26dab1868d3e0bb905db3bccf664ee8ad109f035618a"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:fa67d821c1fd268a5a87922ef4940442513b4e6c377553506b9db3b83beebbd8"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6c7a596d0be71b7baa037f4ac10d5e057d276f65a9a611c46970f012752ebf2d"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:954d9735ee9c3fa74874c830d089a815b7b48df6f6b6e357a74130e478dbd951"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:5cd20f58c29bbf2680039ff9f569fa6d21453fbd2fa84dbdb4092f006424c2e6"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:03f448ffb731b48323bda68bcc93152f751436ad6037f18a42b7e16af9e91c07"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-win32.whl", hash = "sha256:d997c5938a08b5e172c30583ba6b8aad657ed9901fc24caf3a7152eeccb2f1b4"},
- {file = "SQLAlchemy-2.0.27-cp310-cp310-win_amd64.whl", hash = "sha256:eb15ef40b833f5b2f19eeae65d65e191f039e71790dd565c2af2a3783f72262f"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:6c5bad7c60a392850d2f0fee8f355953abaec878c483dd7c3836e0089f046bf6"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a3012ab65ea42de1be81fff5fb28d6db893ef978950afc8130ba707179b4284a"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dbcd77c4d94b23e0753c5ed8deba8c69f331d4fd83f68bfc9db58bc8983f49cd"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d177b7e82f6dd5e1aebd24d9c3297c70ce09cd1d5d37b43e53f39514379c029c"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:680b9a36029b30cf063698755d277885d4a0eab70a2c7c6e71aab601323cba45"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:1306102f6d9e625cebaca3d4c9c8f10588735ef877f0360b5cdb4fdfd3fd7131"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-win32.whl", hash = "sha256:5b78aa9f4f68212248aaf8943d84c0ff0f74efc65a661c2fc68b82d498311fd5"},
- {file = "SQLAlchemy-2.0.27-cp311-cp311-win_amd64.whl", hash = "sha256:15e19a84b84528f52a68143439d0c7a3a69befcd4f50b8ef9b7b69d2628ae7c4"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:0de1263aac858f288a80b2071990f02082c51d88335a1db0d589237a3435fe71"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ce850db091bf7d2a1f2fdb615220b968aeff3849007b1204bf6e3e50a57b3d32"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8dfc936870507da96aebb43e664ae3a71a7b96278382bcfe84d277b88e379b18"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c4fbe6a766301f2e8a4519f4500fe74ef0a8509a59e07a4085458f26228cd7cc"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:4535c49d961fe9a77392e3a630a626af5baa967172d42732b7a43496c8b28876"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:0fb3bffc0ced37e5aa4ac2416f56d6d858f46d4da70c09bb731a246e70bff4d5"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-win32.whl", hash = "sha256:7f470327d06400a0aa7926b375b8e8c3c31d335e0884f509fe272b3c700a7254"},
- {file = "SQLAlchemy-2.0.27-cp312-cp312-win_amd64.whl", hash = "sha256:f9374e270e2553653d710ece397df67db9d19c60d2647bcd35bfc616f1622dcd"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e97cf143d74a7a5a0f143aa34039b4fecf11343eed66538610debc438685db4a"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d7b5a3e2120982b8b6bd1d5d99e3025339f7fb8b8267551c679afb39e9c7c7f1"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e36aa62b765cf9f43a003233a8c2d7ffdeb55bc62eaa0a0380475b228663a38f"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:5ada0438f5b74c3952d916c199367c29ee4d6858edff18eab783b3978d0db16d"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:b1d9d1bfd96eef3c3faedb73f486c89e44e64e40e5bfec304ee163de01cf996f"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-win32.whl", hash = "sha256:ca891af9f3289d24a490a5fde664ea04fe2f4984cd97e26de7442a4251bd4b7c"},
- {file = "SQLAlchemy-2.0.27-cp37-cp37m-win_amd64.whl", hash = "sha256:fd8aafda7cdff03b905d4426b714601c0978725a19efc39f5f207b86d188ba01"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:ec1f5a328464daf7a1e4e385e4f5652dd9b1d12405075ccba1df842f7774b4fc"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:ad862295ad3f644e3c2c0d8b10a988e1600d3123ecb48702d2c0f26771f1c396"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:48217be1de7d29a5600b5c513f3f7664b21d32e596d69582be0a94e36b8309cb"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9e56afce6431450442f3ab5973156289bd5ec33dd618941283847c9fd5ff06bf"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:611068511b5531304137bcd7fe8117c985d1b828eb86043bd944cebb7fae3910"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b86abba762ecfeea359112b2bb4490802b340850bbee1948f785141a5e020de8"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-win32.whl", hash = "sha256:30d81cc1192dc693d49d5671cd40cdec596b885b0ce3b72f323888ab1c3863d5"},
- {file = "SQLAlchemy-2.0.27-cp38-cp38-win_amd64.whl", hash = "sha256:120af1e49d614d2525ac247f6123841589b029c318b9afbfc9e2b70e22e1827d"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:d07ee7793f2aeb9b80ec8ceb96bc8cc08a2aec8a1b152da1955d64e4825fcbac"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:cb0845e934647232b6ff5150df37ceffd0b67b754b9fdbb095233deebcddbd4a"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1fc19ae2e07a067663dd24fca55f8ed06a288384f0e6e3910420bf4b1270cc51"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b90053be91973a6fb6020a6e44382c97739736a5a9d74e08cc29b196639eb979"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:2f5c9dfb0b9ab5e3a8a00249534bdd838d943ec4cfb9abe176a6c33408430230"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:33e8bde8fff203de50399b9039c4e14e42d4d227759155c21f8da4a47fc8053c"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-win32.whl", hash = "sha256:d873c21b356bfaf1589b89090a4011e6532582b3a8ea568a00e0c3aab09399dd"},
- {file = "SQLAlchemy-2.0.27-cp39-cp39-win_amd64.whl", hash = "sha256:ff2f1b7c963961d41403b650842dc2039175b906ab2093635d8319bef0b7d620"},
- {file = "SQLAlchemy-2.0.27-py3-none-any.whl", hash = "sha256:1ab4e0448018d01b142c916cc7119ca573803a4745cfe341b8f95657812700ac"},
- {file = "SQLAlchemy-2.0.27.tar.gz", hash = "sha256:86a6ed69a71fe6b88bf9331594fa390a2adda4a49b5c06f98e47bf0d392534f8"},
-]
-stack-data = [
+
+[package.extras]
+lint = ["docutils-stubs", "flake8", "mypy"]
+standalone = ["Sphinx (>=5)"]
+test = ["pytest"]
+
+[[package]]
+name = "sqlalchemy"
+version = "2.0.31"
+description = "Database Abstraction Library"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:f2a213c1b699d3f5768a7272de720387ae0122f1becf0901ed6eaa1abd1baf6c"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:9fea3d0884e82d1e33226935dac990b967bef21315cbcc894605db3441347443"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f3ad7f221d8a69d32d197e5968d798217a4feebe30144986af71ada8c548e9fa"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9f2bee229715b6366f86a95d497c347c22ddffa2c7c96143b59a2aa5cc9eebbc"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:cd5b94d4819c0c89280b7c6109c7b788a576084bf0a480ae17c227b0bc41e109"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:750900a471d39a7eeba57580b11983030517a1f512c2cb287d5ad0fcf3aebd58"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-win32.whl", hash = "sha256:7bd112be780928c7f493c1a192cd8c5fc2a2a7b52b790bc5a84203fb4381c6be"},
+ {file = "SQLAlchemy-2.0.31-cp310-cp310-win_amd64.whl", hash = "sha256:5a48ac4d359f058474fadc2115f78a5cdac9988d4f99eae44917f36aa1476327"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:f68470edd70c3ac3b6cd5c2a22a8daf18415203ca1b036aaeb9b0fb6f54e8298"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:2e2c38c2a4c5c634fe6c3c58a789712719fa1bf9b9d6ff5ebfce9a9e5b89c1ca"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:bd15026f77420eb2b324dcb93551ad9c5f22fab2c150c286ef1dc1160f110203"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2196208432deebdfe3b22185d46b08f00ac9d7b01284e168c212919891289396"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:352b2770097f41bff6029b280c0e03b217c2dcaddc40726f8f53ed58d8a85da4"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:56d51ae825d20d604583f82c9527d285e9e6d14f9a5516463d9705dab20c3740"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-win32.whl", hash = "sha256:6e2622844551945db81c26a02f27d94145b561f9d4b0c39ce7bfd2fda5776dac"},
+ {file = "SQLAlchemy-2.0.31-cp311-cp311-win_amd64.whl", hash = "sha256:ccaf1b0c90435b6e430f5dd30a5aede4764942a695552eb3a4ab74ed63c5b8d3"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:3b74570d99126992d4b0f91fb87c586a574a5872651185de8297c6f90055ae42"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6f77c4f042ad493cb8595e2f503c7a4fe44cd7bd59c7582fd6d78d7e7b8ec52c"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cd1591329333daf94467e699e11015d9c944f44c94d2091f4ac493ced0119449"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:74afabeeff415e35525bf7a4ecdab015f00e06456166a2eba7590e49f8db940e"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:b9c01990d9015df2c6f818aa8f4297d42ee71c9502026bb074e713d496e26b67"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:66f63278db425838b3c2b1c596654b31939427016ba030e951b292e32b99553e"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-win32.whl", hash = "sha256:0b0f658414ee4e4b8cbcd4a9bb0fd743c5eeb81fc858ca517217a8013d282c96"},
+ {file = "SQLAlchemy-2.0.31-cp312-cp312-win_amd64.whl", hash = "sha256:fa4b1af3e619b5b0b435e333f3967612db06351217c58bfb50cee5f003db2a5a"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:f43e93057cf52a227eda401251c72b6fbe4756f35fa6bfebb5d73b86881e59b0"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d337bf94052856d1b330d5fcad44582a30c532a2463776e1651bd3294ee7e58b"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c06fb43a51ccdff3b4006aafee9fcf15f63f23c580675f7734245ceb6b6a9e05"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-musllinux_1_2_aarch64.whl", hash = "sha256:b6e22630e89f0e8c12332b2b4c282cb01cf4da0d26795b7eae16702a608e7ca1"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-musllinux_1_2_x86_64.whl", hash = "sha256:79a40771363c5e9f3a77f0e28b3302801db08040928146e6808b5b7a40749c88"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-win32.whl", hash = "sha256:501ff052229cb79dd4c49c402f6cb03b5a40ae4771efc8bb2bfac9f6c3d3508f"},
+ {file = "SQLAlchemy-2.0.31-cp37-cp37m-win_amd64.whl", hash = "sha256:597fec37c382a5442ffd471f66ce12d07d91b281fd474289356b1a0041bdf31d"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:dc6d69f8829712a4fd799d2ac8d79bdeff651c2301b081fd5d3fe697bd5b4ab9"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:23b9fbb2f5dd9e630db70fbe47d963c7779e9c81830869bd7d137c2dc1ad05fb"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2a21c97efcbb9f255d5c12a96ae14da873233597dfd00a3a0c4ce5b3e5e79704"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:26a6a9837589c42b16693cf7bf836f5d42218f44d198f9343dd71d3164ceeeac"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:dc251477eae03c20fae8db9c1c23ea2ebc47331bcd73927cdcaecd02af98d3c3"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:2fd17e3bb8058359fa61248c52c7b09a97cf3c820e54207a50af529876451808"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-win32.whl", hash = "sha256:c76c81c52e1e08f12f4b6a07af2b96b9b15ea67ccdd40ae17019f1c373faa227"},
+ {file = "SQLAlchemy-2.0.31-cp38-cp38-win_amd64.whl", hash = "sha256:4b600e9a212ed59355813becbcf282cfda5c93678e15c25a0ef896b354423238"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:5b6cf796d9fcc9b37011d3f9936189b3c8074a02a4ed0c0fbbc126772c31a6d4"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:78fe11dbe37d92667c2c6e74379f75746dc947ee505555a0197cfba9a6d4f1a4"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2fc47dc6185a83c8100b37acda27658fe4dbd33b7d5e7324111f6521008ab4fe"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8a41514c1a779e2aa9a19f67aaadeb5cbddf0b2b508843fcd7bafdf4c6864005"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:afb6dde6c11ea4525318e279cd93c8734b795ac8bb5dda0eedd9ebaca7fa23f1"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:3f9faef422cfbb8fd53716cd14ba95e2ef655400235c3dfad1b5f467ba179c8c"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-win32.whl", hash = "sha256:fc6b14e8602f59c6ba893980bea96571dd0ed83d8ebb9c4479d9ed5425d562e9"},
+ {file = "SQLAlchemy-2.0.31-cp39-cp39-win_amd64.whl", hash = "sha256:3cb8a66b167b033ec72c3812ffc8441d4e9f5f78f5e31e54dcd4c90a4ca5bebc"},
+ {file = "SQLAlchemy-2.0.31-py3-none-any.whl", hash = "sha256:69f3e3c08867a8e4856e92d7afb618b95cdee18e0bc1647b77599722c9a28911"},
+ {file = "SQLAlchemy-2.0.31.tar.gz", hash = "sha256:b607489dd4a54de56984a0c7656247504bd5523d9d0ba799aef59d4add009484"},
+]
+
+[package.dependencies]
+greenlet = {version = "!=0.4.17", markers = "python_version < \"3.13\" and (platform_machine == \"aarch64\" or platform_machine == \"ppc64le\" or platform_machine == \"x86_64\" or platform_machine == \"amd64\" or platform_machine == \"AMD64\" or platform_machine == \"win32\" or platform_machine == \"WIN32\")"}
+typing-extensions = ">=4.6.0"
+
+[package.extras]
+aiomysql = ["aiomysql (>=0.2.0)", "greenlet (!=0.4.17)"]
+aioodbc = ["aioodbc", "greenlet (!=0.4.17)"]
+aiosqlite = ["aiosqlite", "greenlet (!=0.4.17)", "typing_extensions (!=3.10.0.1)"]
+asyncio = ["greenlet (!=0.4.17)"]
+asyncmy = ["asyncmy (>=0.2.3,!=0.2.4,!=0.2.6)", "greenlet (!=0.4.17)"]
+mariadb-connector = ["mariadb (>=1.0.1,!=1.1.2,!=1.1.5)"]
+mssql = ["pyodbc"]
+mssql-pymssql = ["pymssql"]
+mssql-pyodbc = ["pyodbc"]
+mypy = ["mypy (>=0.910)"]
+mysql = ["mysqlclient (>=1.4.0)"]
+mysql-connector = ["mysql-connector-python"]
+oracle = ["cx_oracle (>=8)"]
+oracle-oracledb = ["oracledb (>=1.0.1)"]
+postgresql = ["psycopg2 (>=2.7)"]
+postgresql-asyncpg = ["asyncpg", "greenlet (!=0.4.17)"]
+postgresql-pg8000 = ["pg8000 (>=1.29.1)"]
+postgresql-psycopg = ["psycopg (>=3.0.7)"]
+postgresql-psycopg2binary = ["psycopg2-binary"]
+postgresql-psycopg2cffi = ["psycopg2cffi"]
+postgresql-psycopgbinary = ["psycopg[binary] (>=3.0.7)"]
+pymysql = ["pymysql"]
+sqlcipher = ["sqlcipher3_binary"]
+
+[[package]]
+name = "stack-data"
+version = "0.6.3"
+description = "Extract data from python stack frames and tracebacks for informative displays"
+optional = false
+python-versions = "*"
+files = [
{file = "stack_data-0.6.3-py3-none-any.whl", hash = "sha256:d5558e0c25a4cb0853cddad3d77da9891a08cb85dd9f9f91b9f8cd66e511e695"},
{file = "stack_data-0.6.3.tar.gz", hash = "sha256:836a778de4fec4dcd1dcd89ed8abff8a221f58308462e1c4aa2a3cf30148f0b9"},
]
-tabulate = [
+
+[package.dependencies]
+asttokens = ">=2.1.0"
+executing = ">=1.2.0"
+pure-eval = "*"
+
+[package.extras]
+tests = ["cython", "littleutils", "pygments", "pytest", "typeguard"]
+
+[[package]]
+name = "tabulate"
+version = "0.9.0"
+description = "Pretty-print tabular data"
+optional = false
+python-versions = ">=3.7"
+files = [
{file = "tabulate-0.9.0-py3-none-any.whl", hash = "sha256:024ca478df22e9340661486f85298cff5f6dcdba14f3813e8830015b9ed1948f"},
{file = "tabulate-0.9.0.tar.gz", hash = "sha256:0095b12bf5966de529c0feb1fa08671671b3368eec77d7ef7ab114be2c068b3c"},
]
-tomli = [
+
+[package.extras]
+widechars = ["wcwidth"]
+
+[[package]]
+name = "terminado"
+version = "0.18.1"
+description = "Tornado websocket backend for the Xterm.js Javascript terminal emulator library."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "terminado-0.18.1-py3-none-any.whl", hash = "sha256:a4468e1b37bb318f8a86514f65814e1afc977cf29b3992a4500d9dd305dcceb0"},
+ {file = "terminado-0.18.1.tar.gz", hash = "sha256:de09f2c4b85de4765f7714688fff57d3e75bad1f909b589fde880460c753fd2e"},
+]
+
+[package.dependencies]
+ptyprocess = {version = "*", markers = "os_name != \"nt\""}
+pywinpty = {version = ">=1.1.0", markers = "os_name == \"nt\""}
+tornado = ">=6.1.0"
+
+[package.extras]
+docs = ["myst-parser", "pydata-sphinx-theme", "sphinx"]
+test = ["pre-commit", "pytest (>=7.0)", "pytest-timeout"]
+typing = ["mypy (>=1.6,<2.0)", "traitlets (>=5.11.1)"]
+
+[[package]]
+name = "tinycss2"
+version = "1.3.0"
+description = "A tiny CSS parser"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "tinycss2-1.3.0-py3-none-any.whl", hash = "sha256:54a8dbdffb334d536851be0226030e9505965bb2f30f21a4a82c55fb2a80fae7"},
+ {file = "tinycss2-1.3.0.tar.gz", hash = "sha256:152f9acabd296a8375fbca5b84c961ff95971fcfc32e79550c8df8e29118c54d"},
+]
+
+[package.dependencies]
+webencodings = ">=0.4"
+
+[package.extras]
+doc = ["sphinx", "sphinx_rtd_theme"]
+test = ["pytest", "ruff"]
+
+[[package]]
+name = "tomli"
+version = "2.0.1"
+description = "A lil' TOML parser"
+optional = false
+python-versions = ">=3.7"
+files = [
{file = "tomli-2.0.1-py3-none-any.whl", hash = "sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"},
{file = "tomli-2.0.1.tar.gz", hash = "sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f"},
]
-tomli-w = [
+
+[[package]]
+name = "tomli-w"
+version = "1.0.0"
+description = "A lil' TOML writer"
+optional = false
+python-versions = ">=3.7"
+files = [
{file = "tomli_w-1.0.0-py3-none-any.whl", hash = "sha256:9f2a07e8be30a0729e533ec968016807069991ae2fd921a78d42f429ae5f4463"},
{file = "tomli_w-1.0.0.tar.gz", hash = "sha256:f463434305e0336248cac9c2dc8076b707d8a12d019dd349f5c1e382dd1ae1b9"},
]
-toolz = [
+
+[[package]]
+name = "toolz"
+version = "0.12.1"
+description = "List processing tools and functional utilities"
+optional = false
+python-versions = ">=3.7"
+files = [
{file = "toolz-0.12.1-py3-none-any.whl", hash = "sha256:d22731364c07d72eea0a0ad45bafb2c2937ab6fd38a3507bf55eae8744aa7d85"},
{file = "toolz-0.12.1.tar.gz", hash = "sha256:ecca342664893f177a13dac0e6b41cbd8ac25a358e5f215316d43e2100224f4d"},
]
-tornado = [
- {file = "tornado-6.4-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:02ccefc7d8211e5a7f9e8bc3f9e5b0ad6262ba2fbb683a6443ecc804e5224ce0"},
- {file = "tornado-6.4-cp38-abi3-macosx_10_9_x86_64.whl", hash = "sha256:27787de946a9cffd63ce5814c33f734c627a87072ec7eed71f7fc4417bb16263"},
- {file = "tornado-6.4-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f7894c581ecdcf91666a0912f18ce5e757213999e183ebfc2c3fdbf4d5bd764e"},
- {file = "tornado-6.4-cp38-abi3-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e43bc2e5370a6a8e413e1e1cd0c91bedc5bd62a74a532371042a18ef19e10579"},
- {file = "tornado-6.4-cp38-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f0251554cdd50b4b44362f73ad5ba7126fc5b2c2895cc62b14a1c2d7ea32f212"},
- {file = "tornado-6.4-cp38-abi3-musllinux_1_1_aarch64.whl", hash = "sha256:fd03192e287fbd0899dd8f81c6fb9cbbc69194d2074b38f384cb6fa72b80e9c2"},
- {file = "tornado-6.4-cp38-abi3-musllinux_1_1_i686.whl", hash = "sha256:88b84956273fbd73420e6d4b8d5ccbe913c65d31351b4c004ae362eba06e1f78"},
- {file = "tornado-6.4-cp38-abi3-musllinux_1_1_x86_64.whl", hash = "sha256:71ddfc23a0e03ef2df1c1397d859868d158c8276a0603b96cf86892bff58149f"},
- {file = "tornado-6.4-cp38-abi3-win32.whl", hash = "sha256:6f8a6c77900f5ae93d8b4ae1196472d0ccc2775cc1dfdc9e7727889145c45052"},
- {file = "tornado-6.4-cp38-abi3-win_amd64.whl", hash = "sha256:10aeaa8006333433da48dec9fe417877f8bcc21f48dda8d661ae79da357b2a63"},
- {file = "tornado-6.4.tar.gz", hash = "sha256:72291fa6e6bc84e626589f1c29d90a5a6d593ef5ae68052ee2ef000dfd273dee"},
-]
-tqdm = [
- {file = "tqdm-4.66.2-py3-none-any.whl", hash = "sha256:1ee4f8a893eb9bef51c6e35730cebf234d5d0b6bd112b0271e10ed7c24a02bd9"},
- {file = "tqdm-4.66.2.tar.gz", hash = "sha256:6cd52cdf0fef0e0f543299cfc96fec90d7b8a7e88745f411ec33eb44d5ed3531"},
-]
-traitlets = [
- {file = "traitlets-5.14.1-py3-none-any.whl", hash = "sha256:2e5a030e6eff91737c643231bfcf04a65b0132078dad75e4936700b213652e74"},
- {file = "traitlets-5.14.1.tar.gz", hash = "sha256:8585105b371a04b8316a43d5ce29c098575c2e477850b62b848b964f1444527e"},
-]
-types-dataclasses = [
+
+[[package]]
+name = "tornado"
+version = "6.4.1"
+description = "Tornado is a Python web framework and asynchronous networking library, originally developed at FriendFeed."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "tornado-6.4.1-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:163b0aafc8e23d8cdc3c9dfb24c5368af84a81e3364745ccb4427669bf84aec8"},
+ {file = "tornado-6.4.1-cp38-abi3-macosx_10_9_x86_64.whl", hash = "sha256:6d5ce3437e18a2b66fbadb183c1d3364fb03f2be71299e7d10dbeeb69f4b2a14"},
+ {file = "tornado-6.4.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e2e20b9113cd7293f164dc46fffb13535266e713cdb87bd2d15ddb336e96cfc4"},
+ {file = "tornado-6.4.1-cp38-abi3-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8ae50a504a740365267b2a8d1a90c9fbc86b780a39170feca9bcc1787ff80842"},
+ {file = "tornado-6.4.1-cp38-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:613bf4ddf5c7a95509218b149b555621497a6cc0d46ac341b30bd9ec19eac7f3"},
+ {file = "tornado-6.4.1-cp38-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:25486eb223babe3eed4b8aecbac33b37e3dd6d776bc730ca14e1bf93888b979f"},
+ {file = "tornado-6.4.1-cp38-abi3-musllinux_1_2_i686.whl", hash = "sha256:454db8a7ecfcf2ff6042dde58404164d969b6f5d58b926da15e6b23817950fc4"},
+ {file = "tornado-6.4.1-cp38-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:a02a08cc7a9314b006f653ce40483b9b3c12cda222d6a46d4ac63bb6c9057698"},
+ {file = "tornado-6.4.1-cp38-abi3-win32.whl", hash = "sha256:d9a566c40b89757c9aa8e6f032bcdb8ca8795d7c1a9762910c722b1635c9de4d"},
+ {file = "tornado-6.4.1-cp38-abi3-win_amd64.whl", hash = "sha256:b24b8982ed444378d7f21d563f4180a2de31ced9d8d84443907a0a64da2072e7"},
+ {file = "tornado-6.4.1.tar.gz", hash = "sha256:92d3ab53183d8c50f8204a51e6f91d18a15d5ef261e84d452800d4ff6fc504e9"},
+]
+
+[[package]]
+name = "tqdm"
+version = "4.66.4"
+description = "Fast, Extensible Progress Meter"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "tqdm-4.66.4-py3-none-any.whl", hash = "sha256:b75ca56b413b030bc3f00af51fd2c1a1a5eac6a0c1cca83cbb37a5c52abce644"},
+ {file = "tqdm-4.66.4.tar.gz", hash = "sha256:e4d936c9de8727928f3be6079590e97d9abfe8d39a590be678eb5919ffc186bb"},
+]
+
+[package.dependencies]
+colorama = {version = "*", markers = "platform_system == \"Windows\""}
+
+[package.extras]
+dev = ["pytest (>=6)", "pytest-cov", "pytest-timeout", "pytest-xdist"]
+notebook = ["ipywidgets (>=6)"]
+slack = ["slack-sdk"]
+telegram = ["requests"]
+
+[[package]]
+name = "traitlets"
+version = "5.14.3"
+description = "Traitlets Python configuration system"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "traitlets-5.14.3-py3-none-any.whl", hash = "sha256:b74e89e397b1ed28cc831db7aea759ba6640cb3de13090ca145426688ff1ac4f"},
+ {file = "traitlets-5.14.3.tar.gz", hash = "sha256:9ed0579d3502c94b4b3732ac120375cda96f923114522847de4b3bb98b96b6b7"},
+]
+
+[package.extras]
+docs = ["myst-parser", "pydata-sphinx-theme", "sphinx"]
+test = ["argcomplete (>=3.0.3)", "mypy (>=1.7.0)", "pre-commit", "pytest (>=7.0,<8.2)", "pytest-mock", "pytest-mypy-testing"]
+
+[[package]]
+name = "types-dataclasses"
+version = "0.6.6"
+description = "Typing stubs for dataclasses"
+optional = false
+python-versions = "*"
+files = [
{file = "types-dataclasses-0.6.6.tar.gz", hash = "sha256:4b5a2fcf8e568d5a1974cd69010e320e1af8251177ec968de7b9bb49aa49f7b9"},
{file = "types_dataclasses-0.6.6-py3-none-any.whl", hash = "sha256:a0a1ab5324ba30363a15c9daa0f053ae4fff914812a1ebd8ad84a08e5349574d"},
]
-types-jsonschema = [
- {file = "types-jsonschema-4.21.0.20240118.tar.gz", hash = "sha256:31aae1b5adc0176c1155c2d4f58348b22d92ae64315e9cc83bd6902168839232"},
- {file = "types_jsonschema-4.21.0.20240118-py3-none-any.whl", hash = "sha256:77a4ac36b0be4f24274d5b9bf0b66208ee771c05f80e34c4641de7d63e8a872d"},
+
+[[package]]
+name = "types-jsonschema"
+version = "4.22.0.20240610"
+description = "Typing stubs for jsonschema"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "types-jsonschema-4.22.0.20240610.tar.gz", hash = "sha256:f82ab9fe756e3a2642ea9712c46b403ce61eb380b939b696cff3252af42f65b0"},
+ {file = "types_jsonschema-4.22.0.20240610-py3-none-any.whl", hash = "sha256:89996b9bd1928f820a0e252b2844be21cd2e55d062b6fa1048d88453006ad89e"},
+]
+
+[package.dependencies]
+referencing = "*"
+
+[[package]]
+name = "types-python-dateutil"
+version = "2.9.0.20240316"
+description = "Typing stubs for python-dateutil"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "types-python-dateutil-2.9.0.20240316.tar.gz", hash = "sha256:5d2f2e240b86905e40944dd787db6da9263f0deabef1076ddaed797351ec0202"},
+ {file = "types_python_dateutil-2.9.0.20240316-py3-none-any.whl", hash = "sha256:6b8cb66d960771ce5ff974e9dd45e38facb81718cc1e208b10b1baccbfdbee3b"},
]
-types-tqdm = [
- {file = "types-tqdm-4.66.0.20240106.tar.gz", hash = "sha256:7acf4aade5bad3ded76eb829783f9961b1c2187948eaa6dd1ae8644dff95a938"},
- {file = "types_tqdm-4.66.0.20240106-py3-none-any.whl", hash = "sha256:7459b0f441b969735685645a5d8480f7912b10d05ab45f99a2db8a8e45cb550b"},
+
+[[package]]
+name = "types-tqdm"
+version = "4.66.0.20240417"
+description = "Typing stubs for tqdm"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "types-tqdm-4.66.0.20240417.tar.gz", hash = "sha256:16dce9ef522ea8d40e4f5b8d84dd8a1166eefc13ceee7a7e158bf0f1a1421a31"},
+ {file = "types_tqdm-4.66.0.20240417-py3-none-any.whl", hash = "sha256:248aef1f9986b7b8c2c12b3cb4399fc17dba0a29e7e3f3f9cd704babb879383d"},
]
-typing-extensions = [
- {file = "typing_extensions-4.10.0-py3-none-any.whl", hash = "sha256:69b1a937c3a517342112fb4c6df7e72fc39a38e7891a5730ed4985b5214b5475"},
- {file = "typing_extensions-4.10.0.tar.gz", hash = "sha256:b0abd7c89e8fb96f98db18d86106ff1d90ab692004eb746cf6eda2682f91b3cb"},
+
+[[package]]
+name = "typing-extensions"
+version = "4.12.2"
+description = "Backported and Experimental Type Hints for Python 3.8+"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
+ {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
]
-tzdata = [
+
+[[package]]
+name = "tzdata"
+version = "2024.1"
+description = "Provider of IANA time zone data"
+optional = false
+python-versions = ">=2"
+files = [
{file = "tzdata-2024.1-py2.py3-none-any.whl", hash = "sha256:9068bc196136463f5245e51efda838afa15aaeca9903f49050dfa2679db4d252"},
{file = "tzdata-2024.1.tar.gz", hash = "sha256:2674120f8d891909751c38abcdfd386ac0a5a1127954fbc332af6b5ceae07efd"},
]
-urllib3 = [
- {file = "urllib3-2.2.1-py3-none-any.whl", hash = "sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d"},
- {file = "urllib3-2.2.1.tar.gz", hash = "sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19"},
+
+[[package]]
+name = "uri-template"
+version = "1.3.0"
+description = "RFC 6570 URI Template Processor"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "uri-template-1.3.0.tar.gz", hash = "sha256:0e00f8eb65e18c7de20d595a14336e9f337ead580c70934141624b6d1ffdacc7"},
+ {file = "uri_template-1.3.0-py3-none-any.whl", hash = "sha256:a44a133ea12d44a0c0f06d7d42a52d71282e77e2f937d8abd5655b8d56fc1363"},
+]
+
+[package.extras]
+dev = ["flake8", "flake8-annotations", "flake8-bandit", "flake8-bugbear", "flake8-commas", "flake8-comprehensions", "flake8-continuation", "flake8-datetimez", "flake8-docstrings", "flake8-import-order", "flake8-literal", "flake8-modern-annotations", "flake8-noqa", "flake8-pyproject", "flake8-requirements", "flake8-typechecking-import", "flake8-use-fstring", "mypy", "pep8-naming", "types-PyYAML"]
+
+[[package]]
+name = "urllib3"
+version = "2.2.2"
+description = "HTTP library with thread-safe connection pooling, file post, and more."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "urllib3-2.2.2-py3-none-any.whl", hash = "sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472"},
+ {file = "urllib3-2.2.2.tar.gz", hash = "sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168"},
]
-virtualenv = [
- {file = "virtualenv-20.25.1-py3-none-any.whl", hash = "sha256:961c026ac520bac5f69acb8ea063e8a4f071bcc9457b9c1f28f6b085c511583a"},
- {file = "virtualenv-20.25.1.tar.gz", hash = "sha256:e08e13ecdca7a0bd53798f356d5831434afa5b07b93f0abdf0797b7a06ffe197"},
+
+[package.extras]
+brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"]
+h2 = ["h2 (>=4,<5)"]
+socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"]
+zstd = ["zstandard (>=0.18.0)"]
+
+[[package]]
+name = "virtualenv"
+version = "20.26.3"
+description = "Virtual Python Environment builder"
+optional = false
+python-versions = ">=3.7"
+files = [
+ {file = "virtualenv-20.26.3-py3-none-any.whl", hash = "sha256:8cc4a31139e796e9a7de2cd5cf2489de1217193116a8fd42328f1bd65f434589"},
+ {file = "virtualenv-20.26.3.tar.gz", hash = "sha256:4c43a2a236279d9ea36a0d76f98d84bd6ca94ac4e0f4a3b9d46d05e10fea542a"},
]
-wcwidth = [
+
+[package.dependencies]
+distlib = ">=0.3.7,<1"
+filelock = ">=3.12.2,<4"
+platformdirs = ">=3.9.1,<5"
+
+[package.extras]
+docs = ["furo (>=2023.7.26)", "proselint (>=0.13)", "sphinx (>=7.1.2,!=7.3)", "sphinx-argparse (>=0.4)", "sphinxcontrib-towncrier (>=0.2.1a0)", "towncrier (>=23.6)"]
+test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess (>=1)", "flaky (>=3.7)", "packaging (>=23.1)", "pytest (>=7.4)", "pytest-env (>=0.8.2)", "pytest-freezer (>=0.4.8)", "pytest-mock (>=3.11.1)", "pytest-randomly (>=3.12)", "pytest-timeout (>=2.1)", "setuptools (>=68)", "time-machine (>=2.10)"]
+
+[[package]]
+name = "wcwidth"
+version = "0.2.13"
+description = "Measures the displayed width of unicode strings in a terminal"
+optional = false
+python-versions = "*"
+files = [
{file = "wcwidth-0.2.13-py2.py3-none-any.whl", hash = "sha256:3da69048e4540d84af32131829ff948f1e022c1c6bdb8d6102117aac784f6859"},
{file = "wcwidth-0.2.13.tar.gz", hash = "sha256:72ea0c06399eb286d978fdedb6923a9eb47e1c486ce63e9b4e64fc18303972b5"},
]
-xarray = [
- {file = "xarray-2024.2.0-py3-none-any.whl", hash = "sha256:a31a9b37e39bd5aeb098070a75d6dd4d59019eb339d735b86108b9e0cb391f94"},
- {file = "xarray-2024.2.0.tar.gz", hash = "sha256:a105f02791082c888ebe2622090beaff2e7b68571488d62fe6afdab35b4b717f"},
+
+[[package]]
+name = "webcolors"
+version = "24.6.0"
+description = "A library for working with the color formats defined by HTML and CSS."
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "webcolors-24.6.0-py3-none-any.whl", hash = "sha256:8cf5bc7e28defd1d48b9e83d5fc30741328305a8195c29a8e668fa45586568a1"},
+ {file = "webcolors-24.6.0.tar.gz", hash = "sha256:1d160d1de46b3e81e58d0a280d0c78b467dc80f47294b91b1ad8029d2cedb55b"},
+]
+
+[package.extras]
+docs = ["furo", "sphinx", "sphinx-copybutton", "sphinx-inline-tabs", "sphinx-notfound-page", "sphinxext-opengraph"]
+tests = ["coverage[toml]"]
+
+[[package]]
+name = "webencodings"
+version = "0.5.1"
+description = "Character encoding aliases for legacy web content"
+optional = false
+python-versions = "*"
+files = [
+ {file = "webencodings-0.5.1-py2.py3-none-any.whl", hash = "sha256:a0af1213f3c2226497a97e2b3aa01a7e4bee4f403f95be16fc9acd2947514a78"},
+ {file = "webencodings-0.5.1.tar.gz", hash = "sha256:b36a1c245f2d304965eb4e0a82848379241dc04b865afcc4aab16748587e1923"},
+]
+
+[[package]]
+name = "websocket-client"
+version = "1.8.0"
+description = "WebSocket client for Python with low level API options"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "websocket_client-1.8.0-py3-none-any.whl", hash = "sha256:17b44cc997f5c498e809b22cdf2d9c7a9e71c02c8cc2b6c56e7c2d1239bfa526"},
+ {file = "websocket_client-1.8.0.tar.gz", hash = "sha256:3239df9f44da632f96012472805d40a23281a991027ce11d2f45a6f24ac4c3da"},
+]
+
+[package.extras]
+docs = ["Sphinx (>=6.0)", "myst-parser (>=2.0.0)", "sphinx-rtd-theme (>=1.1.0)"]
+optional = ["python-socks", "wsaccel"]
+test = ["websockets"]
+
+[[package]]
+name = "xarray"
+version = "2024.6.0"
+description = "N-D labeled arrays and datasets in Python"
+optional = false
+python-versions = ">=3.9"
+files = [
+ {file = "xarray-2024.6.0-py3-none-any.whl", hash = "sha256:721a7394e8ec3d592b2d8ebe21eed074ac077dc1bb1bd777ce00e41700b4866c"},
+ {file = "xarray-2024.6.0.tar.gz", hash = "sha256:0b91e0bc4dc0296947947640fe31ec6e867ce258d2f7cbc10bedf4a6d68340c7"},
]
-zipp = [
- {file = "zipp-3.17.0-py3-none-any.whl", hash = "sha256:0e923e726174922dce09c53c59ad483ff7bbb8e572e00c7f7c46b88556409f31"},
- {file = "zipp-3.17.0.tar.gz", hash = "sha256:84e64a1c28cf7e91ed2078bb8cc8c259cb19b76942096c8d7b84947690cabaf0"},
+
+[package.dependencies]
+numpy = ">=1.23"
+packaging = ">=23.1"
+pandas = ">=2.0"
+
+[package.extras]
+accel = ["bottleneck", "flox", "numbagg", "opt-einsum", "scipy"]
+complete = ["xarray[accel,dev,io,parallel,viz]"]
+dev = ["hypothesis", "mypy", "pre-commit", "pytest", "pytest-cov", "pytest-env", "pytest-timeout", "pytest-xdist", "ruff", "xarray[complete]"]
+io = ["cftime", "fsspec", "h5netcdf", "netCDF4", "pooch", "pydap", "scipy", "zarr"]
+parallel = ["dask[complete]"]
+viz = ["matplotlib", "nc-time-axis", "seaborn"]
+
+[[package]]
+name = "zipp"
+version = "3.19.2"
+description = "Backport of pathlib-compatible object wrapper for zip files"
+optional = false
+python-versions = ">=3.8"
+files = [
+ {file = "zipp-3.19.2-py3-none-any.whl", hash = "sha256:f091755f667055f2d02b32c53771a7a6c8b47e1fdbc4b72a8b9072b3eef8015c"},
+ {file = "zipp-3.19.2.tar.gz", hash = "sha256:bf1dcf6450f873a13e952a29504887c89e6de7506209e5b1bcc3460135d4de19"},
]
+
+[package.extras]
+doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-lint"]
+test = ["big-O", "importlib-resources", "jaraco.functools", "jaraco.itertools", "jaraco.test", "more-itertools", "pytest (>=6,!=8.1.*)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy", "pytest-ruff (>=0.2.1)"]
+
+[metadata]
+lock-version = "2.0"
+python-versions = ">=3.10,<3.13"
+content-hash = "c1b38ed1c480346543a234dee99a37a65523c6da3fbeb2a6848acc631895546b"
diff --git a/pyproject.toml b/pyproject.toml
index d518fefae..564857318 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -24,25 +24,25 @@ license = "BSD-3-Clause"
name = "virtual_ecosystem"
readme = "README.md"
repository = "https://github.com/ImperialCollegeLondon/virtual_ecosystem"
-version = "0.1.1a4"
+version = "0.1.1a5"
[tool.poetry.scripts]
ve_run = "virtual_ecosystem.entry_points:ve_run_cli"
[tool.poetry.dependencies]
-Shapely = "^1.8.4"
+Shapely = "^2.0"
dask = "^2023.6.0"
dpath = "^2.0.6"
jsonschema = "^4.14.0"
netcdf4 = "^1.6.5"
-numpy = "^1.23.0"
-pint = "^0.20.1"
-python = ">=3.10,<3.12"
+numpy = "^2.0"
+pint = "^0.24.1"
+python = ">=3.10,<3.13"
scipy = "^1.9.0"
tomli = {version = "^2.0.1", python = "<3.11"}
tomli-w = "^1.0.0"
tqdm = "^4.66.2"
-xarray = "^2024.02.0"
+xarray = "^2024.06.0"
[tool.poetry.group.types.dependencies]
types-dataclasses = "^0.6.6"
@@ -54,17 +54,15 @@ hypothesis = "^6.54.2"
pytest = "^7.1.2"
pytest-cov = "^3.0.0"
pytest-datadir = "^1.4.1"
-pytest-flake8 = "^1.1.1"
pytest-mock = "^3.8.1"
-pytest-mypy = "^0.10.3"
[tool.poetry.group.devenv.dependencies]
-black = "^22.6.0"
-flake8 = "^4.0.1"
-flake8-docstrings = "^1.6.0"
ipykernel = "^6.15.0"
ipython = "^8.4.0"
isort = "^5.12.0"
+jupyterlab = "^4.2.3"
+jupyterlab-myst = "^2.4.2"
+jupytext = "^1.16.2"
matplotlib = "^3.5.2"
mdformat = "^0.7.14"
mdformat_frontmatter = "^0.4.1"
@@ -77,10 +75,62 @@ autodocsumm = "^0.2.8"
myst-nb = "^1.0.0"
pydocstyle = "^6.1.1"
sphinx = "^7.0.0"
-sphinx-rtd-theme = "^1.0.0"
-sphinxcontrib-bibtex = "^2.4.2"
+sphinx-design = "^0.6.0"
+sphinx-external-toc = "^1.0.0"
+sphinx-rtd-theme = "^2.0.0"
+sphinxcontrib-bibtex = "^2.6.1"
sphinxcontrib-mermaid = "^0.9.2"
[build-system]
build-backend = "poetry.core.masonry.api"
requires = ["poetry-core>=1.2.0"]
+
+[tool.pytest.ini_options]
+addopts = """
+ -v
+ -p no:warnings
+ --cov=virtual_ecosystem
+ --cov-report=html:htmlcov/coverage
+ --doctest-modules --ignore=virtual_ecosystem/__main__.py
+ --import-mode importlib
+ """
+python_files = 'test_*.py'
+testpaths = ['tests']
+
+[tool.ruff]
+target-version = "py310"
+
+[tool.ruff.lint]
+# Enable all `pydocstyle` rules, limiting to those that adhere to the
+# Google convention via `convention = "google"`, below.
+select = [
+ # "B", # flake8-bugbear
+ # "SIM", # flake8-simplify
+ "E", # pycodestyle
+ "F", # pyflakes
+ "D", # pydocstyle
+ "I", # isort
+ "UP", # pyupgrade
+ "RUF", # ruff-only checking
+ "NPY201", # Numpy 2.0.1
+]
+
+# On top of the Google convention, disable:
+ignore = [
+ "D202", # Blank line after docstring is ok
+ "D107", # Location of __init__ docstring in class not __init__" # "F401", # module imported but unused
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.per-file-ignores]
+"test/test_*.py" = ["D103"]
+
+[tool.mypy]
+ignore_missing_imports = true
+plugins = "numpy.typing.mypy_plugin"
+
+[tool.jupytext]
+# Stop jupytext from removing mystnb and other settings in MyST Notebook YAML headers
+notebook_metadata_filter = "-jupytext.text_representation.jupytext_version,settings,mystnb"
diff --git a/setup.cfg b/setup.cfg
deleted file mode 100644
index 0f97f4c77..000000000
--- a/setup.cfg
+++ /dev/null
@@ -1,45 +0,0 @@
-[aliases]
-test = pytest
-
-[tool:pytest]
-addopts =
- -v --flake8 --mypy -p no:warnings
- --cov=virtual_ecosystem --cov-report=html:reports/coverage
- --doctest-modules --ignore=virtual_ecosystem/__main__.py
-testpaths = tests
-
-[pycodestyle]
-max-line-length = 88
-
-[flake8]
-max-line-length = 88
-extend-ignore =
- E203,
- D104,
- # Class docstrings under class declaration, not __init__.
- D107,
- # No blank lines allowed after function docstring
- D202
-docstring-convention = google
-
-[mypy]
-ignore_missing_imports = False
-strict_optional = True
-no_implicit_optional = True
-disallow_untyped_calls = True
-disallow_untyped_defs = True
-disallow_incomplete_defs = True
-
-[mypy-setup]
-ignore_errors = True
-
-[mypy-tests.*]
-disallow_untyped_calls = False
-disallow_untyped_defs = False
-disallow_incomplete_defs = False
-
-[isort]
-profile = black
-multi_line_output = 3
-include_trailing_comma = true
-
diff --git a/tests/__init__.py b/tests/__init__.py
index e69de29bb..021f19e67 100644
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -0,0 +1 @@
+"""The pytest suite for the virtual ecosystem."""
diff --git a/tests/conftest.py b/tests/conftest.py
index 904640916..9e4ee2738 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,18 +1,16 @@
"""Collection of fixtures to assist the testing scripts."""
from logging import DEBUG
-from typing import Any
import numpy as np
import pytest
-import xarray as xr
from xarray import DataArray
# An import of LOGGER is required for INFO logging events to be visible to tests
# This can be removed as soon as a script that imports logger is imported
from virtual_ecosystem.core.logger import LOGGER
-# Class uses DEBUG
+# Class uses DEBUG
LOGGER.setLevel(DEBUG)
@@ -83,72 +81,6 @@ def reset_module_registry():
# Shared fixtures
-@pytest.fixture
-def fixture_square_grid():
- """Create a square grid fixture.
-
- A 10 x 10 grid of 1 hectare cells, with non-zero origin.
- """
-
- from virtual_ecosystem.core.grid import Grid
-
- grid = Grid(
- grid_type="square",
- cell_area=10000,
- cell_nx=10,
- cell_ny=10,
- xoff=500000,
- yoff=200000,
- )
-
- return grid
-
-
-@pytest.fixture
-def fixture_square_grid_simple():
- """Create a square grid fixture.
-
- A 2 x 2 grid centred on x=1,1,2,2 y=1,2,1,2
- """
-
- from virtual_ecosystem.core.grid import Grid
-
- grid = Grid(
- grid_type="square",
- cell_area=1,
- cell_nx=2,
- cell_ny=2,
- xoff=0.5,
- yoff=0.5,
- )
-
- return grid
-
-
-@pytest.fixture
-def fixture_data(fixture_square_grid_simple):
- """A Data instance fixture for use in testing."""
-
- from virtual_ecosystem.core.data import Data
-
- data = Data(fixture_square_grid_simple)
-
- # Create an existing variable to test replacement
- data["existing_var"] = DataArray([1, 2, 3, 4], dims=("cell_id",))
-
- return data
-
-
-@pytest.fixture
-def data_instance():
- """Creates an empty data instance."""
- from virtual_ecosystem.core.data import Data
- from virtual_ecosystem.core.grid import Grid
-
- grid = Grid()
- return Data(grid)
-
-
@pytest.fixture
def fixture_config():
"""Simple configuration fixture for use in tests."""
@@ -158,8 +90,8 @@ def fixture_config():
cfg_string = """
[core]
[core.grid]
- cell_nx = 10
- cell_ny = 10
+ cell_nx = 2
+ cell_ny = 2
[core.timing]
start_date = "2020-01-01"
update_interval = "2 weeks"
@@ -172,10 +104,9 @@ def fixture_config():
[core.layers]
canopy_layers = 10
- soil_layers = [-0.25, -1.0]
+ soil_layers = [-0.5, -1.0]
above_canopy_height_offset = 2.0
surface_layer_height = 0.1
- subcanopy_layer_height = 1.5
[plants]
a_plant_integer = 12
@@ -186,49 +117,105 @@ def fixture_config():
pft_name = "broadleaf"
max_height = 50.0
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "carnivorous_bird"
taxa = "bird"
diet = "carnivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "carnivorous_bird"
+ excretion_type = "uricotelic"
birth_mass = 0.1
adult_mass = 1.0
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "herbivorous_bird"
taxa = "bird"
diet = "herbivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "herbivorous_bird"
+ excretion_type = "uricotelic"
birth_mass = 0.05
adult_mass = 0.5
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "carnivorous_mammal"
taxa = "mammal"
diet = "carnivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "carnivorous_mammal"
+ excretion_type = "ureotelic"
birth_mass = 4.0
adult_mass = 40.0
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "herbivorous_mammal"
taxa = "mammal"
diet = "herbivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "herbivorous_mammal"
+ excretion_type = "ureotelic"
birth_mass = 1.0
adult_mass = 10.0
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "carnivorous_insect"
taxa = "insect"
diet = "carnivore"
metabolic_type = "ectothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "carnivorous_insect"
+ excretion_type = "uricotelic"
birth_mass = 0.001
adult_mass = 0.01
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "herbivorous_insect"
taxa = "insect"
diet = "herbivore"
metabolic_type = "ectothermic"
+ reproductive_type = "semelparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "herbivorous_insect"
+ excretion_type = "uricotelic"
+ birth_mass = 0.0005
+ adult_mass = 0.005
+ [[animal.functional_groups]]
+ name = "butterfly"
+ taxa = "insect"
+ diet = "herbivore"
+ metabolic_type = "ectothermic"
+ reproductive_type = "semelparous"
+ development_type = "indirect"
+ development_status = "adult"
+ offspring_functional_group = "caterpillar"
+ excretion_type = "uricotelic"
+ birth_mass = 0.0005
+ adult_mass = 0.005
+ [[animal.functional_groups]]
+ name = "caterpillar"
+ taxa = "insect"
+ diet = "herbivore"
+ metabolic_type = "ectothermic"
+ reproductive_type = "nonreproductive"
+ development_type = "indirect"
+ development_status = "larval"
+ offspring_functional_group = "butterfly"
+ excretion_type = "uricotelic"
birth_mass = 0.0005
adult_mass = 0.005
- """
+
+ [hydrology]
+ """
return Config(cfg_strings=cfg_string)
@@ -238,7 +225,17 @@ def fixture_core_components(fixture_config):
"""A CoreComponents instance for use in testing."""
from virtual_ecosystem.core.core_components import CoreComponents
- return CoreComponents(fixture_config)
+ core_components = CoreComponents(fixture_config)
+
+ # Setup three filled canopy layers
+ canopy_array = np.full(
+ (core_components.layer_structure.n_canopy_layers, core_components.grid.n_cells),
+ np.nan,
+ )
+ canopy_array[np.array([0, 1, 2])] = 1.0
+ core_components.layer_structure.set_filled_canopy(canopy_array)
+
+ return core_components
@pytest.fixture
@@ -246,350 +243,322 @@ def dummy_carbon_data(fixture_core_components):
"""Creates a dummy carbon data object for use in tests."""
from virtual_ecosystem.core.data import Data
- from virtual_ecosystem.core.grid import Grid
# Setup the data object with four cells.
- grid = Grid(cell_nx=4, cell_ny=1)
- data = Data(grid)
-
- # The required data is now added. This includes the four carbon pools: mineral
- # associated organic matter, low molecular weight carbon, microbial carbon and
- # particulate organic matter. It also includes various factors of the physical
- # environment: pH, bulk density, soil moisture, soil temperature, percentage clay in
- # soil.
- data["soil_c_pool_lmwc"] = DataArray([0.05, 0.02, 0.1, 0.005], dims=["cell_id"])
- """Low molecular weight carbon pool (kg C m^-3)"""
- data["soil_c_pool_maom"] = DataArray([2.5, 1.7, 4.5, 0.5], dims=["cell_id"])
- """Mineral associated organic matter pool (kg C m^-3)"""
- data["soil_c_pool_microbe"] = DataArray([5.8, 2.3, 11.3, 1.0], dims=["cell_id"])
- """Microbial biomass (carbon) pool (kg C m^-3)"""
- data["soil_c_pool_pom"] = DataArray([0.1, 1.0, 0.7, 0.35], dims=["cell_id"])
- """Particulate organic matter pool (kg C m^-3)"""
- data["soil_enzyme_pom"] = DataArray(
- [0.022679, 0.009576, 0.050051, 0.003010], dims=["cell_id"]
- )
- """Soil enzyme that breaks down particulate organic matter (kg C m^-3)"""
- data["soil_enzyme_maom"] = DataArray(
- [0.0356, 0.0117, 0.02509, 0.00456], dims=["cell_id"]
+ data = Data(fixture_core_components.grid)
+
+ # The required data is now added. This includes the five carbon pools: mineral
+ # associated organic matter, low molecular weight carbon, microbial biomass and
+ # necromass carbon and particulate organic matter. It also includes various factors
+ # of the physical environment: pH, bulk density, soil moisture, soil temperature,
+ # percentage clay in soil.
+ data_values = {
+ "soil_c_pool_lmwc": [0.05, 0.02, 0.1, 0.005],
+ "soil_c_pool_maom": [2.5, 1.7, 4.5, 0.5],
+ "soil_c_pool_microbe": [5.8, 2.3, 11.3, 1.0],
+ "soil_c_pool_pom": [0.1, 1.0, 0.7, 0.35],
+ "soil_c_pool_necromass": [0.058, 0.015, 0.093, 0.105],
+ "soil_enzyme_pom": [0.022679, 0.009576, 0.050051, 0.003010],
+ "soil_enzyme_maom": [0.0356, 0.0117, 0.02509, 0.00456],
+ "pH": [3.0, 7.5, 9.0, 5.7],
+ "bulk_density": [1350.0, 1800.0, 1000.0, 1500.0],
+ "clay_fraction": [0.8, 0.3, 0.1, 0.9],
+ "litter_C_mineralisation_rate": [0.00212106, 0.00106053, 0.00049000, 0.0055],
+ "vertical_flow": [0.1, 0.5, 2.5, 1.59],
+ }
+
+ for var_name, var_values in data_values.items():
+ data[var_name] = DataArray(var_values, dims=["cell_id"])
+
+ # The layer dependant data has to be handled separately - at present all of these
+ # are defined only for the topsoil layer
+ lyr_str = fixture_core_components.layer_structure
+
+ data["soil_moisture"] = lyr_str.from_template()
+ data["soil_moisture"][lyr_str.index_topsoil] = np.array(
+ [232.61550125, 196.88733175, 126.065797, 75.63195175]
)
- """Soil enzyme that breaks down mineral associated organic matter (kg C m^-3)"""
- data["pH"] = DataArray([3.0, 7.5, 9.0, 5.7], dims=["cell_id"])
- data["bulk_density"] = DataArray([1350.0, 1800.0, 1000.0, 1500.0], dims=["cell_id"])
- data["clay_fraction"] = DataArray([0.8, 0.3, 0.1, 0.9], dims=["cell_id"])
- data["litter_C_mineralisation_rate"] = DataArray(
- [0.00212106, 0.00106053, 0.00049000, 0.0055], dims=["cell_id"]
- )
- # Data for average vertical flow
- data["vertical_flow"] = DataArray([0.1, 0.5, 2.5, 1.59], dims=["cell_id"])
-
- # The layer dependant data has to be handled separately
- data["soil_moisture"] = xr.concat(
- [
- DataArray(np.full((13, 4), np.nan), dims=["layers", "cell_id"]),
- # At present the soil model only uses the top soil layer, so this is the
- # only one with real test values in
- DataArray(
- [[0.9304620050, 0.787549327, 0.504263188, 0.302527807]],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((1, 4), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- )
- data["soil_moisture"] = data["soil_moisture"].assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
- )
- data["matric_potential"] = xr.concat(
- [
- DataArray(np.full((13, 4), np.nan), dims=["layers", "cell_id"]),
- # At present the soil model only uses the top soil layer, so this is the
- # only one with real test values in
- DataArray([[-3.0, -10.0, -250.0, -10000.0]], dims=["layers", "cell_id"]),
- DataArray(np.full((1, 4), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
- )
- data["soil_temperature"] = xr.concat(
- [
- DataArray(np.full((13, 4), np.nan), dims=["dim_0", "cell_id"]),
- # At present the soil model only uses the top soil layer, so this is the
- # only one with real test values in
- DataArray([[35.0, 37.5, 40.0, 25.0]], dims=["dim_0", "cell_id"]),
- DataArray(np.full((1, 4), 22.5), dims=["dim_0", "cell_id"]),
- ],
- dim="dim_0",
+
+ data["matric_potential"] = lyr_str.from_template()
+ data["matric_potential"][lyr_str.index_topsoil] = np.array(
+ [-3.0, -10.0, -250.0, -10000.0]
)
- data["soil_temperature"] = (
- data["soil_temperature"]
- .rename({"dim_0": "layers"})
- .assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
- )
+
+ data["soil_temperature"] = lyr_str.from_template()
+ data["soil_temperature"][lyr_str.index_all_soil] = np.array(
+ [[35.0, 37.5, 40.0, 25.0], [22.5, 22.5, 22.5, 22.5]]
)
return data
-@pytest.fixture
-def top_soil_layer_index(fixture_core_components):
- """The index of the top soil layer in the data fixtures."""
- return fixture_core_components.layer_structure.layer_roles.index("soil")
-
-
-@pytest.fixture
-def surface_layer_index(fixture_core_components):
- """The index of the top soil layer in the data fixtures."""
- return fixture_core_components.layer_structure.layer_roles.index("surface")
-
-
-@pytest.fixture
-def new_axis_validators():
- """Create new axis validators to test methods and registration."""
- from virtual_ecosystem.core.axes import AxisValidator
- from virtual_ecosystem.core.grid import Grid
-
- # Create a new subclass.
- class TestAxis(AxisValidator):
- core_axis = "testing"
- dim_names = {"test"}
-
- def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
- return True if value.sum() > 10 else False
-
- def run_validation(
- self, value: DataArray, grid: Grid, **kwargs: Any
- ) -> DataArray:
- return value * 2
-
- # Create a new duplicate subclass to check mutual exclusivity test
- class TestAxis2(AxisValidator):
- core_axis = "testing"
- dim_names = {"test"}
-
- def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
- return True if value.sum() > 10 else False
-
- def run_validation(
- self, value: DataArray, grid: Grid, **kwargs: Any
- ) -> DataArray:
- return value * 2
-
-
@pytest.fixture
def dummy_climate_data(fixture_core_components):
"""Creates a dummy climate data object for use in tests."""
from virtual_ecosystem.core.data import Data
- from virtual_ecosystem.core.grid import Grid
# Setup the data object with four cells.
- grid = Grid(
- grid_type="square",
- cell_nx=3,
- cell_ny=1,
- cell_area=3,
- xoff=0,
- yoff=0,
- )
- data = Data(grid)
-
- data["air_temperature_ref"] = DataArray(
- np.full((3, 3), 30),
- dims=["cell_id", "time_index"],
- )
- data["mean_annual_temperature"] = DataArray(
- np.full((3), 20),
- dims=["cell_id"],
- )
- data["relative_humidity_ref"] = DataArray(
- np.full((3, 3), 90),
- dims=["cell_id", "time_index"],
- )
- data["vapour_pressure_deficit_ref"] = DataArray(
- np.full((3, 3), 0.14),
- dims=["cell_id", "time_index"],
- )
- data["atmospheric_pressure_ref"] = DataArray(
- np.full((3, 3), 96),
- dims=["cell_id", "time_index"],
- )
- data["atmospheric_co2_ref"] = DataArray(
- np.full((3, 3), 400),
- dims=["cell_id", "time_index"],
- )
- evapotranspiration = np.repeat(a=[np.nan, 20.0, np.nan], repeats=[1, 3, 11])
- data["evapotranspiration"] = DataArray(
- np.broadcast_to(evapotranspiration, (3, 15)).T,
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- },
- name="evapotranspiration",
- )
- leaf_area_index = np.repeat(a=[np.nan, 1.0, np.nan], repeats=[1, 3, 11])
- data["leaf_area_index"] = DataArray(
- np.broadcast_to(leaf_area_index, (3, 15)).T,
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- },
- name="leaf_area_index",
- )
+ data = Data(fixture_core_components.grid)
+
+ # Shorten syntax
+ lyr_str = fixture_core_components.layer_structure
+ from_template = lyr_str.from_template
+
+ # Reference data with a time series
+ ref_values = {
+ "air_temperature_ref": 30.0,
+ "wind_speed_ref": 1.0,
+ "relative_humidity_ref": 90.0,
+ "vapour_pressure_deficit_ref": 0.14,
+ "vapour_pressure_ref": 0.14,
+ "atmospheric_pressure_ref": 96.0,
+ "atmospheric_co2_ref": 400.0,
+ "precipitation": 200.0,
+ "topofcanopy_radiation": 100.0,
+ }
+
+ for var, value in ref_values.items():
+ data[var] = DataArray(
+ np.full((4, 3), value),
+ dims=["cell_id", "time_index"],
+ )
- layer_heights = np.repeat(
- a=[32.0, 30.0, 20.0, 10.0, np.nan, 1.5, 0.1, -0.5, -1.0],
- repeats=[1, 1, 1, 1, 7, 1, 1, 1, 1],
- )
- data["layer_heights"] = DataArray(
- np.broadcast_to(layer_heights, (3, 15)).T,
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- },
- name="layer_heights",
- )
+ # Spatially varying but not vertically structured
+ spatially_variable = {
+ "shortwave_radiation_surface": [100, 10, 0, 0],
+ "sensible_heat_flux_topofcanopy": [100, 50, 10, 10],
+ "friction_velocity": [12, 5, 2, 2],
+ "soil_evaporation": [0.001, 0.01, 0.1, 0.1],
+ # "surface_runoff": [10, 50, 100, 100],
+ "surface_runoff_accumulated": [0, 10, 300, 300],
+ "subsurface_flow_accumulated": [10, 10, 30, 30],
+ "elevation": [200, 100, 10, 10],
+ }
+ for var, vals in spatially_variable.items():
+ data[var] = DataArray(vals, dims=["cell_id"])
+
+ # Spatially constant and not vertically structured
+ spatially_constant = {
+ "sensible_heat_flux_soil": 1,
+ "latent_heat_flux_soil": 1,
+ "zero_displacement_height": 20.0,
+ "diabatic_correction_heat_above": 0.1,
+ "diabatic_correction_heat_canopy": 1.0,
+ "diabatic_correction_momentum_above": 0.1,
+ "diabatic_correction_momentum_canopy": 1.0,
+ "mean_mixing_length": 1.3,
+ "aerodynamic_resistance_surface": 12.5,
+ "mean_annual_temperature": 20.0,
+ }
+ for var, val in spatially_constant.items():
+ data[var] = DataArray(np.repeat(val, 4), dims=["cell_id"])
+
+ # Structural variables - assign values to vertical layer indices across grid id
+ data["leaf_area_index"] = from_template()
+ data["leaf_area_index"][lyr_str.index_filled_canopy] = 1.0
+
+ data["canopy_absorption"] = from_template()
+ data["canopy_absorption"][lyr_str.index_filled_canopy] = 1.0
+
+ data["layer_heights"] = from_template()
+ data["layer_heights"][lyr_str.index_filled_atmosphere] = np.array(
+ [32.0, 30.0, 20.0, 10.0, lyr_str.surface_layer_height]
+ )[:, None]
+
+ data["layer_heights"][lyr_str.index_all_soil] = lyr_str.soil_layer_depths[:, None]
+
+ # Microclimate and energy balance
+ # - Vertically structured
+ data["wind_speed"] = from_template()
+ data["wind_speed"][lyr_str.index_filled_atmosphere] = 0.1
+
+ data["atmospheric_pressure"] = from_template()
+ data["atmospheric_pressure"][lyr_str.index_filled_atmosphere] = 96.0
+
+ data["air_temperature"] = from_template()
+ data["air_temperature"][lyr_str.index_filled_atmosphere] = np.array(
+ [30.0, 29.844995, 28.87117, 27.206405, 16.145945]
+ )[:, None]
+
+ data["soil_temperature"] = from_template()
+ data["soil_temperature"][lyr_str.index_all_soil] = 20.0
+
+ data["relative_humidity"] = from_template()
+ data["relative_humidity"][lyr_str.index_filled_atmosphere] = np.array(
+ [90.0, 90.341644, 92.488034, 96.157312, 100]
+ )[:, None]
+
+ data["absorbed_radiation"] = from_template()
+ data["absorbed_radiation"][lyr_str.index_filled_canopy] = 10.0
+
+ flux_index = np.logical_or(lyr_str.index_above, lyr_str.index_flux_layers)
+
+ data["sensible_heat_flux"] = from_template()
+ data["sensible_heat_flux"][flux_index] = 0.0
+
+ data["latent_heat_flux"] = from_template()
+ data["latent_heat_flux"][flux_index] = 0.0
+
+ data["molar_density_air"] = from_template()
+ data["molar_density_air"][lyr_str.index_filled_atmosphere] = 38.0
+
+ data["specific_heat_air"] = from_template()
+ data["specific_heat_air"][lyr_str.index_filled_atmosphere] = 29.0
+
+ data["attenuation_coefficient"] = from_template()
+ data["attenuation_coefficient"][lyr_str.index_filled_atmosphere] = np.array(
+ [13.0, 13.0, 13.0, 13.0, 2.0]
+ )[:, None]
+
+ data["relative_turbulence_intensity"] = from_template()
+ data["relative_turbulence_intensity"][lyr_str.index_filled_atmosphere] = np.array(
+ [17.64, 16.56, 11.16, 5.76, 0.414]
+ )[:, None]
+
+ data["latent_heat_vapourisation"] = from_template()
+ data["latent_heat_vapourisation"][lyr_str.index_filled_atmosphere] = 2254.0
+
+ data["canopy_temperature"] = from_template()
+ data["canopy_temperature"][lyr_str.index_filled_canopy] = 25.0
+
+ data["leaf_air_heat_conductivity"] = from_template()
+ data["leaf_air_heat_conductivity"][lyr_str.index_filled_canopy] = 0.13
+
+ data["leaf_vapour_conductivity"] = from_template()
+ data["leaf_vapour_conductivity"][lyr_str.index_filled_canopy] = 0.2
+
+ data["conductivity_from_ref_height"] = from_template()
+ data["conductivity_from_ref_height"][
+ np.logical_or(lyr_str.index_filled_canopy, lyr_str.index_surface)
+ ] = 3.0
- data["precipitation"] = DataArray(
- [[200, 200, 200], [200, 200, 200], [200, 200, 200]],
- dims=["time_index", "cell_id"],
- )
- data["elevation"] = DataArray([200, 100, 10], dims="cell_id")
- data["surface_runoff"] = DataArray([10, 50, 100], dims="cell_id")
- data["surface_runoff_accumulated"] = DataArray([0, 10, 300], dims="cell_id")
- data["subsurface_flow_accumulated"] = DataArray([10, 10, 30], dims="cell_id")
- data["soil_moisture"] = xr.concat(
- [
- DataArray(np.full((13, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(np.full((2, 3), 0.20), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- )
- data["soil_temperature"] = xr.concat(
- [DataArray(np.full((13, 3), np.nan)), DataArray(np.full((2, 3), 20))],
- dim="dim_0",
- )
- data["soil_temperature"] = (
- data["soil_temperature"]
- .rename({"dim_0": "layers", "dim_1": "cell_id"})
- .assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
- )
- )
+ data["stomatal_conductance"] = from_template()
+ data["stomatal_conductance"][lyr_str.index_filled_canopy] = 15.0
- data["air_temperature"] = xr.concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.844995, 29.844995, 29.844995],
- [28.87117, 28.87117, 28.87117],
- [27.206405, 27.206405, 27.206405],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [22.65, 22.65, 22.65],
- [16.145945, 16.145945, 16.145945],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles[0:15],
- ),
- "cell_id": data.grid.cell_id,
- }
- )
+ # Hydrology
+ data["evapotranspiration"] = from_template()
+ data["evapotranspiration"][lyr_str.index_filled_canopy] = 20.0
- data["relative_humidity"] = xr.concat(
- [
- DataArray(
- [
- [90.0, 90.0, 90.0],
- [90.341644, 90.341644, 90.341644],
- [92.488034, 92.488034, 92.488034],
- [96.157312, 96.157312, 96.157312],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [100, 100, 100],
- [100, 100, 100],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles[0:15],
- ),
- "cell_id": data.grid.cell_id,
- }
- )
+ data["soil_moisture"] = from_template()
+ data["soil_moisture"][lyr_str.index_all_soil] = np.array([5.0, 500.0])[:, None]
data["groundwater_storage"] = DataArray(
- np.full((2, 3), 450),
+ np.full((2, 4), 450.0),
dims=("groundwater_layers", "cell_id"),
)
return data
+
+
+# dummy climate data with different number of canopy layers
+@pytest.fixture
+def dummy_climate_data_varying_canopy(fixture_core_components, dummy_climate_data):
+ """Creates a dummy climate data object for use in tests.
+
+ This fixture modifies the parent dummy_climate_data to introduce variation in the
+ number of canopy layers within the different cells.
+ """
+
+ index_filled_canopy = fixture_core_components.layer_structure.index_filled_canopy
+
+ # Structural variables
+ dummy_climate_data["leaf_area_index"][index_filled_canopy] = [
+ [1.0, 1.0, 1.0, 1.0],
+ [1.0, 1.0, np.nan, np.nan],
+ [1.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["layer_heights"][index_filled_canopy] = [
+ [30.0, 30.0, 30.0, 30.0],
+ [20.0, 20.0, np.nan, np.nan],
+ [10.0, np.nan, np.nan, np.nan],
+ ]
+
+ # Microclimate and energy balance
+ dummy_climate_data["wind_speed"][index_filled_canopy] = [
+ [0.1, 0.1, 0.1, 0.1],
+ [0.1, 0.1, np.nan, np.nan],
+ [0.1, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["air_temperature"][index_filled_canopy] = [
+ [29.844995, 29.844995, 29.844995, 29.844995],
+ [28.87117, 28.87117, np.nan, np.nan],
+ [27.206405, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["relative_humidity"][index_filled_canopy] = [
+ [90.341644, 90.341644, 90.341644, 90.341644],
+ [92.488034, 92.488034, np.nan, np.nan],
+ [96.157312, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["absorbed_radiation"][index_filled_canopy] = [
+ [10.0, 10.0, 10.0, 10.0],
+ [10.0, 10.0, np.nan, np.nan],
+ [10.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["sensible_heat_flux"][index_filled_canopy] = [
+ [0.0, 0.0, 0.0, 0.0],
+ [0.0, 0.0, np.nan, np.nan],
+ [0.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["latent_heat_flux"][index_filled_canopy] = [
+ [0.0, 0.0, 0.0, 0.0],
+ [0.0, 0.0, np.nan, np.nan],
+ [0.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["attenuation_coefficient"][index_filled_canopy] = [
+ [13.0, 13.0, 13.0, 13.0],
+ [13.0, 13.0, np.nan, np.nan],
+ [13.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["relative_turbulence_intensity"][index_filled_canopy] = [
+ [16.56, 16.56, 16.56, 16.56],
+ [11.16, 11.16, np.nan, np.nan],
+ [5.76, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["canopy_temperature"][index_filled_canopy] = [
+ [25.0, 25.0, 25.0, 25.0],
+ [25.0, 25.0, np.nan, np.nan],
+ [25.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["leaf_air_heat_conductivity"][index_filled_canopy] = [
+ [0.13, 0.13, 0.13, 0.13],
+ [0.13, 0.13, np.nan, np.nan],
+ [0.13, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["leaf_vapour_conductivity"][index_filled_canopy] = [
+ [0.2, 0.2, 0.2, 0.2],
+ [0.2, 0.2, np.nan, np.nan],
+ [0.2, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["conductivity_from_ref_height"][index_filled_canopy] = [
+ [3.0, 3.0, 3.0, 3.0],
+ [3.0, 3.0, np.nan, np.nan],
+ [3.0, np.nan, np.nan, np.nan],
+ ]
+
+ dummy_climate_data["stomatal_conductance"][index_filled_canopy] = [
+ [15.0, 15.0, 15.0, 15.0],
+ [15.0, 15.0, np.nan, np.nan],
+ [15.0, np.nan, np.nan, np.nan],
+ ]
+
+ # Hydrology
+ dummy_climate_data["evapotranspiration"][index_filled_canopy] = [
+ [20.0, 20.0, 20.0, 20.0],
+ [20.0, 20.0, np.nan, np.nan],
+ [20.0, np.nan, np.nan, np.nan],
+ ]
+
+ return dummy_climate_data
diff --git a/tests/core/conftest.py b/tests/core/conftest.py
new file mode 100644
index 000000000..6a0707604
--- /dev/null
+++ b/tests/core/conftest.py
@@ -0,0 +1,91 @@
+"""Fixtures for use in core testing."""
+
+from typing import Any
+
+import pytest
+from xarray import DataArray
+
+
+@pytest.fixture
+def fixture_square_grid():
+ """Create a square grid fixture.
+
+ A 10 x 10 grid of 1 hectare cells, with non-zero origin.
+ """
+
+ from virtual_ecosystem.core.grid import Grid
+
+ return Grid(
+ grid_type="square",
+ cell_area=10000,
+ cell_nx=10,
+ cell_ny=10,
+ xoff=500000,
+ yoff=200000,
+ )
+
+
+@pytest.fixture
+def fixture_square_grid_simple():
+ """Create a square grid fixture.
+
+ A 2 x 2 grid centred on x=1,1,2,2 y=1,2,1,2
+ """
+
+ from virtual_ecosystem.core.grid import Grid
+
+ return Grid(
+ grid_type="square",
+ cell_area=1,
+ cell_nx=2,
+ cell_ny=2,
+ xoff=0.5,
+ yoff=0.5,
+ )
+
+
+@pytest.fixture
+def fixture_data(fixture_square_grid_simple):
+ """A Data instance fixture for use in testing."""
+
+ from virtual_ecosystem.core.data import Data
+
+ data = Data(fixture_square_grid_simple)
+
+ # Create an existing variable to test replacement
+ data["existing_var"] = DataArray([1, 2, 3, 4], dims=("cell_id",))
+
+ return data
+
+
+@pytest.fixture
+def new_axis_validators():
+ """Create new axis validators to test methods and registration."""
+ from virtual_ecosystem.core.axes import AxisValidator
+ from virtual_ecosystem.core.grid import Grid
+
+ # Create a new subclass.
+ class TestAxis(AxisValidator):
+ core_axis = "testing"
+ dim_names = frozenset(["test"])
+
+ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
+ return (value.sum() > 10).item()
+
+ def run_validation(
+ self, value: DataArray, grid: Grid, **kwargs: Any
+ ) -> DataArray:
+ return value * 2
+
+ # Create a new duplicate subclass to check mutual exclusivity test
+ class TestAxis2(AxisValidator):
+ core_axis = "testing"
+ dim_names = frozenset(["test"])
+
+ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
+ return (value.sum() > 10).item()
+
+ def run_validation(
+ self, value: DataArray, grid: Grid, **kwargs: Any
+ ) -> DataArray:
+ return value * 2
diff --git a/tests/core/data/all_config.toml b/tests/core/data/all_config.toml
index 8941b76f7..e98633b42 100644
--- a/tests/core/data/all_config.toml
+++ b/tests/core/data/all_config.toml
@@ -8,71 +8,127 @@ cell_nx = 10
cell_ny = 10
[core.timing]
+run_length = "50 years"
start_date = "2020-01-01"
update_interval = "2 weeks"
-run_length = "50 years"
[core.data_output_options]
-save_initial_state = true
-save_final_state = true
-out_initial_file_name = "model_at_start.nc"
out_final_file_name = "model_at_end.nc"
+out_initial_file_name = "model_at_start.nc"
+save_final_state = true
+save_initial_state = true
[plants]
a_plant_integer = 12
[[plants.ftypes]]
-pft_name = "shrub"
max_height = 1.0
+pft_name = "shrub"
[[plants.ftypes]]
-pft_name = "broadleaf"
max_height = 50.0
+pft_name = "broadleaf"
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "carnivorous_bird"
taxa = "bird"
diet = "carnivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_bird"
+excretion_type = "uricotelic"
birth_mass = 0.1
adult_mass = 1.0
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "herbivorous_bird"
taxa = "bird"
diet = "herbivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_bird"
+excretion_type = "uricotelic"
birth_mass = 0.05
adult_mass = 0.5
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "carnivorous_mammal"
taxa = "mammal"
diet = "carnivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_mammal"
+excretion_type = "ureotelic"
birth_mass = 4.0
adult_mass = 40.0
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "herbivorous_mammal"
taxa = "mammal"
diet = "herbivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_mammal"
+excretion_type = "ureotelic"
birth_mass = 1.0
adult_mass = 10.0
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "carnivorous_insect"
taxa = "insect"
diet = "carnivore"
metabolic_type = "ectothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_insect"
+excretion_type = "uricotelic"
birth_mass = 0.001
adult_mass = 0.01
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "herbivorous_insect"
taxa = "insect"
diet = "herbivore"
metabolic_type = "ectothermic"
+reproductive_type = "semelparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_insect"
+excretion_type = "uricotelic"
birth_mass = 0.0005
adult_mass = 0.005
+
+[[animal.functional_groups]]
+name = "butterfly"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "semelparous"
+development_type = "indirect"
+development_status = "adult"
+offspring_functional_group = "caterpillar"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
+
+[[animal.functional_groups]]
+name = "caterpillar"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "nonreproductive"
+development_type = "indirect"
+development_status = "larval"
+offspring_functional_group = "butterfly"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
\ No newline at end of file
diff --git a/tests/core/test_axes.py b/tests/core/test_axes.py
index 578842514..93045c61f 100644
--- a/tests/core/test_axes.py
+++ b/tests/core/test_axes.py
@@ -17,7 +17,7 @@ def test_AxisValidator_registration_coreaxis_not_set():
with pytest.raises(ValueError) as excep:
# Create a new failing subclass.
class TestAxis(AxisValidator):
- dim_names = {"valid"}
+ dim_names = frozenset(["valid"])
def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
return True
@@ -68,12 +68,12 @@ def run_validation(
(
"ok",
123,
- "Class attribute dim_names is not a set of strings.",
+ "Class attribute dim_names is not a frozenset of strings.",
),
(
"ok",
{123},
- "Class attribute dim_names is not a set of strings.",
+ "Class attribute dim_names is not a frozenset of strings.",
),
],
)
@@ -133,7 +133,7 @@ def test_AxisValidator_methods(new_axis_validators, fixture_data):
argvalues=[
pytest.param(
DataArray(data=np.arange(4), dims=("cell_id")),
- {"spatial": "Spat_CellId_Dim_Any", "testing": None},
+ {"spatial": "Spat_CellId_Dim_Any", "testing": None, "time": None},
does_not_raise(),
None,
id="Match found",
@@ -155,7 +155,7 @@ def test_AxisValidator_methods(new_axis_validators, fixture_data):
),
pytest.param(
DataArray(data=np.arange(4), dims=("cell_identities")),
- {"spatial": None, "testing": None},
+ {"spatial": None, "testing": None, "time": None},
does_not_raise(),
None,
id="No match found",
diff --git a/tests/core/test_base_model.py b/tests/core/test_base_model.py
index 461cd5fd9..428b02475 100644
--- a/tests/core/test_base_model.py
+++ b/tests/core/test_base_model.py
@@ -14,8 +14,12 @@
@pytest.fixture(scope="module")
-def data_instance():
- """Creates a simple data instance for use in testing."""
+def fixture_data_instance_for_model_validation():
+ """Data instance with badly dimensioned data.
+
+ Creates a simple data instance for use in testing whether models correctly apply
+ validation of required variables.
+ """
from xarray import DataArray
from virtual_ecosystem.core.data import Data
@@ -36,31 +40,32 @@ def data_instance():
pytest.param(
{},
pytest.raises(TypeError),
- "BaseModel.__init_subclass__() missing 4 required positional arguments: "
- "'model_name', 'model_update_bounds', 'required_init_vars', "
- "and 'vars_updated'",
+ "BaseModel.__init_subclass__() missing 7 required positional arguments: "
+ "'model_name', 'model_update_bounds', 'vars_required_for_init', "
+ "'vars_updated', 'vars_required_for_update', 'vars_populated_by_init', and "
+ "'vars_populated_by_first_update'",
[],
id="missing_all_args",
),
pytest.param(
{"model_name": 9},
pytest.raises(TypeError),
- "BaseModel.__init_subclass__() missing 3 required positional arguments: "
- "'model_update_bounds', 'required_init_vars', and 'vars_updated'",
+ "BaseModel.__init_subclass__() missing 6 required positional arguments: "
+ "'model_update_bounds', 'vars_required_for_init', 'vars_updated', "
+ "'vars_required_for_update', 'vars_populated_by_init', and "
+ "'vars_populated_by_first_update'",
[],
- id="missing_3_args",
+ id="missing_6_args",
),
pytest.param(
{
"model_name": "should_pass",
- "required_init_vars": (
- (
- "temperature",
- ("spatial",),
- ),
- ),
+ "vars_required_for_init": ("temperature", "wind_speed"),
"model_update_bounds": ("1 day", "1 month"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
does_not_raise(),
None,
@@ -70,9 +75,12 @@ def data_instance():
pytest.param(
{
"model_name": 9,
- "required_init_vars": (),
+ "vars_required_for_init": (),
"model_update_bounds": ("1 day", "1 month"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
pytest.raises(TypeError),
"Class attribute model_name in UnnamedModel is not a string",
@@ -85,9 +93,12 @@ def data_instance():
pytest.param(
{
"model_name": "should_pass",
- "required_init_vars": (),
+ "vars_required_for_init": (),
"model_update_bounds": ("1 day", "1 time"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
pytest.raises(ValueError),
"Class attribute model_update_bounds for UnnamedModel "
@@ -105,9 +116,12 @@ def data_instance():
pytest.param(
{
"model_name": "should_pass",
- "required_init_vars": (),
+ "vars_required_for_init": (),
"model_update_bounds": ("1 day", "1 day"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
pytest.raises(ValueError),
"Lower time bound for UnnamedModel is not less than the upper bound.",
@@ -124,9 +138,12 @@ def data_instance():
pytest.param(
{
"model_name": "should_pass",
- "required_init_vars": (),
+ "vars_required_for_init": (),
"model_update_bounds": ("1 day", "1 second"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
pytest.raises(ValueError),
"Lower time bound for UnnamedModel is not less than the upper bound.",
@@ -143,9 +160,12 @@ def data_instance():
pytest.param(
{
"model_name": "should_pass",
- "required_init_vars": (),
+ "vars_required_for_init": (),
"model_update_bounds": ("1 meter", "1 day"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
pytest.raises(ValueError),
"Class attribute model_update_bounds for UnnamedModel "
@@ -163,9 +183,12 @@ def data_instance():
pytest.param(
{
"model_name": "should_pass",
- "required_init_vars": (),
+ "vars_required_for_init": (),
"model_update_bounds": ("1 spongebob", "1 day"),
- "vars_updated": [],
+ "vars_updated": (),
+ "vars_required_for_update": (),
+ "vars_populated_by_init": (),
+ "vars_populated_by_first_update": (),
},
pytest.raises(ValueError),
"Class attribute model_update_bounds for UnnamedModel "
@@ -206,66 +229,55 @@ class UnnamedModel(BaseModel, **init_args):
@pytest.mark.parametrize(
- argnames="riv_value, exp_raise, exp_msg",
+ argnames="value, exp_raise, exp_msg",
argvalues=[
pytest.param(
1,
pytest.raises(TypeError),
- "Class attribute required_init_vars has the wrong structure in UM",
- id="RIV is integer",
- ),
- pytest.param(
- ["temperature", (1, 2)],
- pytest.raises(TypeError),
- "Class attribute required_init_vars has the wrong structure in UM",
- id="RIV is list",
- ),
- pytest.param(
- ("temperature", ("spatial",)),
- pytest.raises(TypeError),
- "Class attribute required_init_vars has the wrong structure in UM",
- id="RIV is not nested enough",
+ "Class attribute vars_required_for_init has the wrong structure in UM",
+ id="value is integer",
),
pytest.param(
- (("temperature", (1,)),),
+ ["temperature", "wind_speed"],
pytest.raises(TypeError),
- "Class attribute required_init_vars has the wrong structure in UM",
- id="RIV axis is not string",
+ "Class attribute vars_required_for_init has the wrong structure in UM",
+ id="value is list",
),
pytest.param(
- (("temperature", (1,), (2,)),),
+ ("temperature", 1),
pytest.raises(TypeError),
- "Class attribute required_init_vars has the wrong structure in UM",
- id="RIV entry is too long",
- ),
- pytest.param(
- (("temperature", ("special",)),),
- pytest.raises(ValueError),
- "Class attribute required_init_vars uses unknown core axes in UM: special",
- id="RIV entry has bad axis name",
+ "Class attribute vars_required_for_init has the wrong structure in UM",
+ id="value not all strings",
),
pytest.param(
- (("temperature", ("spatial",)),),
+ ("temperature", "wind_speed"),
does_not_raise(),
None,
- id="RIV ok",
+ id="value ok",
),
],
)
-def test_check_required_init_var_structure(riv_value, exp_raise, exp_msg):
- """Test that __init_subclass__ traps bad values for required_init_vars."""
+def test_check_variable_attribute_structure(value, exp_raise, exp_msg):
+ """Test that __init_subclass__ traps bad values for vars_required_for_init.
+
+ This could also test the other BaseModel variable attributes, but this checks
+ the mechanism.
+ """
# BaseModel is required here in the code being exec'd from the params.
- from virtual_ecosystem.core.base_model import BaseModel # noqa: F401
+ from virtual_ecosystem.core.base_model import BaseModel
with exp_raise as err:
# Run the code to define the model
class UM(
BaseModel,
model_name="should_also_pass",
- required_init_vars=riv_value,
+ vars_required_for_init=value,
model_update_bounds=("1 day", "1 month"),
- vars_updated=[],
+ vars_updated=(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
pass
@@ -274,7 +286,7 @@ class UM(
assert str(err.value) == exp_msg
-def test_check_failure_on_missing_methods(data_instance, fixture_core_components):
+def test_check_failure_on_missing_methods(dummy_climate_data, fixture_core_components):
"""Test that a model without methods raises an error.
The two properties get caught earlier, when __init_subclass__ runs, but missing
@@ -286,20 +298,32 @@ class InitVarModel(
BaseModel,
model_name="init_var",
model_update_bounds=("1 second", "1 year"),
- required_init_vars=(),
- vars_updated=[],
+ vars_required_for_init=(),
+ vars_updated=(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
pass
with pytest.raises(TypeError) as err:
- _ = InitVarModel(data=data_instance, core_components=fixture_core_components)
+ _ = InitVarModel(
+ data=dummy_climate_data, core_components=fixture_core_components
+ )
- assert (
- str(err.value) == "Can't instantiate abstract class InitVarModel with "
- "abstract methods cleanup, from_config, setup, spinup, update"
- )
+ # Note python version specific exception messages:
+ # - Can't instantiate abstract class InitVarModel with abstract methods cleanup,
+ # from_config, setup, spinup, update
+ # versus
+ # - Can't instantiate abstract class InitVarModel without an implementation for
+ # abstract methods 'cleanup', 'from_config', 'setup', 'spinup', 'update'
+ assert str(err.value).startswith("Can't instantiate abstract class InitVarModel ")
+@pytest.mark.skip(
+ "This functionality is going to be handed off to the variables system "
+ "so skipping for now but this will probably be deleted"
+)
@pytest.mark.parametrize(
argnames="req_init_vars, raises, exp_err_msg, exp_log",
argvalues=[
@@ -330,7 +354,7 @@ class InitVarModel(
pytest.param(
[("precipitation", ("spatial",))],
pytest.raises(ValueError),
- "init_var model: error checking required_init_vars, see log.",
+ "init_var model: error checking vars_required_for_init, see log.",
(
(
ERROR,
@@ -339,23 +363,23 @@ class InitVarModel(
),
(
ERROR,
- "init_var model: error checking required_init_vars, see log.",
+ "init_var model: error checking vars_required_for_init, see log.",
),
),
id="missing axis",
),
],
)
-def test_check_required_init_vars(
+def test_check_vars_required_for_init(
caplog,
- data_instance,
+ fixture_data_instance_for_model_validation,
fixture_core_components,
req_init_vars,
raises,
exp_err_msg,
exp_log,
):
- """Tests the validation of the required_init_vars property on init."""
+ """Tests the validation of the vars_required_for_init property on init."""
# This gets registered for each parameterisation but I can't figure out how to
# create the instance via a module-scope fixture and the alternative is just
@@ -370,20 +394,20 @@ class TestCaseModel(
BaseModel,
model_name="init_var",
model_update_bounds=("1 second", "1 year"),
- required_init_vars=(),
+ vars_required_for_init=(),
vars_updated=[],
):
def setup(self) -> None:
- return super().setup()
+ pass
def spinup(self) -> None:
- return super().spinup()
+ pass
def update(self, time_index: int, **kwargs: Any) -> None:
- return super().update(time_index)
+ pass
def cleanup(self) -> None:
- return super().cleanup()
+ pass
@classmethod
def from_config(
@@ -399,13 +423,14 @@ def from_config(
# Registration of TestClassModel emits logging messages - discard.
caplog.clear()
- # Override the required_init_vars for different test cases against the data_instance
- TestCaseModel.required_init_vars = req_init_vars
+ # Override the vars_required_for_init for different test cases against the
+ # data_instance
+ TestCaseModel.vars_required_for_init = req_init_vars
# Create an instance to check the handling
with raises as err:
inst = TestCaseModel(
- data=data_instance,
+ data=fixture_data_instance_for_model_validation,
core_components=fixture_core_components,
)
@@ -473,7 +498,13 @@ def from_config(
),
],
)
-def test_check_update_speed(caplog, config_string, raises, expected_log):
+def test_check_update_speed(
+ caplog,
+ fixture_data_instance_for_model_validation,
+ config_string,
+ raises,
+ expected_log,
+):
"""Tests check on update speed."""
from virtual_ecosystem.core.base_model import BaseModel
@@ -485,20 +516,23 @@ class TimingTestModel(
BaseModel,
model_name="timing_test",
model_update_bounds=("1 day", "1 month"),
- required_init_vars=(),
- vars_updated=[],
+ vars_required_for_init=(),
+ vars_updated=(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
def setup(self) -> None:
- return super().setup()
+ pass
def spinup(self) -> None:
- return super().spinup()
+ pass
def update(self, time_index: int, **kwargs: Any) -> None:
- return super().update(time_index)
+ pass
def cleanup(self) -> None:
- return super().cleanup()
+ pass
@classmethod
def from_config(
@@ -517,6 +551,9 @@ def from_config(
caplog.clear()
with raises:
- _ = TimingTestModel(data=data_instance, core_components=core_components)
+ _ = TimingTestModel(
+ data=fixture_data_instance_for_model_validation,
+ core_components=core_components,
+ )
log_check(caplog, expected_log)
diff --git a/tests/core/test_constants_class.py b/tests/core/test_constants_class.py
index 6874f4add..44e60993a 100644
--- a/tests/core/test_constants_class.py
+++ b/tests/core/test_constants_class.py
@@ -34,7 +34,7 @@ class Test(ConstantsDataclass): # type: ignore [misc]
id="defaults_with_no_config",
),
pytest.param(
- {"depth_of_active_soil_layer": 1.55},
+ {"max_depth_of_microbial_activity": 1.55},
does_not_raise(),
1.55,
(),
@@ -70,6 +70,6 @@ def test_ConstantsDataclass_from_config(caplog, config, raises, exp_val, exp_log
constants_instance = CoreConsts.from_config(config)
if isinstance(raises, does_not_raise):
- assert constants_instance.depth_of_active_soil_layer == exp_val
+ pytest.approx(constants_instance.max_depth_of_microbial_activity) == exp_val
log_check(caplog=caplog, expected_log=exp_log)
diff --git a/tests/core/test_constants_loader.py b/tests/core/test_constants_loader.py
index 7ef93eebd..1e77b9249 100644
--- a/tests/core/test_constants_loader.py
+++ b/tests/core/test_constants_loader.py
@@ -22,7 +22,7 @@
id="default_values",
),
pytest.param(
- "[core.constants.CoreConsts]\ndepth_of_active_soil_layer=1.5",
+ "[core.constants.CoreConsts]\nmax_depth_of_microbial_activity=1.5",
"core",
"CoreConsts",
does_not_raise(),
@@ -96,7 +96,7 @@ def test_load_constants(
assert isinstance(constants_instance, CoreConsts)
# The unconfigurable zero_Celsius should take the default value
assert constants_instance.zero_Celsius == constants.zero_Celsius
- # Check the depth_of_active_soil_layer constant has been configured
- assert constants_instance.depth_of_active_soil_layer == exp_val
+ # Check the max_depth_of_microbial_activity constant has been configured
+ assert constants_instance.max_depth_of_microbial_activity == exp_val
log_check(caplog=caplog, expected_log=exp_log)
diff --git a/tests/core/test_core_components.py b/tests/core/test_core_components.py
index 189aa6b2a..bdec35c55 100644
--- a/tests/core/test_core_components.py
+++ b/tests/core/test_core_components.py
@@ -6,39 +6,42 @@
import numpy as np
import pytest
from pint import Quantity
+from xarray import DataArray
from tests.conftest import log_check
from virtual_ecosystem.core.exceptions import ConfigurationError
-DEFAULT_CANOPY = [
- "above",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "canopy",
- "subcanopy",
- "surface",
- "soil",
- "soil",
-]
-
-ALTERNATE_CANOPY = [
- "above",
- "canopy",
- "canopy",
- "canopy",
- "subcanopy",
- "surface",
- "soil",
- "soil",
- "soil",
-]
+DEFAULT_CANOPY = np.array(
+ [
+ "above",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "canopy",
+ "surface",
+ "topsoil",
+ "subsoil",
+ ]
+)
+
+ALTERNATE_CANOPY = np.array(
+ [
+ "above",
+ "canopy",
+ "canopy",
+ "canopy",
+ "surface",
+ "topsoil",
+ "subsoil",
+ "subsoil",
+ ]
+)
@pytest.mark.parametrize(
@@ -47,13 +50,11 @@
pytest.param(
"[core]",
{
- "canopy_layers": 10,
- "soil_layers": [-0.25, -1.0],
+ "n_canopy_layers": 10,
+ "soil_layer_depths": np.array([-0.25, -1.0]),
"above_canopy_height_offset": 2.0,
"surface_layer_height": 0.1,
- "subcanopy_layer_height": 1.5,
- "layer_roles": DEFAULT_CANOPY,
- "n_layers": 15,
+ "n_layers": 14,
},
{
"start_time": np.datetime64("2013-01-01"),
@@ -65,7 +66,7 @@
"reconciled_run_length": np.timedelta64(63115200, "s"),
"n_updates": 24,
},
- {"depth_of_active_soil_layer": 0.25},
+ {"max_depth_of_microbial_activity": 0.25},
id="defaults",
),
pytest.param(
@@ -74,22 +75,19 @@
canopy_layers=3
above_canopy_height_offset=1.5
surface_layer_height=0.2
- subcanopy_layer_height=1.2
[core.timing]
start_date = "2020-01-01"
update_interval = "10 minutes"
run_length = "30 years"
[core.constants.CoreConsts]
- depth_of_active_soil_layer = 2
+ max_depth_of_microbial_activity = 0.8
""",
{
- "canopy_layers": 3,
- "soil_layers": [-0.1, -0.5, -0.9],
+ "n_canopy_layers": 3,
+ "soil_layer_depths": np.array([-0.1, -0.5, -0.9]),
"above_canopy_height_offset": 1.5,
"surface_layer_height": 0.2,
- "subcanopy_layer_height": 1.2,
- "layer_roles": ALTERNATE_CANOPY,
- "n_layers": 9,
+ "n_layers": 8,
},
{
"start_time": np.datetime64("2020-01-01"),
@@ -101,37 +99,66 @@
"reconciled_run_length": np.timedelta64(946728000, "s"),
"n_updates": 1577880,
},
- {"depth_of_active_soil_layer": 2},
+ {"max_depth_of_microbial_activity": 0.8},
id="alternative config",
),
],
)
def test_CoreComponents(config, expected_layers, expected_timing, expected_constants):
- """Simple test of core component generation."""
+ """Simple test of core component generation.
+
+ The expected components contain some simple values to check - the component specific
+ tests provide more rigourous testing.
+ """
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.core_components import CoreComponents
cfg = Config(cfg_strings=config)
core_components = CoreComponents(cfg)
- assert core_components.layer_structure.__dict__ == expected_layers
- assert core_components.model_timing.__dict__ == expected_timing
- assert core_components.core_constants.__dict__ == expected_constants
+ for ky, val in expected_layers.items():
+ # Handle different expected classes
+ result = getattr(core_components.layer_structure, ky)
+ if isinstance(result, np.ndarray):
+ assert np.all(np.equal(result, val))
+ else:
+ assert result == val
+
+ for ky, val in expected_timing.items():
+ assert getattr(core_components.model_timing, ky) == val
+
+ for ky, val in expected_constants.items():
+ assert getattr(core_components.core_constants, ky) == val
@pytest.mark.parametrize(
- argnames="config_string, raises, expected_values, expected_log",
+ argnames="config_string, max_active_depth, raises, expected_values, expected_log",
argvalues=[
pytest.param(
"[core]",
+ 0.25,
does_not_raise(),
- (
- 10,
- [-0.25, -1.0],
- 2.0,
- 0.1,
- 1.5,
- DEFAULT_CANOPY,
+ dict(
+ n_canopy_layers=10,
+ soil_layer_depths=np.array([-0.25, -1.0]),
+ offset_height=2.0,
+ surface_height=0.1,
+ layer_roles=DEFAULT_CANOPY,
+ layer_indices={
+ "above": np.array([0]),
+ "canopy": np.arange(1, 11),
+ "surface": np.array([11]),
+ "topsoil": np.array([12]),
+ "subsoil": np.array([13]),
+ "all_soil": np.array([12, 13]),
+ "active_soil": np.array([12]),
+ "atmosphere": np.arange(0, 12),
+ "filled_canopy": np.array([], dtype=np.int_),
+ "filled_atmosphere": np.array([0, 11]),
+ "flux_layers": np.array([12]),
+ },
+ soil_thickness=np.array([0.25, 0.75]),
+ soil_active=np.array([0.25, 0]),
),
((INFO, "Layer structure built from model configuration"),),
id="defaults",
@@ -142,36 +169,107 @@ def test_CoreComponents(config, expected_layers, expected_timing, expected_const
canopy_layers=3
above_canopy_height_offset=1.5
surface_layer_height=0.2
- subcanopy_layer_height=1.2
""",
+ 0.25,
does_not_raise(),
- (
- 3,
- [-0.1, -0.5, -0.9],
- 1.5,
- 0.2,
- 1.2,
- ALTERNATE_CANOPY,
+ dict(
+ n_canopy_layers=3,
+ soil_layer_depths=np.array([-0.1, -0.5, -0.9]),
+ offset_height=1.5,
+ surface_height=0.2,
+ layer_roles=ALTERNATE_CANOPY,
+ layer_indices={
+ "above": np.array([0]),
+ "canopy": np.arange(1, 4),
+ "surface": np.array([4]),
+ "topsoil": np.array([5]),
+ "subsoil": np.array([6, 7]),
+ "all_soil": np.array([5, 6, 7]),
+ "active_soil": np.array([5, 6]),
+ "atmosphere": np.arange(0, 5),
+ "filled_canopy": np.array([], dtype=np.int_),
+ "filled_atmosphere": np.array([0, 4]),
+ "flux_layers": np.array([5]),
+ },
+ soil_thickness=np.array([0.1, 0.4, 0.4]),
+ soil_active=np.array([0.1, 0.15, 0]),
),
((INFO, "Layer structure built from model configuration"),),
id="alternative",
),
+ pytest.param(
+ """[core.layers]
+ soil_layers=[-0.1, -0.2, -0.3, -0.4, -0.5, -0.6, -0.7, -0.8, -0.9]
+ canopy_layers=3
+ above_canopy_height_offset=1.5
+ surface_layer_height=0.2
+ """,
+ 0.45,
+ does_not_raise(),
+ dict(
+ n_canopy_layers=3,
+ soil_layer_depths=np.array(
+ [-0.1, -0.2, -0.3, -0.4, -0.5, -0.6, -0.7, -0.8, -0.9]
+ ),
+ offset_height=1.5,
+ surface_height=0.2,
+ layer_roles=np.concatenate([ALTERNATE_CANOPY, ["subsoil"] * 6]),
+ layer_indices={
+ "above": np.array([0]),
+ "canopy": np.arange(1, 4),
+ "surface": np.array([4]),
+ "topsoil": np.array([5]),
+ "subsoil": np.arange(6, 14),
+ "all_soil": np.arange(5, 14),
+ "active_soil": np.array([5, 6, 7, 8, 9]),
+ "atmosphere": np.arange(0, 5),
+ "filled_canopy": np.array([], dtype=np.int_),
+ "filled_atmosphere": np.array([0, 4]),
+ "flux_layers": np.array([5]),
+ },
+ soil_thickness=np.repeat(0.1, 9),
+ soil_active=np.array([0.1, 0.1, 0.1, 0.1, 0.05, 0, 0, 0, 0]),
+ ),
+ ((INFO, "Layer structure built from model configuration"),),
+ id="alternative fine soil layers",
+ ),
pytest.param(
"""[core.layers]
soil_layers=[0.1, -0.5, -0.9]
canopy_layers=9
above_canopy_height_offset=1.5
surface_layer_height=0.2
- subcanopy_layer_height=1.2
""",
+ 0.25,
pytest.raises(ConfigurationError),
None,
((ERROR, "Soil layer depths must be strictly decreasing and negative."),),
id="bad_soil",
),
+ pytest.param(
+ """[core.layers]
+ soil_layers=[-0.1, -0.5, -0.9]
+ canopy_layers=9
+ above_canopy_height_offset=1.5
+ surface_layer_height=0.2
+ """,
+ 1.0,
+ pytest.raises(ConfigurationError),
+ None,
+ (
+ (
+ ERROR,
+ "Maximum depth of soil layers is less than the maximum depth "
+ "of microbial activity",
+ ),
+ ),
+ id="soil not deep enough for microbes",
+ ),
],
)
-def test_LayerStructure(caplog, config_string, raises, expected_values, expected_log):
+def test_LayerStructure_init(
+ caplog, config_string, max_active_depth, raises, expected_values, expected_log
+):
"""Test the creation and error handling of LayerStructure."""
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.core_components import LayerStructure
@@ -179,17 +277,130 @@ def test_LayerStructure(caplog, config_string, raises, expected_values, expected
cfg = Config(cfg_strings=config_string)
with raises:
- layer_structure = LayerStructure(cfg)
+ layer_structure = LayerStructure(
+ cfg, n_cells=9, max_depth_of_microbial_activity=max_active_depth
+ )
log_check(caplog=caplog, expected_log=expected_log, subset=slice(-1, None, None))
if isinstance(raises, does_not_raise):
- assert layer_structure.canopy_layers == expected_values[0]
- assert layer_structure.soil_layers == expected_values[1]
- assert layer_structure.above_canopy_height_offset == expected_values[2]
- assert layer_structure.surface_layer_height == expected_values[3]
- assert layer_structure.subcanopy_layer_height == expected_values[4]
- assert layer_structure.layer_roles == expected_values[5]
+ # Check the simple properties
+ assert layer_structure.n_canopy_layers == expected_values["n_canopy_layers"]
+ assert np.all(
+ np.equal(
+ layer_structure.soil_layer_depths, expected_values["soil_layer_depths"]
+ )
+ )
+ assert (
+ layer_structure.above_canopy_height_offset
+ == expected_values["offset_height"]
+ )
+ assert layer_structure.surface_layer_height == expected_values["surface_height"]
+ assert np.all(
+ np.equal(layer_structure.layer_roles, expected_values["layer_roles"])
+ )
+ assert np.allclose(
+ layer_structure.soil_layer_thickness, expected_values["soil_thickness"]
+ )
+ assert np.allclose(
+ layer_structure.soil_layer_active_thickness, expected_values["soil_active"]
+ )
+ assert np.all(
+ np.equal(np.isnan(layer_structure.lowest_canopy_filled), np.repeat(True, 9))
+ )
+
+ # Check the index dictionaries
+ assert (
+ layer_structure._role_indices_int.keys()
+ == expected_values["layer_indices"].keys()
+ )
+ for ky in layer_structure._role_indices_int.keys():
+ exp_int_index = expected_values["layer_indices"][ky]
+ # Do the integer indices match
+ assert np.all(
+ np.equal(layer_structure._role_indices_int[ky], exp_int_index)
+ )
+ # Do the boolean indices match
+
+ bool_indices = np.repeat(False, layer_structure.n_layers)
+ bool_indices[exp_int_index] = True
+ assert np.all(
+ np.equal(layer_structure._role_indices_bool[ky], bool_indices)
+ )
+
+ # Does the attribute/property API return the same as the boolean index
+ assert np.all(
+ np.equal(getattr(layer_structure, f"index_{ky}"), bool_indices)
+ )
+
+ # Check the from_template data array
+ template = layer_structure.from_template("a_variable")
+ assert isinstance(template, DataArray)
+ assert template.shape == (layer_structure.n_layers, layer_structure._n_cells)
+ assert template.dims == ("layers", "cell_id")
+ assert template.name == "a_variable"
+ assert np.all(
+ np.equal(template["layers"].to_numpy(), layer_structure.layer_indices)
+ )
+ assert np.all(
+ np.equal(template["layer_roles"].to_numpy(), layer_structure.layer_roles)
+ )
+ assert np.all(
+ np.equal(
+ template["cell_id"].to_numpy(), np.arange(layer_structure._n_cells)
+ )
+ )
+
+
+def test_LayerStructure_set_filled_canopy():
+ """Test the set_filled_canopy_method.
+
+ This test:
+
+ * Calls the `set_filled_canopy` method with a simple canopy structure with a simple
+ triangle of filled canopy layers across the 9 grid cells, so that the lowest
+ canopy layer is never filled and the ninth cell has no filled.canopy.
+ * Checks that the filled canopy layers and lowest filled canopy attributes are then
+ as expected
+ * Checks that the aggregate role index has been updated with the new canopy state.
+ """
+
+ from virtual_ecosystem.core.config import Config
+ from virtual_ecosystem.core.core_components import LayerStructure
+
+ cfg = Config(cfg_strings="[core]")
+ layer_structure = LayerStructure(
+ cfg, n_cells=9, max_depth_of_microbial_activity=0.25
+ )
+
+ # Run the set_filled_canopy method to populate the filled layers and update cached
+ # indices.
+ canopy_heights = np.full(
+ (layer_structure.n_canopy_layers, layer_structure._n_cells), np.nan
+ )
+ canopy_heights[0:8, 0:8] = np.where(np.flipud(np.tri(8)), 1, np.nan)
+
+ layer_structure.set_filled_canopy(canopy_heights=canopy_heights)
+
+ # Check the attributes have been set correctly.
+ assert np.allclose(
+ layer_structure.lowest_canopy_filled,
+ np.concatenate([np.arange(8, 0, -1), [np.nan]]),
+ equal_nan=True,
+ )
+
+ # Index attributes that are defined using filled_canopy
+ exp_filled_canopy = np.repeat(False, layer_structure.n_layers)
+ exp_filled_canopy[np.arange(1, 9)] = True
+ assert np.allclose(layer_structure.index_filled_canopy, exp_filled_canopy)
+
+ exp_filled_atmosphere = np.repeat(False, layer_structure.n_layers)
+ exp_filled_atmosphere[np.concatenate([[0], np.arange(1, 9), [11]])] = True
+ assert np.allclose(layer_structure.index_filled_atmosphere, exp_filled_atmosphere)
+
+ exp_flux_layers = np.repeat(False, layer_structure.n_layers)
+ exp_flux_layers[np.concatenate([np.arange(1, 9), [12]])] = True
+ assert np.allclose(layer_structure.index_flux_layers, exp_flux_layers)
@pytest.mark.parametrize(
@@ -286,7 +497,7 @@ def test_ModelTiming(caplog, config, output, raises, expected_log_entries):
argvalues=[
(1, does_not_raise()),
(1.23, does_not_raise()),
- (np.infty, pytest.raises(ConfigurationError)),
+ (np.inf, pytest.raises(ConfigurationError)),
(np.nan, pytest.raises(ConfigurationError)),
(-9, pytest.raises(ConfigurationError)),
(-9.5, pytest.raises(ConfigurationError)),
@@ -307,7 +518,7 @@ def test__validate_positive_finite_numeric(value, raises):
argvalues=[
(10, does_not_raise()),
(1.23, pytest.raises(ConfigurationError)),
- (np.infty, pytest.raises(ConfigurationError)),
+ (np.inf, pytest.raises(ConfigurationError)),
(np.nan, pytest.raises(ConfigurationError)),
(-9, pytest.raises(ConfigurationError)),
(-9.5, pytest.raises(ConfigurationError)),
diff --git a/tests/core/test_data.py b/tests/core/test_data.py
index 95695fe43..511a4b7b5 100644
--- a/tests/core/test_data.py
+++ b/tests/core/test_data.py
@@ -840,7 +840,7 @@ def test_save_timeslice_to_netcdf(
dummy_carbon_data["soil_c_pool_lmwc"] = DataArray(
[0.1, 0.05, 0.2, 0.01], dims=["cell_id"], coords={"cell_id": [0, 1, 2, 3]}
)
- dummy_carbon_data["soil_temperature"][13][0] = 15.0
+ dummy_carbon_data["soil_temperature"][12][0] = 15.0
# Append data to netcdf file
dummy_carbon_data.save_timeslice_to_netcdf(
out_path,
@@ -859,7 +859,7 @@ def test_save_timeslice_to_netcdf(
),
)
xr.testing.assert_allclose(
- saved_data["soil_temperature"].isel(layers=range(12, 15)),
+ saved_data["soil_temperature"].isel(layers=range(11, 14)),
DataArray(
[
[
@@ -872,8 +872,8 @@ def test_save_timeslice_to_netcdf(
coords={
"cell_id": [0, 1, 2, 3],
"time_index": [1],
- "layers": [12, 13, 14],
- "layer_roles": ("layers", ["surface", "soil", "soil"]),
+ "layers": [11, 12, 13],
+ "layer_roles": ("layers", ["surface", "topsoil", "subsoil"]),
},
),
)
@@ -890,26 +890,20 @@ def test_save_timeslice_to_netcdf(
log_check(caplog, expected_log)
-def test_Data_add_from_dict(dummy_climate_data):
+def test_Data_add_from_dict(fixture_core_components, dummy_climate_data):
"""Test reading from dictionary."""
from virtual_ecosystem.core.data import Data
var_dict = {
- "air_temperature": DataArray(
- np.full((3, 3), 20),
- dims=["cell_id", "time"],
- coords=dummy_climate_data["air_temperature_ref"].coords,
- name="air_temperature_ref",
- ),
"mean_annual_temperature": DataArray(
- np.full((3), 40),
+ np.full((fixture_core_components.grid.n_cells), 40),
dims=["cell_id"],
coords=dummy_climate_data["mean_annual_temperature"].coords,
name="mean_annual_temperature",
),
"new_variable": DataArray(
- np.full((3), 100),
+ np.full((fixture_core_components.grid.n_cells), 100),
dims=["cell_id"],
coords=dummy_climate_data["mean_annual_temperature"].coords,
name="new_variable",
@@ -918,19 +912,10 @@ def test_Data_add_from_dict(dummy_climate_data):
Data.add_from_dict(dummy_climate_data, var_dict)
- xr.testing.assert_allclose(
- dummy_climate_data["air_temperature"],
- DataArray(
- np.full((3, 3), 20),
- dims=["cell_id", "time"],
- coords=dummy_climate_data["air_temperature"].coords,
- name="air_temperature",
- ),
- )
xr.testing.assert_allclose(
dummy_climate_data["mean_annual_temperature"],
DataArray(
- np.full((3), 40),
+ np.full((fixture_core_components.grid.n_cells), 40),
dims=["cell_id"],
coords=dummy_climate_data["mean_annual_temperature"].coords,
name="mean_annual_temperature",
@@ -939,7 +924,7 @@ def test_Data_add_from_dict(dummy_climate_data):
xr.testing.assert_allclose(
dummy_climate_data["new_variable"],
DataArray(
- np.full((3), 100),
+ np.full((fixture_core_components.grid.n_cells), 100),
dims=["cell_id"],
coords=dummy_climate_data["mean_annual_temperature"].coords,
name="new_variable",
@@ -986,6 +971,7 @@ def test_output_current_state(mocker, dummy_carbon_data, time_index):
"soil_c_pool_lmwc",
"soil_c_pool_microbe",
"soil_c_pool_pom",
+ "soil_c_pool_necromass",
"soil_enzyme_pom",
"soil_enzyme_maom",
],
@@ -1016,7 +1002,7 @@ def test_merge_continuous_data_files(shared_datadir, dummy_carbon_data):
dummy_carbon_data["soil_c_pool_lmwc"] = DataArray(
[0.1, 0.05, 0.2, 0.01], dims=["cell_id"], coords={"cell_id": [0, 1, 2, 3]}
)
- dummy_carbon_data["soil_temperature"][13][0] = 15.0
+ dummy_carbon_data["soil_temperature"][12][0] = 15.0
# Save second data file
dummy_carbon_data.save_timeslice_to_netcdf(
@@ -1050,7 +1036,7 @@ def test_merge_continuous_data_files(shared_datadir, dummy_carbon_data):
),
)
testing.assert_allclose(
- full_data["soil_temperature"].isel(layers=range(12, 15)),
+ full_data["soil_temperature"].isel(layers=range(11, 14)),
DataArray(
[
[
@@ -1068,8 +1054,8 @@ def test_merge_continuous_data_files(shared_datadir, dummy_carbon_data):
coords={
"cell_id": [0, 1, 2, 3],
"time_index": [1, 2],
- "layers": [12, 13, 14],
- "layer_roles": ("layers", ["surface", "soil", "soil"]),
+ "layers": [11, 12, 13],
+ "layer_roles": ("layers", ["surface", "topsoil", "subsoil"]),
},
),
)
diff --git a/tests/core/test_modules/bad_name/test_model.py b/tests/core/test_modules/bad_name/test_model.py
index ee2fe577d..8fc544c98 100644
--- a/tests/core/test_modules/bad_name/test_model.py
+++ b/tests/core/test_modules/bad_name/test_model.py
@@ -6,8 +6,11 @@
class ATestModel(
BaseModel,
model_name="name_is_not_bad_name",
- required_init_vars=tuple(),
+ vars_required_for_init=tuple(),
model_update_bounds=("1 day", "1 month"),
vars_updated=tuple(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
"""A test module."""
diff --git a/tests/core/test_modules/one_model/constants.py b/tests/core/test_modules/one_model/constants.py
index 7e507b8e8..b0fc5eb17 100644
--- a/tests/core/test_modules/one_model/constants.py
+++ b/tests/core/test_modules/one_model/constants.py
@@ -1,4 +1,4 @@
-"""A test constants class for the test module.""" # noqa: D205, D415
+"""A test constants class for the test module."""
from dataclasses import dataclass
diff --git a/tests/core/test_modules/one_model/test_model.py b/tests/core/test_modules/one_model/test_model.py
index b62953225..dbd43807d 100644
--- a/tests/core/test_modules/one_model/test_model.py
+++ b/tests/core/test_modules/one_model/test_model.py
@@ -6,8 +6,11 @@
class ATestModel(
BaseModel,
model_name="one_model",
- required_init_vars=tuple(),
+ vars_required_for_init=tuple(),
model_update_bounds=("1 day", "1 month"),
vars_updated=tuple(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
"""A test module."""
diff --git a/tests/core/test_modules/two_models/test_model.py b/tests/core/test_modules/two_models/test_model.py
index 25700bdab..7535705f4 100644
--- a/tests/core/test_modules/two_models/test_model.py
+++ b/tests/core/test_modules/two_models/test_model.py
@@ -6,9 +6,12 @@
class ATestModel1(
BaseModel,
model_name="two_models",
- required_init_vars=tuple(),
+ vars_required_for_init=tuple(),
model_update_bounds=("1 day", "1 month"),
vars_updated=tuple(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
"""A test module."""
@@ -16,8 +19,11 @@ class ATestModel1(
class ATestModel2(
BaseModel,
model_name="two_models",
- required_init_vars=tuple(),
+ vars_required_for_init=tuple(),
model_update_bounds=("1 day", "1 month"),
vars_updated=tuple(),
+ vars_required_for_update=tuple(),
+ vars_populated_by_init=tuple(),
+ vars_populated_by_first_update=tuple(),
):
"""A second unwanted test module."""
diff --git a/tests/core/test_schema.py b/tests/core/test_schema.py
index f488adc66..cda75e8a9 100644
--- a/tests/core/test_schema.py
+++ b/tests/core/test_schema.py
@@ -86,7 +86,7 @@ def test_merge_schemas():
# Import the models to populate the registry
register_module("virtual_ecosystem.core")
register_module("virtual_ecosystem.models.abiotic_simple")
- register_module("virtual_ecosystem.models.animals")
+ register_module("virtual_ecosystem.models.animal")
register_module("virtual_ecosystem.models.plants")
register_module("virtual_ecosystem.models.soil")
@@ -94,7 +94,7 @@ def test_merge_schemas():
{
"core": MODULE_REGISTRY["core"].schema,
"abiotic_simple": MODULE_REGISTRY["abiotic_simple"].schema,
- "animals": MODULE_REGISTRY["animals"].schema,
+ "animal": MODULE_REGISTRY["animal"].schema,
"plants": MODULE_REGISTRY["plants"].schema,
"soil": MODULE_REGISTRY["soil"].schema,
}
@@ -102,7 +102,7 @@ def test_merge_schemas():
assert set(merged_schemas["required"]) == {
"abiotic_simple",
- "animals",
+ "animal",
"plants",
"soil",
"core",
diff --git a/tests/core/test_utils.py b/tests/core/test_utils.py
index 430e21a6f..faffa8541 100644
--- a/tests/core/test_utils.py
+++ b/tests/core/test_utils.py
@@ -1,13 +1,12 @@
"""Testing the utility functions."""
-from contextlib import nullcontext as does_not_raise
-from logging import CRITICAL, ERROR
+from logging import CRITICAL
from pathlib import Path
import pytest
from tests.conftest import log_check
-from virtual_ecosystem.core.exceptions import ConfigurationError, InitialisationError
+from virtual_ecosystem.core.exceptions import ConfigurationError
@pytest.mark.parametrize(
@@ -59,96 +58,3 @@ def test_check_outfile(caplog, mocker, out_path, expected_log_entries):
check_outfile(Path(out_path))
log_check(caplog, expected_log_entries)
-
-
-@pytest.mark.parametrize(
- "soil_layers, canopy_layers, raises, exp_log",
- [
- pytest.param([-0.25, -1.0], 10, does_not_raise(), (), id="valid"),
- pytest.param(
- "not a list",
- 10,
- pytest.raises(InitialisationError),
- (
- (
- ERROR,
- "The soil layers must be a list of layer depths.",
- ),
- ),
- id="soil_not_list",
- ),
- pytest.param(
- ["0.5", 1.0],
- 10,
- pytest.raises(InitialisationError),
- (
- (
- ERROR,
- "The soil layer depths are not all numeric.",
- ),
- ),
- id="soil_layer_contains_str",
- ),
- pytest.param(
- [-0.25, 1.0],
- 10,
- pytest.raises(InitialisationError),
- (
- (
- ERROR,
- "Soil layer depths must be strictly decreasing and negative.",
- ),
- ),
- id="soil_layer_contains_positive_value",
- ),
- pytest.param(
- [-10.5, -1.0],
- 10,
- pytest.raises(InitialisationError),
- (
- (
- ERROR,
- "Soil layer depths must be strictly decreasing and negative.",
- ),
- ),
- id="soil_layer_not_strictly_decreasing",
- ),
- pytest.param(
- [-0.25, -1.0],
- 3.4,
- pytest.raises(InitialisationError),
- (
- (
- ERROR,
- "The number of canopy layers is not an integer.",
- ),
- ),
- id="canopy_layer_not_integer",
- ),
- pytest.param(
- [-0.25, -1.0],
- -3,
- pytest.raises(InitialisationError),
- (
- (
- ERROR,
- "The number of canopy layer must be greater than zero.",
- ),
- ),
- id="canopy_layers_negative",
- ),
- ],
-)
-def test_set_layer_roles(soil_layers, canopy_layers, raises, caplog, exp_log):
- """Test correct order of layers."""
- from virtual_ecosystem.core.utils import set_layer_roles
-
- with raises:
- result = set_layer_roles(canopy_layers, soil_layers)
-
- assert result == (
- ["above"] + ["canopy"] * 10 + ["subcanopy"] + ["surface"] + ["soil"] * 2
- )
-
- # Final check that expected logging entries are produced
- log_check(caplog, exp_log)
diff --git a/tests/core/test_variables.py b/tests/core/test_variables.py
new file mode 100644
index 000000000..ca5c2c34b
--- /dev/null
+++ b/tests/core/test_variables.py
@@ -0,0 +1,470 @@
+"""Tests for the virtual_ecosystem.core.variables module."""
+
+import sys
+
+import pytest
+
+if sys.version_info[:2] >= (3, 11):
+ import tomllib
+else:
+ import tomli as tomllib # noqa: F401
+
+
+@pytest.fixture
+def known_variables():
+ """Fixture to reset the known variables after each test."""
+ from virtual_ecosystem.core import variables
+
+ vars_bkp = variables.KNOWN_VARIABLES.copy()
+ variables.KNOWN_VARIABLES.clear()
+ yield variables.KNOWN_VARIABLES
+ variables.KNOWN_VARIABLES.clear()
+ variables.KNOWN_VARIABLES.update(vars_bkp)
+
+
+@pytest.fixture
+def run_variables():
+ """Fixture to reset the run variables after each test."""
+ from virtual_ecosystem.core import variables
+
+ vars_bkp = variables.RUN_VARIABLES_REGISTRY.copy()
+ variables.RUN_VARIABLES_REGISTRY.clear()
+ yield variables.RUN_VARIABLES_REGISTRY
+ variables.RUN_VARIABLES_REGISTRY.clear()
+ variables.RUN_VARIABLES_REGISTRY.update(vars_bkp)
+
+
+@pytest.fixture
+def axis_validators():
+ """Fixture to reset the axis validators after each test."""
+ import virtual_ecosystem.core.axes as axes
+
+ vars_bkp = axes.AXIS_VALIDATORS.copy()
+ axes.AXIS_VALIDATORS.clear()
+ yield axes.AXIS_VALIDATORS
+ axes.AXIS_VALIDATORS.clear()
+ axes.AXIS_VALIDATORS.update(vars_bkp)
+
+
+def test_register_variable(known_variables):
+ """Test the register_variable function."""
+ from virtual_ecosystem.core import variables
+
+ var = variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+ assert "test_var" in variables.KNOWN_VARIABLES
+ assert variables.KNOWN_VARIABLES["test_var"] == var
+
+
+def test_register_variable_duplicate(known_variables):
+ """Test the register_variable function with a duplicate variable."""
+ from virtual_ecosystem.core import variables
+
+ variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+ with pytest.raises(ValueError):
+ variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+
+def test_register_all_variables(known_variables):
+ """Test the register_all_variables function."""
+ from virtual_ecosystem.core import variables
+
+ assert len(variables.KNOWN_VARIABLES) == 0
+ variables.register_all_variables()
+ assert len(variables.KNOWN_VARIABLES) > 0
+
+
+def test_discover_models(known_variables):
+ """Test the discover_all_variables_usage function."""
+ from virtual_ecosystem.core import base_model, variables
+
+ models = variables._discover_models()
+ assert len(models) > 0
+ assert all(issubclass(x, base_model.BaseModel) for x in models)
+
+
+def test_output_known_variables(known_variables, mocker, tmpdir):
+ """Test the output_known_variables function."""
+ from virtual_ecosystem.core import variables
+
+ mocker.patch("virtual_ecosystem.core.variables.register_all_variables")
+ mocker.patch("virtual_ecosystem.core.variables._discover_models")
+ mocker.patch("virtual_ecosystem.core.variables._collect_vars_populated_by_init")
+ mocker.patch(
+ "virtual_ecosystem.core.variables._collect_vars_populated_by_first_update"
+ )
+ mocker.patch("virtual_ecosystem.core.variables._collect_vars_required_for_init")
+ mocker.patch("virtual_ecosystem.core.variables._collect_updated_by_vars")
+ mocker.patch("virtual_ecosystem.core.variables._collect_vars_required_for_update")
+
+ variables._discover_models.return_value = []
+
+ variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+ path = tmpdir / "variables.rst"
+
+ variables.output_known_variables(path)
+
+ assert "test_var" in variables.RUN_VARIABLES_REGISTRY
+ variables.register_all_variables.assert_called_once()
+ variables._discover_models.assert_called_once()
+ variables._collect_vars_populated_by_init.assert_called_once_with(
+ [], check_unique_initialisation=False
+ )
+ variables._collect_vars_populated_by_first_update.assert_called_once_with(
+ [], check_unique_initialisation=False
+ )
+ variables._collect_vars_required_for_init.assert_called_once_with([])
+ variables._collect_updated_by_vars.assert_called_once_with([])
+ variables._collect_vars_required_for_update.assert_called_once_with([])
+ assert path.exists()
+
+ with open(path) as f:
+ assert "test_var" in f.read()
+
+
+def test_collect_vars_populated_by_init(known_variables, run_variables):
+ """Test the _collect_vars_populated_by_init function."""
+ from virtual_ecosystem.core import variables
+
+ class TestModel:
+ model_name = "TestModel"
+ vars_populated_by_init = ("test_var",)
+
+ with pytest.raises(ValueError, match="not in the known variables registry."):
+ variables._collect_vars_populated_by_init([TestModel])
+
+ variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ variables._collect_vars_populated_by_init([TestModel])
+
+ assert "test_var" in variables.RUN_VARIABLES_REGISTRY
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].populated_by_init == [
+ "TestModel"
+ ]
+
+ with pytest.raises(ValueError, match="already in registry"):
+ variables._collect_vars_populated_by_init([TestModel])
+
+
+def test_collect_vars_populated_by_first_update(known_variables, run_variables):
+ """Test the _collect_vars_populated_by_first_update function."""
+ from virtual_ecosystem.core import variables
+
+ class TestModel:
+ model_name = "TestModel"
+ vars_populated_by_first_update = ("test_var",)
+ vars_populated_by_init = ("test_var",)
+
+ with pytest.raises(ValueError, match="not in the known variables registry."):
+ variables._collect_vars_populated_by_first_update([TestModel])
+
+ variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ variables._collect_vars_populated_by_first_update([TestModel])
+
+ assert "test_var" in variables.RUN_VARIABLES_REGISTRY
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].populated_by_update == [
+ "TestModel"
+ ]
+
+ with pytest.raises(ValueError, match="already in registry"):
+ variables._collect_vars_populated_by_first_update([TestModel])
+
+ # If the variable was initialised during init...
+ variables.RUN_VARIABLES_REGISTRY.pop("test_var")
+ variables._collect_vars_populated_by_init([TestModel])
+
+ # re-registering ruring update will also fail
+ with pytest.raises(ValueError, match="already in registry"):
+ variables._collect_vars_populated_by_first_update([TestModel])
+
+
+def test_collect_updated_by_vars(known_variables, run_variables, caplog):
+ """Test the _collect_updated_by_vars function."""
+ from virtual_ecosystem.core import variables
+
+ class TestModel:
+ model_name = "TestModel"
+ vars_updated = ("test_var",)
+
+ with pytest.raises(ValueError, match="not in the known variables registry."):
+ variables._collect_updated_by_vars([TestModel])
+
+ var = variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ with pytest.raises(ValueError, match="is not initialised"):
+ variables._collect_updated_by_vars([TestModel])
+
+ variables.RUN_VARIABLES_REGISTRY["test_var"] = var
+ variables.RUN_VARIABLES_REGISTRY["test_var"].populated_by_init = "AnotherModel"
+
+ variables._collect_updated_by_vars([TestModel])
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].updated_by == ["TestModel"]
+
+ variables._collect_updated_by_vars([TestModel])
+ assert caplog.records[-1].levelname == "WARNING"
+ assert "is already updated" in caplog.records[-1].message
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].updated_by == [
+ "TestModel",
+ "TestModel",
+ ]
+
+
+def test_collect_vars_required_for_update(known_variables, run_variables):
+ """Test the _collect_vars_required_for_update function."""
+ from virtual_ecosystem.core import variables
+
+ class TestModel:
+ model_name = "TestModel"
+ vars_required_for_update = ("test_var",)
+
+ with pytest.raises(ValueError, match="not in the known variables registry."):
+ variables._collect_vars_required_for_update([TestModel])
+
+ var = variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ with pytest.raises(ValueError, match="is not initialised"):
+ variables._collect_vars_required_for_update([TestModel])
+
+ variables.RUN_VARIABLES_REGISTRY["test_var"] = var
+ variables.RUN_VARIABLES_REGISTRY["test_var"].populated_by_init = "AnotherModel"
+
+ variables._collect_vars_required_for_update([TestModel])
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].required_by_update == [
+ "TestModel"
+ ]
+
+
+def test_collect_vars_required_for_init(known_variables, run_variables):
+ """Test the _collect_vars_required_for_init function."""
+ from virtual_ecosystem.core import variables
+
+ class TestModel:
+ model_name = "TestModel"
+ vars_required_for_init = ("test_var",)
+
+ with pytest.raises(ValueError, match="not in the known variables registry."):
+ variables._collect_vars_required_for_init([TestModel])
+
+ var = variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ with pytest.raises(ValueError, match="is not initialised"):
+ variables._collect_vars_required_for_init([TestModel])
+
+ variables.RUN_VARIABLES_REGISTRY["test_var"] = var
+ variables.RUN_VARIABLES_REGISTRY["test_var"].populated_by_init = "AnotherModel"
+
+ variables._collect_vars_required_for_init([TestModel])
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].required_by_init == [
+ "TestModel"
+ ]
+
+
+def test_collect_initial_data_vars(known_variables, run_variables):
+ """Test the _collect_initial_data_vars function."""
+ from virtual_ecosystem.core import variables
+
+ with pytest.raises(ValueError, match="defined in data object is not known"):
+ variables._collect_initial_data_vars(["test_var"])
+
+ variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ variables._collect_initial_data_vars(["test_var"])
+
+ assert "test_var" in variables.RUN_VARIABLES_REGISTRY
+ assert variables.RUN_VARIABLES_REGISTRY["test_var"].populated_by_init == ["data"]
+
+ with pytest.raises(ValueError, match="already in registry"):
+ variables._collect_initial_data_vars(["test_var"])
+
+
+def test_setup_variables(mocker):
+ """Test the _collect_initial_data_vars function."""
+ from virtual_ecosystem.core import variables
+
+ mocker.patch("virtual_ecosystem.core.variables._collect_initial_data_vars")
+ mocker.patch("virtual_ecosystem.core.variables._collect_vars_populated_by_init")
+ mocker.patch(
+ "virtual_ecosystem.core.variables._collect_vars_populated_by_first_update"
+ )
+ mocker.patch("virtual_ecosystem.core.variables._collect_vars_required_for_init")
+ mocker.patch("virtual_ecosystem.core.variables._collect_updated_by_vars")
+ mocker.patch("virtual_ecosystem.core.variables._collect_vars_required_for_update")
+
+ class TestModel:
+ pass
+
+ variables.setup_variables([TestModel], ["test_var"])
+
+ variables._collect_initial_data_vars.assert_called_once_with(["test_var"])
+ variables._collect_vars_populated_by_init.assert_called_once_with([TestModel])
+ variables._collect_vars_required_for_init.assert_called_once_with([TestModel])
+ variables._collect_updated_by_vars.assert_called_once_with([TestModel])
+ variables._collect_vars_required_for_update.assert_called_once_with([TestModel])
+
+
+def test_verify_variables_axis(known_variables, run_variables, axis_validators):
+ """Test the verify_variables_axis function."""
+ from virtual_ecosystem.core import variables
+
+ var = variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+ variables.RUN_VARIABLES_REGISTRY["test_var"] = var
+
+ with pytest.raises(ValueError, match="uses unknown axis: x,y,z"):
+ variables.verify_variables_axis()
+
+ axis_validators["x"] = lambda x: x
+
+ with pytest.raises(ValueError, match="uses unknown axis: y,z"):
+ variables.verify_variables_axis()
+
+ axis_validators["y"] = lambda x: x
+ axis_validators["z"] = lambda x: x
+
+ variables.verify_variables_axis()
+
+
+def test_get_variable(known_variables, run_variables):
+ """Test the get_variable function."""
+ from virtual_ecosystem.core import variables
+
+ with pytest.raises(KeyError, match="not a known variable."):
+ variables.get_variable("test_var")
+
+ var = variables.Variable(
+ name="test_var",
+ description="Test variable",
+ unit="m",
+ variable_type="float",
+ axis=("x", "y", "z"),
+ )
+
+ with pytest.raises(
+ KeyError, match="not initialised by any model or provided as input data"
+ ):
+ variables.get_variable("test_var")
+
+ variables.RUN_VARIABLES_REGISTRY["test_var"] = var
+ result = variables.get_variable("test_var")
+ assert result == var
+
+
+def test_to_camel_case():
+ """Test the to_camel_case function."""
+ from virtual_ecosystem.core.variables import to_camel_case
+
+ assert to_camel_case("abiotic") == "Abiotic"
+ assert to_camel_case("abiotic_simple") == "AbioticSimple"
+ assert to_camel_case("abiotic_super_simple") == "AbioticSuperSimple"
+
+
+def test_format_variables_list():
+ """Test the _format_varriables_list function."""
+ from virtual_ecosystem.core.variables import _format_varriables_list
+
+ vars = {
+ "var1": {
+ "name": "Variable 1",
+ "description": "Description 1",
+ "unit": "m",
+ "variable_type": "float",
+ "axis": ("x", "y", "z"),
+ },
+ "var2": {
+ "name": "Variable 2",
+ "description": "Description 2",
+ "unit": "s",
+ "variable_type": "int",
+ "axis": ("x", "y"),
+ },
+ }
+
+ expected_output = """1- Variable 1
+=============
+
+============= ===============
+name Variable 1
+description Description 1
+unit m
+variable_type float
+axis ('x', 'y', 'z')
+============= ===============
+
+2- Variable 2
+=============
+
+============= =============
+name Variable 2
+description Description 2
+unit s
+variable_type int
+axis ('x', 'y')
+============= =============
+"""
+
+ assert _format_varriables_list(vars) == expected_output
diff --git a/tests/models/abiotic/test_abiotic_model.py b/tests/models/abiotic/test_abiotic_model.py
new file mode 100644
index 000000000..b39f0b695
--- /dev/null
+++ b/tests/models/abiotic/test_abiotic_model.py
@@ -0,0 +1,447 @@
+"""Test module for abiotic.abiotic_model.py."""
+
+from contextlib import nullcontext as does_not_raise
+from logging import CRITICAL, DEBUG, ERROR, INFO
+from unittest.mock import patch
+
+import numpy as np
+import pytest
+import xarray as xr
+from xarray import DataArray
+
+from tests.conftest import log_check
+from virtual_ecosystem.core.exceptions import ConfigurationError
+
+REQUIRED_INIT_VAR_CHECKS = (
+ (DEBUG, "abiotic model: required var 'air_temperature_ref' checked"),
+ (DEBUG, "abiotic model: required var 'relative_humidity_ref' checked"),
+ (DEBUG, "abiotic model: required var 'topofcanopy_radiation' checked"),
+ (DEBUG, "abiotic model: required var 'leaf_area_index' checked"),
+ (DEBUG, "abiotic model: required var 'layer_heights' checked"),
+)
+
+SETUP_MANIPULATIONS = (
+ (INFO, "Replacing data array for 'soil_temperature'"),
+ (INFO, "Replacing data array for 'vapour_pressure_deficit_ref'"),
+ (INFO, "Replacing data array for 'vapour_pressure_ref'"),
+ (INFO, "Replacing data array for 'air_temperature'"),
+ (INFO, "Replacing data array for 'relative_humidity'"),
+ (INFO, "Adding data array for 'vapour_pressure_deficit'"),
+ (INFO, "Replacing data array for 'atmospheric_pressure'"),
+ (INFO, "Adding data array for 'atmospheric_co2'"),
+ (INFO, "Replacing data array for 'soil_temperature'"),
+ (INFO, "Replacing data array for 'canopy_absorption'"),
+ (INFO, "Replacing data array for 'canopy_temperature'"),
+ (INFO, "Replacing data array for 'sensible_heat_flux'"),
+ (INFO, "Replacing data array for 'latent_heat_flux'"),
+ (INFO, "Adding data array for 'ground_heat_flux'"),
+ (INFO, "Adding data array for 'air_heat_conductivity'"),
+ (INFO, "Replacing data array for 'leaf_vapour_conductivity'"),
+ (INFO, "Replacing data array for 'leaf_air_heat_conductivity'"),
+)
+
+
+def test_abiotic_model_initialization(
+ caplog, dummy_climate_data, fixture_core_components
+):
+ """Test `AbioticModel` initialization."""
+ from virtual_ecosystem.core.base_model import BaseModel
+ from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel
+ from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+ # Initialize model
+ model = AbioticModel(
+ dummy_climate_data,
+ core_components=fixture_core_components,
+ model_constants=AbioticConsts(),
+ )
+
+ # In cases where it passes then checks that the object has the right properties
+ assert isinstance(model, BaseModel)
+ assert model.model_name == "abiotic"
+ assert str(model) == "A abiotic model instance"
+ assert repr(model) == "AbioticModel(update_interval=1209600 seconds)"
+
+ # Final check that expected logging entries are produced
+ log_check(
+ caplog,
+ expected_log=REQUIRED_INIT_VAR_CHECKS + SETUP_MANIPULATIONS,
+ )
+
+
+def test_abiotic_model_initialization_no_data(caplog, fixture_core_components):
+ """Test `AbioticModel` initialization with no data."""
+
+ from virtual_ecosystem.core.data import Data
+ from virtual_ecosystem.core.grid import Grid
+ from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel
+ from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+ with pytest.raises(ValueError):
+ # Make four cell grid
+ grid = Grid(cell_nx=4, cell_ny=1)
+ empty_data = Data(grid)
+
+ # Try and initialise model with empty data object
+ _ = AbioticModel(
+ empty_data,
+ core_components=fixture_core_components,
+ model_constants=AbioticConsts(),
+ )
+
+ # Final check that expected logging entries are produced
+ log_check(
+ caplog,
+ expected_log=(
+ (
+ ERROR,
+ "abiotic model: init data missing required var 'air_temperature_ref'",
+ ),
+ (
+ ERROR,
+ "abiotic model: init data missing required var 'relative_humidity_ref'",
+ ),
+ (
+ ERROR,
+ "abiotic model: init data missing required var 'topofcanopy_radiation'",
+ ),
+ (
+ ERROR,
+ "abiotic model: init data missing required var 'leaf_area_index'",
+ ),
+ (
+ ERROR,
+ "abiotic model: init data missing required var 'layer_heights'",
+ ),
+ (ERROR, "abiotic model: error checking vars_required_for_init, see log."),
+ ),
+ )
+
+
+@pytest.mark.parametrize(
+ "cfg_string, drag_coeff, raises, expected_log_entries",
+ [
+ pytest.param(
+ "[core]\n[core.timing]\nupdate_interval = '12 hours'\n[abiotic]\n",
+ 0.2,
+ does_not_raise(),
+ (
+ (INFO, "Initialised abiotic.AbioticConsts from config"),
+ (
+ INFO,
+ "Information required to initialise the abiotic model successfully "
+ "extracted.",
+ ),
+ *REQUIRED_INIT_VAR_CHECKS,
+ ),
+ id="default_config",
+ ),
+ pytest.param(
+ "[core]\n[core.timing]\nupdate_interval = '12 hours'\n"
+ "[abiotic.constants.AbioticConsts]\ndrag_coefficient = 0.05\n",
+ 0.05,
+ does_not_raise(),
+ (
+ (INFO, "Initialised abiotic.AbioticConsts from config"),
+ (
+ INFO,
+ "Information required to initialise the abiotic model successfully "
+ "extracted.",
+ ),
+ *REQUIRED_INIT_VAR_CHECKS,
+ ),
+ id="modified_config_correct",
+ ),
+ pytest.param(
+ "[core]\n[core.timing]\nupdate_interval = '12 hours'\n"
+ "[abiotic.constants.AbioticConsts]\ndrag_coefficients = 0.05\n",
+ None,
+ pytest.raises(ConfigurationError),
+ (
+ (ERROR, "Unknown names supplied for AbioticConsts: drag_coefficients"),
+ (INFO, "Valid names are: "),
+ (CRITICAL, "Could not initialise abiotic.AbioticConsts from config"),
+ ),
+ id="modified_config_incorrect",
+ ),
+ ],
+)
+def test_generate_abiotic_model(
+ caplog,
+ dummy_climate_data,
+ cfg_string,
+ drag_coeff,
+ raises,
+ expected_log_entries,
+):
+ """Test that the function to initialise the abiotic model behaves as expected."""
+
+ from virtual_ecosystem.core.config import Config
+ from virtual_ecosystem.core.core_components import CoreComponents
+ from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel
+
+ # Build the config object and core components
+ config = Config(cfg_strings=cfg_string)
+ core_components = CoreComponents(config)
+ caplog.clear()
+
+ # We patch the _setup step as it is tested separately
+ module_name = "virtual_ecosystem.models.abiotic.abiotic_model"
+ with patch(f"{module_name}.AbioticModel._setup") as mock_setup:
+ # Check whether model is initialised (or not) as expected
+ with raises:
+ model = AbioticModel.from_config(
+ data=dummy_climate_data,
+ core_components=core_components,
+ config=config,
+ )
+ assert model.model_constants.drag_coefficient == drag_coeff
+ mock_setup.assert_called_once()
+
+ # Final check that expected logging entries are produced
+ log_check(caplog, expected_log_entries)
+
+
+@pytest.mark.parametrize(
+ "cfg_string, raises, expected_log_entries",
+ [
+ pytest.param(
+ "[core]\n[core.timing]\nupdate_interval = '1 year'\n[abiotic]\n",
+ pytest.raises(ConfigurationError),
+ (
+ (INFO, "Initialised abiotic.AbioticConsts from config"),
+ (
+ INFO,
+ "Information required to initialise the abiotic model "
+ "successfully extracted.",
+ ),
+ *REQUIRED_INIT_VAR_CHECKS,
+ (
+ ERROR,
+ "The update interval is slower than the abiotic upper "
+ "bound of 1 month.",
+ ),
+ ),
+ id="time interval out of bounds",
+ ),
+ ],
+)
+def test_generate_abiotic_model_bounds_error(
+ caplog,
+ dummy_climate_data,
+ cfg_string,
+ raises,
+ expected_log_entries,
+):
+ """Test that the initialisation of the abiotic model from config."""
+
+ from virtual_ecosystem.core.config import Config
+ from virtual_ecosystem.core.core_components import CoreComponents
+ from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel
+
+ # Build the config object and core components
+ config = Config(cfg_strings=cfg_string)
+ core_components = CoreComponents(config)
+ caplog.clear()
+
+ # Check whether model is initialised (or not) as expected
+ with raises:
+ _ = AbioticModel.from_config(
+ data=dummy_climate_data,
+ core_components=core_components,
+ config=config,
+ )
+
+ # Final check that expected logging entries are produced
+ log_check(caplog, expected_log_entries)
+
+
+def test_setup_abiotic_model(dummy_climate_data, fixture_core_components):
+ """Test that setup() returns expected output in data object."""
+
+ from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ # initialise model
+ model = AbioticModel(
+ data=dummy_climate_data,
+ core_components=fixture_core_components,
+ )
+
+ # check all variables are in data object
+ for var in [
+ "air_temperature",
+ "soil_temperature",
+ "relative_humidity",
+ "vapour_pressure_deficit",
+ "atmospheric_pressure",
+ "atmospheric_co2",
+ ]:
+ assert var in model.data
+
+ # Test that VPD was calculated for all time steps
+ xr.testing.assert_allclose(
+ model.data["vapour_pressure_deficit_ref"],
+ DataArray(
+ np.full((4, 3), 0.141727),
+ dims=["cell_id", "time_index"],
+ coords={
+ "cell_id": [0, 1, 2, 3],
+ },
+ ),
+ )
+
+ # Test that soil temperature was created correctly
+ expected_soil_temp = lyr_strct.from_template()
+ expected_soil_temp[lyr_strct.index_all_soil] = np.array([20.712458, 20.0])[:, None]
+ xr.testing.assert_allclose(model.data["soil_temperature"], expected_soil_temp)
+
+ # Test that air temperature was interpolated correctly
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = np.array(
+ [30, 29.91965, 29.414851, 28.551891, 22.81851]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["air_temperature"], exp_air_temp)
+
+ # Test other variables have been inserted and some check values
+ for var in [
+ "canopy_temperature",
+ "sensible_heat_flux",
+ "latent_heat_flux",
+ "ground_heat_flux",
+ "canopy_absorption",
+ "air_heat_conductivity",
+ "leaf_vapour_conductivity",
+ "leaf_air_heat_conductivity",
+ ]:
+ assert var in model.data
+
+ exp_canopy_abs = lyr_strct.from_template()
+ exp_canopy_abs[lyr_strct.index_filled_canopy] = np.array(
+ [0.09995, 0.09985, 0.09975]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["canopy_absorption"], exp_canopy_abs)
+
+ for var in ["sensible_heat_flux", "latent_heat_flux"]:
+ expected_vals = lyr_strct.from_template()
+ expected_vals[lyr_strct.index_flux_layers] = 0.0
+ xr.testing.assert_allclose(model.data[var], expected_vals)
+
+
+def test_update_abiotic_model(dummy_climate_data, fixture_core_components):
+ """Test that update() returns expected output in data object."""
+
+ from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ # initialise model
+ model = AbioticModel(
+ data=dummy_climate_data,
+ core_components=fixture_core_components,
+ )
+
+ model.update(time_index=0)
+
+ # Check that updated vars are in data object
+ for var in [
+ "air_temperature",
+ "canopy_temperature",
+ "soil_temperature",
+ "vapour_pressure",
+ "vapour_pressure_deficit",
+ "air_heat_conductivity",
+ "conductivity_from_ref_height",
+ "leaf_air_heat_conductivity",
+ "leaf_vapour_conductivity",
+ "wind_speed",
+ "friction_velocity",
+ "diabatic_correction_heat_above",
+ "diabatic_correction_momentum_above",
+ "diabatic_correction_heat_canopy",
+ "diabatic_correction_momentum_canopy",
+ "sensible_heat_flux",
+ "latent_heat_flux",
+ "ground_heat_flux",
+ "soil_absorption",
+ "longwave_emission_soil",
+ "molar_density_air",
+ "specific_heat_air",
+ ]:
+ assert var in model.data
+
+ # Test variable values
+ friction_velocity_exp = DataArray(
+ np.repeat(0.161295, fixture_core_components.grid.n_cells),
+ coords={"cell_id": dummy_climate_data["cell_id"]},
+ )
+ xr.testing.assert_allclose(model.data["friction_velocity"], friction_velocity_exp)
+
+ # VIVI - all of the commented values below are the original calculated test values
+ # but these have all changed (mostly very little) when the test data and setup was
+ # updated in #441. This could be a change in the inputs or could be problems with
+ # the changes in the implementation with #441. Either way - these tests pass but
+ # this is circular, since these value are for the moment taken straight from the
+ # outputs and not validated.
+
+ # Wind speed
+ exp_wind_speed = lyr_strct.from_template()
+ exp_wind_speed[lyr_strct.index_filled_atmosphere] = np.array(
+ # [0.727122, 0.615474, 0.587838, 0.537028, 0.50198]
+ [0.72712164, 0.61547404, 0.57491436, 0.47258967, 0.41466282]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["wind_speed"], exp_wind_speed)
+
+ # Soil temperature
+ exp_new_soiltemp = lyr_strct.from_template()
+ exp_new_soiltemp[lyr_strct.index_all_soil] = np.array(
+ [ # [20.713167, 20.708367, 20.707833, 20.707833],
+ [20.712458, 20.712457, 20.712456, 20.712456],
+ [20.0, 20.0, 20.0, 20.0],
+ ]
+ )
+ xr.testing.assert_allclose(model.data["soil_temperature"], exp_new_soiltemp)
+
+ # Leaf vapour conductivity
+ exp_gv = lyr_strct.from_template()
+ exp_gv[lyr_strct.index_filled_canopy] = np.array(
+ # [0.496563, 0.485763, 0.465142]
+ [0.4965627, 0.48056564, 0.43718369]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["leaf_vapour_conductivity"], exp_gv)
+
+ # Air temperature
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = np.array(
+ # [30.0, 29.999943, 29.992298, 29.623399, 20.802228]
+ [30.0, 29.99994326, 29.99237944, 29.6604941, 20.80193877]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["air_temperature"], exp_air_temp)
+
+ # Canopy temperature
+ exp_leaf_temp = lyr_strct.from_template()
+ exp_leaf_temp[lyr_strct.index_filled_canopy] = np.array(
+ # [28.787061, 28.290299, 28.15982]
+ [28.78850297, 28.29326228, 28.19789174]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["canopy_temperature"], exp_leaf_temp)
+
+ # TODO fix fluxes from soil
+
+ # Latent heat flux
+ exp_latent_heat = lyr_strct.from_template()
+ exp_latent_heat[lyr_strct.index_filled_canopy] = np.array(
+ # [28.07077, 27.568715, 16.006325]
+ [28.07077012, 27.35735709, 14.97729136]
+ )[:, None]
+ exp_latent_heat[lyr_strct.index_topsoil] = np.array([2.254, 22.54, 225.4, 225.4])
+ xr.testing.assert_allclose(model.data["latent_heat_flux"], exp_latent_heat)
+
+ # Sensible heat flux
+ exp_sens_heat = lyr_strct.from_template()
+ exp_sens_heat[lyr_strct.index_flux_layers] = np.array(
+ # [-16.970825, -16.47644, -5.637233, -192.074608]
+ [-16.9708248, -16.26697999, -4.65665595, -192.07460835]
+ )[:, None]
+ xr.testing.assert_allclose(model.data["sensible_heat_flux"], exp_sens_heat)
diff --git a/tests/models/abiotic/test_abiotic_tools.py b/tests/models/abiotic/test_abiotic_tools.py
new file mode 100644
index 000000000..b06dbdd93
--- /dev/null
+++ b/tests/models/abiotic/test_abiotic_tools.py
@@ -0,0 +1,94 @@
+"""Test abiotic_tools.py."""
+
+import numpy as np
+import pytest
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def test_calculate_molar_density_air():
+ """Test calculate temperature-dependent molar desity of air."""
+
+ from virtual_ecosystem.models.abiotic.abiotic_tools import (
+ calculate_molar_density_air,
+ )
+
+ result = calculate_molar_density_air(
+ temperature=np.array([[25.0] * 3, [20.0] * 3, [18.0] * 3]),
+ atmospheric_pressure=np.full((3, 3), 96.0),
+ standard_mole=CoreConsts.standard_mole,
+ standard_pressure=CoreConsts.standard_pressure,
+ celsius_to_kelvin=CoreConsts.zero_Celsius,
+ )
+ np.testing.assert_allclose(
+ result,
+ np.array([[38.749371] * 3, [39.410285] * 3, [39.681006] * 3]),
+ rtol=1e-5,
+ atol=1e-5,
+ )
+
+
+def test_calculate_specific_heat_air():
+ """Test calculate specific heat of air."""
+
+ from virtual_ecosystem.models.abiotic.abiotic_tools import (
+ calculate_specific_heat_air,
+ )
+
+ constants = AbioticConsts()
+ result = calculate_specific_heat_air(
+ temperature=np.array([[25.0] * 3, [20.0] * 3, [18.0] * 3]),
+ molar_heat_capacity_air=CoreConsts.molar_heat_capacity_air,
+ specific_heat_equ_factors=constants.specific_heat_equ_factors,
+ )
+
+ exp_result = np.array([[29.2075] * 3, [29.202] * 3, [29.2] * 3])
+
+ np.testing.assert_allclose(result, exp_result, rtol=1e-3, atol=1e-3)
+
+
+def test_calculate_latent_heat_vapourisation():
+ """Test calculation of latent heat of vapourization."""
+
+ from virtual_ecosystem.models.abiotic.abiotic_tools import (
+ calculate_latent_heat_vapourisation,
+ )
+
+ constants = AbioticConsts()
+ result = calculate_latent_heat_vapourisation(
+ temperature=np.array([[25.0] * 3, [20.0] * 3, [18.0] * 3]),
+ celsius_to_kelvin=CoreConsts.zero_Celsius,
+ latent_heat_vap_equ_factors=constants.latent_heat_vap_equ_factors,
+ )
+ exp_result = np.array([[2442.447596] * 3, [2453.174942] * 3, [2457.589459] * 3])
+
+ np.testing.assert_allclose(result, exp_result, rtol=1e-5, atol=1e-5)
+
+
+@pytest.mark.parametrize(
+ "input_array, expected",
+ [
+ (np.array([[1.0, 2.0, 3.0], [4.0, 5.0, 6.0]]), np.array([4.0, 5.0, 6.0])),
+ (
+ np.array([[1.0, np.nan, 3.0], [4.0, 5.0, np.nan], [np.nan, 8.0, 9.0]]),
+ np.array([4.0, 8.0, 9.0]),
+ ),
+ (
+ np.array([[np.nan, 2.0, np.nan], [np.nan, 5.0, np.nan]]),
+ np.array([np.nan, 5.0, np.nan]),
+ ),
+ (np.array([[np.nan, 2.0, 3.0]]), np.array([np.nan, 2.0, 3.0])),
+ (
+ np.array([[np.nan, np.nan, np.nan], [np.nan, np.nan, np.nan]]),
+ np.array([np.nan, np.nan, np.nan]),
+ ),
+ ],
+)
+def test_find_last_valid_row(input_array, expected):
+ """Test that last true value is selected for each column."""
+
+ from virtual_ecosystem.models.abiotic.abiotic_tools import find_last_valid_row
+
+ result = find_last_valid_row(input_array)
+ np.testing.assert_allclose(result, expected)
diff --git a/tests/models/abiotic/test_conductivities.py b/tests/models/abiotic/test_conductivities.py
new file mode 100644
index 000000000..75c4581f8
--- /dev/null
+++ b/tests/models/abiotic/test_conductivities.py
@@ -0,0 +1,281 @@
+"""Test module for abiotic.conductivities.py."""
+
+import numpy as np
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def test_initialise_conductivities(dummy_climate_data, fixture_core_components):
+ """Test conductivities are initialised correctly."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ initialise_conductivities,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ result = initialise_conductivities(
+ layer_structure=lyr_strct,
+ layer_heights=dummy_climate_data["layer_heights"],
+ initial_air_conductivity=50.0,
+ top_leaf_vapour_conductivity=0.32,
+ bottom_leaf_vapour_conductivity=0.25,
+ top_leaf_air_conductivity=0.19,
+ bottom_leaf_air_conductivity=0.13,
+ )
+
+ exp_air_cond = lyr_strct.from_template()
+ exp_air_cond[lyr_strct.index_atmosphere] = np.repeat(
+ a=[4.166667, 3.33333333, 6.66666667], repeats=[1, 10, 1]
+ )[:, None]
+
+ exp_leaf_vap_cond = lyr_strct.from_template()
+ exp_leaf_vap_cond[lyr_strct.index_filled_canopy] = np.array(
+ [0.254389, 0.276332, 0.298276]
+ )[:, None]
+
+ exp_leaf_air_cond = lyr_strct.from_template()
+ exp_leaf_air_cond[lyr_strct.index_filled_canopy] = np.array(
+ [0.133762, 0.152571, 0.171379]
+ )[:, None]
+
+ np.testing.assert_allclose(
+ result["air_heat_conductivity"], exp_air_cond, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["leaf_vapour_conductivity"], exp_leaf_vap_cond, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["leaf_air_heat_conductivity"], exp_leaf_air_cond, rtol=1e-04, atol=1e-04
+ )
+
+
+def test_interpolate_along_heights(dummy_climate_data, fixture_core_components):
+ """Test linear interpolation along heights."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ interpolate_along_heights,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ layer_heights = dummy_climate_data["layer_heights"].to_numpy()
+
+ result = interpolate_along_heights(
+ start_height=layer_heights[lyr_strct.index_surface],
+ end_height=layer_heights[lyr_strct.index_above],
+ target_heights=layer_heights[lyr_strct.index_filled_atmosphere],
+ start_value=50.0,
+ end_value=20.0,
+ )
+
+ # Get layer structure and reduce to only atmospheric layers
+ exp_result = lyr_strct.from_template()
+ exp_result[lyr_strct.index_filled_atmosphere] = np.array(
+ [20.0, 21.88087774, 31.28526646, 40.68965517, 50.0]
+ )[:, None]
+ exp_result = exp_result[lyr_strct.index_filled_atmosphere]
+
+ np.testing.assert_allclose(result, exp_result, rtol=1e-04, atol=1e-04)
+
+
+def test_interpolate_along_heights_arrays(fixture_core_components, dummy_climate_data):
+ """Test linear interpolation along heights with arrays of boundary values."""
+
+ # TODO - I don't think this differs from the test above.
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ interpolate_along_heights,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ # Extract the block of atmospheric layer heights.
+ layer_heights = dummy_climate_data["layer_heights"][
+ lyr_strct.index_atmosphere
+ ].to_numpy()
+
+ # Interpolate from the top to bottom across the atmosphere
+ result = interpolate_along_heights(
+ start_height=layer_heights[-1],
+ end_height=layer_heights[0],
+ target_heights=layer_heights,
+ start_value=np.repeat(50.0, 4),
+ end_value=np.repeat(20.0, 4),
+ )
+
+ # The function only returns values for the atmospheric layers, so fill the template
+ # and then truncate to the atmosphere.
+ exp_result = lyr_strct.from_template()
+ exp_result[lyr_strct.index_filled_atmosphere] = np.array(
+ [20.0, 21.88087774, 31.28526646, 40.68965517, 50.0]
+ )[:, None]
+ exp_result = exp_result[lyr_strct.index_atmosphere]
+
+ np.testing.assert_allclose(
+ result, exp_result, rtol=1e-04, atol=1e-04, equal_nan=True
+ )
+
+
+def test_calculate_air_heat_conductivity_above(dummy_climate_data):
+ """Test heat conductivity above canopy."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ calculate_air_heat_conductivity_above,
+ )
+
+ result = calculate_air_heat_conductivity_above(
+ height_above_canopy=dummy_climate_data["layer_heights"][0],
+ zero_displacement_height=(
+ dummy_climate_data["zero_displacement_height"].to_numpy()
+ ),
+ canopy_height=dummy_climate_data["layer_heights"][1],
+ friction_velocity=dummy_climate_data["friction_velocity"].to_numpy(),
+ molar_density_air=dummy_climate_data["molar_density_air"][0].to_numpy(),
+ diabatic_correction_heat=(
+ dummy_climate_data["diabatic_correction_heat_above"].to_numpy()
+ ),
+ von_karmans_constant=CoreConsts.von_karmans_constant,
+ )
+ np.testing.assert_allclose(
+ result,
+ np.array([523.39996, 218.083317, 87.233327, 87.233327]),
+ rtol=1e-04,
+ atol=1e-04,
+ )
+
+
+def test_calculate_air_heat_conductivity_canopy(dummy_climate_data):
+ """Test calculate air heat conductivity in canopy."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ calculate_air_heat_conductivity_canopy,
+ )
+
+ result = calculate_air_heat_conductivity_canopy(
+ attenuation_coefficient=(
+ dummy_climate_data["attenuation_coefficient"][1].to_numpy()
+ ),
+ mean_mixing_length=dummy_climate_data["mean_mixing_length"].to_numpy(),
+ molar_density_air=dummy_climate_data["molar_density_air"][1].to_numpy(),
+ upper_height=np.repeat(10.0, 4),
+ lower_height=np.repeat(5.0, 4),
+ relative_turbulence_intensity=(
+ dummy_climate_data["relative_turbulence_intensity"][1].to_numpy()
+ ),
+ top_of_canopy_wind_speed=np.repeat(1.0, 4),
+ diabatic_correction_momentum=(
+ dummy_climate_data["diabatic_correction_momentum_canopy"].to_numpy()
+ ),
+ canopy_height=dummy_climate_data["layer_heights"][1].to_numpy(),
+ )
+ exp_result = np.repeat(0.236981, 4)
+ np.testing.assert_allclose(result, exp_result, rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_leaf_air_heat_conductivity(
+ dummy_climate_data, fixture_core_components
+):
+ """Test calculation of leaf air heat conductivity."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ calculate_leaf_air_heat_conductivity,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+ abiotic_consts = AbioticConsts()
+
+ result = calculate_leaf_air_heat_conductivity(
+ temperature=dummy_climate_data["air_temperature"].to_numpy(),
+ wind_speed=dummy_climate_data["wind_speed"].to_numpy(),
+ characteristic_dimension_leaf=0.1,
+ temperature_difference=(
+ dummy_climate_data["canopy_temperature"]
+ - dummy_climate_data["air_temperature"]
+ ).to_numpy(),
+ molar_density_air=dummy_climate_data["molar_density_air"].to_numpy(),
+ kinematic_viscosity_parameters=abiotic_consts.kinematic_viscosity_parameters,
+ thermal_diffusivity_parameters=abiotic_consts.thermal_diffusivity_parameters,
+ grashof_parameter=abiotic_consts.grashof_parameter,
+ forced_conductance_parameter=abiotic_consts.forced_conductance_parameter,
+ positive_free_conductance_parameter=(
+ abiotic_consts.positive_free_conductance_parameter
+ ),
+ negative_free_conductance_parameter=(
+ abiotic_consts.negative_free_conductance_parameter
+ ),
+ )
+ exp_result = lyr_strct.from_template()
+ exp_result[lyr_strct.index_filled_canopy] = np.array(
+ [0.065242, 0.065062, 0.064753]
+ )[:, None]
+
+ np.testing.assert_allclose(result, exp_result, rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_leaf_vapour_conductivity():
+ """Test calculate leaf vapour conductivity."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ calculate_leaf_vapour_conductivity,
+ )
+
+ result = calculate_leaf_vapour_conductivity(
+ leaf_air_conductivity=np.repeat(5.0, 4),
+ stomatal_conductance=np.repeat(5.0, 4),
+ )
+ np.testing.assert_allclose(result, np.repeat(2.5, 4), rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_current_conductivities(dummy_climate_data, fixture_core_components):
+ """Test update current conductivities."""
+
+ from virtual_ecosystem.models.abiotic.conductivities import (
+ calculate_current_conductivities,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ result = calculate_current_conductivities(
+ data=dummy_climate_data,
+ characteristic_dimension_leaf=0.01,
+ von_karmans_constant=CoreConsts.von_karmans_constant,
+ abiotic_constants=AbioticConsts(),
+ )
+
+ exp_gt = lyr_strct.from_template()
+ exp_gt[lyr_strct.index_above] = np.array(
+ [1.460964e02, 6.087350e01, 2.434940e01, 2.434940e01]
+ )
+ exp_gt[lyr_strct.index_flux_layers] = np.array(
+ [1.95435e03, 1.414247e01, 0.125081, 13.654908]
+ )[:, None]
+
+ exp_gv = lyr_strct.from_template()
+ exp_gv[lyr_strct.index_filled_canopy] = np.array([0.203513, 0.202959, 0.202009])[
+ :, None
+ ]
+
+ exp_gha = lyr_strct.from_template()
+ exp_gha[lyr_strct.index_filled_canopy] = np.array([0.206312, 0.205743, 0.204766])[
+ :, None
+ ]
+
+ exp_gtr = lyr_strct.from_template()
+ exp_gtr[lyr_strct.index_flux_layers] = np.array(
+ [1.954354e03, 1.403429e01, 0.123447, 0.604689]
+ )[:, None]
+
+ np.testing.assert_allclose(
+ result["air_heat_conductivity"], exp_gt, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["leaf_air_heat_conductivity"], exp_gha, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["leaf_vapour_conductivity"], exp_gv, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["conductivity_from_ref_height"], exp_gtr, rtol=1e-04, atol=1e-04
+ )
diff --git a/tests/models/abiotic/test_energy_balance.py b/tests/models/abiotic/test_energy_balance.py
new file mode 100644
index 000000000..8c3871dba
--- /dev/null
+++ b/tests/models/abiotic/test_energy_balance.py
@@ -0,0 +1,336 @@
+"""Test module for abiotic.energy_balance.py."""
+
+import numpy as np
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def test_initialise_absorbed_radiation(dummy_climate_data, fixture_core_components):
+ """Test initial absorbed radiation has correct dimensions."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ initialise_absorbed_radiation,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ leaf_area_index_true = dummy_climate_data["leaf_area_index"][
+ lyr_strct.index_filled_canopy
+ ]
+ layer_heights_canopy = dummy_climate_data["layer_heights"][
+ lyr_strct.index_filled_canopy
+ ]
+
+ result = initialise_absorbed_radiation(
+ topofcanopy_radiation=dummy_climate_data["topofcanopy_radiation"]
+ .isel(time_index=0)
+ .to_numpy(),
+ leaf_area_index=leaf_area_index_true.to_numpy(),
+ layer_heights=layer_heights_canopy.to_numpy(),
+ light_extinction_coefficient=0.01,
+ )
+
+ exp_result = np.array([[0.09995] * 4, [0.09985] * 4, [0.09975] * 4])
+ np.testing.assert_allclose(result, exp_result, rtol=1e-04, atol=1e-04)
+
+
+def test_initialise_canopy_temperature(dummy_climate_data, fixture_core_components):
+ """Test that canopy temperature is initialised correctly."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ initialise_canopy_temperature,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ air_temperature = dummy_climate_data["air_temperature"][
+ lyr_strct.index_filled_canopy
+ ]
+
+ absorbed_radiation = np.array([[0.09995] * 4, [0.09985] * 4, [0.09975] * 4])
+
+ result = initialise_canopy_temperature(
+ air_temperature=air_temperature,
+ absorbed_radiation=absorbed_radiation,
+ canopy_temperature_ini_factor=0.01,
+ )
+ exp_result = np.array([[29.845994] * 4, [28.872169] * 4, [27.207403] * 4])
+
+ np.testing.assert_allclose(result, exp_result, rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_slope_of_saturated_pressure_curve():
+ """Test calculation of slope of saturated pressure curve."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ calculate_slope_of_saturated_pressure_curve,
+ )
+
+ const = AbioticConsts()
+ result = calculate_slope_of_saturated_pressure_curve(
+ temperature=np.full((4, 3), 20.0),
+ saturated_pressure_slope_parameters=const.saturated_pressure_slope_parameters,
+ )
+ exp_result = np.full((4, 3), 0.14474)
+ np.testing.assert_allclose(result, exp_result, rtol=1e-04, atol=1e-04)
+
+
+def test_initialise_canopy_and_soil_fluxes(dummy_climate_data, fixture_core_components):
+ """Test that canopy and soil fluxes initialised correctly."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ initialise_canopy_and_soil_fluxes,
+ )
+
+ result = initialise_canopy_and_soil_fluxes(
+ air_temperature=dummy_climate_data["air_temperature"],
+ topofcanopy_radiation=(
+ dummy_climate_data["topofcanopy_radiation"].isel(time_index=0)
+ ),
+ leaf_area_index=dummy_climate_data["leaf_area_index"],
+ layer_heights=dummy_climate_data["layer_heights"],
+ layer_structure=fixture_core_components.layer_structure,
+ light_extinction_coefficient=0.01,
+ canopy_temperature_ini_factor=0.01,
+ )
+
+ exp_abs = np.array([[0.09995] * 4, [0.09985] * 4, [0.09975] * 4])
+
+ for var in [
+ "canopy_temperature",
+ "sensible_heat_flux",
+ "latent_heat_flux",
+ "ground_heat_flux",
+ "canopy_absorption",
+ ]:
+ assert var in result
+
+ np.testing.assert_allclose(
+ result["canopy_absorption"][1:4].to_numpy(), exp_abs, rtol=1e-04, atol=1e-04
+ )
+ for var in ["sensible_heat_flux", "latent_heat_flux"]:
+ np.testing.assert_allclose(result[var][1:4].to_numpy(), np.zeros((3, 4)))
+ np.testing.assert_allclose(result[var][12].to_numpy(), np.zeros(4))
+
+
+def test_calculate_longwave_emission():
+ """Test that longwave radiation is calculated correctly."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ calculate_longwave_emission,
+ )
+
+ result = calculate_longwave_emission(
+ temperature=np.repeat(290.0, 3),
+ emissivity=AbioticConsts.soil_emissivity,
+ stefan_boltzmann=CoreConsts.stefan_boltzmann_constant,
+ )
+ np.testing.assert_allclose(result, np.repeat(320.84384, 3), rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_leaf_and_air_temperature(
+ fixture_core_components,
+ dummy_climate_data,
+):
+ """Test updating leaf and air temperature."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ calculate_leaf_and_air_temperature,
+ )
+ from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ result = calculate_leaf_and_air_temperature(
+ data=dummy_climate_data,
+ time_index=1,
+ layer_structure=lyr_strct,
+ abiotic_constants=AbioticConsts(),
+ abiotic_simple_constants=AbioticSimpleConsts(),
+ core_constants=CoreConsts(),
+ )
+
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = np.array(
+ [30.0, 29.999969, 29.995439, 28.796977, 20.08797]
+ )[:, None]
+
+ exp_leaf_temp = lyr_strct.from_template()
+ exp_leaf_temp[lyr_strct.index_filled_canopy] = np.array(
+ [30.078613, 29.091601, 26.951191]
+ )[:, None]
+
+ exp_vp = lyr_strct.from_template()
+ exp_vp[lyr_strct.index_filled_atmosphere] = np.array(
+ [0.14, 0.140323, 0.18372, 1.296359, 0.023795]
+ )[:, None]
+
+ exp_vpd = lyr_strct.from_template()
+ exp_vpd[lyr_strct.index_filled_atmosphere] = np.array(
+ [0.098781, 0.099009, 0.129644, 0.94264, 0.021697]
+ )[:, None]
+
+ exp_gv = lyr_strct.from_template()
+ exp_gv[lyr_strct.index_filled_canopy] = np.array([0.203513, 0.202959, 0.202009])[
+ :, None
+ ]
+
+ # TODO - flux layer index does not include above but these tests do - what is best.
+ flux_index = np.logical_or(lyr_strct.index_flux_layers, lyr_strct.index_above)
+
+ exp_sens_heat = lyr_strct.from_template()
+ exp_sens_heat[flux_index] = np.array([0.0, 1.397746, 1.315211, -1.515519, 1.0])[
+ :, None
+ ]
+
+ exp_latent_heat = lyr_strct.from_template()
+ exp_latent_heat[flux_index] = np.array([0.0, 8.330748, 8.426556, 11.740824, 1.0])[
+ :, None
+ ]
+
+ np.testing.assert_allclose(
+ result["air_temperature"], exp_air_temp, rtol=1e-03, atol=1e-03
+ )
+ np.testing.assert_allclose(
+ result["canopy_temperature"], exp_leaf_temp, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["vapour_pressure"], exp_vp, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["vapour_pressure_deficit"], exp_vpd, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["leaf_vapour_conductivity"], exp_gv, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["sensible_heat_flux"], exp_sens_heat, rtol=1e-04, atol=1e-04
+ )
+ np.testing.assert_allclose(
+ result["latent_heat_flux"][1:4], exp_latent_heat[1:4], rtol=1e-04, atol=1e-04
+ )
+
+
+def test_leaf_and_air_temperature_linearisation(
+ fixture_core_components, dummy_climate_data
+):
+ """Test linearisation of air and leaf temperature."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ leaf_and_air_temperature_linearisation,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ a_A, b_A = leaf_and_air_temperature_linearisation(
+ conductivity_from_ref_height=(
+ dummy_climate_data["conductivity_from_ref_height"][
+ lyr_strct.index_filled_canopy
+ ]
+ ),
+ conductivity_from_soil=np.repeat(0.1, 4),
+ leaf_air_heat_conductivity=(
+ dummy_climate_data["leaf_air_heat_conductivity"][
+ lyr_strct.index_filled_canopy
+ ]
+ ),
+ air_temperature_ref=(
+ dummy_climate_data["air_temperature_ref"].isel(time_index=0).to_numpy()
+ ),
+ top_soil_temperature=dummy_climate_data["soil_temperature"][
+ lyr_strct.index_topsoil
+ ].to_numpy(),
+ )
+
+ exp_a = np.full((3, 4), fill_value=29.677419)
+ exp_b = np.full((3, 4), fill_value=0.04193548)
+ np.testing.assert_allclose(a_A, exp_a)
+ np.testing.assert_allclose(b_A, exp_b)
+
+
+def test_longwave_radiation_flux_linearisation():
+ """Test linearisation of longwave radiation fluxes."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ longwave_radiation_flux_linearisation,
+ )
+
+ a_R, b_R = longwave_radiation_flux_linearisation(
+ a_A=np.full((3, 4), fill_value=29.677419),
+ b_A=np.full((3, 4), fill_value=0.04193548),
+ air_temperature_ref=np.full((3, 4), 30.0),
+ leaf_emissivity=0.8,
+ stefan_boltzmann_constant=CoreConsts.stefan_boltzmann_constant,
+ )
+
+ exp_a = np.full((3, 4), fill_value=0.035189)
+ exp_b = np.full((3, 4), fill_value=0.005098)
+ np.testing.assert_allclose(a_R, exp_a, rtol=1e-04, atol=1e-04)
+ np.testing.assert_allclose(b_R, exp_b, rtol=1e-04, atol=1e-04)
+
+
+def test_vapour_pressure_linearisation():
+ """Test linearisation of vapour pressure."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ vapour_pressure_linearisation,
+ )
+
+ a_E, b_E = vapour_pressure_linearisation(
+ vapour_pressure_ref=np.full((3, 4), 0.14),
+ saturated_vapour_pressure_ref=np.full((3, 4), 0.5),
+ soil_vapour_pressure=np.full((3, 4), 0.14),
+ conductivity_from_soil=np.repeat(0.1, 4),
+ leaf_vapour_conductivity=np.full((3, 4), 0.2),
+ conductivity_from_ref_height=np.full((3, 4), 3),
+ delta_v_ref=np.full((3, 4), 0.14474),
+ )
+
+ exp_a = np.full((3, 4), fill_value=0.161818)
+ exp_b = np.full((3, 4), fill_value=0.043861)
+ np.testing.assert_allclose(a_E, exp_a, rtol=1e-04, atol=1e-04)
+ np.testing.assert_allclose(b_E, exp_b, rtol=1e-04, atol=1e-04)
+
+
+def test_latent_heat_flux_linearisation():
+ """Test latent heat flux linearisation."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ latent_heat_flux_linearisation,
+ )
+
+ a_L, b_L = latent_heat_flux_linearisation(
+ latent_heat_vapourisation=np.full((3, 4), 2245.0),
+ leaf_vapour_conductivity=np.full((3, 4), 0.2),
+ atmospheric_pressure_ref=np.repeat(96.0, 4),
+ saturated_vapour_pressure_ref=np.full((3, 4), 0.5),
+ a_E=np.full((3, 4), fill_value=0.161818),
+ b_E=np.full((3, 4), fill_value=0.043861),
+ delta_v_ref=np.full((3, 4), 0.14474),
+ )
+
+ exp_a = np.full((3, 4), fill_value=13.830078)
+ exp_b = np.full((3, 4), fill_value=46.3633)
+ np.testing.assert_allclose(a_L, exp_a, rtol=1e-04, atol=1e-04)
+ np.testing.assert_allclose(b_L, exp_b, rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_delta_canopy_temperature():
+ """Test calculate delta canopy temperature."""
+
+ from virtual_ecosystem.models.abiotic.energy_balance import (
+ calculate_delta_canopy_temperature,
+ )
+
+ delta_t = calculate_delta_canopy_temperature(
+ absorbed_radiation=np.full((3, 4), 10),
+ a_R=np.full((3, 4), fill_value=0.035189),
+ a_L=np.full((3, 4), fill_value=13.830078),
+ b_R=np.full((3, 4), fill_value=0.005098),
+ b_L=np.full((3, 4), fill_value=46.3633),
+ b_H=np.full((3, 4), fill_value=46.3633),
+ )
+
+ exp_delta_t = np.full((3, 4), fill_value=-0.041238)
+ np.testing.assert_allclose(delta_t, exp_delta_t, rtol=1e-04, atol=1e-04)
diff --git a/tests/models/abiotic/test_soil_energy_balance.py b/tests/models/abiotic/test_soil_energy_balance.py
new file mode 100644
index 000000000..3dbac9f12
--- /dev/null
+++ b/tests/models/abiotic/test_soil_energy_balance.py
@@ -0,0 +1,154 @@
+"""Test module for abiotic.abiotic_model.energy_balance.py."""
+
+import numpy as np
+import pytest
+from xarray import DataArray
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def test_calculate_soil_absorption():
+ """Test that soil absorption is calculated correctly."""
+
+ from virtual_ecosystem.models.abiotic.soil_energy_balance import (
+ calculate_soil_absorption,
+ )
+
+ result = calculate_soil_absorption(
+ shortwave_radiation_surface=np.array([100, 10, 0]),
+ surface_albedo=np.array([0.2, 0.2, 0.2]),
+ )
+
+ np.testing.assert_allclose(result, np.array([80, 8, 0]), rtol=1e-04, atol=1e-04)
+
+
+def test_calculate_sensible_heat_flux_soil():
+ """Test sensible heat from soil is calculated correctly."""
+
+ from virtual_ecosystem.models.abiotic.soil_energy_balance import (
+ calculate_sensible_heat_flux_soil,
+ )
+
+ result = calculate_sensible_heat_flux_soil(
+ air_temperature_surface=np.array([290, 290, 290]),
+ topsoil_temperature=np.array([295, 290, 285]),
+ molar_density_air=np.array([38, 38, 38]),
+ specific_heat_air=np.array([29, 29, 29]),
+ aerodynamic_resistance=np.array([1250.0, 1250.0, 1250.0]),
+ )
+ np.testing.assert_allclose(
+ result,
+ np.array([4.408, 0.0, -4.408]),
+ rtol=1e-04,
+ atol=1e-04,
+ )
+
+
+def test_calculate_latent_heat_flux_from_soil_evaporation():
+ """Test evaporation to latent heat flux conversion works correctly."""
+
+ from virtual_ecosystem.models.abiotic.soil_energy_balance import (
+ calculate_latent_heat_flux_from_soil_evaporation,
+ )
+
+ result = calculate_latent_heat_flux_from_soil_evaporation(
+ soil_evaporation=np.array([0.001, 0.01, 0.1]),
+ latent_heat_vapourisation=np.array([2254.0, 2254.0, 2254.0]),
+ )
+ np.testing.assert_allclose(result, np.array([2.254, 22.54, 225.4]))
+
+
+def test_update_surface_temperature():
+ """Test surface temperature with positive and negative radiation flux."""
+
+ from virtual_ecosystem.models.abiotic.soil_energy_balance import (
+ update_surface_temperature,
+ )
+
+ result = update_surface_temperature(
+ topsoil_temperature=np.array([297, 297, 297]),
+ surface_net_radiation=np.array([100, 0, -100]),
+ surface_layer_depth=np.array([0.1, 0.1, 0.1]),
+ grid_cell_area=100,
+ update_interval=43200,
+ specific_heat_capacity_soil=AbioticConsts.specific_heat_capacity_soil,
+ volume_to_weight_conversion=1000.0,
+ )
+
+ np.testing.assert_allclose(result, np.array([297.00016, 297.0, 296.99984]))
+
+
+def test_calculate_ground_heat_flux():
+ """Test graound heat flux is calculated correctly."""
+
+ from virtual_ecosystem.models.abiotic.soil_energy_balance import (
+ calculate_ground_heat_flux,
+ )
+
+ result = calculate_ground_heat_flux(
+ soil_absorbed_radiation=np.array([100, 50, 0]),
+ topsoil_longwave_emission=np.array([10, 10, 10]),
+ topsoil_sensible_heat_flux=np.array([10, 10, 10]),
+ topsoil_latent_heat_flux=np.array([10, 10, 10]),
+ )
+ np.testing.assert_allclose(result, np.array([70, 20, -30]))
+
+
+@pytest.mark.skip("Possible bug - not switching in values")
+def test_calculate_soil_heat_balance(fixture_core_components, dummy_climate_data):
+ """Test full surface heat balance is run correctly."""
+
+ from virtual_ecosystem.models.abiotic.soil_energy_balance import (
+ calculate_soil_heat_balance,
+ )
+
+ data = dummy_climate_data
+ data["soil_evaporation"] = DataArray(
+ np.array([0.001, 0.01, 0.1, 0.1]), dims="cell_id"
+ )
+ data["molar_density_air"] = DataArray(
+ np.full((14, 4), 38), dims=["layers", "cell_id"]
+ )
+ data["specific_heat_air"] = DataArray(
+ np.full((14, 4), 29), dims=["layers", "cell_id"]
+ )
+ data["aerodynamic_resistance_surface"] = DataArray(np.repeat(1250.0, 4))
+ data["latent_heat_vapourisation"] = DataArray(
+ np.full((14, 4), 2254.0), dims=["layers", "cell_id"]
+ )
+
+ result = calculate_soil_heat_balance(
+ data=data,
+ time_index=0,
+ layer_structure=fixture_core_components.layer_structure,
+ update_interval=43200,
+ abiotic_consts=AbioticConsts(),
+ core_consts=CoreConsts(),
+ )
+
+ # Check if all variables were created
+ var_list = [
+ "soil_absorption",
+ "longwave_emission_soil",
+ "sensible_heat_flux_soil",
+ "latent_heat_flux_soil",
+ "ground_heat_flux",
+ ]
+
+ variables = [var for var in result if var not in var_list]
+ assert variables
+
+ # VIVI - I can't get these to work. I think there is a bug in the function, that was
+ # getting the total canopy absorption across all cells, not the per cell sum across
+ # layers, so not sure what the right answer is here.
+ test_values = {
+ "soil_absorption": np.repeat(79.625, 4),
+ "longwave_emission_soil": np.repeat(0.007258, 4),
+ "sensible_heat_flux_soil": np.repeat(3.397735, 4),
+ "latent_heat_flux_soil": np.array([2.254, 22.54, 225.4, 225.4]),
+ "ground_heat_flux": np.array([73.966007, 53.680007, -149.179993, -149.179993]),
+ }
+
+ for var, values in test_values.items():
+ assert np.allclose(result[var], values, rtol=1e-04, atol=1e-04)
diff --git a/tests/models/abiotic/test_wind.py b/tests/models/abiotic/test_wind.py
new file mode 100644
index 000000000..60c22a158
--- /dev/null
+++ b/tests/models/abiotic/test_wind.py
@@ -0,0 +1,428 @@
+"""Test module for abiotic.wind.py."""
+
+import numpy as np
+import pytest
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def test_calculate_zero_plane_displacement(dummy_climate_data):
+ """Test if calculated correctly and set to zero without vegetation."""
+
+ from virtual_ecosystem.models.abiotic.wind import calculate_zero_plane_displacement
+
+ result = calculate_zero_plane_displacement(
+ canopy_height=dummy_climate_data["layer_heights"][1].to_numpy(),
+ leaf_area_index=np.array([0.0, np.nan, 7.0, 7.0]),
+ zero_plane_scaling_parameter=7.5,
+ )
+
+ np.testing.assert_allclose(result, np.array([0.0, 0.0, 25.86256, 25.86256]))
+
+
+def test_calculate_roughness_length_momentum(dummy_climate_data):
+ """Test roughness length governing momentum transfer."""
+
+ from virtual_ecosystem.models.abiotic.wind import (
+ calculate_roughness_length_momentum,
+ )
+
+ result = calculate_roughness_length_momentum(
+ canopy_height=dummy_climate_data["layer_heights"][1].to_numpy(),
+ leaf_area_index=np.array([np.nan, 0.0, 7, 7]),
+ zero_plane_displacement=np.array([0.0, 0.0, 27.58673, 27.58673]),
+ substrate_surface_drag_coefficient=0.003,
+ roughness_element_drag_coefficient=0.3,
+ roughness_sublayer_depth_parameter=0.193,
+ max_ratio_wind_to_friction_velocity=0.3,
+ min_roughness_length=0.01,
+ von_karman_constant=CoreConsts.von_karmans_constant,
+ )
+
+ np.testing.assert_allclose(
+ result, np.array([0.01, 0.01666, 0.524479, 0.524479]), rtol=1e-3, atol=1e-3
+ )
+
+
+def test_calculate_diabatic_correction_above(dummy_climate_data):
+ """Test diabatic correction factors for heat and momentum."""
+
+ from virtual_ecosystem.models.abiotic.wind import (
+ calculate_diabatic_correction_above,
+ )
+
+ abiotic_consts = AbioticConsts()
+ core_const = CoreConsts()
+ result = calculate_diabatic_correction_above(
+ molar_density_air=np.repeat(28.96, 4),
+ specific_heat_air=np.repeat(1.0, 4),
+ temperature=dummy_climate_data["air_temperature"][0].to_numpy(),
+ sensible_heat_flux=(
+ dummy_climate_data["sensible_heat_flux_topofcanopy"].to_numpy()
+ ),
+ friction_velocity=dummy_climate_data["friction_velocity"].to_numpy(),
+ wind_heights=dummy_climate_data["layer_heights"][0].to_numpy(),
+ zero_plane_displacement=np.array([0.0, 25.312559, 27.58673, 27.58673]),
+ celsius_to_kelvin=core_const.zero_Celsius,
+ von_karmans_constant=core_const.von_karmans_constant,
+ yasuda_stability_parameters=abiotic_consts.yasuda_stability_parameters,
+ diabatic_heat_momentum_ratio=abiotic_consts.diabatic_heat_momentum_ratio,
+ )
+
+ exp_result_h = np.array([0.105164, 0.024834, 0.008092, 0.008092])
+ exp_result_m = np.array([0.063098, 0.0149, 0.004855, 0.004855])
+ np.testing.assert_allclose(result["psi_h"], exp_result_h, rtol=1e-4, atol=1e-4)
+ np.testing.assert_allclose(result["psi_m"], exp_result_m, rtol=1e-4, atol=1e-4)
+
+
+@pytest.mark.parametrize(
+ "air_temperature, wind_speed, expected_phi_m, expected_phi_h",
+ [
+ # Stable conditions (temperature increasing with height)
+ (
+ np.array([[15.0, 16.0], [14.5, 15.5]]),
+ np.array([[2.1, 2.1], [2.0, 2.0]]),
+ np.array([1.000389, 1.000388]),
+ np.array([1.000389, 1.000388]),
+ ),
+ # Unstable conditions (temperature decreasing with height)
+ (
+ np.array([[15.0, 16.0], [16.0, 17.0]]),
+ np.array([[2.0, 2.0], [3.0, 3.0]]),
+ np.array([0.999685, 0.999686]),
+ np.array([0.999685, 0.999686]),
+ ),
+ ],
+)
+def test_canopy_correction_conditions(
+ air_temperature, wind_speed, expected_phi_m, expected_phi_h
+):
+ """Test diabatic correction canopy for stable and unstable conditions."""
+
+ from virtual_ecosystem.models.abiotic.wind import (
+ calculate_diabatic_correction_canopy,
+ )
+
+ results = calculate_diabatic_correction_canopy(
+ air_temperature,
+ wind_speed,
+ layer_heights=np.array([[20, 20], [10, 10]]),
+ mean_mixing_length=np.array([[1.6, 1.6], [1.5, 1.5]]),
+ stable_temperature_gradient_intercept=0.5,
+ stable_wind_shear_slope=0.1,
+ yasuda_stability_parameters=[0.2, 0.3, 0.4],
+ richardson_bounds=[0.1, -0.1],
+ gravity=9.81,
+ celsius_to_kelvin=273.15,
+ )
+
+ # Assert results
+ np.testing.assert_allclose(results["phi_m"], expected_phi_m, rtol=1e-4, atol=1e-4)
+ np.testing.assert_allclose(results["phi_h"], expected_phi_h, rtol=1e-4, atol=1e-4)
+
+
+def test_calculate_mean_mixing_length(dummy_climate_data):
+ """Test mixing length with and without vegetation."""
+
+ from virtual_ecosystem.models.abiotic.wind import calculate_mean_mixing_length
+
+ result = calculate_mean_mixing_length(
+ canopy_height=dummy_climate_data["layer_heights"][1].to_numpy(),
+ zero_plane_displacement=np.array([0.0, 25.312559, 27.58673, 27.58673]),
+ roughness_length_momentum=np.array([0.017, 1.4533, 0.9591, 0.9591]),
+ mixing_length_factor=AbioticConsts.mixing_length_factor,
+ )
+
+ np.testing.assert_allclose(
+ result, np.array([1.284154, 1.280886, 0.836903, 0.836903]), rtol=1e-4, atol=1e-4
+ )
+
+
+def test_generate_relative_turbulence_intensity(
+ dummy_climate_data_varying_canopy, fixture_core_components
+):
+ """Test relative turbulence intensity for different true layers."""
+
+ from virtual_ecosystem.models.abiotic.wind import (
+ generate_relative_turbulence_intensity,
+ )
+
+ layer_heights = dummy_climate_data_varying_canopy["layer_heights"][
+ fixture_core_components.layer_structure.index_filled_atmosphere
+ ]
+
+ result_t = generate_relative_turbulence_intensity(
+ layer_heights=layer_heights,
+ min_relative_turbulence_intensity=0.36,
+ max_relative_turbulence_intensity=0.9,
+ increasing_with_height=True,
+ )
+
+ exp_result_t = np.array(
+ [
+ [17.64, 17.64, 17.64, 17.64],
+ [16.56, 16.56, 16.56, 16.56],
+ [11.16, 11.16, np.nan, np.nan],
+ [5.76, np.nan, np.nan, np.nan],
+ [0.414, 0.414, 0.414, 0.414],
+ ]
+ )
+ result_f = generate_relative_turbulence_intensity(
+ layer_heights=layer_heights,
+ min_relative_turbulence_intensity=0.36,
+ max_relative_turbulence_intensity=0.9,
+ increasing_with_height=False,
+ )
+
+ exp_result_f = np.array(
+ [
+ [-16.92, -16.92, -16.92, -16.92],
+ [-15.84, -15.84, -15.84, -15.84],
+ [-10.44, -10.44, np.nan, np.nan],
+ [-5.04, np.nan, np.nan, np.nan],
+ [0.306, 0.306, 0.306, 0.306],
+ ]
+ )
+ np.testing.assert_allclose(result_t, exp_result_t, rtol=1e-3, atol=1e-3)
+ np.testing.assert_allclose(result_f, exp_result_f, rtol=1e-3, atol=1e-3)
+
+
+def test_calculate_wind_attenuation_coefficient(
+ dummy_climate_data_varying_canopy, fixture_core_components
+):
+ """Test wind attenuation coefficient with different canopy layers."""
+
+ from virtual_ecosystem.models.abiotic.wind import (
+ calculate_wind_attenuation_coefficient,
+ )
+
+ # TODO: Occupied canopies - the plants model should populate the filled_canopies
+ # index in the data at some point.
+
+ # VIVI - this function was being used in two ways. One with the true aboveground
+ # rows and one with only the true canopy rows, adding the rows for above and surface
+ # My updates assume the former approach, so I've updated this test to match. The
+ # results have changed.
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ leaf_area_index = dummy_climate_data_varying_canopy["leaf_area_index"][
+ lyr_strct.index_filled_atmosphere
+ ].to_numpy()
+
+ relative_turbulence_intensity = dummy_climate_data_varying_canopy[
+ "relative_turbulence_intensity"
+ ][lyr_strct.index_filled_atmosphere].to_numpy()
+
+ # TODO - create a scalar index for this canopy top layer [1]
+ canopy_height = (
+ dummy_climate_data_varying_canopy.data["layer_heights"][1].to_numpy(),
+ )
+
+ result = calculate_wind_attenuation_coefficient(
+ canopy_height=canopy_height,
+ leaf_area_index=leaf_area_index,
+ mean_mixing_length=np.array([1.35804, 1.401984, 0.925228, 0.925228]),
+ drag_coefficient=AbioticConsts.drag_coefficient,
+ relative_turbulence_intensity=relative_turbulence_intensity,
+ )
+
+ exp_result = np.array(
+ # [
+ # [0.0, 0.0, 0.0, 0.0],
+ # [0.12523, 0.121305, 0.183812, 0.183812],
+ # [0.133398, 0.129216, np.nan, np.nan],
+ # [0.197945, np.nan, np.nan, np.nan],
+ # # [0.197945, 0.129216, 0.183812, 0.183812],
+ # [0.197945, 0.129216, 0.183812, 0.183812],
+ # ]
+ [
+ [0.0, 0.0, 0.0, 0.0],
+ [0.13339771, 0.12921647, 0.19579976, 0.19579976],
+ [0.19794498, 0.19174057, np.nan, np.nan],
+ [0.3835184, np.nan, np.nan, np.nan],
+ [0.3835184, 0.19174057, 0.19579976, 0.19579976],
+ ]
+ )
+ np.testing.assert_allclose(result, exp_result, rtol=1e-3, atol=1e-3)
+
+
+def test_wind_log_profile(fixture_core_components, dummy_climate_data):
+ """Test log wind profile."""
+
+ from virtual_ecosystem.models.abiotic.wind import wind_log_profile
+
+ layer_heights = dummy_climate_data["layer_heights"][
+ fixture_core_components.layer_structure.index_filled_atmosphere
+ ].to_numpy()
+
+ result = wind_log_profile(
+ height=layer_heights,
+ zeroplane_displacement=np.array([0.0, 25.312559, 27.58673, 27.58673]),
+ roughness_length_momentum=np.array([0.017, 1.4533, 0.9591, 0.9591]),
+ diabatic_correction_momentum=np.array([0.105164, 0.024834, 0.008092, 0.008092]),
+ )
+
+ exp_result = np.array(
+ [
+ [7.645442, 1.551228, 1.534468, 1.534468],
+ [7.580903, 1.195884, 0.930835, 0.930835],
+ [7.175438, np.nan, np.nan, np.nan],
+ [6.482291, np.nan, np.nan, np.nan],
+ [1.877121, np.nan, np.nan, np.nan],
+ ]
+ )
+
+ np.testing.assert_allclose(result, exp_result, rtol=1e-3, atol=1e-3)
+
+
+def test_calculate_friction_velocity_reference_height(dummy_climate_data):
+ """Calculate friction velocity."""
+
+ from virtual_ecosystem.models.abiotic.wind import (
+ calculate_friction_velocity_reference_height,
+ )
+
+ result = calculate_friction_velocity_reference_height(
+ wind_speed_ref=(
+ dummy_climate_data.data["wind_speed_ref"].isel(time_index=0).to_numpy()
+ ),
+ reference_height=(dummy_climate_data["layer_heights"][1] + 10).to_numpy(),
+ zeroplane_displacement=np.array([0.0, 25.312559, 27.58673, 27.58673]),
+ roughness_length_momentum=np.array([0.017, 1.4533, 0.9591, 0.9591]),
+ diabatic_correction_momentum=np.array([0.063098, 0.0149, 0.004855, 0.004855]),
+ von_karmans_constant=CoreConsts.von_karmans_constant,
+ min_friction_velocity=0.001,
+ )
+ exp_result = np.array([0.051108, 0.171817, 0.155922, 0.155922])
+ np.testing.assert_allclose(result, exp_result, rtol=1e-3, atol=1e-3)
+
+
+def test_calculate_wind_above_canopy():
+ """Wind speed above canopy."""
+
+ from virtual_ecosystem.models.abiotic.wind import calculate_wind_above_canopy
+
+ result = calculate_wind_above_canopy(
+ friction_velocity=np.array([0.0, 0.819397, 1.423534, 1.423534]),
+ wind_height_above=np.array(
+ [[2.0, 32.0, 32.0, 32.0], [np.nan, 30.0, 30.0, 30.0]]
+ ),
+ zeroplane_displacement=np.array([0.0, 25.312559, 27.58673, 27.58673]),
+ roughness_length_momentum=np.array([0.017, 1.4533, 0.9591, 0.9591]),
+ diabatic_correction_momentum=np.array([0.003, 0.026, 0.013, 0.013]),
+ von_karmans_constant=CoreConsts.von_karmans_constant,
+ min_wind_speed_above_canopy=0.55,
+ )
+
+ exp_result = np.array(
+ [[0.55, 3.180068, 5.478385, 5.478385], [np.nan, 2.452148, 3.330154, 3.330154]]
+ )
+ np.testing.assert_allclose(result, exp_result, rtol=1e-3, atol=1e-3)
+
+
+def test_calculate_wind_canopy(
+ dummy_climate_data_varying_canopy, fixture_core_components
+):
+ """Test below canopy wind profile."""
+
+ from virtual_ecosystem.models.abiotic.wind import calculate_wind_canopy
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ # TODO we want to use fixture here, but there is a conflict with expected results
+ # in conductivities (attenuation coefficient two orders of magnitude different, and
+ # test fixture does not include gradient.) FIX in separate PR.
+ attenuation_coeff = np.array(
+ [
+ [0.12523, 0.121305, 0.183812, 0.183812],
+ [0.133398, 0.129216, np.nan, np.nan],
+ [0.197945, np.nan, np.nan, np.nan],
+ [0.197945, 0.129216, 0.183812, 0.183812],
+ ]
+ )
+
+ layer_heights_np = dummy_climate_data_varying_canopy["layer_heights"].to_numpy()
+ layer_heights = layer_heights_np[
+ np.logical_or(lyr_strct.index_filled_canopy, lyr_strct.index_surface)
+ ]
+ canopy_height = layer_heights_np[1]
+
+ result = calculate_wind_canopy(
+ top_of_canopy_wind_speed=np.array([0.5, 5.590124, 10.750233, 10.750233]),
+ wind_layer_heights=layer_heights,
+ canopy_height=canopy_height,
+ attenuation_coefficient=attenuation_coeff,
+ )
+
+ exp_result = np.array(
+ [
+ [0.5, 5.590124, 10.750233, 10.750233],
+ [0.478254, 5.354458, np.nan, np.nan],
+ [0.438187, np.nan, np.nan, np.nan],
+ [0.410478, 4.914629, 8.950668, 8.950668],
+ ]
+ )
+ np.testing.assert_allclose(result, exp_result, rtol=1e-3, atol=1e-3)
+
+
+def test_calculate_wind_profile(
+ dummy_climate_data_varying_canopy, fixture_core_components
+):
+ """Test full update of wind profile."""
+
+ from virtual_ecosystem.models.abiotic.wind import calculate_wind_profile
+
+ lyr_strct = fixture_core_components.layer_structure
+
+ # VIVI - same deal here. Feeding the full true aboveground rows into this, not just
+ # the true canopy rows. Seeing minor test value changes as a result.
+ leaf_area_index = dummy_climate_data_varying_canopy["leaf_area_index"][
+ lyr_strct.index_filled_atmosphere
+ ].to_numpy()
+ layer_heights = dummy_climate_data_varying_canopy["layer_heights"][
+ lyr_strct.index_filled_atmosphere
+ ].to_numpy()
+ air_temperature = dummy_climate_data_varying_canopy["air_temperature"][
+ lyr_strct.index_filled_atmosphere
+ ].to_numpy()
+
+ wind_update = calculate_wind_profile(
+ canopy_height=layer_heights[1],
+ wind_height_above=layer_heights[0:2],
+ wind_layer_heights=layer_heights,
+ leaf_area_index=leaf_area_index,
+ air_temperature=air_temperature,
+ atmospheric_pressure=np.repeat(96.0, 4),
+ sensible_heat_flux_topofcanopy=np.array([100.0, 50.0, 10.0, 10.0]),
+ wind_speed_ref=np.array([0.1, 5.0, 10.0, 10.0]),
+ wind_reference_height=(layer_heights[1] + 10),
+ abiotic_constants=AbioticConsts(),
+ core_constants=CoreConsts(),
+ )
+
+ friction_velocity_exp = np.array([0.012793, 0.84372, 1.811774, 1.811774])
+ wind_speed_exp = np.array(
+ # [
+ # [0.1, 3.719967, 7.722811, 7.722811],
+ # [0.1, 3.226327, 6.915169, 6.915169],
+ # [0.09551, 3.106107, np.nan, np.nan],
+ # [0.087254, np.nan, np.nan, np.nan],
+ # [0.08156, 2.880031, 6.39049, 6.39049],
+ # ]
+ [
+ [0.1, 3.7199665, 7.72281114, 7.72281114],
+ [0.1, 3.22632714, 6.91516866, 6.91516866],
+ [0.09341001, 3.04955397, np.nan, np.nan],
+ [0.07678466, np.nan, np.nan, np.nan],
+ [0.06737292, 2.7260693, 6.35768904, 6.35768904],
+ ]
+ )
+
+ np.testing.assert_allclose(
+ wind_update["friction_velocity"], friction_velocity_exp, rtol=1e-3, atol=1e-3
+ )
+ np.testing.assert_allclose(
+ wind_update["wind_speed"], wind_speed_exp, rtol=1e-3, atol=1e-3
+ )
diff --git a/tests/models/abiotic_simple/test_abiotic_simple_model.py b/tests/models/abiotic_simple/test_abiotic_simple_model.py
index f3078e196..4013e7540 100644
--- a/tests/models/abiotic_simple/test_abiotic_simple_model.py
+++ b/tests/models/abiotic_simple/test_abiotic_simple_model.py
@@ -2,6 +2,7 @@
from contextlib import nullcontext as does_not_raise
from logging import CRITICAL, DEBUG, ERROR, INFO
+from unittest.mock import patch
import numpy as np
import pytest
@@ -15,11 +16,9 @@
MODEL_VAR_CHECK_LOG = [
(DEBUG, "abiotic_simple model: required var 'air_temperature_ref' checked"),
(DEBUG, "abiotic_simple model: required var 'relative_humidity_ref' checked"),
- (DEBUG, "abiotic_simple model: required var 'atmospheric_pressure_ref' checked"),
- (DEBUG, "abiotic_simple model: required var 'atmospheric_co2_ref' checked"),
- (DEBUG, "abiotic_simple model: required var 'mean_annual_temperature' checked"),
- (DEBUG, "abiotic_simple model: required var 'leaf_area_index' checked"),
- (DEBUG, "abiotic_simple model: required var 'layer_heights' checked"),
+ (INFO, "Replacing data array for 'soil_temperature'"),
+ (INFO, "Replacing data array for 'vapour_pressure_deficit_ref'"),
+ (INFO, "Replacing data array for 'vapour_pressure_ref'"),
]
@@ -31,7 +30,7 @@
)
def test_abiotic_simple_model_initialization(
caplog,
- dummy_climate_data,
+ dummy_climate_data_varying_canopy,
fixture_core_components,
raises,
expected_log_entries,
@@ -41,12 +40,15 @@ def test_abiotic_simple_model_initialization(
from virtual_ecosystem.models.abiotic_simple.abiotic_simple_model import (
AbioticSimpleModel,
)
- from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
+ from virtual_ecosystem.models.abiotic_simple.constants import (
+ AbioticSimpleBounds,
+ AbioticSimpleConsts,
+ )
with raises:
# Initialize model
model = AbioticSimpleModel(
- data=dummy_climate_data,
+ data=dummy_climate_data_varying_canopy,
core_components=fixture_core_components,
constants=AbioticSimpleConsts(),
)
@@ -55,17 +57,18 @@ def test_abiotic_simple_model_initialization(
assert isinstance(model, BaseModel)
assert model.model_name == "abiotic_simple"
assert repr(model) == "AbioticSimpleModel(update_interval=1209600 seconds)"
+ assert model.bounds == AbioticSimpleBounds()
# Final check that expected logging entries are produced
log_check(caplog, expected_log_entries)
@pytest.mark.parametrize(
- "cfg_string,relative_humid,raises,expected_log_entries",
+ "cfg_string,satvap1,raises,expected_log_entries",
[
pytest.param(
"[core.timing]\nupdate_interval = '1 week'\n[abiotic_simple]\n",
- 5.4,
+ [0.61078, 7.5, 237.3],
does_not_raise(),
tuple(
[
@@ -78,16 +81,16 @@ def test_abiotic_simple_model_initialization(
"Information required to initialise the abiotic simple model "
"successfully extracted.",
),
- ]
- + MODEL_VAR_CHECK_LOG,
+ *MODEL_VAR_CHECK_LOG[:2],
+ ],
),
id="default_config",
),
pytest.param(
"[core.timing]\nupdate_interval = '1 week'\n"
"[abiotic_simple.constants.AbioticSimpleConsts]\n"
- "relative_humidity_gradient = 10.2\n",
- 10.2,
+ "saturation_vapour_pressure_factors = [1.0, 2.0, 3.0]\n",
+ [1.0, 2.0, 3.0],
does_not_raise(),
tuple(
[
@@ -100,22 +103,22 @@ def test_abiotic_simple_model_initialization(
"Information required to initialise the abiotic simple model "
"successfully extracted.",
),
- ]
- + MODEL_VAR_CHECK_LOG,
+ *MODEL_VAR_CHECK_LOG[:2],
+ ],
),
id="modified_config_correct",
),
pytest.param(
"[core.timing]\nupdate_interval = '1 week'\n"
"[abiotic_simple.constants.AbioticSimpleConsts]\n"
- "relative_humidity_grad = 10.2\n",
+ "saturation_vapour_pressure_factorx = [1.0, 2.0, 3.0]\n",
None,
pytest.raises(ConfigurationError),
(
(
ERROR,
"Unknown names supplied for AbioticSimpleConsts: "
- "relative_humidity_grad",
+ "saturation_vapour_pressure_factorx",
),
(INFO, "Valid names are: "),
(
@@ -130,9 +133,9 @@ def test_abiotic_simple_model_initialization(
)
def test_generate_abiotic_simple_model(
caplog,
- dummy_climate_data,
+ dummy_climate_data_varying_canopy,
cfg_string,
- relative_humid,
+ satvap1,
raises,
expected_log_entries,
):
@@ -148,104 +151,76 @@ def test_generate_abiotic_simple_model(
core_components = CoreComponents(config)
caplog.clear()
- # Check whether model is initialised (or not) as expected
- with raises:
- model = AbioticSimpleModel.from_config(
- data=dummy_climate_data,
- core_components=core_components,
- config=config,
- )
- assert model.model_constants.relative_humidity_gradient == relative_humid
+ # We patch the _setup step as it is tested separately
+ module_name = "virtual_ecosystem.models.abiotic_simple.abiotic_simple_model"
+ with patch(f"{module_name}.AbioticSimpleModel._setup") as mock_setup:
+ # Check whether model is initialised (or not) as expected
+ with raises:
+ model = AbioticSimpleModel.from_config(
+ data=dummy_climate_data_varying_canopy,
+ core_components=core_components,
+ config=config,
+ )
+ assert model.model_constants.saturation_vapour_pressure_factors == satvap1
+ mock_setup.assert_called_once()
# Final check that expected logging entries are produced
log_check(caplog, expected_log_entries)
-def test_setup(
- dummy_climate_data,
-):
+def test_setup(dummy_climate_data_varying_canopy, fixture_core_components):
"""Test set up and update."""
- from virtual_ecosystem.core.config import Config
- from virtual_ecosystem.core.core_components import CoreComponents
+
from virtual_ecosystem.models.abiotic_simple.abiotic_simple_model import (
AbioticSimpleModel,
)
- # Build the config object and core components
- config = Config(
- cfg_strings="[core.timing]\nupdate_interval = '1 week'\n[abiotic_simple]\n"
- )
- core_components = CoreComponents(config)
+ lyr_strct = fixture_core_components.layer_structure
# initialise model
- model = AbioticSimpleModel.from_config(
- data=dummy_climate_data,
- core_components=core_components,
- config=config,
+ model = AbioticSimpleModel(
+ data=dummy_climate_data_varying_canopy,
+ core_components=fixture_core_components,
)
- model.setup()
+ exp_soil_temp = lyr_strct.from_template()
+ xr.testing.assert_allclose(model.data["soil_temperature"], exp_soil_temp)
- xr.testing.assert_allclose(
- model.data["soil_temperature"],
- DataArray(
- np.full((15, 3), np.nan),
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- core_components.layer_structure.layer_roles,
- ),
- "cell_id": [0, 1, 2],
- },
- ),
- )
xr.testing.assert_allclose(
model.data["vapour_pressure_deficit_ref"],
DataArray(
- np.full((3, 3), 0.141727),
+ np.full((4, 3), 0.141727),
dims=["cell_id", "time_index"],
- coords={
- "cell_id": [0, 1, 2],
- },
+ coords={"cell_id": [0, 1, 2, 3]},
),
)
# Run the update step
model.update(time_index=0)
- exp_temperature = xr.concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.91965, 29.91965, 29.91965],
- [29.414851, 29.414851, 29.414851],
- [28.551891, 28.551891, 28.551891],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [26.19, 26.19, 26.19],
- [22.81851, 22.81851, 22.81851],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- core_components.layer_structure.layer_roles,
- ),
- "cell_id": [0, 1, 2],
- },
- )
-
- xr.testing.assert_allclose(dummy_climate_data["air_temperature"], exp_temperature)
+ for var in [
+ "air_temperature",
+ "relative_humidity",
+ "vapour_pressure_deficit",
+ "soil_temperature",
+ "atmospheric_pressure",
+ "atmospheric_co2",
+ ]:
+ assert var in model.data
+
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = [
+ [30.0, 30.0, 30.0, 30.0],
+ [29.91965, 29.946434, 29.973217, 29.973217],
+ [29.414851, 29.609901, np.nan, np.nan],
+ [28.551891, np.nan, np.nan, np.nan],
+ [22.81851, 25.21234, 27.60617, 27.60617],
+ ]
+ xr.testing.assert_allclose(model.data["air_temperature"], exp_air_temp)
+
+ exp_soil_temp = lyr_strct.from_template()
+ exp_soil_temp[lyr_strct.index_all_soil] = [
+ [20.712458, 21.317566, 21.922674, 21.922674],
+ [20.0, 20.0, 20.0, 20.0],
+ ]
+ xr.testing.assert_allclose(model.data["soil_temperature"], exp_soil_temp)
diff --git a/tests/models/abiotic_simple/test_microclimate.py b/tests/models/abiotic_simple/test_microclimate.py
index 4522e9f6b..615bfae95 100644
--- a/tests/models/abiotic_simple/test_microclimate.py
+++ b/tests/models/abiotic_simple/test_microclimate.py
@@ -10,102 +10,80 @@ def test_log_interpolation(dummy_climate_data, fixture_core_components):
from virtual_ecosystem.models.abiotic_simple.microclimate import log_interpolation
- data = dummy_climate_data
-
- leaf_area_index_sum = data["leaf_area_index"].sum(dim="layers")
+ lyr_strct = fixture_core_components.layer_structure
+ leaf_area_index_sum = dummy_climate_data["leaf_area_index"].sum(dim="layers")
# temperature
result = log_interpolation(
- data=data,
- reference_data=data["air_temperature_ref"].isel(time_index=0),
+ data=dummy_climate_data,
+ reference_data=dummy_climate_data["air_temperature_ref"].isel(time_index=0),
leaf_area_index_sum=leaf_area_index_sum,
- layer_roles=fixture_core_components.layer_structure.layer_roles,
- layer_heights=data["layer_heights"],
+ layer_structure=lyr_strct,
+ layer_heights=dummy_climate_data["layer_heights"],
upper_bound=80,
lower_bound=0,
gradient=-2.45,
)
- exp_output = xr.concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.844995, 29.844995, 29.844995],
- [28.87117, 28.87117, 28.87117],
- [27.206405, 27.206405, 27.206405],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [22.65, 22.65, 22.65],
- [16.145945, 16.145945, 16.145945],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles[0:15],
- ),
- "cell_id": data.grid.cell_id,
- }
- )
- xr.testing.assert_allclose(result, exp_output)
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = np.array(
+ [30.0, 29.844995, 28.87117, 27.206405, 16.145945]
+ )[:, None]
+ xr.testing.assert_allclose(result, exp_air_temp)
# relative humidity
result_hum = log_interpolation(
- data=data,
- reference_data=data["relative_humidity_ref"].isel(time_index=0),
+ data=dummy_climate_data,
+ reference_data=dummy_climate_data["relative_humidity_ref"].isel(time_index=0),
leaf_area_index_sum=leaf_area_index_sum,
- layer_roles=fixture_core_components.layer_structure.layer_roles,
- layer_heights=data["layer_heights"],
+ layer_structure=lyr_strct,
+ layer_heights=dummy_climate_data["layer_heights"],
upper_bound=100,
lower_bound=0,
gradient=5.4,
)
- exp_humidity = xr.concat(
- [
- DataArray(
- [
- [90.0, 90.0, 90.0],
- [90.341644, 90.341644, 90.341644],
- [92.488034, 92.488034, 92.488034],
- [96.157312, 96.157312, 96.157312],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [100, 100, 100],
- [100, 100, 100],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles[0:15],
- ),
- "cell_id": data.grid.cell_id,
- }
- )
+
+ exp_humidity = lyr_strct.from_template()
+ exp_humidity[lyr_strct.index_filled_atmosphere] = np.array(
+ [90.0, 90.341644, 92.488034, 96.157312, 100.0]
+ )[:, None]
xr.testing.assert_allclose(result_hum, exp_humidity)
+def test_varying_canopy_log_interpolation(
+ dummy_climate_data_varying_canopy, fixture_core_components
+):
+ """Test interpolation for temperature and humidity non-negative."""
+
+ from virtual_ecosystem.models.abiotic_simple.microclimate import log_interpolation
+
+ data = dummy_climate_data_varying_canopy
+ lyr_strct = fixture_core_components.layer_structure
+ leaf_area_index_sum = data["leaf_area_index"].sum(dim="layers")
+
+ # temperature
+ result = log_interpolation(
+ data=data,
+ reference_data=data["air_temperature_ref"].isel(time_index=0),
+ leaf_area_index_sum=leaf_area_index_sum,
+ layer_structure=lyr_strct,
+ layer_heights=data["layer_heights"],
+ upper_bound=80,
+ lower_bound=0,
+ gradient=-2.45,
+ )
+
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = [
+ [30.0, 30.0, 30.0, 30.0],
+ [29.844995, 29.896663, 29.948332, 29.948332],
+ [28.87117, 29.247446, np.nan, np.nan],
+ [27.206405, np.nan, np.nan, np.nan],
+ [16.145945, 20.763963, 25.381982, 25.381982],
+ ]
+ xr.testing.assert_allclose(result, exp_air_temp)
+
+
def test_calculate_saturation_vapour_pressure(dummy_climate_data):
"""Test calculation of saturation vapour pressure."""
@@ -115,26 +93,24 @@ def test_calculate_saturation_vapour_pressure(dummy_climate_data):
)
data = dummy_climate_data
-
- # Extract saturation factors from constants
constants = AbioticSimpleConsts()
-
+ # Extract saturation factors from constants
result = calculate_saturation_vapour_pressure(
data["air_temperature_ref"].isel(time_index=0),
- factor1=constants.saturation_vapour_pressure_factor1,
- factor2=constants.saturation_vapour_pressure_factor2,
- factor3=constants.saturation_vapour_pressure_factor3,
+ saturation_vapour_pressure_factors=(
+ constants.saturation_vapour_pressure_factors
+ ),
)
exp_output = DataArray(
- [1.41727, 1.41727, 1.41727],
+ np.repeat(1.41727, 4),
dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
+ coords={"cell_id": [0, 1, 2, 3]},
)
xr.testing.assert_allclose(result, exp_output)
-def test_calculate_vapour_pressure_deficit():
+def test_calculate_vapour_pressure_deficit(fixture_core_components):
"""Test calculation of VPD."""
from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
@@ -142,171 +118,165 @@ def test_calculate_vapour_pressure_deficit():
calculate_vapour_pressure_deficit,
)
- temperature = xr.concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.844995, 29.844995, 29.844995],
- [28.87117, 28.87117, 28.87117],
- [27.206405, 27.206405, 27.206405],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [22.65, 22.65, 22.65],
- [16.145945, 16.145945, 16.145945],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
+ lyr_strct = fixture_core_components.layer_structure
+
+ temperature = lyr_strct.from_template()
+ temperature[lyr_strct.index_filled_atmosphere] = np.array(
+ [30.0, 29.844995, 28.87117, 27.206405, 16.145945]
+ )[:, None]
+
+ rel_humidity = lyr_strct.from_template()
+ rel_humidity[lyr_strct.index_filled_atmosphere] = np.array(
+ [90.0, 90.341644, 92.488034, 96.157312, 100.0]
+ )[:, None]
+
+ constants = AbioticSimpleConsts()
+ result = calculate_vapour_pressure_deficit(
+ temperature=temperature,
+ relative_humidity=rel_humidity,
+ saturation_vapour_pressure_factors=(
+ constants.saturation_vapour_pressure_factors
+ ),
)
- rel_humidity = xr.concat(
- [
- DataArray(
- [
- [90.0, 90.0, 90.0],
- [88.5796455, 88.5796455, 88.5796455],
- [79.65622765, 79.65622765, 79.65622765],
- [64.40154408, 64.40154408, 64.40154408],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [22.65, 22.65, 22.65],
- [0, 0, 0],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
+ exp_output = lyr_strct.from_template()
+ exp_output[lyr_strct.index_filled_atmosphere] = np.array(
+ [0.141727, 0.136357, 0.103501, 0.050763, 0.0]
+ )[:, None]
+ xr.testing.assert_allclose(result["vapour_pressure_deficit"], exp_output)
+
+
+def test_varying_canopy_calculate_vapour_pressure_deficit(
+ fixture_core_components, dummy_climate_data_varying_canopy
+):
+ """Test calculation of VPD with different number of canopy layers."""
+
+ from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
+ from virtual_ecosystem.models.abiotic_simple.microclimate import (
+ calculate_vapour_pressure_deficit,
)
+ lyr_strct = fixture_core_components.layer_structure
+
+ data = dummy_climate_data_varying_canopy
+ constants = AbioticSimpleConsts()
result = calculate_vapour_pressure_deficit(
- temperature, rel_humidity, constants=AbioticSimpleConsts()
- )
- exp_output = xr.concat(
- [
- DataArray(
- [
- [0.141727, 0.141727, 0.141727],
- [0.161233, 0.161233, 0.161233],
- [0.280298, 0.280298, 0.280298],
- [0.470266, 0.470266, 0.470266],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [[0.90814, 0.90814, 0.90814], [0.984889, 0.984889, 0.984889]],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
+ temperature=data["air_temperature"],
+ relative_humidity=data["relative_humidity"],
+ saturation_vapour_pressure_factors=(
+ constants.saturation_vapour_pressure_factors
+ ),
)
- xr.testing.assert_allclose(result, exp_output)
+ exp_output = lyr_strct.from_template()
+ exp_output[lyr_strct.index_filled_atmosphere] = [
+ [0.141727, 0.141727, 0.141727, 0.141727],
+ [0.136357, 0.136357, 0.136357, 0.136357],
+ [0.103501, 0.103501, np.nan, np.nan],
+ [0.050763, np.nan, np.nan, np.nan],
+ [0.0, 0.0, 0.0, 0.0],
+ ]
+ xr.testing.assert_allclose(result["vapour_pressure_deficit"], exp_output)
def test_run_microclimate(dummy_climate_data, fixture_core_components):
"""Test interpolation of all variables."""
- from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
+ from virtual_ecosystem.models.abiotic_simple.constants import (
+ AbioticSimpleBounds,
+ AbioticSimpleConsts,
+ )
from virtual_ecosystem.models.abiotic_simple.microclimate import run_microclimate
+ lyr_strct = fixture_core_components.layer_structure
data = dummy_climate_data
- data["atmospheric_pressure"] = DataArray(
- np.full((15, 3), np.nan),
- dims=["layers", "cell_id"],
- coords=data["layer_heights"].coords,
- name="atmospheric_pressure",
+ result = run_microclimate(
+ data=data,
+ layer_structure=lyr_strct,
+ time_index=0,
+ constants=AbioticSimpleConsts(),
+ bounds=AbioticSimpleBounds(),
)
- data["atmospheric_co2"] = (
- data["atmospheric_pressure"].copy().rename("atmospheric_co2")
+
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = np.array(
+ [30.0, 29.91965, 29.414851, 28.551891, 22.81851]
+ )[:, None]
+ xr.testing.assert_allclose(result["air_temperature"], exp_air_temp)
+
+ exp_soil_temp = lyr_strct.from_template()
+ exp_soil_temp[lyr_strct.index_all_soil] = np.array([20.712458, 20.0])[:, None]
+ xr.testing.assert_allclose(result["soil_temperature"], exp_soil_temp)
+
+ exp_pressure = lyr_strct.from_template()
+ exp_pressure[lyr_strct.index_atmosphere] = 96
+ xr.testing.assert_allclose(result["atmospheric_pressure"], exp_pressure)
+
+
+def test_run_microclimate_varying_canopy(
+ dummy_climate_data_varying_canopy, fixture_core_components
+):
+ """Test interpolation of all variables with varying canopy arrays."""
+
+ from virtual_ecosystem.models.abiotic_simple.constants import (
+ AbioticSimpleBounds,
+ AbioticSimpleConsts,
)
+ from virtual_ecosystem.models.abiotic_simple.microclimate import run_microclimate
+
+ data = dummy_climate_data_varying_canopy
+ lyr_strct = fixture_core_components.layer_structure
+
result = run_microclimate(
data=data,
- layer_roles=fixture_core_components.layer_structure.layer_roles,
+ layer_structure=lyr_strct,
time_index=0,
constants=AbioticSimpleConsts(),
+ bounds=AbioticSimpleBounds(),
)
- exp_air_temperature = xr.concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.91965, 29.91965, 29.91965],
- [29.414851, 29.414851, 29.414851],
- [28.551891, 28.551891, 28.551891],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [26.19, 26.19, 26.19],
- [22.81851, 22.81851, 22.81851],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(data["layer_heights"].coords)
- xr.testing.assert_allclose(result["air_temperature"], exp_air_temperature)
-
- exp_atmospheric_pressure = xr.concat(
- [
- DataArray(
- np.full((13, 3), 96),
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(data["layer_heights"].coords)
- xr.testing.assert_allclose(result["atmospheric_pressure"], exp_atmospheric_pressure)
-
-
-def test_interpolate_soil_temperature(dummy_climate_data):
+ exp_air_temp = lyr_strct.from_template()
+ exp_air_temp[lyr_strct.index_filled_atmosphere] = [
+ [30.0, 30.0, 30.0, 30.0],
+ [29.91965, 29.946434, 29.973217, 29.973217],
+ [29.414851, 29.609901, np.nan, np.nan],
+ [28.551891, np.nan, np.nan, np.nan],
+ [22.81851, 25.21234, 27.60617, 27.60617],
+ ]
+ xr.testing.assert_allclose(result["air_temperature"], exp_air_temp)
+
+ exp_soil_temp = lyr_strct.from_template()
+ exp_soil_temp[lyr_strct.index_all_soil] = [
+ [20.712458, 21.317566, 21.922674, 21.922674],
+ [20.0, 20.0, 20.0, 20.0],
+ ]
+ xr.testing.assert_allclose(result["soil_temperature"], exp_soil_temp)
+
+ exp_pressure = lyr_strct.from_template()
+ exp_pressure[lyr_strct.index_atmosphere] = 96
+ xr.testing.assert_allclose(result["atmospheric_pressure"], exp_pressure)
+
+
+def test_interpolate_soil_temperature(dummy_climate_data, fixture_core_components):
"""Test soil temperature interpolation."""
from virtual_ecosystem.models.abiotic_simple.microclimate import (
interpolate_soil_temperature,
)
+ lyr_strct = fixture_core_components.layer_structure
data = dummy_climate_data
- surface_temperature = DataArray(
- [22.0, 22, 22],
- dims="cell_id",
- )
+ surface_temperature = DataArray([22.0, 22.0, 22.0, 22.0], dims="cell_id")
result = interpolate_soil_temperature(
layer_heights=data["layer_heights"],
surface_temperature=surface_temperature,
mean_annual_temperature=data["mean_annual_temperature"],
+ layer_structure=lyr_strct,
+ upper_bound=50.0,
+ lower_bound=-10.0,
)
- exp_output = DataArray(
- [
- [20.505557, 20.505557, 20.505557],
- [20.0, 20.0, 20.0],
- ],
- dims=["layers", "cell_id"],
- coords={
- "layers": [13, 14],
- "layer_roles": ("layers", ["soil", "soil"]),
- "cell_id": [0, 1, 2],
- },
- )
+ exp_output = lyr_strct.from_template()
+ exp_output[lyr_strct.index_all_soil] = np.array([20.505557, 20.0])[:, None]
xr.testing.assert_allclose(result, exp_output)
diff --git a/tests/models/animals/conftest.py b/tests/models/animals/conftest.py
index f53245352..1219be66f 100644
--- a/tests/models/animals/conftest.py
+++ b/tests/models/animals/conftest.py
@@ -5,6 +5,19 @@
import xarray
from xarray import DataArray
+# FIXME: Need to reconcile these data instances - a lot of overlap and some
+# inconsistency with fixture_core_components
+
+
+@pytest.fixture
+def data_instance():
+ """Creates an empty data instance."""
+ from virtual_ecosystem.core.data import Data
+ from virtual_ecosystem.core.grid import Grid
+
+ grid = Grid()
+ return Data(grid)
+
@pytest.fixture
def plant_data_instance():
@@ -24,7 +37,7 @@ def plant_data_instance():
@pytest.fixture
-def plant_climate_data_instance(fixture_core_components):
+def animal_data_for_model_instance(fixture_core_components):
"""Fixture returning a combination of plant and air temperature data."""
from virtual_ecosystem.core.data import Data
@@ -34,46 +47,84 @@ def plant_climate_data_instance(fixture_core_components):
grid = Grid(
grid_type="square",
cell_nx=3,
- cell_ny=1,
+ cell_ny=3,
)
data = Data(grid)
- leaf_mass = np.full((15, 3), fill_value=np.nan)
+ leaf_mass = np.full(
+ (fixture_core_components.layer_structure.n_layers, grid.n_cells),
+ fill_value=np.nan,
+ )
leaf_mass[1:4, :] = 10000
data["layer_leaf_mass"] = xarray.DataArray(
data=leaf_mass, dims=["layers", "cell_id"]
)
- data["air_temperature"] = xarray.concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.844995, 29.844995, 29.844995],
- [28.87117, 28.87117, 28.87117],
- [27.206405, 27.206405, 27.206405],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [22.65, 22.65, 22.65],
- [16.145945, 16.145945, 16.145945],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles[0:15],
- ),
- "cell_id": data.grid.cell_id,
- }
+
+ # grid.cell_id gives the spatial dimension, and we want a single "time" or "layer"
+ air_temperature_values = np.full(
+ (1, grid.n_cells), 25.0
+ ) # All cells at 25.0 for one time step or layer
+ air_temperature = DataArray(
+ air_temperature_values,
+ dims=[
+ "time_or_layer",
+ "cell_id",
+ ], # Adjust dimension names as appropriate for your model
+ coords={
+ "time_or_layer": [0], # Assuming a single time step or layer for simplicity
+ "cell_id": grid.cell_id,
+ },
+ )
+ data["air_temperature"] = air_temperature
+
+ return data
+
+
+@pytest.fixture
+def animal_data_for_community_instance(fixture_core_components):
+ """Fixture returning a combination of plant and air temperature data."""
+
+ from virtual_ecosystem.core.data import Data
+ from virtual_ecosystem.core.grid import Grid
+
+ # Setup the data object with four cells.
+ grid = Grid(
+ grid_type="square",
+ cell_nx=3,
+ cell_ny=3,
+ )
+ data = Data(grid)
+
+ leaf_mass = np.full(
+ (fixture_core_components.layer_structure.n_layers, grid.n_cells),
+ fill_value=np.nan,
+ )
+ leaf_mass[1:4, :] = 10000
+ data["layer_leaf_mass"] = xarray.DataArray(
+ data=leaf_mass, dims=["layers", "cell_id"]
+ )
+
+ # grid.cell_id gives the spatial dimension, and we want a single "time" or "layer"
+ air_temperature_values = np.full(
+ (1, grid.n_cells), 25.0
+ ) # All cells at 25.0 for one time step or layer
+ air_temperature = DataArray(
+ air_temperature_values,
+ dims=[
+ "time_or_layer",
+ "cell_id",
+ ], # Adjust dimension names as appropriate for your model
+ coords={
+ "time_or_layer": [0], # Assuming a single time step or layer for simplicity
+ "cell_id": grid.cell_id,
+ },
+ )
+ data["air_temperature"] = air_temperature
+
+ # Initialize total_animal_respiration with zeros for each cell
+ total_animal_respiration = np.zeros(len(grid.cell_id))
+ data["total_animal_respiration"] = DataArray(
+ total_animal_respiration, dims=["cell_id"], coords={"cell_id": grid.cell_id}
)
return data
@@ -82,7 +133,7 @@ def plant_climate_data_instance(fixture_core_components):
@pytest.fixture
def constants_instance():
"""Fixture for an instance of animal constants."""
- from virtual_ecosystem.models.animals.constants import AnimalConsts
+ from virtual_ecosystem.models.animal.constants import AnimalConsts
return AnimalConsts()
@@ -90,7 +141,7 @@ def constants_instance():
@pytest.fixture
def functional_group_list_instance(shared_datadir, constants_instance):
"""Fixture for an animal functional group used in tests."""
- from virtual_ecosystem.models.animals.functional_group import (
+ from virtual_ecosystem.models.animal.functional_group import (
import_functional_groups,
)
@@ -109,7 +160,7 @@ def animal_model_instance(
):
"""Fixture for an animal model object used in tests."""
- from virtual_ecosystem.models.animals.animal_model import AnimalModel
+ from virtual_ecosystem.models.animal.animal_model import AnimalModel
return AnimalModel(
data=data_instance,
@@ -123,15 +174,15 @@ def animal_model_instance(
def animal_community_instance(
functional_group_list_instance,
animal_model_instance,
- plant_data_instance,
+ animal_data_for_community_instance,
constants_instance,
):
"""Fixture for an animal community used in tests."""
- from virtual_ecosystem.models.animals.animal_communities import AnimalCommunity
+ from virtual_ecosystem.models.animal.animal_communities import AnimalCommunity
return AnimalCommunity(
functional_groups=functional_group_list_instance,
- data=plant_data_instance,
+ data=animal_data_for_community_instance,
community_key=4,
neighbouring_keys=[1, 3, 5, 7],
get_destination=animal_model_instance.get_community_by_key,
@@ -142,7 +193,7 @@ def animal_community_instance(
@pytest.fixture
def herbivore_functional_group_instance(shared_datadir, constants_instance):
"""Fixture for an animal functional group used in tests."""
- from virtual_ecosystem.models.animals.functional_group import (
+ from virtual_ecosystem.models.animal.functional_group import (
import_functional_groups,
)
@@ -155,7 +206,7 @@ def herbivore_functional_group_instance(shared_datadir, constants_instance):
@pytest.fixture
def herbivore_cohort_instance(herbivore_functional_group_instance, constants_instance):
"""Fixture for an animal cohort used in tests."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
return AnimalCohort(
herbivore_functional_group_instance, 10000.0, 1, 10, constants_instance
@@ -163,9 +214,57 @@ def herbivore_cohort_instance(herbivore_functional_group_instance, constants_ins
@pytest.fixture
-def excrement_instance():
+def caterpillar_functional_group_instance(shared_datadir, constants_instance):
+ """Fixture for an animal functional group used in tests."""
+ from virtual_ecosystem.models.animal.functional_group import (
+ import_functional_groups,
+ )
+
+ file = shared_datadir / "example_functional_group_import.csv"
+ fg_list = import_functional_groups(file, constants_instance)
+
+ return fg_list[9]
+
+
+@pytest.fixture
+def caterpillar_cohort_instance(
+ caterpillar_functional_group_instance, constants_instance
+):
+ """Fixture for an animal cohort used in tests."""
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+
+ return AnimalCohort(
+ caterpillar_functional_group_instance, 1.0, 1, 100, constants_instance
+ )
+
+
+@pytest.fixture
+def butterfly_functional_group_instance(shared_datadir, constants_instance):
+ """Fixture for an animal functional group used in tests."""
+ from virtual_ecosystem.models.animal.functional_group import (
+ import_functional_groups,
+ )
+
+ file = shared_datadir / "example_functional_group_import.csv"
+ fg_list = import_functional_groups(file, constants_instance)
+
+ return fg_list[8]
+
+
+@pytest.fixture
+def butterfly_cohort_instance(butterfly_functional_group_instance, constants_instance):
+ """Fixture for an animal cohort used in tests."""
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+
+ return AnimalCohort(
+ butterfly_functional_group_instance, 1.0, 1, 100, constants_instance
+ )
+
+
+@pytest.fixture
+def excrement_pool_instance():
"""Fixture for a soil pool used in tests."""
- from virtual_ecosystem.models.animals.decay import ExcrementPool
+ from virtual_ecosystem.models.animal.decay import ExcrementPool
return ExcrementPool(100000.0, 0.0)
@@ -173,8 +272,34 @@ def excrement_instance():
@pytest.fixture
def plant_instance(plant_data_instance, constants_instance):
"""Fixture for a plant community used in tests."""
- from virtual_ecosystem.models.animals.plant_resources import PlantResources
+ from virtual_ecosystem.models.animal.plant_resources import PlantResources
return PlantResources(
data=plant_data_instance, cell_id=4, constants=constants_instance
)
+
+
+@pytest.fixture
+def plant_list_instance(plant_data_instance, constants_instance):
+ """Fixture providing a list of plant resources."""
+ from virtual_ecosystem.models.animal.plant_resources import PlantResources
+
+ return [
+ PlantResources(
+ data=plant_data_instance, cell_id=4, constants=constants_instance
+ )
+ for idx in range(3)
+ ]
+
+
+@pytest.fixture
+def animal_list_instance(herbivore_functional_group_instance, constants_instance):
+ """Fixture providing a list of animal cohorts."""
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+
+ return [
+ AnimalCohort(
+ herbivore_functional_group_instance, 10000.0, 1, 10, constants_instance
+ )
+ for idx in range(3)
+ ]
diff --git a/tests/models/animals/data/example_functional_group_import.csv b/tests/models/animals/data/example_functional_group_import.csv
index afbf819a8..d307bcffb 100644
--- a/tests/models/animals/data/example_functional_group_import.csv
+++ b/tests/models/animals/data/example_functional_group_import.csv
@@ -1,7 +1,11 @@
-name,taxa,diet,metabolic_type,birth_mass,adult_mass
-carnivorous_bird,bird,carnivore,endothermic,0.1,1.0
-herbivorous_bird,bird,herbivore,endothermic,0.05,0.5
-carnivorous_mammal,mammal,carnivore,endothermic,4.0,40.0
-herbivorous_mammal,mammal,herbivore,endothermic,1.0,10.0
-carnivorous_insect,insect,carnivore,ectothermic,0.001,0.01
-herbivorous_insect,insect,herbivore,ectothermic,0.0005,0.005
+name,taxa,diet,metabolic_type,reproductive_type,development_type,development_status,offspring_functional_group,excretion_type,birth_mass,adult_mass
+carnivorous_bird,bird,carnivore,endothermic,iteroparous,direct,adult,carnivorous_bird,uricotelic,0.1,1.0
+herbivorous_bird,bird,herbivore,endothermic,iteroparous,direct,adult,herbivorous_bird,uricotelic,0.05,0.5
+carnivorous_mammal,mammal,carnivore,endothermic,iteroparous,direct,adult,carnivorous_mammal,ureotelic,4.0,40.0
+herbivorous_mammal,mammal,herbivore,endothermic,iteroparous,direct,adult,herbivorous_mammal,ureotelic,1.0,10.0
+carnivorous_insect_iteroparous,insect,carnivore,ectothermic,iteroparous,direct,adult,carnivorous_insect_iteroparous,uricotelic,0.001,0.01
+herbivorous_insect_iteroparous,insect,herbivore,ectothermic,iteroparous,direct,adult,herbivorous_insect_iteroparous,uricotelic,0.0005,0.005
+carnivorous_insect_semelparous,insect,carnivore,ectothermic,semelparous,direct,adult,carnivorous_insect_semelparous,uricotelic,0.001,0.01
+herbivorous_insect_semelparous,insect,herbivore,ectothermic,semelparous,direct,adult,herbivorous_insect_semelparous,uricotelic,0.0005,0.005
+butterfly,insect,herbivore,ectothermic,semelparous,indirect,adult,caterpillar,uricotelic,0.0005,0.005
+caterpillar,insect,herbivore,ectothermic,nonreproductive,indirect,larval,butterfly,uricotelic,0.0005,0.005
diff --git a/tests/models/animals/test_animal_cohorts.py b/tests/models/animals/test_animal_cohorts.py
index 3efc8eaba..9acfed5d1 100644
--- a/tests/models/animals/test_animal_cohorts.py
+++ b/tests/models/animals/test_animal_cohorts.py
@@ -7,7 +7,7 @@
@pytest.fixture
def predator_functional_group_instance(shared_datadir, constants_instance):
"""Fixture for an animal functional group used in tests."""
- from virtual_ecosystem.models.animals.functional_group import (
+ from virtual_ecosystem.models.animal.functional_group import (
import_functional_groups,
)
@@ -20,7 +20,7 @@ def predator_functional_group_instance(shared_datadir, constants_instance):
@pytest.fixture
def predator_cohort_instance(predator_functional_group_instance, constants_instance):
"""Fixture for an animal cohort used in tests."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
return AnimalCohort(
predator_functional_group_instance, 10000.0, 1, 10, constants_instance
@@ -30,7 +30,7 @@ def predator_cohort_instance(predator_functional_group_instance, constants_insta
@pytest.fixture
def ectotherm_functional_group_instance(shared_datadir, constants_instance):
"""Fixture for an animal functional group used in tests."""
- from virtual_ecosystem.models.animals.functional_group import (
+ from virtual_ecosystem.models.animal.functional_group import (
import_functional_groups,
)
@@ -43,7 +43,7 @@ def ectotherm_functional_group_instance(shared_datadir, constants_instance):
@pytest.fixture
def ectotherm_cohort_instance(ectotherm_functional_group_instance, constants_instance):
"""Fixture for an animal cohort used in tests."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
return AnimalCohort(
ectotherm_functional_group_instance, 100.0, 1, 10, constants_instance
@@ -53,7 +53,7 @@ def ectotherm_cohort_instance(ectotherm_functional_group_instance, constants_ins
@pytest.fixture
def prey_cohort_instance(herbivore_functional_group_instance, constants_instance):
"""Fixture for an animal cohort used in tests."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
return AnimalCohort(
herbivore_functional_group_instance, 100.0, 1, 10, constants_instance
@@ -61,13 +61,14 @@ def prey_cohort_instance(herbivore_functional_group_instance, constants_instance
@pytest.fixture
-def carcass_instance():
+def carcass_pool_instance():
"""Fixture for an carcass pool used in tests."""
- from virtual_ecosystem.models.animals.decay import CarcassPool
+ from virtual_ecosystem.models.animal.decay import CarcassPool
return CarcassPool(0.0, 0.0)
+@pytest.mark.usefixtures("mocker")
class TestAnimalCohort:
"""Test AnimalCohort class."""
@@ -94,7 +95,7 @@ def test_invalid_animal_cohort_initialization(
constants_instance,
):
"""Test for invalid inputs during AnimalCohort initialization."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
with pytest.raises(error_type):
AnimalCohort(
@@ -106,60 +107,226 @@ def test_invalid_animal_cohort_initialization(
)
@pytest.mark.parametrize(
- "dt, initial_mass, temperature, final_mass",
+ "cohort_type, dt, initial_mass, temperature, expected_final_mass, error_type,"
+ "metabolic_rate_return_value",
[
- (timedelta64(1, "D"), 1000.0, 298.0, 998.5205247106326), # normal case
- (timedelta64(1, "D"), 0.0, 298.0, 0.0), # edge case: zero mass
- (timedelta64(3, "D"), 1000.0, 298.0, 995.5615741318977), # 3 days
- ],
- )
- def test_metabolize_endotherm(
- self, herbivore_cohort_instance, dt, initial_mass, temperature, final_mass
- ):
- """Testing metabolize with an endothermic metabolism."""
- herbivore_cohort_instance.mass_current = initial_mass
- herbivore_cohort_instance.metabolize(temperature, dt)
- assert herbivore_cohort_instance.mass_current == final_mass
- assert isclose(herbivore_cohort_instance.mass_current, final_mass, rtol=1e-9)
-
- @pytest.mark.parametrize(
- "dt, initial_mass, temperature, final_mass",
- [
- (timedelta64(1, "D"), 100.0, 20.0, 99.95896219913648), # normal case
- (timedelta64(1, "D"), 0.0, 20.0, 0.0), # edge case: zero mass
+ # Endotherm cases
+ (
+ "herbivore",
+ timedelta64(1, "D"),
+ 1000.0,
+ 298.0,
+ 998.5205247106326,
+ None,
+ 1.4794752893674,
+ ), # normal case
(
+ "herbivore",
+ timedelta64(1, "D"),
+ 0.0,
+ 298.0,
+ 0.0,
+ None,
+ 0.0,
+ ), # edge case: zero mass
+ (
+ "herbivore",
+ timedelta64(3, "D"),
+ 1000.0,
+ 298.0,
+ 995.5615741318977,
+ None,
+ 1.4794752893674,
+ ), # 3 days
+ # Ectotherm cases
+ (
+ "ectotherm",
+ timedelta64(1, "D"),
+ 100.0,
+ 20.0,
+ 99.95896219913648,
+ None,
+ 0.04103780086352,
+ ), # normal case
+ (
+ "ectotherm",
+ timedelta64(1, "D"),
+ 0.0,
+ 20.0,
+ 0.0,
+ None,
+ 0.0,
+ ), # edge case: zero mass
+ (
+ "ectotherm",
timedelta64(1, "D"),
100.0,
0.0,
99.99436706014961,
+ None,
+ 0.00563293985039,
), # edge case: zero temperature
+ # Invalid input cases
+ (
+ "herbivore",
+ timedelta64(-1, "D"),
+ 100.0,
+ 298.0,
+ None,
+ ValueError,
+ 1.0,
+ ), # negative dt
+ (
+ "herbivore",
+ timedelta64(1, "D"),
+ -100.0,
+ 298.0,
+ None,
+ ValueError,
+ 1.0,
+ ), # negative mass
+ ],
+ ids=[
+ "endotherm_normal",
+ "endotherm_zero_mass",
+ "endotherm_three_days",
+ "ectotherm_normal",
+ "ectotherm_zero_mass",
+ "ectotherm_zero_temp",
+ "invalid_negative_dt",
+ "invalid_negative_mass",
],
)
- def test_metabolize_ectotherm(
- self, ectotherm_cohort_instance, dt, initial_mass, temperature, final_mass
+ def test_metabolize(
+ self,
+ mocker,
+ herbivore_cohort_instance,
+ ectotherm_cohort_instance,
+ cohort_type,
+ dt,
+ initial_mass,
+ temperature,
+ expected_final_mass,
+ error_type,
+ metabolic_rate_return_value,
):
- """Testing metabolize with ectotherms."""
- # from math import isclose
+ """Testing metabolize method for various scenarios."""
- ectotherm_cohort_instance.mass_current = initial_mass
- ectotherm_cohort_instance.metabolize(temperature, dt)
- assert ectotherm_cohort_instance.mass_current == final_mass
+ # Select the appropriate cohort instance
+ if cohort_type == "herbivore":
+ cohort_instance = herbivore_cohort_instance
+ elif cohort_type == "ectotherm":
+ cohort_instance = ectotherm_cohort_instance
+ else:
+ raise ValueError("Invalid cohort type provided.")
+
+ # Set initial mass
+ cohort_instance.mass_current = initial_mass
+
+ # Mocking the sf.metabolic_rate function to return a specific value
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.metabolic_rate",
+ return_value=metabolic_rate_return_value,
+ )
+
+ if error_type:
+ with pytest.raises(error_type):
+ cohort_instance.metabolize(temperature, dt)
+ else:
+ cohort_instance.metabolize(temperature, dt)
+ assert isclose(cohort_instance.mass_current, expected_final_mass, rtol=1e-9)
@pytest.mark.parametrize(
- "dt, initial_mass, temperature, error_type",
+ "cohort_type, excreta_mass, initial_pool_energy, expected_pool_energy",
[
- (timedelta64(-1, "D"), 28266000000.0, 298.0, ValueError),
- (timedelta64(1, "D"), -100.0, 298.0, ValueError),
- # Add more invalid cases as needed
+ ("herbivore", 100.0, 500.0, 500.0), # normal case for herbivore
+ ("herbivore", 0.0, 500.0, 500.0), # zero excreta mass for herbivore
+ ("ectotherm", 50.0, 300.0, 300.0), # normal case for ectotherm
+ ("ectotherm", 0.0, 300.0, 300.0), # zero excreta mass for ectotherm
+ ],
+ ids=[
+ "herbivore_normal",
+ "herbivore_zero_excreta",
+ "ectotherm_normal",
+ "ectotherm_zero_excreta",
],
)
- def test_metabolize_invalid_input(
- self, herbivore_cohort_instance, dt, initial_mass, temperature, error_type
+ def test_excrete(
+ self,
+ mocker,
+ herbivore_cohort_instance,
+ ectotherm_cohort_instance,
+ cohort_type,
+ excreta_mass,
+ initial_pool_energy,
+ expected_pool_energy,
):
- """Testing metabolize for invalid input."""
- herbivore_cohort_instance.mass_current = initial_mass
- with pytest.raises(error_type):
- herbivore_cohort_instance.metabolize(temperature, dt)
+ """Testing excrete method for various scenarios.
+
+ This method is doing nothing of substance until the stoichiometry rework.
+
+ """
+
+ # Select the appropriate cohort instance
+ if cohort_type == "herbivore":
+ cohort_instance = herbivore_cohort_instance
+ elif cohort_type == "ectotherm":
+ cohort_instance = ectotherm_cohort_instance
+ else:
+ raise ValueError("Invalid cohort type provided.")
+
+ # Mock the excrement pool
+ excrement_pool = mocker.Mock()
+ excrement_pool.decomposed_energy = initial_pool_energy
+
+ # Call the excrete method
+ cohort_instance.excrete(excreta_mass, excrement_pool)
+
+ # Check the expected results
+ assert excrement_pool.decomposed_energy == expected_pool_energy
+
+ @pytest.mark.parametrize(
+ "cohort_type, excreta_mass, expected_carbon_waste",
+ [
+ ("herbivore", 100.0, 100.0), # normal case for herbivore
+ ("herbivore", 0.0, 0.0), # zero excreta mass for herbivore
+ ("ectotherm", 50.0, 50.0), # normal case for ectotherm
+ ("ectotherm", 0.0, 0.0), # zero excreta mass for ectotherm
+ ],
+ ids=[
+ "herbivore_normal",
+ "herbivore_zero_excreta",
+ "ectotherm_normal",
+ "ectotherm_zero_excreta",
+ ],
+ )
+ def test_respire(
+ self,
+ herbivore_cohort_instance,
+ ectotherm_cohort_instance,
+ cohort_type,
+ excreta_mass,
+ expected_carbon_waste,
+ ):
+ """Testing respire method for various scenarios.
+
+ This test is deliberately simple because it will be reworked with stoichiometry.
+
+ """
+
+ # Select the appropriate cohort instance
+ if cohort_type == "herbivore":
+ cohort_instance = herbivore_cohort_instance
+ elif cohort_type == "ectotherm":
+ cohort_instance = ectotherm_cohort_instance
+ else:
+ raise ValueError("Invalid cohort type provided.")
+
+ # Call the respire method
+ carbon_waste = cohort_instance.respire(excreta_mass)
+
+ # Check the expected results
+ assert carbon_waste == expected_carbon_waste
@pytest.mark.parametrize(
"scav_initial, scav_final, decomp_initial, decomp_final, consumed_energy",
@@ -170,22 +337,22 @@ def test_metabolize_invalid_input(
(0.0, 0.0, 1000.0, 1000.0, 0.0),
],
)
- def test_excrete(
+ def test_defecate(
self,
herbivore_cohort_instance,
- excrement_instance,
+ excrement_pool_instance,
scav_initial,
scav_final,
decomp_initial,
decomp_final,
consumed_energy,
):
- """Testing excrete() for varying soil energy levels."""
- excrement_instance.scavengeable_energy = scav_initial
- excrement_instance.decomposed_energy = decomp_initial
- herbivore_cohort_instance.excrete(excrement_instance, consumed_energy)
- assert excrement_instance.scavengeable_energy == scav_final
- assert excrement_instance.decomposed_energy == decomp_final
+ """Testing defecate() for varying soil energy levels."""
+ excrement_pool_instance.scavengeable_energy = scav_initial
+ excrement_pool_instance.decomposed_energy = decomp_initial
+ herbivore_cohort_instance.defecate(excrement_pool_instance, consumed_energy)
+ assert excrement_pool_instance.scavengeable_energy == scav_final
+ assert excrement_pool_instance.decomposed_energy == decomp_final
@pytest.mark.parametrize(
"dt, initial_age, final_age",
@@ -224,135 +391,105 @@ def test_die_individual(
number_dead,
initial_pop,
final_pop,
- carcass_instance,
+ carcass_pool_instance,
initial_carcass,
final_carcass,
decomp_carcass,
):
"""Testing death."""
herbivore_cohort_instance.individuals = initial_pop
- carcass_instance.scavengeable_energy = initial_carcass
- herbivore_cohort_instance.die_individual(number_dead, carcass_instance)
+ carcass_pool_instance.scavengeable_energy = initial_carcass
+ herbivore_cohort_instance.die_individual(number_dead, carcass_pool_instance)
assert herbivore_cohort_instance.individuals == final_pop
- assert carcass_instance.scavengeable_energy == final_carcass
- assert carcass_instance.decomposed_energy == decomp_carcass
+ assert carcass_pool_instance.scavengeable_energy == final_carcass
+ assert carcass_pool_instance.decomposed_energy == decomp_carcass
def test_get_eaten(
- self, prey_cohort_instance, predator_cohort_instance, carcass_instance
+ self, prey_cohort_instance, predator_cohort_instance, carcass_pool_instance
):
- """Testing get_eaten.
-
- Currently, this just tests rough execution. As the model gets paramterized,
- these tests will be expanded to specific values.
- """
-
+ """Test the get_eaten method for accuracy in updating prey and carcass pool."""
+ potential_consumed_mass = 100 # Set a potential consumed mass for testing
initial_individuals = prey_cohort_instance.individuals
- initial_scavengeable_energy = carcass_instance.scavengeable_energy
+ initial_mass_current = prey_cohort_instance.mass_current
+ initial_carcass_scavengeable_energy = carcass_pool_instance.scavengeable_energy
+ initial_carcass_decomposed_energy = carcass_pool_instance.decomposed_energy
- # Execution
- prey_cohort_instance.get_eaten(predator_cohort_instance, carcass_instance)
+ # Execute the get_eaten method with test parameters
+ actual_consumed_mass = prey_cohort_instance.get_eaten(
+ potential_consumed_mass, predator_cohort_instance, carcass_pool_instance
+ )
- # Assertions
- assert prey_cohort_instance.individuals < initial_individuals
- assert carcass_instance.scavengeable_energy > initial_scavengeable_energy
- assert carcass_instance.decomposed_energy > 0.0
+ # Assertions to check if individuals were correctly removed and carcass pool
+ # updated
+ assert (
+ prey_cohort_instance.individuals < initial_individuals
+ ), "Prey cohort should have fewer individuals."
+ assert (
+ prey_cohort_instance.mass_current == initial_mass_current
+ ), "Prey cohort should have the same total mass."
+ assert (
+ actual_consumed_mass <= potential_consumed_mass
+ ), "Actual consumed mass should be less than/equal to potential consumed mass."
+ assert (
+ carcass_pool_instance.scavengeable_energy
+ > initial_carcass_scavengeable_energy
+ ), "Carcass pool's scavengeable energy should increase."
+ assert (
+ carcass_pool_instance.decomposed_energy > initial_carcass_decomposed_energy
+ ), "Carcass pool's decomposed energy should increase."
- def test_forage_cohort(
- self, predator_cohort_instance, prey_cohort_instance, mocker
+ @pytest.mark.parametrize(
+ "below_threshold,expected_mass_current_increase,"
+ "expected_reproductive_mass_increase",
+ [
+ (
+ 0.5,
+ 100,
+ 0,
+ ), # Scenario where the current total mass is below the threshold
+ (
+ 1.5,
+ 0,
+ 100,
+ ), # Scenario where the current total mass is above the threshold
+ ],
+ )
+ def test_eat(
+ self,
+ herbivore_cohort_instance,
+ below_threshold,
+ expected_mass_current_increase,
+ expected_reproductive_mass_increase,
):
- """Testing forage_cohort."""
- # Setup
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
- from virtual_ecosystem.models.animals.animal_traits import DietType
- from virtual_ecosystem.models.animals.decay import CarcassPool, ExcrementPool
- from virtual_ecosystem.models.animals.plant_resources import PlantResources
-
- # Mocking the eat method of AnimalCohort
- mock_eat = mocker.patch.object(AnimalCohort, "eat")
-
- # Instances
- plant_list_instance = [mocker.MagicMock(spec=PlantResources)]
- animal_list_instance = [
- mocker.MagicMock(spec=AnimalCohort) for _ in range(3)
- ] # Assuming 3 animal cohorts
- carcass_pool_instance = mocker.MagicMock(spec=CarcassPool)
- excrement_pool_instance = mocker.MagicMock(spec=ExcrementPool)
- excrement_pool_instance.scavengeable_energy = 0
- excrement_pool_instance.decomposed_energy = 0
-
- animal_cohort_instances = [predator_cohort_instance, prey_cohort_instance]
-
- for animal_cohort_instance in animal_cohort_instances:
- # Execution
- animal_cohort_instance.forage_cohort(
- plant_list=plant_list_instance,
- animal_list=animal_list_instance,
- carcass_pool=carcass_pool_instance,
- excrement_pool=excrement_pool_instance,
- )
+ """Testing eat method adjusting for the mass threshold."""
+ mass_consumed = 100 # Define a test mass consumed
- # Assertions
- if animal_cohort_instance.functional_group.diet == DietType.HERBIVORE:
- mock_eat.assert_called_with(
- plant_list_instance[0], excrement_pool_instance
- ) # Assuming just one plant instance for simplicity
- elif animal_cohort_instance.functional_group.diet == DietType.CARNIVORE:
- # Ensure eat was called for each animal in the list
- assert len(mock_eat.call_args_list) == 1
- for call in mock_eat.call_args_list:
- # Ensure each call had a single AnimalCohort and the CarcassPool
- args, _ = call
- assert args[0] in animal_list_instance
- assert args[1] == carcass_pool_instance
-
- # Reset mock_eat for next iteration
- mock_eat.reset_mock()
-
- def test_eat(self, herbivore_cohort_instance, mocker):
- """Testing eat."""
- from virtual_ecosystem.models.animals.protocols import Pool, Resource
-
- mock_food = mocker.MagicMock(spec=Resource)
- mock_pool = mocker.MagicMock(spec=Pool)
-
- # Common Setup
- herbivore_cohort_instance.individuals = 10
- mock_mass_return = 100
- mock_food.get_eaten.return_value = mock_mass_return
-
- # Scenario 1: Test mass_current is updated when below threshold
- herbivore_cohort_instance.mass_current = 0 # Resetting for test
- herbivore_cohort_instance.reproductive_mass = 0 # Resetting for test
- herbivore_cohort_instance.is_below_mass_threshold = mocker.MagicMock(
- return_value=True
- )
-
- # Execution
- herbivore_cohort_instance.eat(mock_food, mock_pool)
-
- # Assertions for Scenario 1
- assert (
- herbivore_cohort_instance.mass_current
- == mock_mass_return / herbivore_cohort_instance.individuals
- )
- assert herbivore_cohort_instance.reproductive_mass == 0
+ # Set up the instance to reflect the test scenario
+ adult_mass = 200 # Assume an adult mass for calculation
+ herbivore_cohort_instance.functional_group.adult_mass = adult_mass
+ total_mass = adult_mass * below_threshold
+ herbivore_cohort_instance.mass_current = (
+ total_mass * 0.8
+ ) # 80% towards current mass
+ herbivore_cohort_instance.reproductive_mass = (
+ total_mass * 0.2
+ ) # 20% towards reproductive mass
- # Scenario 2: Test reproductive_mass is updated when above threshold
- herbivore_cohort_instance.mass_current = 0 # Resetting for test
- herbivore_cohort_instance.reproductive_mass = 0 # Resetting for test
- herbivore_cohort_instance.is_below_mass_threshold = mocker.MagicMock(
- return_value=False
- )
+ initial_mass_current = herbivore_cohort_instance.mass_current
+ initial_reproductive_mass = herbivore_cohort_instance.reproductive_mass
- # Execution
- herbivore_cohort_instance.eat(mock_food, mock_pool)
+ # Execute the eat method
+ herbivore_cohort_instance.eat(mass_consumed)
- # Assertions for Scenario 2
+ # Assertions
+ assert (
+ herbivore_cohort_instance.mass_current
+ == initial_mass_current + expected_mass_current_increase
+ ), "Current mass did not increase as expected."
assert (
herbivore_cohort_instance.reproductive_mass
- == mock_mass_return / herbivore_cohort_instance.individuals
- )
- assert herbivore_cohort_instance.mass_current == 0
+ == initial_reproductive_mass + expected_reproductive_mass_increase
+ ), "Reproductive mass did not increase as expected."
def test_is_below_mass_threshold(
self, herbivore_cohort_instance, constants_instance
@@ -396,49 +533,734 @@ def test_is_below_mass_threshold(
)
@pytest.mark.parametrize(
- "initial_individuals, number_days, mortality_prob",
- [(100, 10.0, 0.01), (1000, 20.0, 0.05), (0, 10.0, 0.01), (100, 10.0, 0.0)],
+ "alpha_0_herb, mass_current, expected_alpha",
+ [
+ pytest.param(1.0e-11, 50, 5e-10, id="base rate and mass"),
+ pytest.param(2.0e-11, 100, 2e-9, id="increased rate and mass"),
+ pytest.param(5.0e-12, 25, 1.25e-10, id="decreased rate and mass"),
+ pytest.param(2.0e-11, 25, 5e-10, id="high rate, low mass"),
+ pytest.param(5.0e-12, 100, 5e-10, id="low rate, high mass"),
+ ],
)
- def test_inflict_natural_mortality(
+ def test_calculate_alpha(
self,
- herbivore_cohort_instance,
- carcass_instance,
mocker,
- initial_individuals,
- number_days,
- mortality_prob,
+ alpha_0_herb,
+ mass_current,
+ expected_alpha,
+ herbivore_functional_group_instance,
):
- """Testing inflict natural mortality method."""
- from random import seed
+ """Testing for calculate alpha."""
+ # Assuming necessary imports and setup based on previous examples
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.constants import AnimalConsts
+
+ # Mock the scaling function to control its return value
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.alpha_i_k",
+ return_value=expected_alpha,
+ )
- from numpy import floor
+ # Setup constants and functional group mock
+ constants = AnimalConsts()
+ functional_group_mock = herbivore_functional_group_instance
+
+ # Initialize the AnimalCohort instance with test parameters
+ cohort_instance = AnimalCohort(
+ functional_group=functional_group_mock,
+ mass=mass_current,
+ age=1.0, # Example age
+ individuals=1, # Example number of individuals
+ constants=constants,
+ )
+
+ # Execute the method under test
+ result = cohort_instance.calculate_alpha()
- seed(42)
+ # Assert that the result matches the expected outcome for the given scenario
+ assert (
+ result == expected_alpha
+ ), f"Failed scenario: alpha_0_herb={alpha_0_herb}, mass_current={mass_current}"
- expected_deaths = initial_individuals * (
- 1 - (1 - mortality_prob) ** number_days
+ @pytest.mark.parametrize(
+ "alpha, mass_current, phi_herb_t, expected_biomass",
+ [
+ pytest.param(1.0e-11, 100, 0.1, 1, id="low_alpha_high_mass"),
+ pytest.param(2.0e-11, 100, 0.2, 2, id="high_alpha_high_mass"),
+ pytest.param(1.0e-11, 0.1, 0.1, 3, id="low_alpha_low_mass"),
+ pytest.param(2.0e-11, 0.1, 0.2, 4, id="high_alpha_low_mass"),
+ ],
+ )
+ def test_calculate_potential_consumed_biomass(
+ self, mocker, alpha, mass_current, phi_herb_t, expected_biomass
+ ):
+ """Testing for calculate_potential_consumed_biomass."""
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_traits import DietType
+ from virtual_ecosystem.models.animal.protocols import Resource
+
+ # Mock the target plant
+ target_plant = mocker.MagicMock(spec=Resource, mass_current=mass_current)
+
+ # Mock k_i_k to return the expected_biomass
+ k_i_k_mock = mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.k_i_k",
+ return_value=expected_biomass,
)
- expected_deaths = int(floor(expected_deaths))
- # Set individuals and adult natural mortality probability
- herbivore_cohort_instance.individuals = initial_individuals
- herbivore_cohort_instance.adult_natural_mortality_prob = mortality_prob
+ # Setup functional group mock to provide phi_herb_t
+ functional_group_mock = mocker.MagicMock()
+ functional_group_mock.diet = DietType("herbivore")
+ functional_group_mock.constants.phi_herb_t = phi_herb_t
+
+ # Initialize the AnimalCohort instance with mocked functional group
+ cohort_instance = AnimalCohort(
+ functional_group=functional_group_mock,
+ mass=100.0, # Arbitrary value since mass is not directly used in this test
+ age=1.0, # Arbitrary value
+ individuals=1, # Arbitrary value
+ constants=mocker.MagicMock(),
+ )
+
+ # Execute the method under test
+ result = cohort_instance.calculate_potential_consumed_biomass(
+ target_plant, alpha
+ )
+
+ # Verify that the result matches the expected outcome for the given scenario
+ assert result == expected_biomass, (
+ f"Failed scenario: alpha={alpha}, mass_current={mass_current}, "
+ f"phi_herb_t={phi_herb_t}"
+ )
+
+ # verify that k_i_k was called with the correct parameters
+ A_cell = 1.0
+ k_i_k_mock.assert_called_once_with(alpha, phi_herb_t, mass_current, A_cell)
+
+ def calculate_total_handling_time_for_herbivory(
+ self, mocker, herbivore_cohort_instance, plant_list_instance
+ ):
+ """Test aggregation of handling times across all available plant resources."""
+
+ alpha = 0.1 # Assume this is the calculated search efficiency
+ with (
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.k_i_k",
+ return_value=20.0,
+ ),
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.H_i_k",
+ return_value=0.2,
+ ),
+ ):
+ total_handling_time = (
+ herbivore_cohort_instance.calculate_total_handling_time_for_herbivory(
+ plant_list_instance, alpha
+ )
+ )
+ # Assert based on expected behavior; this will need to be adjusted based on
+ # number of plants and their handling times
+ expected_handling_time = sum(
+ [20.2 for _ in plant_list_instance]
+ ) # Simplified; adjust calculation as needed
+ assert total_handling_time == pytest.approx(
+ expected_handling_time, rel=1e-6
+ )
+
+ @pytest.mark.parametrize(
+ "alpha, potential_biomass, total_handling_time, plant_biomass, "
+ "cohort_size, expected_rate, scenario_id",
+ [
+ pytest.param(
+ 0.1,
+ 20.0,
+ 40.4,
+ 100,
+ 10,
+ "expected_rate_calculation_1",
+ "low_alpha_high_mass",
+ ),
+ pytest.param(
+ 0.2,
+ 30.0,
+ 20.2,
+ 200,
+ 5,
+ "expected_rate_calculation_2",
+ "high_alpha_high_mass",
+ ),
+ ],
+ )
+ def test_F_i_k(
+ self,
+ mocker,
+ alpha,
+ potential_biomass,
+ total_handling_time,
+ plant_biomass,
+ cohort_size,
+ expected_rate,
+ scenario_id,
+ herbivore_cohort_instance,
+ ):
+ """Test for F_i_k."""
+ from virtual_ecosystem.models.animal.protocols import Resource
+
+ # Mock the target plant with specified biomass
+ target_plant = mocker.MagicMock(spec=Resource, mass_current=plant_biomass)
+ plant_list = [target_plant] # Simplified plant list for testing
+
+ # Mock internal method calls
+ mocker.patch.object(
+ herbivore_cohort_instance, "calculate_alpha", return_value=alpha
+ )
+ mocker.patch.object(
+ herbivore_cohort_instance,
+ "calculate_potential_consumed_biomass",
+ return_value=potential_biomass,
+ )
+ mocker.patch.object(
+ herbivore_cohort_instance,
+ "calculate_total_handling_time_for_herbivory",
+ return_value=total_handling_time,
+ )
+
+ # Execute the method under test
+ rate = herbivore_cohort_instance.F_i_k(plant_list, target_plant)
+
+ N = herbivore_cohort_instance.individuals
+ k = potential_biomass
+ B_k = plant_biomass
+ total_handling_t = total_handling_time
+
+ calculated_expected_rate = N * (k / (1 + total_handling_t)) * (1 / B_k)
+
+ # Assert that the rate matches the expected output
+ assert rate == pytest.approx(calculated_expected_rate, rel=1e-6), (
+ f"The calculated rate does not match"
+ f"the expected rate for scenario {scenario_id}"
+ )
+
+ def test_calculate_theta_opt_i(self, mocker, herbivore_cohort_instance):
+ """Test calculate_theta_opt_i."""
+ theta_opt_i_mock = mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.theta_opt_i",
+ return_value=0.5, # Mocked return value to simulate `theta_opt_i` behavior
+ )
+ result = herbivore_cohort_instance.calculate_theta_opt_i()
+
+ # Assert the result matches the mocked return value
+ assert (
+ result == 0.5
+ ), "The result does not match the expected return value from sf.theta_opt_i"
+
+ # Assert sf.theta_opt_i was called with the correct parameters
+ theta_opt_i_mock.assert_called_once_with(
+ herbivore_cohort_instance.constants.theta_opt_min_f,
+ herbivore_cohort_instance.constants.theta_opt_f,
+ herbivore_cohort_instance.constants.sigma_opt_f,
+ )
+
+ def test_calculate_predation_success_probability(
+ self, mocker, herbivore_cohort_instance
+ ):
+ """Test successful predation probability calculation."""
+
+ target_mass = 50.0 # Example target mass
- # Mock the random.binomial call
+ mock_theta_opt_i = mocker.patch(
+ "virtual_ecosystem.models.animal.animal_cohorts.AnimalCohort"
+ ".calculate_theta_opt_i",
+ return_value=0.7,
+ )
+
+ mock_w_bar = mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.w_bar_i_j",
+ return_value=0.6,
+ )
+
+ result = herbivore_cohort_instance.calculate_predation_success_probability(
+ target_mass
+ )
+
+ # Ensure calculate_theta_opt_i is called within the method
+ mock_theta_opt_i.assert_called_once()
+
+ # Verify that w_bar_i_j was called with the correct parameters
+ mock_w_bar.assert_called_once_with(
+ herbivore_cohort_instance.mass_current,
+ target_mass,
+ 0.7, # Expected theta_opt_i from mocked
+ herbivore_cohort_instance.constants.sigma_opt_pred_prey,
+ )
+
+ # Asserting the result matches the mocked return value
+ assert result == 0.6, "Expected predation success probability not returned."
+
+ def test_calculate_predation_search_rate(self, mocker, herbivore_cohort_instance):
+ """Test predation search rate calculation."""
+
+ success_probability = 0.5 # Example success probability
+
+ mock_alpha_i_j = mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.alpha_i_j",
+ return_value=0.8,
+ )
+
+ result = herbivore_cohort_instance.calculate_predation_search_rate(
+ success_probability
+ )
+
+ # Verify that alpha_i_j was called with the correct parameters
+ mock_alpha_i_j.assert_called_once_with(
+ herbivore_cohort_instance.constants.alpha_0_pred,
+ herbivore_cohort_instance.mass_current,
+ success_probability,
+ )
+
+ # Asserting the result matches the mocked return value
+ assert result == 0.8, "Expected predation search rate not returned."
+
+ def test_calculate_potential_prey_consumed(self, mocker, herbivore_cohort_instance):
+ """Test calculation of potential number of prey consumed."""
+
+ alpha = 0.8 # Example search rate
+ theta_i_j = 0.7 # Example predation parameter
+
+ mock_k_i_j = mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.k_i_j",
+ return_value=15.0,
+ )
+
+ result = herbivore_cohort_instance.calculate_potential_prey_consumed(
+ alpha, theta_i_j
+ )
+
+ # Verify that k_i_j was called with the correct parameters
+ mock_k_i_j.assert_called_once_with(
+ alpha,
+ herbivore_cohort_instance.individuals,
+ 1.0,
+ theta_i_j,
+ )
+
+ # Asserting the result matches the mocked return value
+ assert result == 15.0, "Expected potential prey consumed not returned."
+
+ def test_calculate_total_handling_time_for_predation(
+ self, mocker, herbivore_cohort_instance
+ ):
+ """Test total handling time calculation for predation."""
+
+ mock_H_i_j = mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.H_i_j", return_value=2.5
+ )
+
+ result = herbivore_cohort_instance.calculate_total_handling_time_for_predation()
+
+ # Verify that H_i_j was called with the correct parameters
+ mock_H_i_j.assert_called_once_with(
+ herbivore_cohort_instance.constants.h_pred_0,
+ herbivore_cohort_instance.constants.M_pred_ref,
+ herbivore_cohort_instance.mass_current,
+ herbivore_cohort_instance.constants.b_pred,
+ )
+
+ # Asserting the result matches the mocked return value
+ assert result == 2.5, "Expected total handling time for predation not returned."
+
+ def test_F_i_j_individual(
+ self, mocker, predator_cohort_instance, animal_list_instance
+ ):
+ """Test instantaneous predation rate calculation on a selected target cohort."""
+
+ target_animal = animal_list_instance[0]
+
+ # Mock methods using the mocker fixture
+ mock_success_prob = mocker.patch(
+ (
+ "virtual_ecosystem.models.animal.animal_cohorts."
+ "AnimalCohort.calculate_predation_success_probability"
+ ),
+ return_value=0.5,
+ )
+ mock_search_rate = mocker.patch(
+ (
+ "virtual_ecosystem.models.animal.animal_cohorts."
+ "AnimalCohort.calculate_predation_search_rate"
+ ),
+ return_value=0.8,
+ )
+ mock_theta_i_j = mocker.patch(
+ (
+ "virtual_ecosystem.models.animal.animal_cohorts."
+ "AnimalCohort.theta_i_j"
+ ),
+ return_value=0.7,
+ )
+ mock_potential_prey = mocker.patch(
+ (
+ "virtual_ecosystem.models.animal.animal_cohorts."
+ "AnimalCohort.calculate_potential_prey_consumed"
+ ),
+ return_value=10,
+ )
+ mock_total_handling = mocker.patch(
+ (
+ "virtual_ecosystem.models.animal.animal_cohorts."
+ "AnimalCohort.calculate_total_handling_time_for_predation"
+ ),
+ return_value=2,
+ )
+
+ # Execute the method under test
+ rate = predator_cohort_instance.F_i_j_individual(
+ animal_list_instance, target_animal
+ )
+
+ # Verify each mocked method was called with expected arguments
+ mock_success_prob.assert_called_once_with(target_animal.mass_current)
+ mock_search_rate.assert_called_once_with(0.5)
+ mock_theta_i_j.assert_called_once_with(animal_list_instance)
+ mock_potential_prey.assert_called_once_with(0.8, 0.7)
+ mock_total_handling.assert_called_once()
+
+ # Calculate the expected rate based on the mocked return values and assert
+ N_i = predator_cohort_instance.individuals
+ N_target = target_animal.individuals
+ expected_rate = N_i * (10 / (1 + 2)) * (1 / N_target)
+ assert rate == pytest.approx(
+ expected_rate
+ ), "F_i_j_individual did not return the expected predation rate."
+
+ def test_theta_i_j(self, predator_cohort_instance, animal_list_instance):
+ """Test theta_i_j."""
+ # TODO change this A_cell to call it from its real plant in the data
+ A_cell = 1.0 # Define A_cell value used in method implementation
+
+ # Execute the method under test
+ theta = predator_cohort_instance.theta_i_j(animal_list_instance)
+
+ # Calculate expected theta value considering A_cell
+ expected_theta = (
+ sum(
+ cohort.individuals
+ for cohort in animal_list_instance
+ if cohort.mass_current == predator_cohort_instance.mass_current
+ )
+ / A_cell
+ )
+
+ assert theta == expected_theta
+
+ @pytest.mark.parametrize(
+ "consumed_mass, expected_total_consumed_mass",
+ [
+ (100.0, 300.0), # Assuming three cohorts each consuming 100.0 units
+ ],
+ )
+ def test_delta_mass_predation(
+ self,
+ mocker,
+ predator_cohort_instance,
+ animal_list_instance,
+ excrement_pool_instance,
+ carcass_pool_instance,
+ consumed_mass,
+ expected_total_consumed_mass,
+ ):
+ """Test the delta_mass_predation.
+
+ The expected total consumed mass is 300 because there are three cohorts in the
+ animal cohort instance.
+ """
+
+ # Mock calculate_consumed_mass_predation to return a specific consumed mass
+ mocker.patch.object(
+ predator_cohort_instance,
+ "calculate_consumed_mass_predation",
+ return_value=consumed_mass,
+ )
+
+ # Mock AnimalCohort.get_eaten to simulate consumption behavior
mocker.patch(
- "virtual_ecosystem.models.animals.animal_cohorts.random.binomial",
- return_value=expected_deaths,
+ "virtual_ecosystem.models.animal.animal_cohorts.AnimalCohort.get_eaten",
+ return_value=consumed_mass,
)
- # Keep a copy of initial individuals to validate number_of_deaths
- initial_individuals_copy = herbivore_cohort_instance.individuals
- # Call the inflict_natural_mortality method
- herbivore_cohort_instance.inflict_natural_mortality(
- carcass_instance, number_days
+ # Mock predator_cohort_instance.defecate to verify its call
+ mock_defecate = mocker.patch.object(predator_cohort_instance, "defecate")
+
+ total_consumed_mass = predator_cohort_instance.delta_mass_predation(
+ animal_list_instance, excrement_pool_instance, carcass_pool_instance
)
- # Verify the number_of_deaths and remaining individuals
+ # Check if the total consumed mass matches the expected value
assert (
- herbivore_cohort_instance.individuals
- == initial_individuals_copy - expected_deaths
+ total_consumed_mass == expected_total_consumed_mass
+ ), "Total consumed mass should match expected value."
+
+ # Ensure defecate was called with the correct total consumed mass
+ mock_defecate.assert_called_once_with(
+ excrement_pool_instance, total_consumed_mass
)
+
+ def test_delta_mass_herbivory(
+ self,
+ mocker,
+ herbivore_cohort_instance,
+ plant_list_instance,
+ excrement_pool_instance,
+ ):
+ """Test mass assimilation calculation from herbivory."""
+
+ # Mock the calculate_consumed_mass_herbivory method
+ mock_calculate_consumed_mass_herbivory = mocker.patch.object(
+ herbivore_cohort_instance,
+ "calculate_consumed_mass_herbivory",
+ side_effect=lambda plant_list, plant: 10.0,
+ # Assume 10.0 kg mass consumed from each plant for simplicity
+ )
+
+ # Mock the PlantResources.get_eaten method
+ mock_get_eaten = mocker.patch(
+ "virtual_ecosystem.models.animal.plant_resources.PlantResources.get_eaten",
+ side_effect=lambda consumed_mass, herbivore, excrement_pool: consumed_mass,
+ )
+
+ delta_mass = herbivore_cohort_instance.delta_mass_herbivory(
+ plant_list_instance, excrement_pool_instance
+ )
+
+ # Ensure calculate_consumed_mass_herbivory and get_eaten were called correctly
+ assert mock_calculate_consumed_mass_herbivory.call_count == len(
+ plant_list_instance
+ )
+ assert mock_get_eaten.call_count == len(plant_list_instance)
+
+ # Calculate the expected total consumed mass based on the number of plants
+ expected_delta_mass = 10.0 * len(plant_list_instance)
+
+ # Assert the calculated delta_mass_herb matches the expected value
+ assert delta_mass == pytest.approx(
+ expected_delta_mass
+ ), "Calculated change in mass due to herbivory did not match expected value."
+
+ def test_forage_cohort(
+ self,
+ mocker,
+ herbivore_cohort_instance,
+ predator_cohort_instance,
+ plant_list_instance,
+ animal_list_instance,
+ excrement_pool_instance,
+ carcass_pool_instance,
+ ):
+ """Test foraging behavior for different diet types."""
+
+ # Mocking the delta_mass_herbivory and delta_mass_predation methods
+ mock_delta_mass_herbivory = mocker.patch.object(
+ herbivore_cohort_instance, "delta_mass_herbivory", return_value=100
+ )
+ mock_delta_mass_predation = mocker.patch.object(
+ predator_cohort_instance, "delta_mass_predation", return_value=200
+ )
+ mock_eat_herbivore = mocker.patch.object(herbivore_cohort_instance, "eat")
+ mock_eat_predator = mocker.patch.object(predator_cohort_instance, "eat")
+
+ # Test herbivore diet
+ herbivore_cohort_instance.forage_cohort(
+ plant_list_instance, [], excrement_pool_instance, carcass_pool_instance
+ )
+ mock_delta_mass_herbivory.assert_called_once_with(
+ plant_list_instance, excrement_pool_instance
+ )
+ mock_eat_herbivore.assert_called_once_with(100)
+
+ # Test carnivore diet
+ predator_cohort_instance.forage_cohort(
+ [], animal_list_instance, excrement_pool_instance, carcass_pool_instance
+ )
+ mock_delta_mass_predation.assert_called_once_with(
+ animal_list_instance, excrement_pool_instance, carcass_pool_instance
+ )
+ mock_eat_predator.assert_called_once_with(200)
+
+ @pytest.mark.parametrize(
+ "mass_current, V_disp, M_disp_ref, o_disp, expected_probability",
+ [
+ pytest.param(10, 0.5, 10, 0.5, 0.5, id="normal_case"),
+ pytest.param(10, 1.5, 10, 0.5, 1.0, id="cap_at_1"),
+ pytest.param(10, 0, 10, 0.5, 0, id="zero_velocity"),
+ pytest.param(0, 0.5, 10, 0.5, 0, id="zero_mass"),
+ ],
+ )
+ def test_migrate_juvenile_probability(
+ self,
+ mocker,
+ mass_current,
+ V_disp,
+ M_disp_ref,
+ o_disp,
+ expected_probability,
+ herbivore_cohort_instance,
+ ):
+ """Test the calculation of juvenile migration probability."""
+ from math import sqrt
+
+ # Assign test-specific values to the cohort instance
+ cohort = herbivore_cohort_instance
+ cohort.mass_current = mass_current
+ cohort.constants = mocker.MagicMock(
+ V_disp=V_disp, M_disp_ref=M_disp_ref, o_disp=o_disp
+ )
+
+ # Mock juvenile_dispersal_speed
+ mocked_velocity = V_disp * (mass_current / M_disp_ref) ** o_disp
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions."
+ "juvenile_dispersal_speed",
+ return_value=mocked_velocity,
+ )
+
+ # Calculate expected probability
+ A_cell = 1.0
+ grid_side = sqrt(A_cell)
+ calculated_probability = mocked_velocity / grid_side
+ expected_probability = min(calculated_probability, 1.0) # Cap at 1.0
+
+ # Call the method under test
+ probability_of_dispersal = cohort.migrate_juvenile_probability()
+
+ # Assertion to check if the method returns the correct probability
+ assert (
+ probability_of_dispersal == expected_probability
+ ), "The probability calculated did not match the expected probability."
+
+ @pytest.mark.parametrize(
+ "is_mature, u_bg, lambda_se, t_to_maturity, t_since_maturity, lambda_max, J_st,"
+ "zeta_st, mass_current, mass_max, dt, expected_dead",
+ [
+ pytest.param(
+ True,
+ 0.001,
+ 0.003,
+ 365,
+ 30,
+ 1.0,
+ 0.6,
+ 0.05,
+ 600,
+ 600,
+ 30,
+ 13,
+ id="mature_with_all_mortalities",
+ ),
+ pytest.param(
+ False,
+ 0.001,
+ 0.003,
+ 365,
+ 30,
+ 1.0,
+ 0.6,
+ 0.05,
+ 600,
+ 600,
+ 30,
+ 4,
+ id="immature_without_senescence",
+ ),
+ ],
+ )
+ def test_inflict_non_predation_mortality(
+ self,
+ mocker,
+ is_mature,
+ u_bg,
+ lambda_se,
+ t_to_maturity,
+ t_since_maturity,
+ lambda_max,
+ J_st,
+ zeta_st,
+ mass_current,
+ mass_max,
+ dt,
+ expected_dead,
+ predator_cohort_instance,
+ carcass_pool_instance,
+ ):
+ """Test the calculation of total non-predation mortality in a cohort."""
+ from math import ceil, exp
+
+ import virtual_ecosystem.models.animal.scaling_functions as sf
+
+ # Use the predator cohort instance and set initial individuals to 100
+ cohort = predator_cohort_instance
+ cohort.individuals = 100 # Set initial individuals count
+ cohort.is_mature = is_mature
+ cohort.mass_current = mass_current
+ cohort.time_to_maturity = t_to_maturity
+ cohort.time_since_maturity = t_since_maturity
+ cohort.functional_group.adult_mass = mass_max
+
+ # Mocking the mortality functions to return predefined values
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.background_mortality",
+ return_value=u_bg,
+ )
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.senescence_mortality",
+ return_value=(
+ lambda_se * exp(t_since_maturity / t_to_maturity) if is_mature else 0.0
+ ),
+ )
+ mocker.patch(
+ "virtual_ecosystem.models.animal.scaling_functions.starvation_mortality",
+ return_value=(
+ lambda_max
+ / (1 + exp((mass_current - J_st * mass_max) / (zeta_st * mass_max)))
+ ),
+ )
+
+ # Diagnostics
+ print(f"Initial individuals: {cohort.individuals}")
+
+ # Run the method
+ cohort.inflict_non_predation_mortality(dt, carcass_pool_instance)
+
+ # Calculate expected number of deaths inside the test
+ u_bg_value = sf.background_mortality(u_bg)
+ u_se_value = (
+ sf.senescence_mortality(lambda_se, t_to_maturity, t_since_maturity)
+ if is_mature
+ else 0.0
+ )
+ u_st_value = sf.starvation_mortality(
+ lambda_max, J_st, zeta_st, mass_current, mass_max
+ )
+ u_t = u_bg_value + u_se_value + u_st_value
+
+ number_dead = ceil(100 * (1 - exp(-u_t * dt)))
+
+ # Diagnostics
+ print(
+ f"background: {u_bg_value},"
+ f"senescence: {u_se_value},"
+ f"starvation: {u_st_value}"
+ )
+ print(f"Calculated total mortality rate: {u_t}")
+ print(
+ f"Calculated number dead: {number_dead},"
+ f"Expected number dead: {expected_dead}"
+ )
+ print(
+ f"Remaining individuals: {cohort.individuals},"
+ f"Expected remaining: {100 - expected_dead}"
+ )
+
+ # Verify
+ assert (
+ cohort.individuals == 100 - expected_dead
+ ), "The calculated number of dead individuals doesn't match the expected value."
diff --git a/tests/models/animals/test_animal_communities.py b/tests/models/animals/test_animal_communities.py
index 25380dc32..61058cb3c 100644
--- a/tests/models/animals/test_animal_communities.py
+++ b/tests/models/animals/test_animal_communities.py
@@ -1,21 +1,24 @@
"""Test module for animal_communities.py."""
+from math import ceil
+
import pytest
+from pytest_mock import MockerFixture
@pytest.fixture
def animal_community_destination_instance(
functional_group_list_instance,
animal_model_instance,
- plant_data_instance,
+ animal_data_for_community_instance,
constants_instance,
):
"""Fixture for an animal community used in tests."""
- from virtual_ecosystem.models.animals.animal_communities import AnimalCommunity
+ from virtual_ecosystem.models.animal.animal_communities import AnimalCommunity
return AnimalCommunity(
functional_groups=functional_group_list_instance,
- data=plant_data_instance,
+ data=animal_data_for_community_instance,
community_key=4,
neighbouring_keys=[1, 3, 5, 7],
get_destination=animal_model_instance.get_community_by_key,
@@ -26,7 +29,7 @@ def animal_community_destination_instance(
@pytest.fixture
def functional_group_instance(shared_datadir, constants_instance):
"""Fixture for an animal functional group used in tests."""
- from virtual_ecosystem.models.animals.functional_group import (
+ from virtual_ecosystem.models.animal.functional_group import (
import_functional_groups,
)
@@ -39,7 +42,7 @@ def functional_group_instance(shared_datadir, constants_instance):
@pytest.fixture
def animal_cohort_instance(functional_group_instance, constants_instance):
"""Fixture for an animal cohort used in tests."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
return AnimalCohort(
functional_group_instance,
@@ -60,8 +63,12 @@ def test_initialization(self, animal_community_instance):
"herbivorous_bird",
"carnivorous_mammal",
"herbivorous_mammal",
- "carnivorous_insect",
- "herbivorous_insect",
+ "carnivorous_insect_iteroparous",
+ "herbivorous_insect_iteroparous",
+ "carnivorous_insect_semelparous",
+ "herbivorous_insect_semelparous",
+ "butterfly",
+ "caterpillar",
]
def test_all_animal_cohorts_property(
@@ -115,48 +122,101 @@ def test_migrate(
]
)
+ @pytest.mark.parametrize(
+ "mass_ratio, age, probability_output, should_migrate",
+ [
+ (0.5, 5.0, False, True), # Starving non-juvenile, should migrate
+ (
+ 1.0,
+ 0.0,
+ False,
+ False,
+ ), # Well-fed juvenile, low probability, should not migrate
+ (
+ 1.0,
+ 0.0,
+ True,
+ True,
+ ), # Well-fed juvenile, high probability, should migrate
+ (
+ 0.5,
+ 0.0,
+ True,
+ True,
+ ), # Starving juvenile, high probability, should migrate
+ (
+ 0.5,
+ 0.0,
+ False,
+ True,
+ ), # Starving juvenile, low probability, should migrate due to starvation
+ (1.0, 5.0, False, False), # Well-fed non-juvenile, should not migrate
+ ],
+ ids=[
+ "starving_non_juvenile",
+ "well_fed_juvenile_low_prob",
+ "well_fed_juvenile_high_prob",
+ "starving_juvenile_high_prob",
+ "starving_juvenile_low_prob",
+ "well_fed_non_juvenile",
+ ],
+ )
def test_migrate_community(
self,
+ mocker,
animal_community_instance,
animal_community_destination_instance,
animal_cohort_instance,
- mocker,
+ mass_ratio,
+ age,
+ probability_output,
+ should_migrate,
):
- """Test migration of cohorts below the mass threshold."""
+ """Test migration of cohorts for both starving and juvenile conditions."""
- # Mock the get_destination callable in this specific test context.
+ cohort = animal_cohort_instance
+ cohort.age = age
+ cohort.mass_current = cohort.functional_group.adult_mass * mass_ratio
+
+ # Mock the get_destination callable to return a specific community.
mocker.patch.object(
animal_community_instance,
"get_destination",
return_value=animal_community_destination_instance,
)
- # Create a low mass cohort and append it to the source community.
- low_mass_cohort = animal_cohort_instance
- low_mass_cohort.mass_current = low_mass_cohort.functional_group.adult_mass / 2
- animal_community_instance.animal_cohorts["herbivorous_mammal"].append(
- low_mass_cohort
+ # Append cohort to the source community
+ animal_community_instance.animal_cohorts["herbivorous_mammal"].append(cohort)
+
+ # Mock `migrate_juvenile_probability` to control juvenile migration logic
+ mocker.patch.object(
+ cohort, "migrate_juvenile_probability", return_value=probability_output
)
# Perform the migration
animal_community_instance.migrate_community()
- # Check that the cohort has been removed from the source community
- assert (
- low_mass_cohort
- not in animal_community_instance.animal_cohorts["herbivorous_mammal"]
- )
-
- # Check that the cohort has been added to the destination community
- assert (
- low_mass_cohort
- in animal_community_destination_instance.animal_cohorts[
- "herbivorous_mammal"
- ]
- )
+ # Check migration outcome based on expected results
+ if should_migrate:
+ assert (
+ cohort
+ not in animal_community_instance.animal_cohorts["herbivorous_mammal"]
+ )
+ assert (
+ cohort
+ in animal_community_destination_instance.animal_cohorts[
+ "herbivorous_mammal"
+ ]
+ )
+ else:
+ assert (
+ cohort in animal_community_instance.animal_cohorts["herbivorous_mammal"]
+ )
- def test_die_cohort(self, animal_cohort_instance, animal_community_instance):
- """Testing die_cohort."""
+ def test_remove_dead_cohort(
+ self, animal_cohort_instance, animal_community_instance
+ ):
+ """Testing remove_dead_cohort."""
animal_community_instance.animal_cohorts["herbivorous_mammal"].append(
animal_cohort_instance
)
@@ -165,48 +225,88 @@ def test_die_cohort(self, animal_cohort_instance, animal_community_instance):
in animal_community_instance.animal_cohorts["herbivorous_mammal"]
)
assert animal_cohort_instance.is_alive
- animal_community_instance.die_cohort(animal_cohort_instance)
+ animal_community_instance.remove_dead_cohort(animal_cohort_instance)
+ assert (
+ animal_cohort_instance
+ in animal_community_instance.animal_cohorts["herbivorous_mammal"]
+ )
+ animal_cohort_instance.is_alive = False
assert not animal_cohort_instance.is_alive
+ animal_community_instance.remove_dead_cohort(animal_cohort_instance)
assert (
animal_cohort_instance
not in animal_community_instance.animal_cohorts["herbivorous_mammal"]
)
+ @pytest.mark.parametrize(
+ "reproductive_type, initial_mass, expected_offspring",
+ [
+ pytest.param("iteroparous", 10, 1, id="iteroparous_survival"),
+ pytest.param("semelparous", 10, 1, id="semelparous_death"),
+ ],
+ )
def test_birth(
- self, animal_community_instance, animal_cohort_instance, constants_instance
+ self,
+ reproductive_type,
+ initial_mass,
+ expected_offspring,
+ animal_community_instance,
+ animal_cohort_instance,
):
- """Test the birth method in AnimalCommunity."""
+ """Test the birth method in AnimalCommunity under various conditions."""
# Setup initial conditions
parent_cohort_name = animal_cohort_instance.name
- animal_community_instance.animal_cohorts[parent_cohort_name].append(
+ animal_cohort_instance.functional_group.reproductive_type = reproductive_type
+ animal_cohort_instance.functional_group.birth_mass = 2
+ animal_cohort_instance.mass_current = initial_mass
+ animal_cohort_instance.individuals = 10
+
+ # Prepare the community
+ animal_community_instance.animal_cohorts[parent_cohort_name] = [
animal_cohort_instance
- )
- initial_cohort_count = len(
- animal_community_instance.animal_cohorts[parent_cohort_name]
- )
+ ]
- # Set the reproductive mass of the parent cohort to ensure it can reproduce
- required_mass_for_birth = (
- animal_cohort_instance.functional_group.adult_mass
- * constants_instance.birth_mass_threshold
- - animal_cohort_instance.functional_group.adult_mass
+ number_cohorts = len(
+ animal_community_instance.animal_cohorts[parent_cohort_name]
)
- animal_cohort_instance.reproductive_mass = required_mass_for_birth
-
- # Call the birth method
animal_community_instance.birth(animal_cohort_instance)
# Assertions
- # 1. Check that a new cohort is added
- new_cohort_count = len(
- animal_community_instance.animal_cohorts[parent_cohort_name]
- )
- assert new_cohort_count == initial_cohort_count + 1
+ # 1. Check for changes in the parent cohort based on reproductive type
+ if reproductive_type == "semelparous":
+ # The parent should be removed if it dies
+ assert (
+ animal_cohort_instance
+ not in animal_community_instance.animal_cohorts[parent_cohort_name]
+ )
+ else:
+ # Reproductive mass should be reset
+ assert animal_cohort_instance.reproductive_mass == 0
+ # The parent should still be present in the community
+ assert (
+ animal_cohort_instance
+ in animal_community_instance.animal_cohorts[parent_cohort_name]
+ )
+
+ # 2. Check that the offspring were added if reproduction occurred
- # 2. Check that the reproductive mass of the parent cohort is reduced to 0
- assert animal_cohort_instance.reproductive_mass == 0
+ if expected_offspring and reproductive_type == "semelparous":
+ assert (
+ len(animal_community_instance.animal_cohorts[parent_cohort_name])
+ == number_cohorts
+ )
+ elif expected_offspring and reproductive_type == "iteroparous":
+ assert (
+ len(animal_community_instance.animal_cohorts[parent_cohort_name])
+ == number_cohorts + 1
+ )
+ else:
+ assert (
+ len(animal_community_instance.animal_cohorts[parent_cohort_name])
+ == number_cohorts
+ )
def test_birth_community(self, animal_community_instance, constants_instance):
"""Test the thresholding behavior of birth_community."""
@@ -265,8 +365,8 @@ def test_forage_community(
import unittest
from copy import deepcopy
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
- from virtual_ecosystem.models.animals.animal_communities import AnimalCommunity
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_communities import AnimalCommunity
# Prepare data
animal_cohort_instance_2 = deepcopy(animal_cohort_instance)
@@ -309,7 +409,7 @@ def test_collect_prey_finds_eligible_prey(
functional_group_instance,
):
"""Testing collect_prey with eligible prey items."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
prey_cohort = AnimalCohort(functional_group_instance, 5000.0, 1, 10)
animal_community_instance.animal_cohorts[functional_group_instance.name].append(
@@ -331,7 +431,7 @@ def test_collect_prey_filters_out_ineligible_prey(
functional_group_instance,
):
"""Testing collect_prey with no eligible prey items."""
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
prey_cohort = AnimalCohort(functional_group_instance, 20000.0, 1, 10)
animal_community_instance.animal_cohorts[functional_group_instance.name].append(
@@ -354,56 +454,223 @@ def test_increase_age_community(self, animal_community_instance):
animal_community_instance.populate_community()
- initial_age = list(
- chain.from_iterable(animal_community_instance.animal_cohorts.values())
- )[0].age
+ initial_age = next(
+ iter(chain.from_iterable(animal_community_instance.animal_cohorts.values()))
+ ).age
animal_community_instance.increase_age_community(timedelta64(5, "D"))
- new_age = list(
- chain.from_iterable(animal_community_instance.animal_cohorts.values())
- )[0].age
+ new_age = next(
+ iter(chain.from_iterable(animal_community_instance.animal_cohorts.values()))
+ ).age
assert new_age == initial_age + 5
def test_metabolize_community(
- self, dummy_climate_data, animal_community_instance, mocker
+ self, animal_community_instance, mocker: MockerFixture
):
"""Testing metabolize_community."""
from itertools import chain
from numpy import timedelta64
- from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
+ from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+
+ # Mocking the AnimalCohort methods
+ mock_metabolize = mocker.patch.object(
+ AnimalCohort, "metabolize", return_value=100.0
+ )
+ mock_respire = mocker.patch.object(AnimalCohort, "respire", return_value=90.0)
+ mock_excrete = mocker.patch.object(AnimalCohort, "excrete")
+
+ # Initial value of total animal respiration
+ initial_respiration = (
+ animal_community_instance.data["total_animal_respiration"]
+ .loc[{"cell_id": animal_community_instance.community_key}]
+ .item()
+ )
- mock_metabolize = mocker.patch.object(AnimalCohort, "metabolize")
+ # Call the metabolize_community method
animal_community_instance.metabolize_community(25.0, timedelta64(5, "D"))
- assert mock_metabolize.call_count == len(
+
+ # Calculate expected respiration after the method call
+ num_cohorts = len(
list(chain.from_iterable(animal_community_instance.animal_cohorts.values()))
)
+ expected_total_respiration = initial_respiration + num_cohorts * 90.0
+
+ # Check that metabolize was called the correct number of times
+ assert mock_metabolize.call_count == num_cohorts
+
+ # Check that respire was called the correct number of times
+ assert mock_respire.call_count == num_cohorts
- def test_inflict_natural_mortality_community(
- self, animal_community_instance, mocker
+ # Check that excrete was called the correct number of times
+ assert mock_excrete.call_count == num_cohorts
+
+ # Verify that total_animal_respiration was updated correctly
+ updated_respiration = (
+ animal_community_instance.data["total_animal_respiration"]
+ .loc[{"cell_id": animal_community_instance.community_key}]
+ .item()
+ )
+ assert updated_respiration == expected_total_respiration
+
+ @pytest.mark.parametrize(
+ "days",
+ [
+ pytest.param(1, id="one_day"),
+ pytest.param(5, id="five_days"),
+ pytest.param(10, id="ten_days"),
+ ],
+ )
+ def test_inflict_non_predation_mortality_community(
+ self, mocker, animal_community_instance, days
):
"""Testing natural mortality infliction for the entire community."""
from numpy import timedelta64
- # Create a time delta (for example, 5 days)
- dt = timedelta64(5, "D")
+ dt = timedelta64(days, "D")
animal_community_instance.populate_community()
- # Iterate over the animal cohorts within the community
- for cohorts in animal_community_instance.animal_cohorts.values():
- for cohort in cohorts:
- # Mock the cohort's inflict_natural_mortality method
- cohort.inflict_natural_mortality = mocker.MagicMock()
+ # Mock the inflict_non_predation_mortality method
+ mock_mortality = mocker.patch(
+ "virtual_ecosystem.models.animal.animal_cohorts.AnimalCohort."
+ "inflict_non_predation_mortality"
+ )
# Call the community method to inflict natural mortality
- animal_community_instance.inflict_natural_mortality_community(dt)
+ animal_community_instance.inflict_non_predation_mortality_community(dt)
- # Check that the inflict_natural_mortality method was called correctly for each
- # #cohort
number_of_days = float(dt / timedelta64(1, "D"))
+
+ # Assert the inflict_non_predation_mortality method was called for each cohort
for cohorts in animal_community_instance.animal_cohorts.values():
for cohort in cohorts:
- cohort.inflict_natural_mortality.assert_called_once_with(
- animal_community_instance.carcass_pool, number_of_days
+ mock_mortality.assert_called_with(
+ number_of_days, animal_community_instance.carcass_pool
)
+
+ # Check if cohorts with no individuals left are flagged as not alive
+ for cohorts in animal_community_instance.animal_cohorts.values():
+ for cohort in cohorts:
+ if cohort.individuals <= 0:
+ assert (
+ not cohort.is_alive
+ ), "Cohort with no individuals should be marked as not alive"
+ assert (
+ cohort
+ not in animal_community_instance.animal_cohorts[cohort.name]
+ ), "Dead cohort should be removed from the community"
+
+ def test_metamorphose(
+ self,
+ mocker,
+ animal_community_instance,
+ caterpillar_cohort_instance,
+ butterfly_cohort_instance,
+ ):
+ """Test the metamorphose method for different scenarios."""
+
+ larval_cohort = caterpillar_cohort_instance
+ larval_cohort.is_alive = True
+
+ adult_functional_group = butterfly_cohort_instance.functional_group
+ adult_functional_group.birth_mass = 5.0
+ mock_get_functional_group_by_name = mocker.patch(
+ "virtual_ecosystem.models.animal.animal_communities.get_functional_group_by_name",
+ return_value=adult_functional_group,
+ )
+ animal_community_instance.animal_cohorts["butterfly"] = []
+
+ mock_remove_dead_cohort = mocker.patch.object(
+ animal_community_instance, "remove_dead_cohort"
+ )
+
+ # Verify
+ number_dead = ceil(
+ larval_cohort.individuals * larval_cohort.constants.metamorph_mortality
+ )
+ expected_individuals = larval_cohort.individuals - number_dead
+
+ animal_community_instance.metamorphose(larval_cohort)
+
+ assert not larval_cohort.is_alive
+ assert len(animal_community_instance.animal_cohorts["butterfly"]) == 1
+ assert (
+ animal_community_instance.animal_cohorts["butterfly"][0].individuals
+ == expected_individuals
+ )
+ mock_remove_dead_cohort.assert_called_once_with(larval_cohort)
+ mock_get_functional_group_by_name.assert_called_once_with(
+ animal_community_instance.functional_groups,
+ larval_cohort.functional_group.offspring_functional_group,
+ )
+
+ @pytest.mark.parametrize(
+ "mass_current, expected_caterpillar_count, expected_butterfly_count,"
+ "expected_is_alive",
+ [
+ pytest.param(
+ 0.9, # Caterpillar mass is below the adult mass threshold
+ 1, # Caterpillar count should remain the same
+ 0, # Butterfly count should remain the same
+ True, # Caterpillar should still be alive
+ id="Below_mass_threshold",
+ ),
+ pytest.param(
+ 1.1, # Caterpillar mass is above the adult mass threshold
+ 0, # Caterpillar count should decrease
+ 1, # Butterfly count should increase
+ False, # Caterpillar should no longer be alive
+ id="Above_mass_threshold",
+ ),
+ ],
+ )
+ def test_metamorphose_community(
+ self,
+ animal_community_instance,
+ caterpillar_cohort_instance,
+ mass_current,
+ expected_caterpillar_count,
+ expected_butterfly_count,
+ expected_is_alive,
+ ):
+ """Test the metamorphosis behavior of metamorphose_community."""
+
+ # Manually set the mass_current for the caterpillar cohort
+ caterpillar_cohort = caterpillar_cohort_instance
+ caterpillar_cohort.mass_current = (
+ caterpillar_cohort.functional_group.adult_mass * mass_current
+ )
+
+ # Initialize the animal_cohorts with both caterpillar and butterfly entries
+ animal_community_instance.animal_cohorts = {
+ "caterpillar": [caterpillar_cohort],
+ "butterfly": [],
+ }
+
+ # Initial counts
+ initial_caterpillar_count = len(
+ animal_community_instance.animal_cohorts.get("caterpillar", [])
+ )
+ initial_butterfly_count = len(
+ animal_community_instance.animal_cohorts.get("butterfly", [])
+ )
+
+ assert initial_caterpillar_count == 1
+ assert initial_butterfly_count == 0
+
+ # Execution: apply metamorphose to the community
+ animal_community_instance.metamorphose_community()
+
+ # New counts after metamorphosis
+ new_caterpillar_count = len(
+ animal_community_instance.animal_cohorts.get("caterpillar", [])
+ )
+ new_butterfly_count = len(
+ animal_community_instance.animal_cohorts.get("butterfly", [])
+ )
+
+ # Assertions
+ assert new_caterpillar_count == expected_caterpillar_count
+ assert new_butterfly_count == expected_butterfly_count
+ assert caterpillar_cohort.is_alive == expected_is_alive
diff --git a/tests/models/animals/test_animal_model.py b/tests/models/animals/test_animal_model.py
index 82c5cacd6..e93cbe4ef 100644
--- a/tests/models/animals/test_animal_model.py
+++ b/tests/models/animals/test_animal_model.py
@@ -9,19 +9,39 @@
from tests.conftest import log_check
+@pytest.fixture
+def prepared_animal_model_instance(
+ animal_data_for_model_instance,
+ fixture_core_components,
+ functional_group_list_instance,
+ constants_instance,
+):
+ """Animal model instance in which setup has already been run."""
+ from virtual_ecosystem.models.animal.animal_model import AnimalModel
+
+ model = AnimalModel(
+ data=animal_data_for_model_instance,
+ core_components=fixture_core_components,
+ functional_groups=functional_group_list_instance,
+ model_constants=constants_instance,
+ )
+ model.setup() # Ensure setup is called
+ return model
+
+
def test_animal_model_initialization(
- plant_climate_data_instance,
+ animal_data_for_model_instance,
fixture_core_components,
functional_group_list_instance,
constants_instance,
):
"""Test `AnimalModel` initialization."""
from virtual_ecosystem.core.base_model import BaseModel
- from virtual_ecosystem.models.animals.animal_model import AnimalModel
+ from virtual_ecosystem.models.animal.animal_model import AnimalModel
# Initialize model
model = AnimalModel(
- data=plant_climate_data_instance,
+ data=animal_data_for_model_instance,
core_components=fixture_core_components,
functional_groups=functional_group_list_instance,
model_constants=constants_instance,
@@ -29,8 +49,8 @@ def test_animal_model_initialization(
# In cases where it passes then checks that the object has the right properties
assert isinstance(model, BaseModel)
- assert model.model_name == "animals"
- assert str(model) == "A animals model instance"
+ assert model.model_name == "animal"
+ assert str(model) == "A animal model instance"
assert repr(model) == "AnimalModel(update_interval=1209600 seconds)"
assert isinstance(model.communities, dict)
@@ -42,43 +62,113 @@ def test_animal_model_initialization(
"""[core.timing]
start_date = "2020-01-01"
update_interval = "7 days"
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "carnivorous_bird"
taxa = "bird"
diet = "carnivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "carnivorous_bird"
+ excretion_type = "uricotelic"
birth_mass = 0.1
adult_mass = 1.0
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "herbivorous_bird"
taxa = "bird"
diet = "herbivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "herbivorous_bird"
+ excretion_type = "uricotelic"
birth_mass = 0.05
adult_mass = 0.5
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "carnivorous_mammal"
taxa = "mammal"
diet = "carnivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "carnivorous_mammal"
+ excretion_type = "ureotelic"
birth_mass = 4.0
adult_mass = 40.0
- [[animals.functional_groups]]
+ [[animal.functional_groups]]
name = "herbivorous_mammal"
taxa = "mammal"
diet = "herbivore"
metabolic_type = "endothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "herbivorous_mammal"
+ excretion_type = "ureotelic"
birth_mass = 1.0
adult_mass = 10.0
+ [[animal.functional_groups]]
+ name = "carnivorous_insect"
+ taxa = "insect"
+ diet = "carnivore"
+ metabolic_type = "ectothermic"
+ reproductive_type = "iteroparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "carnivorous_insect"
+ excretion_type = "uricotelic"
+ birth_mass = 0.001
+ adult_mass = 0.01
+ [[animal.functional_groups]]
+ name = "herbivorous_insect"
+ taxa = "insect"
+ diet = "herbivore"
+ metabolic_type = "ectothermic"
+ reproductive_type = "semelparous"
+ development_type = "direct"
+ development_status = "adult"
+ offspring_functional_group = "herbivorous_insect"
+ excretion_type = "uricotelic"
+ birth_mass = 0.0005
+ adult_mass = 0.005
+ [[animal.functional_groups]]
+ name = "butterfly"
+ taxa = "insect"
+ diet = "herbivore"
+ metabolic_type = "ectothermic"
+ reproductive_type = "semelparous"
+ development_type = "indirect"
+ development_status = "adult"
+ offspring_functional_group = "caterpillar"
+ excretion_type = "uricotelic"
+ birth_mass = 0.0005
+ adult_mass = 0.005
+ [[animal.functional_groups]]
+ name = "caterpillar"
+ taxa = "insect"
+ diet = "herbivore"
+ metabolic_type = "ectothermic"
+ reproductive_type = "nonreproductive"
+ development_type = "indirect"
+ development_status = "larval"
+ offspring_functional_group = "butterfly"
+ excretion_type = "uricotelic"
+ birth_mass = 0.0005
+ adult_mass = 0.005
""",
does_not_raise(),
(
- (INFO, "Initialised animals.AnimalConsts from config"),
+ (INFO, "Initialised animal.AnimalConsts from config"),
(
INFO,
"Information required to initialise the animal model successfully "
"extracted.",
),
+ (INFO, "Adding data array for 'total_animal_respiration'"),
+ (INFO, "Adding data array for 'population_densities'"),
(INFO, "Adding data array for 'decomposed_excrement'"),
(INFO, "Adding data array for 'decomposed_carcasses'"),
),
@@ -88,7 +178,7 @@ def test_animal_model_initialization(
)
def test_generate_animal_model(
caplog,
- plant_climate_data_instance,
+ animal_data_for_model_instance,
config_string,
raises,
expected_log_entries,
@@ -96,7 +186,7 @@ def test_generate_animal_model(
"""Test that the function to initialise the animal model behaves as expected."""
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.core_components import CoreComponents
- from virtual_ecosystem.models.animals.animal_model import AnimalModel
+ from virtual_ecosystem.models.animal.animal_model import AnimalModel
# Build the config object and core components
config = Config(cfg_strings=config_string)
@@ -106,7 +196,7 @@ def test_generate_animal_model(
# Check whether model is initialised (or not) as expected
with raises:
model = AnimalModel.from_config(
- data=plant_climate_data_instance,
+ data=animal_data_for_model_instance,
core_components=core_components,
config=config,
)
@@ -117,11 +207,14 @@ def test_generate_animal_model(
# Final check that expected logging entries are produced
log_check(caplog, expected_log_entries)
+ for record in caplog.records:
+ print(f"Level: {record.levelname}, Message: {record.message}")
+
def test_get_community_by_key(animal_model_instance):
"""Test the `get_community_by_key` method."""
- from virtual_ecosystem.models.animals.animal_model import AnimalCommunity
+ from virtual_ecosystem.models.animal.animal_model import AnimalCommunity
# If you know that your model_instance should have a community with key 0
community_0 = animal_model_instance.get_community_by_key(0)
@@ -142,75 +235,48 @@ def test_get_community_by_key(animal_model_instance):
animal_model_instance.get_community_by_key(999)
-def test_update_method_sequence(
- plant_climate_data_instance,
- fixture_core_components,
- functional_group_list_instance,
- constants_instance,
-):
- """Test update to ensure it runs the community methods in order.
-
- As a bonus this test checks that the litter output pools have all been created.
- """
- from unittest.mock import MagicMock
-
- from virtual_ecosystem.models.animals.animal_model import AnimalModel
-
- model = AnimalModel(
- data=plant_climate_data_instance,
- core_components=fixture_core_components,
- functional_groups=functional_group_list_instance,
- model_constants=constants_instance,
- )
-
- # Mock all the methods that are supposed to be called by update
+def test_update_method_sequence(mocker, prepared_animal_model_instance):
+ """Test update to ensure it runs the community methods in order."""
method_names = [
"forage_community",
"migrate_community",
"birth_community",
+ "metamorphose_community",
"metabolize_community",
- "inflict_natural_mortality_community",
- "die_cohort_community",
+ "inflict_non_predation_mortality_community",
+ "remove_dead_cohort_community",
"increase_age_community",
]
- mock_methods = {}
- for method_name in method_names:
- for community in model.communities.values():
- mock_method = MagicMock(name=method_name)
- setattr(community, method_name, mock_method)
- mock_methods[method_name] = mock_method
+ # Setup mock methods using spy
+ for community in prepared_animal_model_instance.communities.values():
+ for method_name in method_names:
+ mocker.spy(community, method_name)
- model.update(time_index=0)
+ prepared_animal_model_instance.update(time_index=0)
- # Collect the call sequence
- call_sequence = []
- for mock in mock_methods.values():
- if mock.call_args_list:
- call_sequence.append(mock._mock_name)
+ # Now, let's verify the order of the calls for each community
+ for community in prepared_animal_model_instance.communities.values():
+ called_methods = []
+ for method_name in method_names:
+ method = getattr(community, method_name)
+ # If the method was called, add its name to the list
+ if method.spy_return is not None or method.call_count > 0:
+ called_methods.append(method_name)
- # Assert the methods were called in the expected order
- assert call_sequence == method_names
- # Check that excrement and carcass data is created, all elements are zero as no
- # actual updates have occurred
- assert np.allclose(model.data["decomposed_excrement"], 0.0)
- assert np.allclose(model.data["decomposed_carcasses"], 0.0)
+ # Verify the called_methods list matches the expected method_names list
+ assert (
+ called_methods == method_names
+ ), f"Methods called in wrong order: {called_methods} for community {community}"
def test_update_method_time_index_argument(
- plant_climate_data_instance, fixture_core_components, functional_group_list_instance
+ prepared_animal_model_instance,
):
"""Test update to ensure the time index argument does not create an error."""
- from virtual_ecosystem.models.animals.animal_model import AnimalModel
-
- model = AnimalModel(
- data=plant_climate_data_instance,
- core_components=fixture_core_components,
- functional_groups=functional_group_list_instance,
- )
time_index = 5
- model.update(time_index=time_index)
+ prepared_animal_model_instance.update(time_index=time_index)
assert True
@@ -222,7 +288,7 @@ def test_calculate_litter_additions(functional_group_list_instance):
from virtual_ecosystem.core.core_components import CoreComponents
from virtual_ecosystem.core.data import Data
from virtual_ecosystem.core.grid import Grid
- from virtual_ecosystem.models.animals.animal_model import AnimalModel
+ from virtual_ecosystem.models.animal.animal_model import AnimalModel
# Build the config object and core components
config = Config(cfg_strings='[core.timing]\nupdate_interval="1 week"')
@@ -276,3 +342,141 @@ def test_calculate_litter_additions(functional_group_list_instance):
],
0.0,
)
+
+
+def test_setup_initializes_total_animal_respiration(
+ prepared_animal_model_instance,
+):
+ """Test that the setup method initializes the total_animal_respiration variable."""
+ import numpy as np
+ from xarray import DataArray
+
+ # Check if 'total_animal_respiration' is in the data object
+ assert (
+ "total_animal_respiration" in prepared_animal_model_instance.data
+ ), "'total_animal_respiration' should be initialized in the data object."
+
+ # Retrieve the total_animal_respiration DataArray from the model's data object
+ total_animal_respiration = prepared_animal_model_instance.data[
+ "total_animal_respiration"
+ ]
+
+ # Check that total_animal_respiration is an instance of xarray.DataArray
+ assert isinstance(
+ total_animal_respiration, DataArray
+ ), "'total_animal_respiration' should be an instance of xarray.DataArray."
+
+ # Check the initial values of total_animal_respiration are all zeros
+ assert np.all(
+ total_animal_respiration.values == 0
+ ), "Initial values of 'total_animal_respiration' should be all zeros."
+
+ # Optionally, you can also check the dimensions and coordinates
+ # This is useful if your setup method is supposed to initialize the data variable
+ # with specific dimensions or coordinates based on your model's structure
+ assert (
+ "cell_id" in total_animal_respiration.dims
+ ), "'cell_id' should be a dimension of 'total_animal_respiration'."
+
+
+def test_population_density_initialization(
+ prepared_animal_model_instance,
+):
+ """Test the initialization of the population density data variable."""
+
+ # Check that 'population_densities' is in the data
+ assert (
+ "population_densities" in prepared_animal_model_instance.data.data.data_vars
+ ), "'population_densities' data variable not found in Data object after setup."
+
+ # Retrieve the population densities data variable
+ population_densities = prepared_animal_model_instance.data["population_densities"]
+
+ # Check dimensions
+ expected_dims = ["community_id", "functional_group_id"]
+ assert all(
+ dim in population_densities.dims for dim in expected_dims
+ ), f"Expected dimensions {expected_dims} not found in 'population_densities'."
+
+ # Check coordinates
+ # you should adjust according to actual community IDs and functional group names
+ expected_community_ids = list(prepared_animal_model_instance.communities.keys())
+ expected_functional_group_names = [
+ fg.name for fg in prepared_animal_model_instance.functional_groups
+ ]
+ assert (
+ population_densities.coords["community_id"].values.tolist()
+ == expected_community_ids
+ ), "Community IDs in 'population_densities' do not match expected values."
+ assert (
+ population_densities.coords["functional_group_id"].values.tolist()
+ == expected_functional_group_names
+ ), "Functional group names in 'population_densities' do not match expected values."
+
+ # Assuming densities have been updated, check if densities are greater than or equal
+ # to zero
+ assert np.all(
+ population_densities.values >= 0
+ ), "Population densities should be greater than or equal to zero."
+
+
+def test_update_population_densities(prepared_animal_model_instance):
+ """Test that the update_population_densities method correctly updates."""
+
+ # Set up expected densities
+ expected_densities = {}
+
+ # For simplicity in this example, assume we manually calculate expected densities
+ # based on your cohort setup logic. In practice, you would calculate these
+ # based on your specific test setup conditions.
+ for community_id, community in prepared_animal_model_instance.communities.items():
+ expected_densities[community_id] = {}
+ for fg_name, cohorts in community.animal_cohorts.items():
+ total_individuals = sum(cohort.individuals for cohort in cohorts)
+ community_area = prepared_animal_model_instance.data.grid.cell_area
+ density = total_individuals / community_area
+ expected_densities[community_id][fg_name] = density
+
+ # Run the method under test
+ prepared_animal_model_instance.update_population_densities()
+
+ # Retrieve the updated population densities data variable
+ population_densities = prepared_animal_model_instance.data["population_densities"]
+
+ # Verify updated densities match expected values
+ for community_id in expected_densities:
+ for fg_name in expected_densities[community_id]:
+ calculated_density = population_densities.sel(
+ community_id=community_id, functional_group_id=fg_name
+ ).item()
+ expected_density = expected_densities[community_id][fg_name]
+ assert calculated_density == pytest.approx(expected_density), (
+ f"Mismatch in density for community {community_id} and FG{fg_name}. "
+ f"Expected: {expected_density}, Found: {calculated_density}"
+ )
+
+
+def test_calculate_density_for_cohort(prepared_animal_model_instance, mocker):
+ """Test the calculate_density_for_cohort method."""
+
+ mock_cohort = mocker.MagicMock()
+ mock_cohort.individuals = 100 # Example number of individuals
+
+ # Set a known community area in the model's data.grid.cell_area
+ prepared_animal_model_instance.data.grid.cell_area = 2000 # Example area in m2
+
+ # Expected density = individuals / area
+ expected_density = (
+ mock_cohort.individuals / prepared_animal_model_instance.data.grid.cell_area
+ )
+
+ # Calculate density using the method under test
+ calculated_density = prepared_animal_model_instance.calculate_density_for_cohort(
+ mock_cohort
+ )
+
+ # Assert the calculated density matches the expected density
+ assert calculated_density == pytest.approx(expected_density), (
+ f"Calculated density ({calculated_density}) "
+ f"did not match expected density ({expected_density})."
+ )
diff --git a/tests/models/animals/test_decay.py b/tests/models/animals/test_decay.py
index 2abab4233..c77bd6417 100644
--- a/tests/models/animals/test_decay.py
+++ b/tests/models/animals/test_decay.py
@@ -11,7 +11,7 @@ class TestCarcassPool:
def test_initialization(self):
"""Testing initialization of CarcassPool."""
- from virtual_ecosystem.models.animals.decay import CarcassPool
+ from virtual_ecosystem.models.animal.decay import CarcassPool
carcasses = CarcassPool(1000.7, 25.0)
assert pytest.approx(carcasses.scavengeable_energy) == 1000.7
@@ -27,7 +27,7 @@ class TestExcrementPool:
def test_initialization(self):
"""Testing initialization of CarcassPool."""
- from virtual_ecosystem.models.animals.decay import ExcrementPool
+ from virtual_ecosystem.models.animal.decay import ExcrementPool
poo = ExcrementPool(77.7, 25.0)
# Test that function to calculate stored carbon works as expected
diff --git a/tests/models/animals/test_functional_group.py b/tests/models/animals/test_functional_group.py
index 4d7b4398b..44109d64c 100644
--- a/tests/models/animals/test_functional_group.py
+++ b/tests/models/animals/test_functional_group.py
@@ -4,12 +4,14 @@
class TestFunctionalGroup:
- """Test Animal class."""
+ """Test FunctionalGroup class."""
@pytest.mark.parametrize(
(
- "name, taxa, diet, metabolic_type, "
- "birth_mass, adult_mass, dam_law_exp, dam_law_coef, conv_eff"
+ "name, taxa, diet, metabolic_type, reproductive_type, "
+ "development_type, development_status, offspring_functional_group,"
+ "excretion_type, birth_mass, adult_mass, dam_law_exp, dam_law_coef,"
+ "conv_eff"
),
[
(
@@ -17,6 +19,11 @@ class TestFunctionalGroup:
"mammal",
"herbivore",
"endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "herbivorous_mammal",
+ "ureotelic",
1.0,
10.0,
-0.75,
@@ -28,6 +35,11 @@ class TestFunctionalGroup:
"mammal",
"carnivore",
"endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "carnivorous_mammal",
+ "ureotelic",
4.0,
40.0,
-0.75,
@@ -39,6 +51,11 @@ class TestFunctionalGroup:
"bird",
"herbivore",
"endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "herbivorous_bird",
+ "uricotelic",
0.05,
0.5,
-0.75,
@@ -50,6 +67,11 @@ class TestFunctionalGroup:
"bird",
"carnivore",
"endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "carnivorous_bird",
+ "uricotelic",
0.1,
1.0,
-0.75,
@@ -57,10 +79,47 @@ class TestFunctionalGroup:
0.25,
),
(
- "herbivorous_insect",
+ "herbivorous_insect_iteroparous",
+ "insect",
+ "herbivore",
+ "ectothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "herbivorous_insect_iteroparous",
+ "uricotelic",
+ 0.0005,
+ 0.005,
+ -0.75,
+ 5.00,
+ 0.1,
+ ),
+ (
+ "carnivorous_insect_iteroparous",
+ "insect",
+ "carnivore",
+ "ectothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "carnivorous_insect_iteroparous",
+ "uricotelic",
+ 0.001,
+ 0.01,
+ -0.75,
+ 2.00,
+ 0.25,
+ ),
+ (
+ "herbivorous_insect_semelparous",
"insect",
"herbivore",
"ectothermic",
+ "semelparous",
+ "direct",
+ "adult",
+ "herbivorous_insect_semelparous",
+ "uricotelic",
0.0005,
0.005,
-0.75,
@@ -68,10 +127,15 @@ class TestFunctionalGroup:
0.1,
),
(
- "carnivorous_insect",
+ "carnivorous_insect_semelparous",
"insect",
"carnivore",
"ectothermic",
+ "semelparous",
+ "direct",
+ "adult",
+ "carnivorous_insect_semelparous",
+ "uricotelic",
0.001,
0.01,
-0.75,
@@ -86,6 +150,11 @@ def test_initialization(
taxa,
diet,
metabolic_type,
+ reproductive_type,
+ development_type,
+ development_status,
+ offspring_functional_group,
+ excretion_type,
birth_mass,
adult_mass,
dam_law_exp,
@@ -94,19 +163,26 @@ def test_initialization(
):
"""Testing initialization of derived parameters for animal cohorts."""
- from virtual_ecosystem.models.animals.animal_traits import (
+ from virtual_ecosystem.models.animal.animal_traits import (
DietType,
+ ExcretionType,
MetabolicType,
+ ReproductiveType,
TaxaType,
)
- from virtual_ecosystem.models.animals.constants import AnimalConsts
- from virtual_ecosystem.models.animals.functional_group import FunctionalGroup
+ from virtual_ecosystem.models.animal.constants import AnimalConsts
+ from virtual_ecosystem.models.animal.functional_group import FunctionalGroup
func_group = FunctionalGroup(
name,
taxa,
diet,
metabolic_type,
+ reproductive_type,
+ development_type,
+ development_status,
+ offspring_functional_group,
+ excretion_type,
birth_mass,
adult_mass,
constants=AnimalConsts(),
@@ -115,42 +191,208 @@ def test_initialization(
assert func_group.taxa == TaxaType(taxa)
assert func_group.diet == DietType(diet)
assert func_group.metabolic_type == MetabolicType(metabolic_type)
+ assert func_group.reproductive_type == ReproductiveType(reproductive_type)
+ assert func_group.offspring_functional_group == offspring_functional_group
+ assert func_group.excretion_type == ExcretionType(excretion_type)
assert func_group.damuths_law_terms[0] == dam_law_exp
assert func_group.damuths_law_terms[1] == dam_law_coef
assert func_group.conversion_efficiency == conv_eff
@pytest.mark.parametrize(
- "index, name, taxa, diet, metabolic_type",
+ "index, name, taxa, diet, metabolic_type, reproductive_type, "
+ "development_type, development_status, offspring_functional_group, excretion_type",
[
- (0, "carnivorous_bird", "bird", "carnivore", "endothermic"),
- (1, "herbivorous_bird", "bird", "herbivore", "endothermic"),
- (2, "carnivorous_mammal", "mammal", "carnivore", "endothermic"),
- (3, "herbivorous_mammal", "mammal", "herbivore", "endothermic"),
- (4, "carnivorous_insect", "insect", "carnivore", "ectothermic"),
- (5, "herbivorous_insect", "insect", "herbivore", "ectothermic"),
+ (
+ 0,
+ "carnivorous_bird",
+ "bird",
+ "carnivore",
+ "endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "carnivorous_bird",
+ "uricotelic",
+ ),
+ (
+ 1,
+ "herbivorous_bird",
+ "bird",
+ "herbivore",
+ "endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "herbivorous_bird",
+ "uricotelic",
+ ),
+ (
+ 2,
+ "carnivorous_mammal",
+ "mammal",
+ "carnivore",
+ "endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "carnivorous_mammal",
+ "ureotelic",
+ ),
+ (
+ 3,
+ "herbivorous_mammal",
+ "mammal",
+ "herbivore",
+ "endothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "herbivorous_mammal",
+ "ureotelic",
+ ),
+ (
+ 4,
+ "carnivorous_insect_iteroparous",
+ "insect",
+ "carnivore",
+ "ectothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "carnivorous_insect_iteroparous",
+ "uricotelic",
+ ),
+ (
+ 5,
+ "herbivorous_insect_iteroparous",
+ "insect",
+ "herbivore",
+ "ectothermic",
+ "iteroparous",
+ "direct",
+ "adult",
+ "herbivorous_insect_iteroparous",
+ "uricotelic",
+ ),
+ (
+ 6,
+ "carnivorous_insect_semelparous",
+ "insect",
+ "carnivore",
+ "ectothermic",
+ "semelparous",
+ "direct",
+ "adult",
+ "carnivorous_insect_semelparous",
+ "uricotelic",
+ ),
+ (
+ 7,
+ "herbivorous_insect_semelparous",
+ "insect",
+ "herbivore",
+ "ectothermic",
+ "semelparous",
+ "direct",
+ "adult",
+ "herbivorous_insect_semelparous",
+ "uricotelic",
+ ),
+ (
+ 8,
+ "butterfly",
+ "insect",
+ "herbivore",
+ "ectothermic",
+ "semelparous",
+ "indirect",
+ "adult",
+ "caterpillar",
+ "uricotelic",
+ ),
+ (
+ 9,
+ "caterpillar",
+ "insect",
+ "herbivore",
+ "ectothermic",
+ "nonreproductive",
+ "indirect",
+ "larval",
+ "butterfly",
+ "uricotelic",
+ ),
],
)
def test_import_functional_groups(
- shared_datadir, index, name, taxa, diet, metabolic_type
+ shared_datadir,
+ index,
+ name,
+ taxa,
+ diet,
+ metabolic_type,
+ reproductive_type,
+ development_type,
+ development_status,
+ offspring_functional_group,
+ excretion_type,
):
"""Testing import functional groups."""
- from virtual_ecosystem.models.animals.animal_traits import (
+ from virtual_ecosystem.models.animal.animal_traits import (
+ DevelopmentStatus,
+ DevelopmentType,
DietType,
+ ExcretionType,
MetabolicType,
+ ReproductiveType,
TaxaType,
)
- from virtual_ecosystem.models.animals.constants import AnimalConsts
- from virtual_ecosystem.models.animals.functional_group import (
+ from virtual_ecosystem.models.animal.constants import AnimalConsts
+ from virtual_ecosystem.models.animal.functional_group import (
FunctionalGroup,
import_functional_groups,
)
file = shared_datadir / "example_functional_group_import.csv"
fg_list = import_functional_groups(file, constants=AnimalConsts())
- assert len(fg_list) == 6
+ assert len(fg_list) == 10
assert isinstance(fg_list[index], FunctionalGroup)
assert fg_list[index].name == name
assert fg_list[index].taxa == TaxaType(taxa)
assert fg_list[index].diet == DietType(diet)
assert fg_list[index].metabolic_type == MetabolicType(metabolic_type)
+ assert fg_list[index].reproductive_type == ReproductiveType(reproductive_type)
+ assert fg_list[index].development_type == DevelopmentType(development_type)
+ assert fg_list[index].development_status == DevelopmentStatus(development_status)
+ assert fg_list[index].offspring_functional_group == offspring_functional_group
+ assert fg_list[index].excretion_type == ExcretionType(excretion_type)
+
+
+@pytest.mark.parametrize(
+ "name, raises_exception",
+ [
+ pytest.param("herbivorous_mammal", False, id="Valid functional group name"),
+ pytest.param("non_existent_group", True, id="Invalid functional group name"),
+ ],
+)
+def test_get_functional_group_by_name(
+ functional_group_list_instance, name, raises_exception
+):
+ """Test get_functional_group_by_name for both valid and invalid names."""
+ from virtual_ecosystem.models.animal.functional_group import (
+ FunctionalGroup,
+ get_functional_group_by_name,
+ )
+
+ functional_groups = tuple(functional_group_list_instance)
+
+ if raises_exception:
+ with pytest.raises(
+ ValueError, match=f"No FunctionalGroup with name '{name}' found."
+ ):
+ get_functional_group_by_name(functional_groups, name)
+ else:
+ result = get_functional_group_by_name(functional_groups, name)
+ assert isinstance(result, FunctionalGroup)
+ assert result.name == name
diff --git a/tests/models/animals/test_plant_resources.py b/tests/models/animals/test_plant_resources.py
index ae0d92cbd..3cdbeec02 100644
--- a/tests/models/animals/test_plant_resources.py
+++ b/tests/models/animals/test_plant_resources.py
@@ -5,20 +5,42 @@ class TestPlantResources:
"""Test Plant class."""
def test_get_eaten(
- self, plant_instance, herbivore_cohort_instance, excrement_instance
+ self, plant_instance, herbivore_cohort_instance, excrement_pool_instance
):
- """Testing get_eaten.
+ """Test the get_eaten method for PlantResources."""
+ import pytest
- Currently, this just tests rough execution. As the model gets paramterized,
- these tests will be expanded to specific values.
- """
+ consumed_mass = 50.0 # Define a mass to be consumed for the test
+ initial_mass_current = plant_instance.mass_current
+ initial_excrement_energy = excrement_pool_instance.decomposed_energy
- initial_plant_mass = plant_instance.mass_current
- initial_decay_pool_energy = excrement_instance.decomposed_energy
+ actual_mass_gain = plant_instance.get_eaten(
+ consumed_mass, herbivore_cohort_instance, excrement_pool_instance
+ )
- # Execution
- plant_instance.get_eaten(herbivore_cohort_instance, excrement_instance)
+ # Check if the plant mass has been correctly reduced
+ assert plant_instance.mass_current == pytest.approx(
+ initial_mass_current - consumed_mass
+ ), "Plant mass should be reduced by the consumed amount."
- # Assertions
- assert plant_instance.mass_current < initial_plant_mass
- assert excrement_instance.decomposed_energy > initial_decay_pool_energy
+ # Check if the actual mass gain matches the expected value after
+ # efficiency adjustments
+ expected_mass_gain = (
+ consumed_mass
+ * herbivore_cohort_instance.functional_group.mechanical_efficiency
+ * herbivore_cohort_instance.functional_group.conversion_efficiency
+ )
+ assert actual_mass_gain == pytest.approx(
+ expected_mass_gain
+ ), "Actual mass gain should match expected value after efficiency adjustments."
+
+ # Check if the excess mass has been correctly added to the excrement pool
+ excess_mass = consumed_mass * (
+ 1 - herbivore_cohort_instance.functional_group.mechanical_efficiency
+ )
+ expected_excrement_energy_increase = (
+ excess_mass * plant_instance.constants.energy_density["plant"]
+ )
+ assert excrement_pool_instance.decomposed_energy == pytest.approx(
+ initial_excrement_energy + expected_excrement_energy_increase
+ ), "Excrement pool energy should increase by energy value of the excess mass."
diff --git a/tests/models/animals/test_scaling_functions.py b/tests/models/animals/test_scaling_functions.py
index 3dc5808ee..4118c7a17 100644
--- a/tests/models/animals/test_scaling_functions.py
+++ b/tests/models/animals/test_scaling_functions.py
@@ -4,64 +4,84 @@
@pytest.mark.parametrize(
- "mass, population_density, terms",
+ "mass, population_density, terms, scenario_id",
[
- (100000.0, 1.0, (-0.75, 4.23)),
- (0.07, 32.0, (-0.75, 4.23)),
- (1.0, 5.0, (-0.75, 4.23)),
+ pytest.param(100000.0, 1.0, (-0.75, 4.23), "large_mass_low_density"),
+ pytest.param(0.07, 32.0, (-0.75, 4.23), "small_mass_high_density"),
+ pytest.param(1.0, 5.0, (-0.75, 4.23), "medium_mass_medium_density"),
],
)
-def test_damuths_law(mass, population_density, terms):
+def test_damuths_law(mass, population_density, terms, scenario_id):
"""Testing damuth's law for various body-masses."""
- from virtual_ecosystem.models.animals.scaling_functions import damuths_law
+ from virtual_ecosystem.models.animal.scaling_functions import damuths_law
testing_pop = damuths_law(mass, terms)
- assert testing_pop == population_density
+ assert testing_pop == pytest.approx(
+ population_density
+ ), f"Scenario {scenario_id} failed: Expect {population_density}, got {testing_pop}"
@pytest.mark.parametrize(
"mass, temperature, terms, metabolic_type, met_rate",
[
# Test cases for an endothermic animal
- (0.0, 25, {"basal": (0.75, 0.047), "field": (0.75, 0.047)}, "endothermic", 0.0),
- (
+ pytest.param(
+ 0.0,
+ 25,
+ {"basal": (0.75, 0.047), "field": (0.75, 0.047)},
+ "endothermic",
+ 0.0,
+ id="endothermic_zero_mass",
+ ),
+ pytest.param(
1.0,
25,
{"basal": (0.75, 0.047), "field": (0.75, 0.047)},
"endothermic",
2.3264417757316824e-16,
+ id="endothermic_small_mass",
),
- (
+ pytest.param(
1000.0,
25,
{"basal": (0.75, 0.047), "field": (0.75, 0.047)},
"endothermic",
3.218786623537764e-16,
+ id="endothermic_large_mass",
),
# Test cases for an ectothermic animal
- (0.0, 25, {"basal": (0.75, 0.047), "field": (0.75, 0.047)}, "ectothermic", 0.0),
- (
+ pytest.param(
+ 0.0,
+ 25,
+ {"basal": (0.75, 0.047), "field": (0.75, 0.047)},
+ "ectothermic",
+ 0.0,
+ id="ectothermic_zero_mass",
+ ),
+ pytest.param(
1.0,
25,
{"basal": (0.75, 0.047), "field": (0.75, 0.047)},
"ectothermic",
9.116692117764761e-17,
+ id="ectothermic_small_mass",
),
- (
+ pytest.param(
1000.0,
25,
{"basal": (0.75, 0.047), "field": (0.75, 0.047)},
"ectothermic",
1.261354870157637e-16,
+ id="ectothermic_large_mass",
),
],
)
def test_metabolic_rate(mass, temperature, terms, metabolic_type, met_rate):
"""Testing metabolic rate for various body-masses."""
- from virtual_ecosystem.models.animals.animal_traits import MetabolicType
- from virtual_ecosystem.models.animals.scaling_functions import metabolic_rate
+ from virtual_ecosystem.models.animal.animal_traits import MetabolicType
+ from virtual_ecosystem.models.animal.scaling_functions import metabolic_rate
testing_rate = metabolic_rate(
mass, temperature, terms, MetabolicType(metabolic_type)
@@ -69,79 +89,9 @@ def test_metabolic_rate(mass, temperature, terms, metabolic_type, met_rate):
assert testing_rate == pytest.approx(met_rate, rel=1e-6)
-@pytest.mark.parametrize(
- "mass, muscle, terms",
- [
- (0.0, 0.0, (1.0, 0.38)),
- (1.0, 380.0, (1.0, 0.38)),
- (1000.0, 380000.0, (1.0, 0.38)),
- ],
-)
-def test_muscle_mass_scaling(mass, muscle, terms):
- """Testing muscle mass scaling for various body-masses."""
-
- from virtual_ecosystem.models.animals.scaling_functions import muscle_mass_scaling
-
- gains = muscle_mass_scaling(mass, terms)
- assert gains == pytest.approx(muscle, rel=1e-6)
-
-
-@pytest.mark.parametrize(
- "mass, fat, terms",
- [
- (0.0, 0.0, (1.19, 0.02)),
- (1.0, 74.307045, (1.19, 0.02)),
- (1000.0, 276076.852920, (1.19, 0.02)),
- ],
-)
-def test_fat_mass_scaling(mass, fat, terms):
- """Testing fat mass scaling for various body-masses."""
-
- from virtual_ecosystem.models.animals.scaling_functions import fat_mass_scaling
-
- gains = fat_mass_scaling(mass, terms)
- assert gains == pytest.approx(fat, rel=1e-6)
-
-
-@pytest.mark.parametrize(
- "mass, energy, muscle_terms, fat_terms",
- [
- (0.0, 0.0, (1.0, 0.38), (1.19, 0.02)),
- (1.0, 3180149.320736, (1.0, 0.38), (1.19, 0.02)),
- (1000.0, 4592537970.444037, (1.0, 0.38), (1.19, 0.02)),
- ],
-)
-def test_energetic_reserve_scaling(mass, energy, muscle_terms, fat_terms):
- """Testing energetic reserve scaling for various body-masses."""
-
- from virtual_ecosystem.models.animals.scaling_functions import (
- energetic_reserve_scaling,
- )
-
- gains = energetic_reserve_scaling(mass, muscle_terms, fat_terms)
- assert gains == pytest.approx(energy, rel=1e-6)
-
-
-@pytest.mark.parametrize(
- "mass, intake_rate, terms",
- [
- (0.0, 0.0, (0.71, 0.63)),
- (1.0, 0.3024, (0.71, 0.63)),
- (1000.0, 40.792637, (0.71, 0.63)),
- ],
-)
-def test_intake_rate_scaling(mass, intake_rate, terms):
- """Testing intake rate scaling for various body-masses."""
-
- from virtual_ecosystem.models.animals.scaling_functions import intake_rate_scaling
-
- test_rate = intake_rate_scaling(mass, terms)
- assert test_rate == pytest.approx(intake_rate, rel=1e-6)
-
-
def test_herbivore_prey_group_selection():
"""Test for herbivore diet type selection."""
- from virtual_ecosystem.models.animals.scaling_functions import (
+ from virtual_ecosystem.models.animal.scaling_functions import (
DietType,
prey_group_selection,
)
@@ -152,7 +102,7 @@ def test_herbivore_prey_group_selection():
def test_carnivore_prey_group_selection():
"""Test for carnivore diet type selection."""
- from virtual_ecosystem.models.animals.scaling_functions import (
+ from virtual_ecosystem.models.animal.scaling_functions import (
DietType,
prey_group_selection,
)
@@ -171,9 +121,8 @@ def test_carnivore_prey_group_selection():
def test_prey_group_selection_invalid_diet_type():
"""Test for an invalid diet type."""
- import pytest
- from virtual_ecosystem.models.animals.scaling_functions import prey_group_selection
+ from virtual_ecosystem.models.animal.scaling_functions import prey_group_selection
with pytest.raises(ValueError, match="Invalid diet type:"):
prey_group_selection("omnivore", 10.0, (0.1, 1000.0))
@@ -181,7 +130,7 @@ def test_prey_group_selection_invalid_diet_type():
def test_prey_group_selection_mass_and_terms_impact():
"""Test to ensure `mass` and `terms` don't affect output."""
- from virtual_ecosystem.models.animals.scaling_functions import (
+ from virtual_ecosystem.models.animal.scaling_functions import (
DietType,
prey_group_selection,
)
@@ -194,47 +143,362 @@ def test_prey_group_selection_mass_and_terms_impact():
@pytest.mark.parametrize(
- "mass, terms, expected",
+ "input_value, expected_output",
[
- (1.0, (0.25, 0.05), 0.2055623),
- (1000.0, (0.01, 0.1), 0.1018162),
+ pytest.param(1.0, 1.0, id="unit_value"),
+ pytest.param(0.0, 0.0, id="zero_value"),
+ pytest.param(-0.01, -0.01, id="negative_value"),
],
)
-def test_natural_mortality_scaling(mass, terms, expected):
- """Testing natural mortality scaling for various body-masses."""
- from virtual_ecosystem.models.animals.scaling_functions import (
- natural_mortality_scaling,
- )
+def test_background_mortality(input_value, expected_output):
+ """Test the background_mortality function returns the correct mortality rate."""
+ from virtual_ecosystem.models.animal.scaling_functions import background_mortality
+
+ assert (
+ background_mortality(input_value) == expected_output
+ ), "The mortality rate returned did not match the expected value."
+
+
+@pytest.mark.parametrize(
+ "lambda_se, t_to_maturity, t_since_maturity, expected_mortality",
+ [
+ pytest.param(0.01, 100, 50, 0.01648721, id="typical_case"),
+ pytest.param(0.01, 50, 100, 0.07389056, id="more_since_than_to"),
+ pytest.param(0.0, 100, 50, 0.0, id="zero_senescence_rate"),
+ pytest.param(
+ 0.01,
+ 0,
+ 100,
+ None,
+ id="zero_time_to_maturity",
+ marks=pytest.mark.xfail(reason="Division by zero"),
+ ),
+ pytest.param(0.01, 100, 0, 0.01, id="zero_time_since_maturity"),
+ ],
+)
+def test_senescence_mortality(
+ lambda_se, t_to_maturity, t_since_maturity, expected_mortality
+):
+ """Test the calculation of senescence mortality rate."""
+
+ from virtual_ecosystem.models.animal.scaling_functions import senescence_mortality
- result = natural_mortality_scaling(mass, terms)
- assert result == pytest.approx(expected, rel=1e-6)
+ if t_to_maturity == 0:
+ with pytest.raises(ZeroDivisionError):
+ senescence_mortality(lambda_se, t_to_maturity, t_since_maturity)
+ else:
+ result = senescence_mortality(lambda_se, t_to_maturity, t_since_maturity)
+ assert result == pytest.approx(
+ expected_mortality
+ ), "The calculated mortality did not match the expected value."
-def test_natural_mortality_scaling_zero_mass():
- """Testing natural mortality scaling with a zero mass."""
- from virtual_ecosystem.models.animals.scaling_functions import (
- natural_mortality_scaling,
+@pytest.mark.parametrize(
+ "lambda_max, J_st, zeta_st, mass_current, mass_max, expected_mortality, param_id",
+ [
+ pytest.param(
+ 1.0,
+ 0.6,
+ 0.05,
+ 50,
+ 100,
+ 0.880797077,
+ "half_mass_case",
+ id="half_mass_case",
+ ),
+ pytest.param(
+ 1.0,
+ 0.6,
+ 0.05,
+ 0,
+ 100,
+ 0.999993855,
+ "zero_mass",
+ id="zero_mass",
+ ),
+ pytest.param(
+ 1.0,
+ 0.6,
+ 0.05,
+ 100,
+ 100,
+ 0.00033535,
+ "mass_equals_max",
+ id="mass_equals_max",
+ ),
+ pytest.param(
+ 1.0,
+ 0.6,
+ 0.05,
+ 200,
+ 100,
+ 0.0,
+ "mass_exceeds_max",
+ id="mass_exceeds_max",
+ ),
+ ],
+)
+def test_starvation_mortality(
+ lambda_max, J_st, zeta_st, mass_current, mass_max, expected_mortality, param_id
+):
+ """Test the calculation of starvation mortality based on body mass."""
+ from virtual_ecosystem.models.animal.scaling_functions import starvation_mortality
+
+ # Diagnostics
+ print(
+ f"Testing with: lambda_max={lambda_max}, J_st={J_st}, zeta_st={zeta_st}, "
+ f"mass_current={mass_current}, mass_max={mass_max}, param_id={param_id}"
)
- with pytest.raises(ZeroDivisionError):
- natural_mortality_scaling(0.0, (0.71, 0.63))
+ # Call the function with provided parameters
+ mortality_rate = starvation_mortality(
+ lambda_max, J_st, zeta_st, mass_current, mass_max
+ )
+ # Assert that the returned mortality rate matches the expected mortality rate
+ assert mortality_rate == pytest.approx(expected_mortality), (
+ f"Test {param_id}: The calculated starvation mortality {mortality_rate} does"
+ f" not match the expected value {expected_mortality}."
+ )
-def test_natural_mortality_scaling_negative_mass():
- """Testing natural mortality scaling with a negative mass."""
- from virtual_ecosystem.models.animals.scaling_functions import (
- natural_mortality_scaling,
+ # Diagnostics
+ print(
+ f"Test {param_id} passed: Calculated mortality rate: {mortality_rate}, "
+ f"Expected mortality rate: {expected_mortality}"
)
- with pytest.raises(TypeError):
- natural_mortality_scaling(-1.0, (0.71, 0.63))
+@pytest.mark.parametrize(
+ "alpha_0_herb, mass, expected_search_rate",
+ [
+ pytest.param(0.1, 1.0, 0.1, id="base_rate"),
+ pytest.param(0.2, 5.0, 1.0, id="increased_rate"),
+ pytest.param(0.05, 10.0, 0.5, id="decreased_rate"),
+ pytest.param(0.0, 10.0, 0.0, id="zero_rate"),
+ pytest.param(0.1, 0.0, 0.0, id="zero_mass"),
+ ],
+)
+def test_alpha_i_k(alpha_0_herb, mass, expected_search_rate):
+ """Testing effective search rate calculation for various herbivore body masses."""
+
+ from virtual_ecosystem.models.animal.scaling_functions import alpha_i_k
+
+ calculated_search_rate = alpha_i_k(alpha_0_herb, mass)
+ assert calculated_search_rate == pytest.approx(expected_search_rate, rel=1e-6)
+
+
+@pytest.mark.parametrize(
+ "alpha_i_k, phi_herb_t, B_k_t, A_cell, expected_biomass",
+ [
+ pytest.param(0.1, 0.5, 1000, 1, 25000.0, id="standard_scenario"),
+ pytest.param(0.2, 0.5, 1000, 1, 50000.0, id="increased_search_rate"),
+ pytest.param(0.1, 1, 1000, 1, 100000.0, id="all_plant_stock_available"),
+ pytest.param(0.1, 0.5, 2000, 1, 100000.0, id="increased_plant_biomass"),
+ pytest.param(0.1, 0.5, 1000, 2, 6250.0, id="increased_cell_area"),
+ pytest.param(0, 0.5, 1000, 1, 0.0, id="zero_search_rate"),
+ pytest.param(0.1, 0, 1000, 1, 0.0, id="no_plant_stock_available"),
+ pytest.param(0.1, 0.5, 0, 1, 0.0, id="zero_plant_biomass"),
+ ],
+)
+def test_k_i_k(alpha_i_k, phi_herb_t, B_k_t, A_cell, expected_biomass):
+ """Testing the potential biomass eaten calculation for various scenarios."""
+
+ from virtual_ecosystem.models.animal.scaling_functions import k_i_k
+
+ calculated_biomass = k_i_k(alpha_i_k, phi_herb_t, B_k_t, A_cell)
+ assert calculated_biomass == pytest.approx(expected_biomass, rel=1e-6)
+
+
+@pytest.mark.parametrize(
+ "h_herb_0, M_ref, M_i_t, b_herb, expected_handling_time, expect_exception",
+ [
+ pytest.param(1.0, 10.0, 10.0, 0.75, 1.0, False, id="M_ref_equals_M_i_t"),
+ pytest.param(1.0, 10.0, 5.0, 0.75, 1.6817928, False, id="M_i_t_half_of_M_ref"),
+ pytest.param(
+ 1.0, 10.0, 20.0, 0.75, 0.5946035, False, id="M_i_t_double_of_M_ref"
+ ),
+ pytest.param(2.0, 10.0, 10.0, 0.75, 2.0, False, id="increased_h_herb_0"),
+ pytest.param(1.0, 10.0, 10.0, 1.0, 1.0, False, id="increased_b_herb"),
+ pytest.param(1.0, 10.0, 10.0, 0.0, 1.0, False, id="b_herb_zero"),
+ pytest.param(
+ 1.0, 10.0, 0.0, 0.75, None, True, id="M_i_t_zero_expect_exception"
+ ),
+ ],
+)
+def test_H_i_k(
+ h_herb_0, M_ref, M_i_t, b_herb, expected_handling_time, expect_exception
+):
+ """Testing the handling time calculation for various herbivore masses."""
+ from virtual_ecosystem.models.animal.scaling_functions import H_i_k
+
+ if expect_exception:
+ with pytest.raises(ZeroDivisionError):
+ H_i_k(h_herb_0, M_ref, M_i_t, b_herb)
+ else:
+ calculated_handling_time = H_i_k(h_herb_0, M_ref, M_i_t, b_herb)
+ assert calculated_handling_time == pytest.approx(
+ expected_handling_time, rel=1e-6
+ )
+
+
+@pytest.mark.parametrize(
+ "theta_opt_min_f, theta_opt_f, sigma_opt_f, random_value, expected",
+ [
+ pytest.param(
+ 0.1, 0.2, 0.05, 0.15, 0.15, id="random_value_between_min_f_and_opt_f"
+ ),
+ pytest.param(0.1, 0.2, 0.05, 0.05, 0.1, id="random_value_less_than_min_f"),
+ pytest.param(0.1, 0.2, 0.05, 0.25, 0.25, id="random_value_greater_than_opt_f"),
+ ],
+)
+def test_theta_opt_i(
+ mocker, theta_opt_min_f, theta_opt_f, sigma_opt_f, random_value, expected
+):
+ """Testing the optimum predator-prey mass ratio calculation with randomness."""
+
+ import numpy as np
+
+ # Mock np.random.normal to return a controlled random value
+ mocker.patch.object(np.random, "normal", return_value=random_value)
+
+ from virtual_ecosystem.models.animal.scaling_functions import theta_opt_i
-def test_natural_mortality_scaling_invalid_terms():
- """Testing natural mortality scaling with invalid terms."""
- from virtual_ecosystem.models.animals.scaling_functions import (
- natural_mortality_scaling,
+ result = theta_opt_i(theta_opt_min_f, theta_opt_f, sigma_opt_f)
+ assert result == expected
+
+
+@pytest.mark.parametrize(
+ (
+ "mass_predator, mass_prey, theta_opt_i, "
+ "sigma_opt_pred_prey, expected_output, expect_exception"
+ ),
+ [
+ pytest.param(10.0, 5.0, 2.0, 0.1, None, False, id="predator_twice_prey"),
+ pytest.param(5.0, 10.0, 0.5, 0.1, None, False, id="prey_twice_predator"),
+ pytest.param(10.0, 10.0, 1.0, 0.1, None, False, id="equal_mass_optimal_ratio"),
+ pytest.param(
+ 10.0, 10.0, 1.0, 0.5, None, False, id="increased_standard_deviation"
+ ),
+ pytest.param(0.0, 10.0, 1.0, 0.1, None, True, id="zero_mass_predator"),
+ pytest.param(10.0, 0.0, 1.0, 0.1, None, True, id="zero_mass_prey"),
+ ],
+)
+def test_w_bar_i_j(
+ mass_predator,
+ mass_prey,
+ theta_opt_i,
+ sigma_opt_pred_prey,
+ expected_output,
+ expect_exception,
+):
+ """Testing the success probability for various predator-prey mass ratios."""
+ from virtual_ecosystem.models.animal.scaling_functions import w_bar_i_j
+
+ if expect_exception:
+ with pytest.raises((ZeroDivisionError, ValueError)):
+ w_bar_i_j(mass_predator, mass_prey, theta_opt_i, sigma_opt_pred_prey)
+ else:
+ result = w_bar_i_j(mass_predator, mass_prey, theta_opt_i, sigma_opt_pred_prey)
+ assert (
+ 0.0 <= result <= 1.0
+ ), "Result is outside the expected probability range [0.0, 1.0]"
+
+
+@pytest.mark.parametrize(
+ "alpha_0_pred, mass, w_bar_i_j, expected_search_rate",
+ [
+ pytest.param(0.1, 10.0, 0.5, 0.5, id="basic_scenario"),
+ pytest.param(0.2, 5.0, 0.75, 0.75, id="different_values"),
+ pytest.param(0.0, 10.0, 0.5, 0.0, id="zero_alpha_0_pred"),
+ pytest.param(0.1, 0.0, 0.5, 0.0, id="zero_mass"),
+ pytest.param(0.1, 10.0, 0.0, 0.0, id="zero_w_bar_i_j"),
+ pytest.param(0.1, 10.0, 1.0, 1.0, id="w_bar_i_j_is_1"),
+ ],
+)
+def test_alpha_i_j(alpha_0_pred, mass, w_bar_i_j, expected_search_rate):
+ """Testing the effective search rate calculation for various inputs."""
+ from virtual_ecosystem.models.animal.scaling_functions import alpha_i_j
+
+ calculated_search_rate = alpha_i_j(alpha_0_pred, mass, w_bar_i_j)
+ assert calculated_search_rate == pytest.approx(expected_search_rate, rel=1e-6)
+
+
+@pytest.mark.parametrize(
+ "alpha_i_j, N_i_t, A_cell, theta_i_j, expected_output",
+ [
+ pytest.param(0.1, 100, 1.0, 0.5, 5.0, id="basic_scenario"),
+ pytest.param(0.2, 50, 2.0, 0.75, 3.75, id="varied_parameters"),
+ pytest.param(0.0, 100, 1.0, 0.5, 0.0, id="zero_search_rate"),
+ pytest.param(0.1, 0, 1.0, 0.5, 0.0, id="zero_predator_population"),
+ pytest.param(
+ 0.1, 100, 0.0, 0.5, float("inf"), id="zero_cell_area_expect_inf_or_error"
+ ),
+ pytest.param(0.1, 100, 1.0, 0.0, 0.0, id="zero_theta_i_j"),
+ ],
+)
+def test_k_i_j(alpha_i_j, N_i_t, A_cell, theta_i_j, expected_output):
+ """Testing the calculation of potential prey items eaten."""
+ from virtual_ecosystem.models.animal.scaling_functions import k_i_j
+
+ # Handle special case where division by zero might occur
+ if A_cell == 0:
+ with pytest.raises(ZeroDivisionError):
+ k_i_j(alpha_i_j, N_i_t, A_cell, theta_i_j)
+ else:
+ calculated_output = k_i_j(alpha_i_j, N_i_t, A_cell, theta_i_j)
+ assert calculated_output == pytest.approx(expected_output, rel=1e-6)
+
+
+@pytest.mark.parametrize(
+ "h_pred_0, M_ref, M_i_t, b_pred, expected_handling_time",
+ [
+ pytest.param(1.0, 10.0, 10.0, 0.75, 10.0, id="basic_scenario"),
+ pytest.param(1.0, 10.0, 5.0, 0.75, 8.4089641, id="M_i_t_half_of_M_ref"),
+ pytest.param(1.0, 10.0, 20.0, 0.75, 11.892071, id="M_i_t_double_of_M_ref"),
+ pytest.param(2.0, 10.0, 10.0, 0.75, 20.0, id="increased_h_pred_0"),
+ pytest.param(1.0, 10.0, 10.0, 1.0, 10.0, id="increased_b_pred"),
+ pytest.param(1.0, 10.0, 0.0, 0.75, float("inf"), id="zero_M_i_t_expect_inf"),
+ pytest.param(1.0, 0.0, 10.0, 0.75, 0.0, id="zero_M_ref_leads_to_zero"),
+ ],
+)
+def test_H_i_j(h_pred_0, M_ref, M_i_t, b_pred, expected_handling_time):
+ """Testing the handling time calculation for various predator-prey interactions."""
+ from virtual_ecosystem.models.animal.scaling_functions import H_i_j
+
+ # Handle special case where division by zero might occur
+ if M_i_t == 0:
+ with pytest.raises(ZeroDivisionError):
+ H_i_j(h_pred_0, M_ref, M_i_t, b_pred)
+ else:
+ calculated_handling_time = H_i_j(h_pred_0, M_ref, M_i_t, b_pred)
+ assert calculated_handling_time == pytest.approx(
+ expected_handling_time, rel=1e-6
+ )
+
+
+@pytest.mark.parametrize(
+ "current_mass, V_disp, M_disp_ref, o_disp, expected_speed",
+ [
+ pytest.param(1.0, 10.0, 1.0, 1.0, 10.0, id="reference_mass"),
+ pytest.param(0.5, 10.0, 1.0, 1.0, 5.0, id="half_reference_mass"),
+ pytest.param(2.0, 10.0, 1.0, 1.0, 20.0, id="double_reference_mass"),
+ pytest.param(1.0, 20.0, 1.0, 1.0, 20.0, id="double_speed"),
+ pytest.param(1.0, 10.0, 1.0, 0.5, 10.0, id="sqrt_scaling"),
+ pytest.param(
+ 4.0, 10.0, 2.0, 0.5, 14.142135, id="sqrt_scaling_with_different_ref"
+ ),
+ pytest.param(0.0, 10.0, 1.0, 1.0, 0.0, id="zero_mass"),
+ ],
+)
+def test_juvenile_dispersal_speed(
+ current_mass, V_disp, M_disp_ref, o_disp, expected_speed
+):
+ """Testing the juvenile dispersal speed calculation for various scenarios."""
+ from virtual_ecosystem.models.animal.scaling_functions import (
+ juvenile_dispersal_speed,
)
- with pytest.raises(IndexError):
- natural_mortality_scaling(1.0, (0.71,))
+ calculated_speed = juvenile_dispersal_speed(
+ current_mass, V_disp, M_disp_ref, o_disp
+ )
+ assert calculated_speed == pytest.approx(expected_speed, rel=1e-6)
diff --git a/tests/models/hydrology/test_above_ground.py b/tests/models/hydrology/test_above_ground.py
index d0dc0dfe3..79392f5b4 100644
--- a/tests/models/hydrology/test_above_ground.py
+++ b/tests/models/hydrology/test_above_ground.py
@@ -7,25 +7,24 @@
import pytest
from tests.conftest import log_check
+from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.models.hydrology.constants import HydroConsts
@pytest.mark.parametrize(
- "wind, dens_air, latvap",
+ "dens_air, latvap",
[
(
- 0.1,
- HydroConsts.density_air,
- HydroConsts.latent_heat_vapourisation,
+ 1.225,
+ 2.45,
),
(
- np.array([0.1, 0.1, 0.1]),
np.array([1.225, 1.225, 1.225]),
np.array([2.45, 2.45, 2.45]),
),
],
)
-def test_calculate_soil_evaporation(wind, dens_air, latvap):
+def test_calculate_soil_evaporation(dens_air, latvap):
"""Test soil evaporation with float and DataArray."""
from virtual_ecosystem.models.hydrology.above_ground import (
@@ -34,42 +33,48 @@ def test_calculate_soil_evaporation(wind, dens_air, latvap):
result = calculate_soil_evaporation(
temperature=np.array([20.0, 20.0, 30.0]),
- wind_speed=wind,
+ wind_speed_surface=np.array([1.0, 0.5, 0.1]),
relative_humidity=np.array([80, 80, 90]),
atmospheric_pressure=np.array([90, 90, 90]),
soil_moisture=np.array([0.01, 0.1, 0.5]),
soil_moisture_residual=0.1,
soil_moisture_capacity=0.9,
leaf_area_index=np.array([3, 4, 5]),
- celsius_to_kelvin=HydroConsts.celsius_to_kelvin,
+ celsius_to_kelvin=273.15,
density_air=dens_air,
latent_heat_vapourisation=latvap,
- gas_constant_water_vapour=HydroConsts.gas_constant_water_vapour,
- heat_transfer_coefficient=HydroConsts.heat_transfer_coefficient,
+ gas_constant_water_vapour=CoreConsts.gas_constant_water_vapour,
+ soil_surface_heat_transfer_coefficient=(
+ HydroConsts.soil_surface_heat_transfer_coefficient
+ ),
extinction_coefficient_global_radiation=(
HydroConsts.extinction_coefficient_global_radiation
),
)
- exp_result = np.array([0.007452, 0.003701, 0.135078])
- np.testing.assert_allclose(result, exp_result, rtol=0.01)
+ exp_evap = np.array([0.745206, 0.092515, 0.135078])
+ np.testing.assert_allclose(result["soil_evaporation"], exp_evap, rtol=0.01)
-def test_find_lowest_neighbour(dummy_climate_data):
+def test_find_lowest_neighbour(fixture_core_components, dummy_climate_data):
"""Test finding lowest neighbours."""
- from math import sqrt
+ # FIXME: At the moment this is being tested on a 2x2 grid with these elevations and
+ # the implementation uses rook case neighbours. There is some odd behaviour
+ # with the ties.
+ #
+ # 200, 100
+ # 10, 10
from virtual_ecosystem.models.hydrology.above_ground import find_lowest_neighbour
data = dummy_climate_data
- data.grid.set_neighbours(distance=sqrt(data.grid.cell_area))
- neighbours = data.grid.neighbours
- elevation = np.array(data["elevation"])
- result = find_lowest_neighbour(neighbours, elevation)
+ grid = fixture_core_components.grid
+ grid.set_neighbours(distance=np.sqrt(grid.cell_area))
+ result = find_lowest_neighbour(grid.neighbours, data["elevation"].to_numpy())
- exp_result = [1, 2, 2]
+ exp_result = [2, 3, 2, 2]
assert result == exp_result
@@ -199,7 +204,7 @@ def test_calculate_drainage_map(caplog, grid_type, raises, expected_log_entries)
log_check(caplog, expected_log_entries)
-def test_estimate_interception():
+def test_calculate_interception():
"""Test."""
from virtual_ecosystem.models.hydrology.above_ground import calculate_interception
from virtual_ecosystem.models.hydrology.constants import HydroConsts
@@ -210,9 +215,7 @@ def test_estimate_interception():
result = calculate_interception(
leaf_area_index=lai,
precipitation=precip,
- intercept_param_1=HydroConsts.intercept_param_1,
- intercept_param_2=HydroConsts.intercept_param_2,
- intercept_param_3=HydroConsts.intercept_param_3,
+ intercept_parameters=HydroConsts.intercept_parameters,
veg_density_param=HydroConsts.veg_density_param,
)
@@ -264,7 +267,7 @@ def test_convert_mm_flow_to_m3_per_second():
river_discharge_mm=channel_flow,
area=np.array([10000, 10000, 10000]),
days=30,
- seconds_to_day=HydroConsts.seconds_to_day,
+ seconds_to_day=CoreConsts.seconds_to_day,
meters_to_millimeters=1000,
)
diff --git a/tests/models/hydrology/test_below_ground.py b/tests/models/hydrology/test_below_ground.py
index 90f59f87a..d4c32e846 100644
--- a/tests/models/hydrology/test_below_ground.py
+++ b/tests/models/hydrology/test_below_ground.py
@@ -84,18 +84,15 @@ def test_update_soil_moisture():
np.testing.assert_allclose(result, exp_result, rtol=0.001)
-def test_convert_soil_moisture_to_water_potential(dummy_climate_data):
+def test_convert_soil_moisture_to_water_potential():
"""Test that function to convert soil moisture to a water potential works."""
from virtual_ecosystem.models.hydrology.below_ground import (
convert_soil_moisture_to_water_potential,
)
- expected_potentials = np.array(
- [-198467.26813379, -198467.26813379, -198467.26813379]
- )
- dummy_data = dummy_climate_data
+ expected_potentials = np.repeat(-198467.26813379, 3)
actual_potentials = convert_soil_moisture_to_water_potential(
- dummy_data["soil_moisture"].isel(layers=13).to_numpy(),
+ soil_moisture=np.repeat(0.2, 3),
air_entry_water_potential=HydroConsts.air_entry_water_potential,
water_retention_curvature=HydroConsts.water_retention_curvature,
soil_moisture_capacity=HydroConsts.soil_moisture_capacity,
@@ -104,28 +101,28 @@ def test_convert_soil_moisture_to_water_potential(dummy_climate_data):
np.testing.assert_allclose(actual_potentials, expected_potentials)
-def test_update_groundwater_storge(dummy_climate_data):
+def test_update_groundwater_storage(dummy_climate_data):
"""Test the update_groundwater_storage() function."""
from virtual_ecosystem.models.hydrology.below_ground import (
- update_groundwater_storge,
+ update_groundwater_storage,
)
from virtual_ecosystem.models.hydrology.constants import HydroConsts
data = dummy_climate_data
- result = update_groundwater_storge(
+ result = update_groundwater_storage(
groundwater_storage=np.array(data["groundwater_storage"]),
- vertical_flow_to_groundwater=np.array([2, 4, 5]),
- bypass_flow=np.array([2, 4, 5]),
+ vertical_flow_to_groundwater=np.array([2, 4, 5, 5]),
+ bypass_flow=np.array([2, 4, 5, 5]),
max_percolation_rate_uzlz=HydroConsts.max_percolation_rate_uzlz,
groundwater_loss=HydroConsts.groundwater_loss,
reservoir_const_upper_groundwater=HydroConsts.reservoir_const_upper_groundwater,
reservoir_const_lower_groundwater=HydroConsts.reservoir_const_lower_groundwater,
)
- exp_groundwater = np.array([[453, 457, 459], [450.0, 450.0, 450.0]])
- exp_upper_flow = np.array([22.65, 22.85, 22.95])
- exp_lower_flow = np.array([22.5, 22.5, 22.5])
+ exp_groundwater = np.array([[453, 457, 459, 459], [450.0, 450.0, 450.0, 450]])
+ exp_upper_flow = np.array([22.65, 22.85, 22.95, 22.95])
+ exp_lower_flow = np.array([22.5, 22.5, 22.5, 22.5])
np.testing.assert_allclose(result["groundwater_storage"], exp_groundwater)
np.testing.assert_allclose(result["subsurface_flow"], exp_upper_flow)
np.testing.assert_allclose(result["baseflow"], exp_lower_flow)
diff --git a/tests/models/hydrology/test_hydrology_model.py b/tests/models/hydrology/test_hydrology_model.py
index ef6bfdc94..20ff36390 100644
--- a/tests/models/hydrology/test_hydrology_model.py
+++ b/tests/models/hydrology/test_hydrology_model.py
@@ -2,10 +2,11 @@
from contextlib import nullcontext as does_not_raise
from logging import CRITICAL, DEBUG, ERROR, INFO
+from unittest.mock import patch
import numpy as np
+import pint
import pytest
-import xarray as xr
from xarray import DataArray
from tests.conftest import log_check
@@ -13,11 +14,7 @@
# Global set of messages from model required var checks
MODEL_VAR_CHECK_LOG = [
- (DEBUG, "hydrology model: required var 'precipitation' checked"),
- (DEBUG, "hydrology model: required var 'leaf_area_index' checked"),
- (DEBUG, "hydrology model: required var 'air_temperature_ref' checked"),
- (DEBUG, "hydrology model: required var 'relative_humidity_ref' checked"),
- (DEBUG, "hydrology model: required var 'atmospheric_pressure_ref' checked"),
+ (DEBUG, "hydrology model: required var 'layer_heights' checked"),
(DEBUG, "hydrology model: required var 'elevation' checked"),
]
@@ -37,18 +34,22 @@
0.9,
pytest.raises(InitialisationError),
tuple(
- MODEL_VAR_CHECK_LOG
- + [(ERROR, "The initial_soil_moisture has to be between 0 and 1!")]
+ [
+ *MODEL_VAR_CHECK_LOG,
+ (ERROR, "The initial_soil_moisture has to be between 0 and 1!"),
+ ]
),
id="soil moisture out of bounds",
),
pytest.param(
- DataArray([50, 30, 20]),
+ DataArray([50, 30, 20, 20]),
0.9,
pytest.raises(InitialisationError),
tuple(
- MODEL_VAR_CHECK_LOG
- + [(ERROR, "The initial_soil_moisture must be numeric!")]
+ [
+ *MODEL_VAR_CHECK_LOG,
+ (ERROR, "The initial_soil_moisture must be numeric!"),
+ ]
),
id="soil moisture not numeric",
),
@@ -57,12 +58,12 @@
1.9,
pytest.raises(InitialisationError),
tuple(
- MODEL_VAR_CHECK_LOG
- + [
+ [
+ *MODEL_VAR_CHECK_LOG,
(
ERROR,
"The initial_groundwater_saturation has to be between 0 and 1!",
- )
+ ),
]
),
id="grnd sat out of bounds",
@@ -83,23 +84,29 @@ def test_hydrology_model_initialization(
from virtual_ecosystem.models.hydrology.constants import HydroConsts
from virtual_ecosystem.models.hydrology.hydrology_model import HydrologyModel
- with raises:
- # Initialize model
- model = HydrologyModel(
- data=dummy_climate_data,
- core_components=fixture_core_components,
- initial_soil_moisture=ini_soil_moisture,
- initial_groundwater_saturation=ini_groundwater_sat,
- model_constants=HydroConsts(),
- )
-
- # In cases where it passes then checks that the object has the right properties
- assert isinstance(model, BaseModel)
- assert model.model_name == "hydrology"
- assert repr(model) == "HydrologyModel(update_interval=1209600 seconds)"
- assert model.initial_soil_moisture == ini_soil_moisture
- assert model.initial_groundwater_saturation == ini_groundwater_sat
- assert model.drainage_map == {0: [], 1: [0], 2: [1, 2]}
+ # We patch the _setup step as it is tested separately
+ with patch(
+ "virtual_ecosystem.models.hydrology.hydrology_model.HydrologyModel._setup"
+ ) as mock_setup:
+ with raises:
+ # Initialize model
+ model = HydrologyModel(
+ data=dummy_climate_data,
+ core_components=fixture_core_components,
+ initial_soil_moisture=ini_soil_moisture,
+ initial_groundwater_saturation=ini_groundwater_sat,
+ model_constants=HydroConsts(),
+ )
+
+ # In cases where it passes we check that the object has the right properties
+ assert isinstance(model, BaseModel)
+ assert model.model_name == "hydrology"
+ assert repr(model) == "HydrologyModel(update_interval=1209600 seconds)"
+ assert model.initial_soil_moisture == ini_soil_moisture
+ assert model.initial_groundwater_saturation == ini_groundwater_sat
+ # TODO: not sure on the value below, test with more expansive drainage maps
+ assert model.drainage_map == {0: [], 1: [], 2: [0, 2, 3], 3: [1]}
+ mock_setup.assert_called_once()
# Final check that expected logging entries are produced
log_check(caplog, expected_log_entries)
@@ -122,8 +129,8 @@ def test_hydrology_model_initialization(
"Information required to initialise the hydrology model "
"successfully extracted.",
),
+ *MODEL_VAR_CHECK_LOG,
]
- + MODEL_VAR_CHECK_LOG
),
id="default_config",
),
@@ -142,8 +149,8 @@ def test_hydrology_model_initialization(
"Information required to initialise the hydrology model "
"successfully extracted.",
),
+ *MODEL_VAR_CHECK_LOG,
]
- + MODEL_VAR_CHECK_LOG
),
id="modified_config_correct",
),
@@ -183,34 +190,33 @@ def test_generate_hydrology_model(
caplog.clear()
# Check whether model is initialised (or not) as expected
- with raises:
- model = HydrologyModel.from_config(
- data=dummy_climate_data,
- core_components=core_components,
- config=config,
- )
- assert model.model_constants.soil_moisture_capacity == sm_capacity
+ # We patch the _setup step as it is tested separately
+ with patch(
+ "virtual_ecosystem.models.hydrology.hydrology_model.HydrologyModel._setup"
+ ) as mock_setup:
+ with raises:
+ model = HydrologyModel.from_config(
+ data=dummy_climate_data,
+ core_components=core_components,
+ config=config,
+ )
+ assert model.model_constants.soil_moisture_capacity == sm_capacity
+ mock_setup.assert_called_once()
# Final check that expected logging entries are produced
log_check(caplog, expected_log_entries)
@pytest.mark.parametrize(
- "cfg_string, raises",
+ "update_interval, raises",
[
pytest.param(
- "[core]\n"
- "[core.timing]\nupdate_interval = '1 month'\n"
- "[hydrology]\ninitial_soil_moisture = 0.5\n"
- "initial_groundwater_saturation = 0.9\n",
+ pint.Quantity(1, "month"),
does_not_raise(),
id="updates correctly",
),
pytest.param(
- "[core]\n"
- "[core.timing]\nupdate_interval = '1 week'\n"
- "[hydrology]\ninitial_soil_moisture = 0.5\n"
- "initial_groundwater_saturation = 0.9\n",
+ pint.Quantity(1, "week"),
pytest.raises(NotImplementedError),
id="incorrect update frequency",
),
@@ -218,55 +224,49 @@ def test_generate_hydrology_model(
)
def test_setup(
dummy_climate_data,
- cfg_string,
+ fixture_config,
+ update_interval,
raises,
+ fixture_core_components,
):
"""Test set up and update."""
- from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.core_components import CoreComponents
from virtual_ecosystem.models.hydrology.hydrology_model import HydrologyModel
# Build the config object and core components
- config = Config(cfg_strings=cfg_string)
- core_components = CoreComponents(config)
+ fixture_config["core"]["timing"]["update_interval"] = update_interval
+ core_components = CoreComponents(fixture_config)
+ lyr_strct = core_components.layer_structure
with raises:
- # initialise model
+ # initialise model. The setup is run as part of the initialisation
model = HydrologyModel.from_config(
data=dummy_climate_data,
core_components=core_components,
- config=config,
+ config=fixture_config,
)
- model.setup()
+ # Test soil moisture
- soil_moisture_values = np.repeat(a=[np.nan, 0.5], repeats=[13, 2])
+ exp_soilm_setup = lyr_strct.from_template()
+ soil_indices = lyr_strct.index_all_soil
+ exp_soilm_setup[soil_indices] = np.array([[250], [250]])
np.testing.assert_allclose(
- dummy_climate_data["soil_moisture"],
- DataArray(
- np.broadcast_to(soil_moisture_values, (3, 15)).T,
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(15),
- "layer_roles": (
- "layers",
- core_components.layer_structure.layer_roles,
- ),
- "cell_id": [0, 1, 2],
- },
- name="soil_moisture",
- ),
+ model.data["soil_moisture"],
+ exp_soilm_setup,
rtol=1e-3,
atol=1e-3,
)
+ # Test groundwater storage
+ exp_groundwater = DataArray(
+ np.full((2, fixture_core_components.grid.n_cells), 450.0),
+ dims=("groundwater_layers", "cell_id"),
+ )
np.testing.assert_allclose(
- dummy_climate_data["groundwater_storage"],
- DataArray(
- [[450.0, 450.0, 450.0], [450.0, 450.0, 450.0]],
- dims=("groundwater_layers", "cell_id"),
- ),
+ model.data["groundwater_storage"],
+ exp_groundwater,
rtol=1e-3,
atol=1e-3,
)
@@ -274,186 +274,42 @@ def test_setup(
# Run the update step
model.update(time_index=1, seed=42)
- exp_soil_moisture = xr.concat(
- [
- DataArray(
- np.full((13, 3), np.nan),
- dims=["layers", "cell_id"],
- ),
- DataArray(
- [[0.52002, 0.520263, 0.520006], [0.455899, 0.456052, 0.455858]],
- dims=["layers", "cell_id"],
- ),
+ # Test 2d variables
+ expected_2d = {
+ "soil_moisture": [
+ [67.0621, 67.0829, 67.05435, 67.04017],
+ [209.8470, 209.8500, 209.8491, 209.8467],
],
- dim="layers",
- ).assign_coords(model.data["layer_heights"].coords)
-
- exp_matric_pot = xr.concat(
- [
- DataArray(
- np.full((13, 3), np.nan),
- dims=["layers", "cell_id"],
- ),
- DataArray(
- [
- [-201.975325, -201.197219, -202.071172],
- [-549.007624, -547.513334, -549.340899],
- ],
- dims=["layers", "cell_id"],
- ),
+ "matric_potential": [
+ [-1.532961e07, -1.536408e07, -1.528976e07, -1.53231e07],
+ [-1.250262e03, -1.250131e03, -1.250172e03, -1.250276e3],
],
- dim="layers",
- ).assign_coords(model.data["layer_heights"].coords)
-
- exp_surf_prec = DataArray(
- [177.121093, 177.118977, 177.121364],
- dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
- )
- exp_runoff = DataArray(
- [0.0, 0.0, 0.0],
- dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
- )
- exp_vertical_flow = DataArray(
- [1.111498, 1.114365, 1.11434],
- dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
- )
- exp_soil_evap = DataArray(
- [16.433136, 16.433136, 16.433136],
- dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
- )
- exp_total_discharge = DataArray(
- [0, 1423, 2846],
- dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
- )
- exp_runoff_acc = DataArray(
- [0, 0, 0],
- dims=["cell_id"],
- coords={"cell_id": [0, 1, 2]},
- )
-
- np.testing.assert_allclose(
- model.data["precipitation_surface"],
- exp_surf_prec,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["soil_moisture"],
- exp_soil_moisture,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["vertical_flow"],
- exp_vertical_flow,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["surface_runoff"],
- exp_runoff,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["soil_evaporation"],
- exp_soil_evap,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["total_river_discharge"],
- exp_total_discharge,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["surface_runoff_accumulated"],
- exp_runoff_acc,
- rtol=1e-4,
- atol=1e-4,
- )
- np.testing.assert_allclose(
- model.data["matric_potential"],
- exp_matric_pot,
- rtol=1e-4,
- atol=1e-4,
- )
-
-
-def test_calculate_layer_thickness():
- """Test."""
-
- from virtual_ecosystem.models.hydrology.hydrology_model import (
- calculate_layer_thickness,
- )
-
- soil_layer_heights = np.array([[-0.5, -0.5, -0.5], [-1.2, -1.2, -1.2]])
- exp_result = np.array([[500, 500, 500], [700, 700, 700]])
-
- result = calculate_layer_thickness(soil_layer_heights, 1000)
-
- np.testing.assert_allclose(result, exp_result)
-
-
-def test_setup_hydrology_input_current_timestep(
- dummy_climate_data, fixture_core_components
-):
- """Test that correct values are selected for current time step."""
-
- from virtual_ecosystem.models.hydrology.hydrology_model import (
- setup_hydrology_input_current_timestep,
- )
-
- result = setup_hydrology_input_current_timestep(
- data=dummy_climate_data,
- time_index=1,
- days=30,
- seed=42,
- layer_roles=fixture_core_components.layer_structure.layer_roles,
- soil_moisture_capacity=0.9,
- soil_moisture_residual=0.1,
- meters_to_mm=1000,
- )
-
- # Check if all variables were created
- var_list = [
- "current_precipitation",
- "subcanopy_temperature",
- "subcanopy_humidity",
- "subcanopy_pressure",
- "leaf_area_index_sum"
- "current_evapotranspiration"
- "soil_layer_heights"
- "soil_layer_thickness"
- "top_soil_moisture_capacity_mm"
- "top_soil_moisture_residual_mm"
- "soil_moisture_mm"
- "previous_accumulated_runoff"
- "previous_subsurface_flow_accumulated"
- "groundwater_storage",
- ]
-
- variables = [var for var in result if var not in var_list]
- assert variables
-
- # check if climate values are selected correctly
- np.testing.assert_allclose(
- np.sum(result["current_precipitation"], axis=1),
- (dummy_climate_data["precipitation"].isel(time_index=1)).to_numpy(),
- )
- np.testing.assert_allclose(
- result["subcanopy_temperature"], dummy_climate_data["air_temperature"][11]
- )
- np.testing.assert_allclose(
- result["subcanopy_humidity"], dummy_climate_data["relative_humidity"][11]
- )
- np.testing.assert_allclose(
- result["subcanopy_pressure"],
- (dummy_climate_data["atmospheric_pressure_ref"].isel(time_index=1)).to_numpy(),
- )
+ }
+
+ for var_name, expected_vals in expected_2d.items():
+ exp_var = lyr_strct.from_template()
+ exp_var[soil_indices] = expected_vals
+
+ np.testing.assert_allclose(
+ model.data[var_name],
+ exp_var,
+ rtol=1e-4,
+ atol=1e-4,
+ )
+
+ # Test one dimensional variables
+ expected_1d = {
+ "vertical_flow": [0.69471, 0.695691, 0.695682, 0.694436],
+ "total_river_discharge": [0, 0, 63361, 20925],
+ "surface_runoff": [0, 0, 0, 0],
+ "surface_runoff_accumulated": [0, 0, 0, 0],
+ "soil_evaporation": [345.1148, 344.759928, 345.15422, 344.90802],
+ }
+
+ for var_name, expected_vals in expected_1d.items():
+ np.testing.assert_allclose(
+ model.data[var_name],
+ expected_vals,
+ rtol=1e-4,
+ atol=1e-4,
+ )
diff --git a/tests/models/hydrology/test_hydrology_tools.py b/tests/models/hydrology/test_hydrology_tools.py
new file mode 100644
index 000000000..ecc022218
--- /dev/null
+++ b/tests/models/hydrology/test_hydrology_tools.py
@@ -0,0 +1,104 @@
+"""Test module for hydrology.hydrology_model.py."""
+
+import numpy as np
+import pytest
+from xarray import DataArray
+
+from virtual_ecosystem.core.constants import CoreConsts
+
+
+def test_setup_hydrology_input_current_timestep(
+ dummy_climate_data, fixture_core_components
+):
+ """Test that correct values are selected for current time step."""
+
+ from virtual_ecosystem.models.hydrology.hydrology_tools import (
+ setup_hydrology_input_current_timestep,
+ )
+
+ lyr_strct = fixture_core_components.layer_structure
+ result = setup_hydrology_input_current_timestep(
+ data=dummy_climate_data,
+ time_index=0,
+ days=30,
+ seed=42,
+ layer_structure=lyr_strct,
+ soil_layer_thickness_mm=lyr_strct.soil_layer_thickness * 1000,
+ soil_moisture_capacity=0.9,
+ soil_moisture_residual=0.1,
+ core_constants=CoreConsts(),
+ latent_heat_vap_equ_factors=[1.91846e6, 33.91],
+ )
+
+ # Check if all variables were created TODO switch back to subcanopy
+ var_list = [
+ "latent_heat_vapourisation",
+ "molar_density_air",
+ "current_precipitation",
+ "surface_temperature",
+ "surface_humidity",
+ "surface_pressure",
+ "surface_wind_speed",
+ "leaf_area_index_sum",
+ "current_evapotranspiration",
+ "top_soil_moisture_capacity",
+ "top_soil_moisture_residual",
+ "previous_accumulated_runoff",
+ "previous_subsurface_flow_accumulated",
+ "groundwater_storage",
+ "current_soil_moisture",
+ ]
+
+ assert set(result.keys()) == set(var_list)
+
+ # check if climate values are selected correctly
+ np.testing.assert_allclose(
+ np.sum(result["current_precipitation"], axis=1),
+ (dummy_climate_data["precipitation"].isel(time_index=0)).to_numpy(),
+ )
+ # Get the surface layer index as an integer to extract a 1D slice
+ surface_idx = lyr_strct.index_surface_scalar
+ np.testing.assert_allclose(
+ result["surface_temperature"],
+ dummy_climate_data["air_temperature"][surface_idx],
+ )
+ np.testing.assert_allclose(
+ result["surface_humidity"],
+ dummy_climate_data["relative_humidity"][surface_idx],
+ )
+ # The reference data is a time series with cell id in axis 0, the result has cell_id
+ # on axis 1, so need to extract from the second axis
+ np.testing.assert_allclose(
+ result["surface_pressure"],
+ dummy_climate_data["atmospheric_pressure_ref"][:, 0].to_numpy(),
+ )
+ np.testing.assert_allclose(
+ result["current_soil_moisture"],
+ DataArray(np.tile([[5], [500]], fixture_core_components.grid.n_cells)),
+ )
+
+
+@pytest.mark.parametrize(
+ argnames="init_soilm, expected",
+ argvalues=(pytest.param(0.5, np.array([[250], [250]]), id="scalar_init_soilm"),),
+)
+def test_initialise_soil_moisture_mm(fixture_core_components, init_soilm, expected):
+ """Test soil moisture is initialised correctly."""
+
+ from virtual_ecosystem.models.hydrology.hydrology_tools import (
+ initialise_soil_moisture_mm,
+ )
+
+ layer_structure = fixture_core_components.layer_structure
+
+ result = initialise_soil_moisture_mm(
+ layer_structure=layer_structure,
+ soil_layer_thickness=np.tile(
+ layer_structure.soil_layer_thickness[:, None] * 1000,
+ fixture_core_components.grid.n_cells,
+ ),
+ initial_soil_moisture=init_soilm,
+ )
+ # The fixture is configured with soil layers [-0.25, -1.0]
+ exp_result = DataArray(np.broadcast_to(expected, (2, 4)))
+ np.testing.assert_allclose(result[layer_structure.index_all_soil], exp_result)
diff --git a/tests/models/litter/conftest.py b/tests/models/litter/conftest.py
index 467ec4065..49a55d488 100644
--- a/tests/models/litter/conftest.py
+++ b/tests/models/litter/conftest.py
@@ -2,11 +2,13 @@
import numpy as np
import pytest
-from xarray import DataArray, concat
+from xarray import DataArray
+
+from virtual_ecosystem.models.litter.constants import LitterConsts
@pytest.fixture
-def fixture_litter_model(dummy_litter_data):
+def fixture_litter_model(dummy_litter_data, fixture_core_components):
"""Create a litter model fixture based on the dummy litter data."""
from virtual_ecosystem.core.config import Config
@@ -29,121 +31,169 @@ def dummy_litter_data(fixture_core_components):
"""Creates a dummy litter data object for use in tests."""
from virtual_ecosystem.core.data import Data
- from virtual_ecosystem.core.grid import Grid
+
+ lyr_strct = fixture_core_components.layer_structure
# Setup the data object with four cells.
- grid = Grid(cell_nx=3, cell_ny=1)
- data = Data(grid)
+ data = Data(fixture_core_components.grid)
# These values are taken from SAFE Project data, albeit in a very unsystematic
- # manner
- data["litter_pool_above_metabolic"] = DataArray([0.3, 0.15, 0.07], dims=["cell_id"])
- """Above ground metabolic litter pool (kg C m^-2)"""
- data["litter_pool_above_structural"] = DataArray(
- [0.5, 0.25, 0.09], dims=["cell_id"]
+ # manner. The repeated fourth value is simply to adapt three hand validated examples
+ # to the shared fixture core components grid
+ pool_values = {
+ "litter_pool_above_metabolic": [0.3, 0.15, 0.07, 0.07],
+ "litter_pool_above_structural": [0.5, 0.25, 0.09, 0.09],
+ "litter_pool_woody": [4.7, 11.8, 7.3, 7.3],
+ "litter_pool_below_metabolic": [0.4, 0.37, 0.07, 0.07],
+ "litter_pool_below_structural": [0.6, 0.31, 0.02, 0.02],
+ "lignin_above_structural": [0.5, 0.1, 0.7, 0.7],
+ "lignin_woody": [0.5, 0.8, 0.35, 0.35],
+ "lignin_below_structural": [0.5, 0.25, 0.75, 0.75],
+ "c_n_ratio_above_metabolic": [7.3, 8.7, 10.1, 9.8],
+ "c_n_ratio_above_structural": [37.5, 43.2, 45.8, 50.2],
+ "c_n_ratio_woody": [55.5, 63.3, 47.3, 59.1],
+ "c_n_ratio_below_metabolic": [10.7, 11.3, 15.2, 12.4],
+ "c_n_ratio_below_structural": [50.5, 55.6, 73.1, 61.2],
+ "decomposed_excrement": [8e-07, 8.42857e-07, 3.28571e-05, 3.28571e-05],
+ "decomposed_carcasses": [1.0714e-4, 4.8571e-4, 1.15714e-3, 1.15714e-3],
+ "deadwood_production": [0.075, 0.099, 0.063, 0.033],
+ "leaf_turnover": [0.027, 0.0003, 0.021, 0.0285],
+ "plant_reproductive_tissue_turnover": [0.003, 0.0075, 0.00255, 0.00375],
+ "root_turnover": [0.027, 0.021, 0.0003, 0.0249],
+ "deadwood_lignin": [0.233, 0.545, 0.612, 0.378],
+ "leaf_turnover_lignin": [0.05, 0.25, 0.3, 0.57],
+ "plant_reproductive_tissue_turnover_lignin": [0.01, 0.03, 0.04, 0.02],
+ "root_turnover_lignin": [0.2, 0.35, 0.27, 0.4],
+ "deadwood_c_n_ratio": [60.7, 57.9, 73.1, 55.1],
+ "leaf_turnover_c_n_ratio": [15.0, 25.5, 43.1, 57.4],
+ "plant_reproductive_tissue_turnover_c_n_ratio": [12.5, 23.8, 15.7, 18.2],
+ "root_turnover_c_n_ratio": [30.3, 45.6, 43.3, 37.1],
+ }
+
+ for var, vals in pool_values.items():
+ data[var] = DataArray(vals, dims=["cell_id"])
+
+ # Vertically structured variables
+ data["soil_temperature"] = lyr_strct.from_template()
+ data["soil_temperature"][lyr_strct.index_topsoil] = 20
+ data["soil_temperature"][lyr_strct.index_subsoil] = [19.5, 18.7, 18.7, 17.6]
+
+ # At present the soil model only uses the top soil layer, so this is the
+ # only one with real test values in
+ data["matric_potential"] = lyr_strct.from_template()
+ data["matric_potential"][lyr_strct.index_topsoil] = [-10.0, -25.0, -100.0, -100.0]
+ data["matric_potential"][lyr_strct.index_subsoil] = [-11.0, -29.5, -123.0, -154.1]
+
+ data["air_temperature"] = lyr_strct.from_template()
+ data["air_temperature"][lyr_strct.index_filled_atmosphere] = np.array(
+ [30.0, 29.844995, 28.87117, 27.206405, 16.145945]
+ )[:, None]
+
+ return data
+
+
+@pytest.fixture
+def decay_rates(dummy_litter_data, fixture_core_components):
+ """Decay rates for the various litter pools."""
+
+ from virtual_ecosystem.models.litter.carbon import calculate_decay_rates
+
+ decay_rates = calculate_decay_rates(
+ above_metabolic=dummy_litter_data["litter_pool_above_metabolic"].to_numpy(),
+ above_structural=dummy_litter_data["litter_pool_above_structural"].to_numpy(),
+ woody=dummy_litter_data["litter_pool_woody"].to_numpy(),
+ below_metabolic=dummy_litter_data["litter_pool_below_metabolic"].to_numpy(),
+ below_structural=dummy_litter_data["litter_pool_below_structural"].to_numpy(),
+ lignin_above_structural=dummy_litter_data["lignin_above_structural"].to_numpy(),
+ lignin_woody=dummy_litter_data["lignin_woody"].to_numpy(),
+ lignin_below_structural=dummy_litter_data["lignin_below_structural"].to_numpy(),
+ air_temperatures=dummy_litter_data["air_temperature"],
+ soil_temperatures=dummy_litter_data["soil_temperature"],
+ water_potentials=dummy_litter_data["matric_potential"],
+ layer_structure=fixture_core_components.layer_structure,
+ constants=LitterConsts,
)
- """Above ground structural litter pool (kg C m^-2)"""
- data["litter_pool_woody"] = DataArray([4.7, 11.8, 7.3], dims=["cell_id"])
- """Woody litter pool (kg C m^-2)"""
- data["litter_pool_below_metabolic"] = DataArray([0.4, 0.37, 0.07], dims=["cell_id"])
- """Below ground metabolic litter pool (kg C m^-2)"""
- data["litter_pool_below_structural"] = DataArray(
- [0.6, 0.31, 0.02], dims=["cell_id"]
+
+ return decay_rates
+
+
+@pytest.fixture
+def metabolic_splits(dummy_litter_data):
+ """Metabolic splits for the various plant inputs."""
+
+ from virtual_ecosystem.models.litter.input_partition import (
+ calculate_metabolic_proportions_of_input,
)
- """Below ground structural litter pool (kg C m^-2)"""
- data["lignin_above_structural"] = DataArray([0.5, 0.1, 0.7], dims=["cell_id"])
- """Proportion of above ground structural pool which is lignin [unitless]"""
- data["lignin_woody"] = DataArray([0.5, 0.8, 0.35], dims=["cell_id"])
- """Proportion of dead wood pool which is lignin [unitless]"""
- data["lignin_below_structural"] = DataArray([0.5, 0.25, 0.75], dims=["cell_id"])
- """Proportion of below ground structural pool which is lignin [unitless]"""
- data["decomposed_excrement"] = DataArray(
- [8e-07, 8.42857e-07, 3.28571e-05], dims=["cell_id"]
+
+ metabolic_splits = calculate_metabolic_proportions_of_input(
+ leaf_turnover_lignin_proportion=dummy_litter_data[
+ "leaf_turnover_lignin"
+ ].to_numpy(),
+ reproduct_turnover_lignin_proportion=dummy_litter_data[
+ "plant_reproductive_tissue_turnover_lignin"
+ ].to_numpy(),
+ root_turnover_lignin_proportion=dummy_litter_data[
+ "root_turnover_lignin"
+ ].to_numpy(),
+ leaf_turnover_c_n_ratio=dummy_litter_data["leaf_turnover_c_n_ratio"].to_numpy(),
+ reproduct_turnover_c_n_ratio=dummy_litter_data[
+ "plant_reproductive_tissue_turnover_c_n_ratio"
+ ].to_numpy(),
+ root_turnover_c_n_ratio=dummy_litter_data["root_turnover_c_n_ratio"].to_numpy(),
+ constants=LitterConsts,
)
- """Rate of excrement input from the animal model [kg C m^-2 day^-1].
- These values are completely made up, so you should not read anything into them.
- """
- data["decomposed_carcasses"] = DataArray(
- [1.0714e-4, 4.8571e-4, 1.15714e-3], dims=["cell_id"]
+ return metabolic_splits
+
+
+@pytest.fixture
+def plant_inputs(dummy_litter_data, metabolic_splits):
+ """Plant inputs to each of the litter pools."""
+
+ from virtual_ecosystem.models.litter.input_partition import (
+ partion_plant_inputs_between_pools,
)
- """Rate of carcass biomass input from the animal model [kg C m^-2 day^-1].
-
- These values are completely made up, so you should not read anything into them.
- """
- data["soil_temperature"] = (
- concat(
- [DataArray(np.full((13, 3), np.nan)), DataArray(np.full((2, 3), 20))],
- dim="dim_0",
- )
- .rename({"dim_0": "layers", "dim_1": "cell_id"})
- .assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
- )
+
+ plant_inputs = partion_plant_inputs_between_pools(
+ deadwood_production=dummy_litter_data["deadwood_production"],
+ leaf_turnover=dummy_litter_data["leaf_turnover"],
+ reproduct_turnover=dummy_litter_data["plant_reproductive_tissue_turnover"],
+ root_turnover=dummy_litter_data["root_turnover"],
+ metabolic_splits=metabolic_splits,
)
- # The layer dependant data has to be handled separately
- data["matric_potential"] = concat(
- [
- DataArray(np.full((13, 3), np.nan), dims=["layers", "cell_id"]),
- # At present the soil model only uses the top soil layer, so this is the
- # only one with real test values in
- DataArray(
- [[-10.0, -25.0, -100.0]],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((1, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
+ return plant_inputs
+
+
+@pytest.fixture
+def litter_chemistry(dummy_litter_data):
+ """LitterChemistry object to be use throughout testing."""
+ from virtual_ecosystem.models.litter.chemistry import LitterChemistry
+
+ litter_chemistry = LitterChemistry(dummy_litter_data, constants=LitterConsts)
+
+ return litter_chemistry
+
+
+@pytest.fixture
+def input_lignin(dummy_litter_data, plant_inputs, litter_chemistry):
+ """Lignin proportion of the relevant input flows."""
+
+ input_lignin = litter_chemistry.calculate_litter_input_lignin_concentrations(
+ plant_input_below_struct=plant_inputs["below_ground_structural"],
+ plant_input_above_struct=plant_inputs["above_ground_structural"],
)
- data["air_temperature"] = concat(
- [
- DataArray(
- [
- [30.0, 30.0, 30.0],
- [29.844995, 29.844995, 29.844995],
- [28.87117, 28.87117, 28.87117],
- [27.206405, 27.206405, 27.206405],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((7, 3), np.nan), dims=["layers", "cell_id"]),
- DataArray(
- [
- [22.65, 22.65, 22.65],
- [16.145945, 16.145945, 16.145945],
- ],
- dims=["layers", "cell_id"],
- ),
- DataArray(np.full((2, 3), np.nan), dims=["layers", "cell_id"]),
- ],
- dim="layers",
- ).assign_coords(
- {
- "layers": np.arange(0, 15),
- "layer_roles": (
- "layers",
- fixture_core_components.layer_structure.layer_roles,
- ),
- "cell_id": data.grid.cell_id,
- }
+ return input_lignin
+
+
+@pytest.fixture
+def input_c_n_ratios(dummy_litter_data, metabolic_splits, litter_chemistry):
+ """Carbon:nitrogen ratio of each input flow."""
+
+ input_c_n_ratios = litter_chemistry.calculate_litter_input_nitrogen_ratios(
+ metabolic_splits=metabolic_splits,
+ struct_to_meta_nitrogen_ratio=LitterConsts.structural_to_metabolic_n_ratio,
)
- return data
+ return input_c_n_ratios
diff --git a/tests/models/litter/test_carbon.py b/tests/models/litter/test_carbon.py
new file mode 100644
index 000000000..c0776c1ae
--- /dev/null
+++ b/tests/models/litter/test_carbon.py
@@ -0,0 +1,249 @@
+"""Test module for litter.carbon.py.
+
+This module tests the functionality of the litter carbon module
+"""
+
+import numpy as np
+import pytest
+
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+
+@pytest.fixture
+def temp_and_water_factors(dummy_litter_data, fixture_core_components):
+ """Temperature and water factors for the various litter layers."""
+ from virtual_ecosystem.models.litter.env_factors import (
+ calculate_soil_water_effect_on_litter_decomp,
+ calculate_temperature_effect_on_litter_decomp,
+ )
+
+ # Calculate temperature factor for the above ground litter layers
+ temperature_factor_above = calculate_temperature_effect_on_litter_decomp(
+ temperature=dummy_litter_data["air_temperature"][
+ fixture_core_components.layer_structure.index_surface_scalar
+ ],
+ reference_temp=LitterConsts.litter_decomp_reference_temp,
+ offset_temp=LitterConsts.litter_decomp_offset_temp,
+ temp_response=LitterConsts.litter_decomp_temp_response,
+ )
+ # Calculate temperature factor for the below ground litter layers
+ temperature_factor_below = calculate_temperature_effect_on_litter_decomp(
+ temperature=dummy_litter_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ reference_temp=LitterConsts.litter_decomp_reference_temp,
+ offset_temp=LitterConsts.litter_decomp_offset_temp,
+ temp_response=LitterConsts.litter_decomp_temp_response,
+ )
+ # Calculate the water factor (relevant for below ground layers)
+ water_factor = calculate_soil_water_effect_on_litter_decomp(
+ water_potential=dummy_litter_data["matric_potential"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ water_potential_halt=LitterConsts.litter_decay_water_potential_halt,
+ water_potential_opt=LitterConsts.litter_decay_water_potential_optimum,
+ moisture_response_curvature=LitterConsts.moisture_response_curvature,
+ )
+
+ return {
+ "temp_above": temperature_factor_above,
+ "temp_below": temperature_factor_below,
+ "water": water_factor,
+ }
+
+
+def test_calculate_decay_rates(dummy_litter_data, fixture_core_components):
+ """Test that calculation of the decay rates works as expected."""
+ from virtual_ecosystem.models.litter.carbon import calculate_decay_rates
+
+ expected_decay = {
+ "metabolic_above": [0.00450883, 0.00225442, 0.00105206, 0.00105206],
+ "structural_above": [1.6742967e-4, 6.1857359e-4, 1.1086908e-5, 1.1086908e-5],
+ "woody": [0.0004832, 0.00027069, 0.0015888, 0.0015888],
+ "metabolic_below": [0.00912788, 0.00747205, 0.00113563, 0.00113563],
+ "structural_below": [3.0375501e-4, 4.8476324e-4, 2.0623487e-6, 2.0623487e-6],
+ }
+
+ actual_decay = calculate_decay_rates(
+ above_metabolic=dummy_litter_data["litter_pool_above_metabolic"].to_numpy(),
+ above_structural=dummy_litter_data["litter_pool_above_structural"].to_numpy(),
+ woody=dummy_litter_data["litter_pool_woody"].to_numpy(),
+ below_metabolic=dummy_litter_data["litter_pool_below_metabolic"].to_numpy(),
+ below_structural=dummy_litter_data["litter_pool_below_structural"].to_numpy(),
+ lignin_above_structural=dummy_litter_data["lignin_above_structural"].to_numpy(),
+ lignin_woody=dummy_litter_data["lignin_woody"].to_numpy(),
+ lignin_below_structural=dummy_litter_data["lignin_below_structural"].to_numpy(),
+ air_temperatures=dummy_litter_data["air_temperature"],
+ soil_temperatures=dummy_litter_data["soil_temperature"],
+ water_potentials=dummy_litter_data["matric_potential"],
+ layer_structure=fixture_core_components.layer_structure,
+ constants=LitterConsts,
+ )
+
+ for name in expected_decay.keys():
+ assert np.allclose(actual_decay[name], expected_decay[name])
+
+
+def test_calculate_total_C_mineralised(decay_rates):
+ """Test that calculation of total C mineralised is as expected."""
+ from virtual_ecosystem.core.constants import CoreConsts
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_total_C_mineralised,
+ )
+
+ expected_mineralisation = [0.02652423, 0.02033658, 0.00746131, 0.00746131]
+
+ actual_mineralisation = calculate_total_C_mineralised(
+ decay_rates=decay_rates, model_constants=LitterConsts, core_constants=CoreConsts
+ )
+
+ assert np.allclose(actual_mineralisation, expected_mineralisation)
+
+
+def test_calculate_updated_pools(dummy_litter_data, decay_rates, plant_inputs):
+ """Test that the function to calculate the pool values after the update works."""
+ from virtual_ecosystem.models.litter.carbon import calculate_updated_pools
+
+ expected_pools = {
+ "above_metabolic": [0.31632696, 0.15296346, 0.08537701, 0.08087947],
+ "above_structural": [0.50453639, 0.25006367, 0.09842669, 0.11162423],
+ "woody": [4.77403361, 11.89845863, 7.3598224, 7.3298224],
+ "below_metabolic": [0.40174907, 0.36687303, 0.06792061, 0.08224246],
+ "below_structural": [0.60638765, 0.31821335, 0.02010401, 0.03038216],
+ }
+
+ actual_pools = calculate_updated_pools(
+ above_metabolic=dummy_litter_data["litter_pool_above_metabolic"].to_numpy(),
+ above_structural=dummy_litter_data["litter_pool_above_structural"].to_numpy(),
+ woody=dummy_litter_data["litter_pool_woody"].to_numpy(),
+ below_metabolic=dummy_litter_data["litter_pool_below_metabolic"].to_numpy(),
+ below_structural=dummy_litter_data["litter_pool_below_structural"].to_numpy(),
+ decomposed_excrement=dummy_litter_data["decomposed_excrement"].to_numpy(),
+ decomposed_carcasses=dummy_litter_data["decomposed_carcasses"].to_numpy(),
+ decay_rates=decay_rates,
+ plant_inputs=plant_inputs,
+ update_interval=2.0,
+ )
+
+ for name in expected_pools.keys():
+ assert np.allclose(actual_pools[name], expected_pools[name])
+
+
+def test_calculate_litter_decay_metabolic_above(
+ dummy_litter_data, temp_and_water_factors
+):
+ """Test calculation of above ground metabolic litter decay."""
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_litter_decay_metabolic_above,
+ )
+
+ expected_decay = [0.00450883464, 0.00225441732, 0.00105206141, 0.00105206141]
+
+ actual_decay = calculate_litter_decay_metabolic_above(
+ temperature_factor=temp_and_water_factors["temp_above"],
+ litter_pool_above_metabolic=dummy_litter_data["litter_pool_above_metabolic"],
+ litter_decay_coefficient=LitterConsts.litter_decay_constant_metabolic_above,
+ )
+
+ assert np.allclose(actual_decay, expected_decay)
+
+
+def test_calculate_litter_decay_structural_above(
+ dummy_litter_data, temp_and_water_factors
+):
+ """Test calculation of above ground structural litter decay."""
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_litter_decay_structural_above,
+ )
+
+ expected_decay = [1.67429665e-4, 6.18573593e-4, 1.10869077e-5, 1.10869077e-5]
+
+ actual_decay = calculate_litter_decay_structural_above(
+ temperature_factor=temp_and_water_factors["temp_above"],
+ litter_pool_above_structural=dummy_litter_data["litter_pool_above_structural"],
+ lignin_proportion=dummy_litter_data["lignin_above_structural"],
+ litter_decay_coefficient=LitterConsts.litter_decay_constant_structural_above,
+ lignin_inhibition_factor=LitterConsts.lignin_inhibition_factor,
+ )
+
+ assert np.allclose(actual_decay, expected_decay)
+
+
+def test_calculate_litter_decay_woody(dummy_litter_data, temp_and_water_factors):
+ """Test calculation of woody litter decay."""
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_litter_decay_woody,
+ )
+
+ expected_decay = [0.0004832, 0.00027069, 0.0015888, 0.0015888]
+
+ actual_decay = calculate_litter_decay_woody(
+ temperature_factor=temp_and_water_factors["temp_above"],
+ litter_pool_woody=dummy_litter_data["litter_pool_woody"],
+ lignin_proportion=dummy_litter_data["lignin_woody"],
+ litter_decay_coefficient=LitterConsts.litter_decay_constant_woody,
+ lignin_inhibition_factor=LitterConsts.lignin_inhibition_factor,
+ )
+
+ assert np.allclose(actual_decay, expected_decay)
+
+
+def test_calculate_litter_decay_metabolic_below(
+ dummy_litter_data, temp_and_water_factors
+):
+ """Test calculation of below ground metabolic litter decay."""
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_litter_decay_metabolic_below,
+ )
+
+ expected_decay = [0.01092804, 0.00894564, 0.00135959, 0.00135959]
+
+ actual_decay = calculate_litter_decay_metabolic_below(
+ temperature_factor=temp_and_water_factors["temp_below"],
+ moisture_factor=temp_and_water_factors["water"],
+ litter_pool_below_metabolic=dummy_litter_data["litter_pool_below_metabolic"],
+ litter_decay_coefficient=LitterConsts.litter_decay_constant_metabolic_below,
+ )
+
+ assert np.allclose(actual_decay, expected_decay)
+
+
+def test_calculate_litter_decay_structural_below(
+ dummy_litter_data, temp_and_water_factors
+):
+ """Test calculation of below ground structural litter decay."""
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_litter_decay_structural_below,
+ )
+
+ expected_decay = [3.63659952e-04, 5.80365659e-04, 2.46907410e-06, 2.46907410e-06]
+
+ actual_decay = calculate_litter_decay_structural_below(
+ temperature_factor=temp_and_water_factors["temp_below"],
+ moisture_factor=temp_and_water_factors["water"],
+ litter_pool_below_structural=dummy_litter_data["litter_pool_below_structural"],
+ lignin_proportion=dummy_litter_data["lignin_below_structural"],
+ litter_decay_coefficient=LitterConsts.litter_decay_constant_structural_below,
+ lignin_inhibition_factor=LitterConsts.lignin_inhibition_factor,
+ )
+
+ assert np.allclose(actual_decay, expected_decay)
+
+
+def test_calculate_carbon_mineralised():
+ """Test that the calculation of litter decay mineralisation works as expected."""
+ from virtual_ecosystem.models.litter.carbon import (
+ calculate_carbon_mineralised,
+ )
+
+ litter_decay = np.array(
+ [0.000167429, 8.371483356e-5, 3.013734008e-5, 3.013734008e-5]
+ )
+
+ expected_mineral = [7.534305e-5, 3.767167e-5, 1.356180e-5, 1.356180e-5]
+
+ actual_mineral = calculate_carbon_mineralised(
+ litter_decay, LitterConsts.cue_metabolic
+ )
+
+ assert np.allclose(actual_mineral, expected_mineral)
diff --git a/tests/models/litter/test_chemistry.py b/tests/models/litter/test_chemistry.py
new file mode 100644
index 000000000..963ae9065
--- /dev/null
+++ b/tests/models/litter/test_chemistry.py
@@ -0,0 +1,237 @@
+"""Test module for litter.chemistry.py.
+
+This module tests the functionality of the litter chemistry module
+"""
+
+import numpy as np
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+
+def test_calculate_litter_chemistry_factor():
+ """Test that litter chemistry effects on decomposition are calculated correctly."""
+ from virtual_ecosystem.models.litter.chemistry import (
+ calculate_litter_chemistry_factor,
+ )
+
+ lignin_proportions = np.array([0.01, 0.1, 0.5, 0.8])
+
+ expected_factor = [0.95122942, 0.60653065, 0.08208499, 0.01831563]
+
+ actual_factor = calculate_litter_chemistry_factor(
+ lignin_proportions, LitterConsts.lignin_inhibition_factor
+ )
+
+ assert np.allclose(actual_factor, expected_factor)
+
+
+def test_calculate_new_pool_chemistries(
+ dummy_litter_data, plant_inputs, metabolic_splits, litter_chemistry
+):
+ """Test that function to calculate updated pool chemistries works correctly."""
+
+ updated_pools = {
+ "above_metabolic": np.array([0.32072786, 0.15473132, 0.08523907, 0.08074153]),
+ "above_structural": np.array([0.5047038, 0.25068224, 0.09843778, 0.11163532]),
+ "woody": np.array([4.774517, 11.898729, 7.361411, 7.331411]),
+ "below_metabolic": np.array([0.4090768, 0.37287148, 0.06883228, 0.08315412]),
+ "below_structural": np.array([0.6066315, 0.31860251, 0.02010566, 0.03038382]),
+ }
+
+ expected_chemistries = {
+ "lignin_above_structural": [0.49790843, 0.10067782, 0.70495536, 0.71045831],
+ "lignin_woody": [0.49580586, 0.79787834, 0.35224223, 0.35012603],
+ "lignin_below_structural": [0.50313604, 0.26586391, 0.7499951, 0.82142894],
+ "c_n_ratio_above_metabolic": [7.42828417, 8.93702902, 11.13974273, 10.28862942],
+ "c_n_ratio_above_structural": [37.5698310, 43.3465444, 49.0206010, 54.4471558],
+ "c_n_ratio_woody": [55.58168366, 63.25507083, 47.52080006, 59.08199528],
+ "c_n_ratio_below_metabolic": [10.9044015, 11.4675610, 15.2070612, 12.6623415],
+ "c_n_ratio_below_structural": [50.7755820, 56.387878, 73.1837156, 64.0424461],
+ }
+
+ actual_chemistries = litter_chemistry.calculate_new_pool_chemistries(
+ plant_inputs=plant_inputs,
+ metabolic_splits=metabolic_splits,
+ updated_pools=updated_pools,
+ )
+
+ assert set(actual_chemistries.keys()) == set(expected_chemistries.keys())
+
+ for name in actual_chemistries.keys():
+ assert np.allclose(actual_chemistries[name], expected_chemistries[name])
+
+
+def test_calculate_lignin_updates(
+ dummy_litter_data, plant_inputs, input_lignin, litter_chemistry
+):
+ """Test that the function to calculate the lignin updates works as expected."""
+
+ updated_pools = {
+ "above_structural": np.array([0.5047038, 0.25068224, 0.09843778, 0.11163532]),
+ "woody": np.array([4.774517, 11.898729, 7.361411, 7.331411]),
+ "below_structural": np.array([0.6066315, 0.31860251, 0.02010566, 0.03038382]),
+ }
+
+ expected_lignin = {
+ "above_structural": [-0.00209157, 0.00067782, 0.00495532, 0.01045834],
+ "woody": [-0.00419414, -0.00212166, 0.00224223, 0.00012603],
+ "below_structural": [3.1360386e-3, 1.5863906e-2, -4.90160482e-6, 7.1428885e-2],
+ }
+
+ actual_lignin = litter_chemistry.calculate_lignin_updates(
+ input_lignin=input_lignin,
+ plant_inputs=plant_inputs,
+ updated_pools=updated_pools,
+ )
+
+ assert set(actual_lignin.keys()) == set(expected_lignin.keys())
+
+ for name in actual_lignin.keys():
+ assert np.allclose(actual_lignin[name], expected_lignin[name])
+
+
+def test_calculate_change_in_chemical_concentration(dummy_litter_data):
+ """Test that function to calculate chemistry changes works properly."""
+ from virtual_ecosystem.models.litter.chemistry import (
+ calculate_change_in_chemical_concentration,
+ )
+
+ expected_lignin = [-0.008079787, -0.001949152, 0.0012328767, 0.0012328767]
+
+ input_carbon = np.array([0.0775, 0.05, 0.0225, 0.0225])
+ input_lignin = np.array([0.01, 0.34, 0.75, 0.75])
+
+ actual_lignin = calculate_change_in_chemical_concentration(
+ input_carbon=input_carbon,
+ updated_pool_carbon=dummy_litter_data["litter_pool_woody"].to_numpy(),
+ input_conc=input_lignin,
+ old_pool_conc=dummy_litter_data["lignin_woody"].to_numpy(),
+ )
+
+ assert np.allclose(actual_lignin, expected_lignin)
+
+
+def test_calculate_c_n_ratio_updates(
+ dummy_litter_data, plant_inputs, input_c_n_ratios, litter_chemistry
+):
+ """Test that calculation of C:N ratio updates works properly."""
+
+ updated_pools = {
+ "above_metabolic": np.array([0.32072786, 0.15473132, 0.08523907, 0.08074153]),
+ "above_structural": np.array([0.5047038, 0.25068224, 0.09843778, 0.11163532]),
+ "woody": np.array([4.774517, 11.898729, 7.361411, 7.331411]),
+ "below_metabolic": np.array([0.4090768, 0.37287148, 0.06883228, 0.08315412]),
+ "below_structural": np.array([0.6066315, 0.31860251, 0.02010566, 0.03038382]),
+ }
+
+ expected_change = {
+ "above_metabolic": [0.12828416, 0.23702901, 1.03974239, 0.48862956],
+ "above_structural": [0.06983094, 0.14654437, 3.22060275, 4.24715499],
+ "woody": [0.081683655, -0.04492917, 0.220800061, -0.01800472],
+ "below_metabolic": [0.20440145, 0.16756069, 0.00706121, 0.26234147],
+ "below_structural": [0.27558203, 0.78787769, 0.08371555, 2.8424462],
+ }
+
+ actual_change = litter_chemistry.calculate_c_n_ratio_updates(
+ plant_inputs=plant_inputs,
+ input_c_n_ratios=input_c_n_ratios,
+ updated_pools=updated_pools,
+ )
+
+ assert set(expected_change.keys()) == set(actual_change.keys())
+
+ for key in actual_change.keys():
+ assert np.allclose(actual_change[key], expected_change[key])
+
+
+def test_calculate_N_mineralisation(dummy_litter_data, decay_rates, litter_chemistry):
+ """Test that function to calculate nitrogen mineralisation rate works properly."""
+
+ expected_n_mineral = [0.00595963, 0.00379074, 0.00085095, 0.0009043]
+
+ actual_n_mineral = litter_chemistry.calculate_N_mineralisation(
+ decay_rates=decay_rates,
+ active_microbe_depth=CoreConsts.max_depth_of_microbial_activity,
+ )
+
+ assert np.allclose(actual_n_mineral, expected_n_mineral)
+
+
+def test_calculate_litter_input_lignin_concentrations(
+ dummy_litter_data, plant_inputs, litter_chemistry
+):
+ """Check calculation of lignin concentrations of each plant flow to litter."""
+
+ expected_woody = [0.233, 0.545, 0.612, 0.378]
+ expected_concs_above_struct = [0.28329484, 0.23062465, 0.75773447, 0.75393599]
+ expected_concs_below_struct = [0.77196233, 0.80040249, 0.74908861, 0.95895666]
+
+ actual_concs = litter_chemistry.calculate_litter_input_lignin_concentrations(
+ plant_input_below_struct=plant_inputs["below_ground_structural"],
+ plant_input_above_struct=plant_inputs["above_ground_structural"],
+ )
+
+ assert np.allclose(actual_concs["woody"], expected_woody)
+ assert np.allclose(actual_concs["above_structural"], expected_concs_above_struct)
+ assert np.allclose(actual_concs["below_structural"], expected_concs_below_struct)
+
+
+def test_calculate_litter_input_nitrogen_ratios(
+ dummy_litter_data, metabolic_splits, litter_chemistry
+):
+ """Check function to calculate the C:N ratios of input to each litter pool works."""
+
+ expected_c_n_ratios = {
+ "woody": [60.7, 57.9, 73.1, 55.1],
+ "below_metabolic": [14.879783, 16.587126, 17.733169, 13.903046],
+ "below_structural": [74.398916, 82.935630, 88.665843, 69.515230],
+ "above_metabolic": [8.9373399, 14.343140, 15.968877, 13.520689],
+ "above_structural": [44.735092, 71.440811, 83.323241, 72.103527],
+ }
+
+ actual_c_n_ratios = litter_chemistry.calculate_litter_input_nitrogen_ratios(
+ metabolic_splits=metabolic_splits,
+ struct_to_meta_nitrogen_ratio=LitterConsts.structural_to_metabolic_n_ratio,
+ )
+
+ assert set(expected_c_n_ratios.keys()) == set(actual_c_n_ratios.keys())
+
+ for key in actual_c_n_ratios.keys():
+ assert np.allclose(actual_c_n_ratios[key], expected_c_n_ratios[key])
+
+
+def test_calculate_nutrient_split_between_litter_pools(
+ dummy_litter_data, metabolic_splits
+):
+ """Check the function to calculate the nutrient split between litter pools."""
+ from virtual_ecosystem.models.litter.chemistry import (
+ calculate_nutrient_split_between_litter_pools,
+ )
+
+ expected_meta_c_n = np.array([14.879783, 16.587126, 17.733169, 13.903046])
+ expected_struct_c_n = np.array([74.398916, 82.935630, 88.665843, 69.515230])
+
+ actual_meta_c_n, actual_struct_c_n = calculate_nutrient_split_between_litter_pools(
+ input_c_nut_ratio=dummy_litter_data["root_turnover_c_n_ratio"],
+ metabolic_split=metabolic_splits["roots"],
+ struct_to_meta_nutrient_ratio=LitterConsts.structural_to_metabolic_n_ratio,
+ )
+
+ # Standard checks of the produced values
+ assert np.allclose(actual_meta_c_n, expected_meta_c_n)
+ assert np.allclose(actual_struct_c_n, expected_struct_c_n)
+ # Check that expected ratio is actually preserved by the function
+ assert np.allclose(
+ expected_struct_c_n,
+ expected_meta_c_n * LitterConsts.structural_to_metabolic_n_ratio,
+ )
+ # Check that weighted sum of the two new C:N ratios is compatible with the original
+ # C:N ratio
+ assert np.allclose(
+ dummy_litter_data["root_turnover_c_n_ratio"],
+ (
+ actual_meta_c_n * metabolic_splits["roots"]
+ + actual_struct_c_n * (1 - metabolic_splits["roots"])
+ ),
+ )
diff --git a/tests/models/litter/test_env_factors.py b/tests/models/litter/test_env_factors.py
new file mode 100644
index 000000000..d375155f3
--- /dev/null
+++ b/tests/models/litter/test_env_factors.py
@@ -0,0 +1,178 @@
+"""Test module for litter.env_factors.py."""
+
+import numpy as np
+import pytest
+
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+
+def test_calculate_temperature_effect_on_litter_decomp(
+ dummy_litter_data, fixture_core_components
+):
+ """Test that temperature effects on decomposition are calculated correctly."""
+ from virtual_ecosystem.models.litter.env_factors import (
+ calculate_temperature_effect_on_litter_decomp,
+ )
+
+ expected_factor = [0.2732009, 0.2732009, 0.2732009, 0.2732009]
+
+ actual_factor = calculate_temperature_effect_on_litter_decomp(
+ dummy_litter_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ reference_temp=LitterConsts.litter_decomp_reference_temp,
+ offset_temp=LitterConsts.litter_decomp_offset_temp,
+ temp_response=LitterConsts.litter_decomp_temp_response,
+ )
+
+ assert np.allclose(actual_factor, expected_factor)
+
+
+def test_calculate_soil_water_effect_on_litter_decomp(
+ dummy_litter_data, fixture_core_components
+):
+ """Test that soil moisture effects on decomposition are calculated correctly."""
+ from virtual_ecosystem.models.litter.env_factors import (
+ calculate_soil_water_effect_on_litter_decomp,
+ )
+
+ expected_factor = [1.0, 0.88496823, 0.71093190, 0.71093190]
+
+ actual_factor = calculate_soil_water_effect_on_litter_decomp(
+ water_potential=dummy_litter_data["matric_potential"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ water_potential_halt=LitterConsts.litter_decay_water_potential_halt,
+ water_potential_opt=LitterConsts.litter_decay_water_potential_optimum,
+ moisture_response_curvature=LitterConsts.moisture_response_curvature,
+ )
+
+ assert np.allclose(actual_factor, expected_factor)
+
+
+@pytest.mark.parametrize(
+ "increased_depth,expected_av_temps",
+ [
+ pytest.param(
+ True,
+ [18.6319817, 18.498648, 18.498648, 18.315315],
+ id="increased depth",
+ ),
+ pytest.param(
+ False,
+ [18.0729725, 18.0729725, 18.0729725, 18.0729725],
+ id="normal depth",
+ ),
+ ],
+)
+def test_average_temperature_over_microbially_active_layers(
+ dummy_litter_data, fixture_core_components, increased_depth, expected_av_temps
+):
+ """Check averaging of temperatures over soil layers works correctly."""
+ from virtual_ecosystem.models.litter.env_factors import (
+ average_temperature_over_microbially_active_layers,
+ )
+
+ if increased_depth:
+ fixture_core_components.layer_structure.soil_layer_active_thickness = np.array(
+ [0.5, 0.25]
+ )
+ fixture_core_components.layer_structure.max_depth_of_microbial_activity = 0.75
+
+ actual_av_temps = average_temperature_over_microbially_active_layers(
+ soil_temperatures=dummy_litter_data["soil_temperature"],
+ surface_temperature=dummy_litter_data["air_temperature"][
+ fixture_core_components.layer_structure.index_surface
+ ].to_numpy(),
+ layer_structure=fixture_core_components.layer_structure,
+ )
+
+ assert np.allclose(actual_av_temps, expected_av_temps)
+
+
+@pytest.mark.parametrize(
+ "increased_depth,expected_water_pots",
+ [
+ pytest.param(
+ True,
+ [-10.1667, -25.750, -103.8333, -109.0167],
+ id="increased depth",
+ ),
+ pytest.param(
+ False,
+ [-10.0, -25.0, -100.0, -100.0],
+ id="normal depth",
+ ),
+ ],
+)
+def test_average_water_potential_over_microbially_active_layers(
+ dummy_litter_data, fixture_core_components, increased_depth, expected_water_pots
+):
+ """Check averaging of water potentials over soil layers works correctly."""
+ from virtual_ecosystem.models.litter.env_factors import (
+ average_water_potential_over_microbially_active_layers,
+ )
+
+ if increased_depth:
+ fixture_core_components.layer_structure.soil_layer_active_thickness = np.array(
+ [0.5, 0.25]
+ )
+ fixture_core_components.layer_structure.max_depth_of_microbial_activity = 0.75
+
+ actual_water_pots = average_water_potential_over_microbially_active_layers(
+ water_potentials=dummy_litter_data["matric_potential"],
+ layer_structure=fixture_core_components.layer_structure,
+ )
+
+ assert np.allclose(actual_water_pots, expected_water_pots)
+
+
+@pytest.mark.parametrize(
+ "increased_depth,expected_factors",
+ [
+ pytest.param(
+ True,
+ {
+ "temp_above": [0.1878681, 0.1878681, 0.1878681, 0.1878681],
+ "temp_below": [0.2407699, 0.2377353, 0.2377353, 0.2335993],
+ "water": [0.9979245, 0.8812574, 0.7062095, 0.7000939],
+ },
+ id="increased depth",
+ ),
+ pytest.param(
+ False,
+ {
+ "temp_above": [0.1878681, 0.1878681, 0.1878681, 0.1878681],
+ "temp_below": [0.2281971, 0.2281971, 0.2281971, 0.2281971],
+ "water": [1.0, 0.88496823, 0.71093190, 0.71093190],
+ },
+ id="normal depth",
+ ),
+ ],
+)
+def test_calculate_environmental_factors(
+ dummy_litter_data, fixture_core_components, increased_depth, expected_factors
+):
+ """Check that the calculation of the relevant environmental factors is correct."""
+ from virtual_ecosystem.models.litter.env_factors import (
+ calculate_environmental_factors,
+ )
+
+ if increased_depth:
+ fixture_core_components.layer_structure.soil_layer_active_thickness = np.array(
+ [0.5, 0.25]
+ )
+ fixture_core_components.layer_structure.max_depth_of_microbial_activity = 0.75
+
+ actual_factors = calculate_environmental_factors(
+ air_temperatures=dummy_litter_data["air_temperature"],
+ soil_temperatures=dummy_litter_data["soil_temperature"],
+ water_potentials=dummy_litter_data["matric_potential"],
+ layer_structure=fixture_core_components.layer_structure,
+ constants=LitterConsts,
+ )
+
+ assert set(expected_factors.keys()) == set(actual_factors.keys())
+
+ for key in actual_factors.keys():
+ assert np.allclose(actual_factors[key], expected_factors[key])
diff --git a/tests/models/litter/test_input_partition.py b/tests/models/litter/test_input_partition.py
new file mode 100644
index 000000000..86d10a995
--- /dev/null
+++ b/tests/models/litter/test_input_partition.py
@@ -0,0 +1,140 @@
+"""Test module for models.litter.input_partition.py."""
+
+from logging import ERROR
+
+import numpy as np
+import pytest
+
+from tests.conftest import log_check
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+
+def test_calculate_metabolic_proportions_of_input(dummy_litter_data):
+ """Test that function to calculate metabolic input proportions works as expected."""
+
+ from virtual_ecosystem.models.litter.input_partition import (
+ calculate_metabolic_proportions_of_input,
+ )
+
+ expected_proportions = {
+ "leaves": [0.8365, 0.73525, 0.61726, 0.261076],
+ "reproductive": [0.84775, 0.837148, 0.838696, 0.843448],
+ "roots": [0.74092, 0.56272, 0.639562, 0.58288],
+ }
+
+ actual_proportions = calculate_metabolic_proportions_of_input(
+ leaf_turnover_lignin_proportion=dummy_litter_data["leaf_turnover_lignin"],
+ reproduct_turnover_lignin_proportion=dummy_litter_data[
+ "plant_reproductive_tissue_turnover_lignin"
+ ],
+ root_turnover_lignin_proportion=dummy_litter_data["root_turnover_lignin"],
+ leaf_turnover_c_n_ratio=dummy_litter_data["leaf_turnover_c_n_ratio"],
+ reproduct_turnover_c_n_ratio=dummy_litter_data[
+ "plant_reproductive_tissue_turnover_c_n_ratio"
+ ],
+ root_turnover_c_n_ratio=dummy_litter_data["root_turnover_c_n_ratio"],
+ constants=LitterConsts,
+ )
+
+ assert set(expected_proportions.keys()) == set(actual_proportions.keys())
+
+ for key in actual_proportions.keys():
+ assert np.allclose(actual_proportions[key], expected_proportions[key])
+
+
+def test_partion_plant_inputs_between_pools(dummy_litter_data, metabolic_splits):
+ """Check function to partition inputs into litter pools works as expected."""
+
+ from virtual_ecosystem.models.litter.input_partition import (
+ partion_plant_inputs_between_pools,
+ )
+
+ expected_woody = [0.075, 0.099, 0.063, 0.033]
+ expected_above_meta = [0.02512875, 0.006499185, 0.01510113, 0.0106036]
+ expected_above_struct = [0.00487125, 0.001300815, 0.00844887, 0.0216464]
+ expected_below_meta = [0.02000484, 0.01181712, 0.00019187, 0.01451371]
+ expected_below_struct = [0.00699516, 0.00918288, 0.00010813, 0.01038629]
+
+ actual_splits = partion_plant_inputs_between_pools(
+ deadwood_production=dummy_litter_data["deadwood_production"],
+ leaf_turnover=dummy_litter_data["leaf_turnover"],
+ reproduct_turnover=dummy_litter_data["plant_reproductive_tissue_turnover"],
+ root_turnover=dummy_litter_data["root_turnover"],
+ metabolic_splits=metabolic_splits,
+ )
+
+ assert np.allclose(actual_splits["woody"], expected_woody)
+ assert np.allclose(actual_splits["above_ground_metabolic"], expected_above_meta)
+ assert np.allclose(actual_splits["above_ground_structural"], expected_above_struct)
+ assert np.allclose(actual_splits["below_ground_metabolic"], expected_below_meta)
+ assert np.allclose(actual_splits["below_ground_structural"], expected_below_struct)
+
+
+def test_split_pool_into_metabolic_and_structural_litter(dummy_litter_data):
+ """Check function to split input biomass between litter pools works as expected."""
+
+ from virtual_ecosystem.models.litter.input_partition import (
+ split_pool_into_metabolic_and_structural_litter,
+ )
+
+ expected_split = [0.8365, 0.73525, 0.61726, 0.261076]
+
+ actual_split = split_pool_into_metabolic_and_structural_litter(
+ lignin_proportion=dummy_litter_data["leaf_turnover_lignin"],
+ carbon_nitrogen_ratio=dummy_litter_data["leaf_turnover_c_n_ratio"],
+ max_metabolic_fraction=LitterConsts.max_metabolic_fraction_of_input,
+ split_sensitivity=LitterConsts.structural_metabolic_split_sensitivity,
+ )
+
+ assert np.allclose(actual_split, expected_split)
+
+
+@pytest.mark.parametrize(
+ "c_n_ratios,expected_log",
+ [
+ pytest.param(
+ np.array([34.2, 55.5, 37.1, 400.7]),
+ (
+ (
+ ERROR,
+ "Fraction of input biomass going to metabolic pool has dropped "
+ "below zero!",
+ ),
+ ),
+ id="negative_metabolic_flow",
+ ),
+ pytest.param(
+ np.array([34.2, 55.5, 37.1, 3.7]),
+ (
+ (
+ ERROR,
+ "Fraction of input biomass going to structural biomass is less than"
+ " the lignin fraction!",
+ ),
+ ),
+ id="less_than_lignin",
+ ),
+ ],
+)
+def test_split_pool_into_metabolic_and_structural_litter_bad_data(
+ caplog, c_n_ratios, expected_log
+):
+ """Check that pool split functions raises an error if out of bounds data is used."""
+
+ from virtual_ecosystem.models.litter.input_partition import (
+ split_pool_into_metabolic_and_structural_litter,
+ )
+
+ # C:N ratio of >400 is far too high for the function to behave sensibly
+ lignin_proportions = np.array([0.5, 0.4, 0.35, 0.23])
+
+ with pytest.raises(ValueError):
+ split_pool_into_metabolic_and_structural_litter(
+ lignin_proportion=lignin_proportions,
+ carbon_nitrogen_ratio=c_n_ratios,
+ max_metabolic_fraction=LitterConsts.max_metabolic_fraction_of_input,
+ split_sensitivity=LitterConsts.structural_metabolic_split_sensitivity,
+ )
+
+ # Check the error reports
+ log_check(caplog, expected_log)
diff --git a/tests/models/litter/test_litter_model.py b/tests/models/litter/test_litter_model.py
index 8720c5c99..ef524faba 100644
--- a/tests/models/litter/test_litter_model.py
+++ b/tests/models/litter/test_litter_model.py
@@ -50,6 +50,11 @@ def test_litter_model_initialization(
(DEBUG, "litter model: required var 'lignin_above_structural' checked"),
(DEBUG, "litter model: required var 'lignin_woody' checked"),
(DEBUG, "litter model: required var 'lignin_below_structural' checked"),
+ (DEBUG, "litter model: required var 'c_n_ratio_above_metabolic' checked"),
+ (DEBUG, "litter model: required var 'c_n_ratio_above_structural' checked"),
+ (DEBUG, "litter model: required var 'c_n_ratio_woody' checked"),
+ (DEBUG, "litter model: required var 'c_n_ratio_below_metabolic' checked"),
+ (DEBUG, "litter model: required var 'c_n_ratio_below_structural' checked"),
),
)
@@ -118,8 +123,26 @@ def test_litter_model_initialization_no_data(caplog, fixture_core_components):
),
(
ERROR,
- "litter model: error checking required_init_vars, see log.",
+ "litter model: init data missing required var "
+ "'c_n_ratio_above_metabolic'",
+ ),
+ (
+ ERROR,
+ "litter model: init data missing required var "
+ "'c_n_ratio_above_structural'",
+ ),
+ (ERROR, "litter model: init data missing required var 'c_n_ratio_woody'"),
+ (
+ ERROR,
+ "litter model: init data missing required var "
+ "'c_n_ratio_below_metabolic'",
),
+ (
+ ERROR,
+ "litter model: init data missing required var "
+ "'c_n_ratio_below_structural'",
+ ),
+ (ERROR, "litter model: error checking vars_required_for_init, see log."),
),
)
@@ -134,7 +157,7 @@ def test_litter_model_initialization_bad_pool_bounds(
with pytest.raises(InitialisationError):
# Put incorrect data in for lmwc
dummy_litter_data["litter_pool_above_metabolic"] = DataArray(
- [0.05, 0.02, -0.1], dims=["cell_id"]
+ [0.05, 0.02, -0.1, -0.1], dims=["cell_id"]
)
LitterModel(
@@ -162,7 +185,7 @@ def test_litter_model_initialization_bad_lignin_bounds(
# Make four cell grid
litter_data = deepcopy(dummy_litter_data)
# Put incorrect data in for woody lignin
- litter_data["lignin_woody"] = DataArray([0.5, 0.4, 1.1], dims=["cell_id"])
+ litter_data["lignin_woody"] = DataArray([0.5, 0.4, 1.1, 1.1], dims=["cell_id"])
LitterModel(
data=litter_data,
@@ -178,6 +201,35 @@ def test_litter_model_initialization_bad_lignin_bounds(
)
+def test_litter_model_initialization_bad_nutrient_ratio_bounds(
+ caplog, dummy_litter_data, fixture_core_components
+):
+ """Test `LitterModel` initialization fails for nutrient ratios not in bounds."""
+ from virtual_ecosystem.models.litter.constants import LitterConsts
+ from virtual_ecosystem.models.litter.litter_model import LitterModel
+
+ with pytest.raises(InitialisationError):
+ # Make four cell grid
+ litter_data = deepcopy(dummy_litter_data)
+ # Put incorrect data in for woody lignin
+ litter_data["c_n_ratio_woody"] = DataArray(
+ [23.3, 45.6, -23.4, -11.1], dims=["cell_id"]
+ )
+
+ LitterModel(
+ data=litter_data,
+ core_components=fixture_core_components,
+ model_constants=LitterConsts,
+ )
+
+ # Final check that expected logging entries are produced
+ log_check(
+ caplog,
+ expected_log=((ERROR, "Negative nutrient ratios found in: "),),
+ subset=slice(-1, None, None),
+ )
+
+
@pytest.mark.parametrize(
"cfg_string,temp_response,raises,expected_log_entries",
[
@@ -224,6 +276,23 @@ def test_litter_model_initialization_bad_lignin_bounds(
DEBUG,
"litter model: required var 'lignin_below_structural' checked",
),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_above_metabolic' checked",
+ ),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_above_structural' checked",
+ ),
+ (DEBUG, "litter model: required var 'c_n_ratio_woody' checked"),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_below_metabolic' checked",
+ ),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_below_structural' checked",
+ ),
),
id="default_config",
),
@@ -259,6 +328,23 @@ def test_litter_model_initialization_bad_lignin_bounds(
(DEBUG, "litter model: required var 'lignin_above_structural' checked"),
(DEBUG, "litter model: required var 'lignin_woody' checked"),
(DEBUG, "litter model: required var 'lignin_below_structural' checked"),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_above_metabolic' checked",
+ ),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_above_structural' checked",
+ ),
+ (DEBUG, "litter model: required var 'c_n_ratio_woody' checked"),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_below_metabolic' checked",
+ ),
+ (
+ DEBUG,
+ "litter model: required var 'c_n_ratio_below_structural' checked",
+ ),
),
id="modified_config_correct",
),
@@ -311,15 +397,21 @@ def test_generate_litter_model(
def test_update(fixture_litter_model, dummy_litter_data):
"""Test to check that the update step works and increments the update step."""
- end_above_meta = [0.29587973, 0.14851276, 0.07041856]
- end_above_struct = [0.50055126, 0.25010012, 0.0907076]
- end_woody = [4.702103, 11.802315, 7.300997]
- end_below_meta = [0.38949196, 0.36147436, 0.06906041]
- end_below_struct = [0.60011634, 0.30989963, 0.02047753]
- end_lignin_above_struct = [0.4996410, 0.1004310, 0.6964345]
- end_lignin_woody = [0.49989001, 0.79989045, 0.34998229]
- end_lignin_below_struct = [0.499760108, 0.249922519, 0.737107757]
- c_mineral = [0.02987233, 0.02316114, 0.00786517]
+ end_above_meta = [0.32072786, 0.15473132, 0.08523907, 0.08074153]
+ end_above_struct = [0.50470382, 0.25068224, 0.09843778, 0.11163532]
+ end_woody = [4.7745168, 11.89872931, 7.3614112, 7.3314112]
+ end_below_meta = [0.41087696, 0.37434507, 0.06905624, 0.08337808]
+ end_below_struct = [0.6066914, 0.31869812, 0.02010607, 0.03038423]
+ end_lignin_above_struct = [0.49790843, 0.10067782, 0.70495536, 0.71045831]
+ end_lignin_woody = [0.49580586, 0.79787834, 0.35224223, 0.35012603]
+ end_lignin_below_struct = [0.50313573, 0.26585915, 0.7499951, 0.82142798]
+ end_c_n_above_metabolic = [7.42828416, 8.93702901, 11.13974239, 10.28862956]
+ end_c_n_above_structural = [37.56983094, 43.34654437, 49.02060275, 54.44715499]
+ end_c_n_woody = [55.581683655, 63.25507083, 47.520800061, 59.08199528]
+ end_c_n_below_metabolic = [10.90350592, 11.4669011, 15.20703826, 12.66163681]
+ end_c_n_below_structural = [50.77558203, 56.38787769, 73.18371555, 64.0424462]
+ c_mineral = [0.02652423, 0.02033658, 0.00746131, 0.00746131]
+ n_mineral = [0.00595963, 0.00379074, 0.00085095, 0.0009043]
fixture_litter_model.update(time_index=0)
@@ -340,4 +432,18 @@ def test_update(fixture_litter_model, dummy_litter_data):
assert np.allclose(
dummy_litter_data["lignin_below_structural"], end_lignin_below_struct
)
+ assert np.allclose(
+ dummy_litter_data["c_n_ratio_above_metabolic"], end_c_n_above_metabolic
+ )
+ assert np.allclose(
+ dummy_litter_data["c_n_ratio_above_structural"], end_c_n_above_structural
+ )
+ assert np.allclose(dummy_litter_data["c_n_ratio_woody"], end_c_n_woody)
+ assert np.allclose(
+ dummy_litter_data["c_n_ratio_below_metabolic"], end_c_n_below_metabolic
+ )
+ assert np.allclose(
+ dummy_litter_data["c_n_ratio_below_structural"], end_c_n_below_structural
+ )
assert np.allclose(dummy_litter_data["litter_C_mineralisation_rate"], c_mineral)
+ assert np.allclose(dummy_litter_data["litter_N_mineralisation_rate"], n_mineral)
diff --git a/tests/models/litter/test_litter_pools.py b/tests/models/litter/test_litter_pools.py
deleted file mode 100644
index 8833c3a34..000000000
--- a/tests/models/litter/test_litter_pools.py
+++ /dev/null
@@ -1,417 +0,0 @@
-"""Test module for litter.litter_pools.py.
-
-This module tests the functionality of the litter pools module
-"""
-
-import numpy as np
-import pytest
-
-from virtual_ecosystem.models.litter.constants import LitterConsts
-
-
-@pytest.fixture
-def temp_and_water_factors(
- dummy_litter_data, surface_layer_index, top_soil_layer_index
-):
- """Temperature and water factors for the various litter layers."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_environmental_factors,
- )
-
- environmental_factors = calculate_environmental_factors(
- surface_temp=dummy_litter_data["air_temperature"][surface_layer_index],
- topsoil_temp=dummy_litter_data["soil_temperature"][top_soil_layer_index],
- water_potential=dummy_litter_data["matric_potential"][top_soil_layer_index],
- constants=LitterConsts,
- )
-
- return environmental_factors
-
-
-# TODO - Compare the below
-# [-297.1410435034187, -4.264765510307134, -79.66618999943468]
-# [-10.0, -25.0, -100.0]
-
-
-@pytest.fixture
-def decay_rates(dummy_litter_data, temp_and_water_factors):
- """Decay rates for the various litter pools."""
-
- return {
- "metabolic_above": np.array([0.00450883464, 0.00225441732, 0.00105206141]),
- "structural_above": np.array([0.000167429, 8.371483356e-5, 3.013734008e-5]),
- "woody": np.array([0.0004831961, 0.0012131307, 0.0007504961]),
- "metabolic_below": np.array([0.00627503, 0.01118989, 0.00141417]),
- "structural_below": np.array([2.08818455e-04, 2.07992589e-04, 8.96385948e-06]),
- }
-
-
-def test_calculate_environmental_factors(
- dummy_litter_data, surface_layer_index, top_soil_layer_index
-):
- """Test that the calculation of the environmental factors works as expected."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_environmental_factors,
- )
-
- expected_water_factors = [1.0, 0.88496823, 0.71093190]
- expected_temp_above_factors = [0.1878681, 0.1878681, 0.1878681]
- expected_temp_below_factors = [0.2732009, 0.2732009, 0.2732009]
-
- environmental_factors = calculate_environmental_factors(
- surface_temp=dummy_litter_data["air_temperature"][surface_layer_index],
- topsoil_temp=dummy_litter_data["soil_temperature"][top_soil_layer_index],
- water_potential=dummy_litter_data["matric_potential"][top_soil_layer_index],
- constants=LitterConsts,
- )
-
- assert np.allclose(environmental_factors["water"], expected_water_factors)
- assert np.allclose(environmental_factors["temp_above"], expected_temp_above_factors)
- assert np.allclose(environmental_factors["temp_below"], expected_temp_below_factors)
-
-
-def test_calculate_temperature_effect_on_litter_decomp(
- dummy_litter_data, top_soil_layer_index
-):
- """Test that temperature effects on decomposition are calculated correctly."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_temperature_effect_on_litter_decomp,
- )
-
- expected_factor = [0.2732009, 0.2732009, 0.2732009]
-
- actual_factor = calculate_temperature_effect_on_litter_decomp(
- dummy_litter_data["soil_temperature"][top_soil_layer_index],
- reference_temp=LitterConsts.litter_decomp_reference_temp,
- offset_temp=LitterConsts.litter_decomp_offset_temp,
- temp_response=LitterConsts.litter_decomp_temp_response,
- )
-
- assert np.allclose(actual_factor, expected_factor)
-
-
-def test_calculate_moisture_effect_on_litter_decomp(top_soil_layer_index):
- """Test that soil moisture effects on decomposition are calculated correctly."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_moisture_effect_on_litter_decomp,
- )
-
- water_potentials = np.array([-10.0, -25.0, -100.0, -400.0])
-
- expected_factor = [1.0, 0.88496823, 0.71093190, 0.53689556]
-
- actual_factor = calculate_moisture_effect_on_litter_decomp(
- water_potentials,
- water_potential_halt=LitterConsts.litter_decay_water_potential_halt,
- water_potential_opt=LitterConsts.litter_decay_water_potential_optimum,
- moisture_response_curvature=LitterConsts.moisture_response_curvature,
- )
-
- assert np.allclose(actual_factor, expected_factor)
-
-
-def test_calculate_litter_chemistry_factor():
- """Test that litter chemistry effects on decomposition are calculated correctly."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_litter_chemistry_factor,
- )
-
- lignin_proportions = np.array([0.01, 0.1, 0.5, 0.8])
-
- expected_factor = [0.95122942, 0.60653065, 0.08208499, 0.01831563]
-
- actual_factor = calculate_litter_chemistry_factor(
- lignin_proportions, LitterConsts.lignin_inhibition_factor
- )
-
- assert np.allclose(actual_factor, expected_factor)
-
-
-def test_calculate_change_in_litter_variables(
- dummy_litter_data, surface_layer_index, top_soil_layer_index
-):
- """Test that litter pool update calculation is correct."""
- from virtual_ecosystem.core.constants import CoreConsts
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_change_in_litter_variables,
- )
-
- expected_pools = {
- "litter_pool_above_metabolic": [0.29587973, 0.14851276, 0.07041856],
- "litter_pool_above_structural": [0.50055126, 0.25010012, 0.0907076],
- "litter_pool_woody": [4.702103, 11.802315, 7.300997],
- "litter_pool_below_metabolic": [0.38949196, 0.36147436, 0.06906041],
- "litter_pool_below_structural": [0.60011634, 0.30989963, 0.02047753],
- "lignin_above_structural": [0.4996410, 0.1004310, 0.6964345],
- "lignin_woody": [0.49989001, 0.79989045, 0.34998229],
- "lignin_below_structural": [0.499760108, 0.249922519, 0.737107757],
- "litter_C_mineralisation_rate": [0.02987233, 0.02316114, 0.00786517],
- }
-
- result = calculate_change_in_litter_variables(
- surface_temp=dummy_litter_data["air_temperature"][
- surface_layer_index
- ].to_numpy(),
- topsoil_temp=dummy_litter_data["soil_temperature"][
- top_soil_layer_index
- ].to_numpy(),
- water_potential=dummy_litter_data["matric_potential"][
- top_soil_layer_index
- ].to_numpy(),
- above_metabolic=dummy_litter_data["litter_pool_above_metabolic"].to_numpy(),
- above_structural=dummy_litter_data["litter_pool_above_structural"].to_numpy(),
- woody=dummy_litter_data["litter_pool_woody"].to_numpy(),
- below_metabolic=dummy_litter_data["litter_pool_below_metabolic"].to_numpy(),
- below_structural=dummy_litter_data["litter_pool_below_structural"].to_numpy(),
- lignin_above_structural=dummy_litter_data["lignin_above_structural"].to_numpy(),
- lignin_woody=dummy_litter_data["lignin_woody"].to_numpy(),
- lignin_below_structural=dummy_litter_data["lignin_below_structural"].to_numpy(),
- decomposed_excrement=dummy_litter_data["decomposed_excrement"].to_numpy(),
- decomposed_carcasses=dummy_litter_data["decomposed_carcasses"].to_numpy(),
- update_interval=1.0,
- model_constants=LitterConsts,
- core_constants=CoreConsts,
- )
-
- for name in expected_pools.keys():
- assert np.allclose(result[name], expected_pools[name])
-
-
-def test_calculate_decay_rates(dummy_litter_data, temp_and_water_factors):
- """Test that calculation of the decay rates works as expected."""
- from virtual_ecosystem.models.litter.litter_pools import calculate_decay_rates
-
- expected_decay = {
- "metabolic_above": [0.00450883, 0.00225442, 0.00105206],
- "structural_above": [1.67429665e-4, 6.18573593e-4, 1.10869077e-5],
- "woody": [0.0004832, 0.00027069, 0.0015888],
- "metabolic_below": [0.01092804, 0.00894564, 0.00135959],
- "structural_below": [3.63659952e-04, 5.80365659e-04, 2.46907410e-06],
- }
-
- actual_decay = calculate_decay_rates(
- above_metabolic=dummy_litter_data["litter_pool_above_metabolic"].to_numpy(),
- above_structural=dummy_litter_data["litter_pool_above_structural"].to_numpy(),
- woody=dummy_litter_data["litter_pool_woody"].to_numpy(),
- below_metabolic=dummy_litter_data["litter_pool_below_metabolic"].to_numpy(),
- below_structural=dummy_litter_data["litter_pool_below_structural"].to_numpy(),
- lignin_above_structural=dummy_litter_data["lignin_above_structural"].to_numpy(),
- lignin_woody=dummy_litter_data["lignin_woody"].to_numpy(),
- lignin_below_structural=dummy_litter_data["lignin_below_structural"].to_numpy(),
- environmental_factors=temp_and_water_factors,
- constants=LitterConsts,
- )
-
- for name in expected_decay.keys():
- assert np.allclose(actual_decay[name], expected_decay[name])
-
-
-def test_calculate_total_C_mineralised(decay_rates):
- """Test that calculation of total C mineralised is as expected."""
- from virtual_ecosystem.core.constants import CoreConsts
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_total_C_mineralised,
- )
-
- expected_mineralisation = [0.0212182, 0.0274272, 0.00617274]
-
- actual_mineralisation = calculate_total_C_mineralised(
- decay_rates=decay_rates, model_constants=LitterConsts, core_constants=CoreConsts
- )
-
- assert np.allclose(actual_mineralisation, expected_mineralisation)
-
-
-def test_calculate_updated_pools(dummy_litter_data, decay_rates):
- """Test that the function to calculate the pool values after the update works."""
- from virtual_ecosystem.models.litter.litter_pools import calculate_updated_pools
-
- expected_pools = {
- "above_metabolic": [0.291759466, 0.147025527, 0.070837127],
- "above_structural": [0.501102522, 0.251269950, 0.091377105],
- "woody": [4.7042056, 11.802745, 7.3036710],
- "below_metabolic": [0.38828994, 0.34846022, 0.06801166],
- "below_structural": [0.60054236, 0.31054401, 0.02094207],
- }
-
- actual_pools = calculate_updated_pools(
- above_metabolic=dummy_litter_data["litter_pool_above_metabolic"].to_numpy(),
- above_structural=dummy_litter_data["litter_pool_above_structural"].to_numpy(),
- woody=dummy_litter_data["litter_pool_woody"].to_numpy(),
- below_metabolic=dummy_litter_data["litter_pool_below_metabolic"].to_numpy(),
- below_structural=dummy_litter_data["litter_pool_below_structural"].to_numpy(),
- decomposed_excrement=dummy_litter_data["decomposed_excrement"].to_numpy(),
- decomposed_carcasses=dummy_litter_data["decomposed_carcasses"].to_numpy(),
- decay_rates=decay_rates,
- update_interval=2.0,
- constants=LitterConsts,
- )
-
- for name in expected_pools.keys():
- assert np.allclose(actual_pools[name], expected_pools[name])
-
-
-def test_calculate_lignin_updates(dummy_litter_data):
- """Test that the function to calculate the lignin updates works as expected."""
- from virtual_ecosystem.models.litter.litter_pools import calculate_lignin_updates
-
- updated_pools = {
- "above_structural": np.array([0.501102522, 0.251269950, 0.091377105]),
- "woody": np.array([4.7042056, 11.802745, 7.3036710]),
- "below_structural": np.array([0.60054236, 0.31054401, 0.02094207]),
- }
-
- expected_lignin = {
- "above_structural": [-0.000717108, 0.0008580691, -0.007078589],
- "woody": [-0.0002198883, -0.0002191015, -3.5406852e-5],
- "below_structural": [-0.000479566, -0.000154567, -0.025212407],
- }
-
- actual_lignin = calculate_lignin_updates(
- lignin_above_structural=dummy_litter_data["lignin_above_structural"],
- lignin_woody=dummy_litter_data["lignin_woody"].to_numpy(),
- lignin_below_structural=dummy_litter_data["lignin_below_structural"].to_numpy(),
- updated_pools=updated_pools,
- update_interval=2.0,
- constants=LitterConsts,
- )
-
- for name in actual_lignin.keys():
- assert np.allclose(actual_lignin[name], expected_lignin[name])
-
-
-def test_calculate_litter_decay_metabolic_above(
- dummy_litter_data, temp_and_water_factors
-):
- """Test calculation of above ground metabolic litter decay."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_litter_decay_metabolic_above,
- )
-
- expected_decay = [0.00450883464, 0.00225441732, 0.00105206141]
-
- actual_decay = calculate_litter_decay_metabolic_above(
- temperature_factor=temp_and_water_factors["temp_above"],
- litter_pool_above_metabolic=dummy_litter_data["litter_pool_above_metabolic"],
- litter_decay_coefficient=LitterConsts.litter_decay_constant_metabolic_above,
- )
-
- assert np.allclose(actual_decay, expected_decay)
-
-
-def test_calculate_litter_decay_structural_above(
- dummy_litter_data, temp_and_water_factors
-):
- """Test calculation of above ground structural litter decay."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_litter_decay_structural_above,
- )
-
- expected_decay = [1.67429665e-4, 6.18573593e-4, 1.10869077e-5]
-
- actual_decay = calculate_litter_decay_structural_above(
- temperature_factor=temp_and_water_factors["temp_above"],
- litter_pool_above_structural=dummy_litter_data["litter_pool_above_structural"],
- lignin_proportion=dummy_litter_data["lignin_above_structural"],
- litter_decay_coefficient=LitterConsts.litter_decay_constant_structural_above,
- lignin_inhibition_factor=LitterConsts.lignin_inhibition_factor,
- )
-
- assert np.allclose(actual_decay, expected_decay)
-
-
-def test_calculate_litter_decay_woody(dummy_litter_data, temp_and_water_factors):
- """Test calculation of woody litter decay."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_litter_decay_woody,
- )
-
- expected_decay = [0.0004832, 0.00027069, 0.0015888]
-
- actual_decay = calculate_litter_decay_woody(
- temperature_factor=temp_and_water_factors["temp_above"],
- litter_pool_woody=dummy_litter_data["litter_pool_woody"],
- lignin_proportion=dummy_litter_data["lignin_woody"],
- litter_decay_coefficient=LitterConsts.litter_decay_constant_woody,
- lignin_inhibition_factor=LitterConsts.lignin_inhibition_factor,
- )
-
- assert np.allclose(actual_decay, expected_decay)
-
-
-def test_calculate_litter_decay_metabolic_below(
- dummy_litter_data, temp_and_water_factors
-):
- """Test calculation of below ground metabolic litter decay."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_litter_decay_metabolic_below,
- )
-
- expected_decay = [0.01092804, 0.00894564, 0.00135959]
-
- actual_decay = calculate_litter_decay_metabolic_below(
- temperature_factor=temp_and_water_factors["temp_below"],
- moisture_factor=temp_and_water_factors["water"],
- litter_pool_below_metabolic=dummy_litter_data["litter_pool_below_metabolic"],
- litter_decay_coefficient=LitterConsts.litter_decay_constant_metabolic_below,
- )
-
- assert np.allclose(actual_decay, expected_decay)
-
-
-def test_calculate_litter_decay_structural_below(
- dummy_litter_data, temp_and_water_factors
-):
- """Test calculation of below ground structural litter decay."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_litter_decay_structural_below,
- )
-
- expected_decay = [3.63659952e-04, 5.80365659e-04, 2.46907410e-06]
-
- actual_decay = calculate_litter_decay_structural_below(
- temperature_factor=temp_and_water_factors["temp_below"],
- moisture_factor=temp_and_water_factors["water"],
- litter_pool_below_structural=dummy_litter_data["litter_pool_below_structural"],
- lignin_proportion=dummy_litter_data["lignin_below_structural"],
- litter_decay_coefficient=LitterConsts.litter_decay_constant_structural_below,
- lignin_inhibition_factor=LitterConsts.lignin_inhibition_factor,
- )
-
- assert np.allclose(actual_decay, expected_decay)
-
-
-def test_calculate_carbon_mineralised():
- """Test that the calculation of litter decay mineralisation works as expected."""
- from virtual_ecosystem.models.litter.litter_pools import (
- calculate_carbon_mineralised,
- )
-
- litter_decay = np.array([0.000167429, 8.371483356e-5, 3.013734008e-5])
-
- expected_mineral = [7.534305e-5, 3.767167e-5, 1.356180e-5]
-
- actual_mineral = calculate_carbon_mineralised(
- litter_decay, LitterConsts.cue_metabolic
- )
-
- assert np.allclose(actual_mineral, expected_mineral)
-
-
-def test_calculate_change_in_lignin(dummy_litter_data):
- """Test that function to calculate lignin changes works properly."""
- from virtual_ecosystem.models.litter.litter_pools import calculate_change_in_lignin
-
- expected_lignin = [-0.008079787, -0.001949152, 0.0012328767]
-
- input_carbon = np.array([0.0775, 0.05, 0.0225])
- input_lignin = np.array([0.01, 0.34, 0.75])
-
- actual_lignin = calculate_change_in_lignin(
- input_carbon=input_carbon,
- updated_pool_carbon=dummy_litter_data["litter_pool_woody"].to_numpy(),
- input_lignin=input_lignin,
- old_pool_lignin=dummy_litter_data["lignin_woody"].to_numpy(),
- )
-
- assert np.allclose(actual_lignin, expected_lignin)
diff --git a/tests/models/plants/conftest.py b/tests/models/plants/conftest.py
index b8662b857..caf2c04b5 100644
--- a/tests/models/plants/conftest.py
+++ b/tests/models/plants/conftest.py
@@ -16,32 +16,44 @@ def flora(fixture_config):
@pytest.fixture
-def plants_data():
+def plants_data(fixture_core_components):
"""Construct a minimal data object with plant cohort data."""
from virtual_ecosystem.core.data import Data
- from virtual_ecosystem.core.grid import Grid
- from virtual_ecosystem.core.utils import set_layer_roles
- data = Data(grid=Grid(cell_ny=2, cell_nx=2))
+ data = Data(grid=fixture_core_components.grid)
+ n_cells = fixture_core_components.grid.n_cells
# Add cohort configuration
- data["plant_cohorts_n"] = DataArray(np.array([5] * 4))
- data["plant_cohorts_pft"] = DataArray(np.array(["broadleaf"] * 4))
- data["plant_cohorts_cell_id"] = DataArray(np.arange(4))
- data["plant_cohorts_dbh"] = DataArray(np.array([0.1] * 4))
+ data["plant_cohorts_n"] = DataArray(np.array([5] * n_cells))
+ data["plant_cohorts_pft"] = DataArray(np.array(["broadleaf"] * n_cells))
+ data["plant_cohorts_cell_id"] = DataArray(np.arange(n_cells))
+ data["plant_cohorts_dbh"] = DataArray(np.array([0.1] * n_cells))
# Spatio-temporal data
data["photosynthetic_photon_flux_density"] = DataArray(
- data=np.full((4, 12), fill_value=1000),
+ data=np.full((n_cells, 12), fill_value=1000),
coords={
- "cell_id": np.arange(4),
+ "cell_id": fixture_core_components.grid.cell_id,
"time_index": np.arange(12),
},
)
+ # TODO - This elevation data is created so that the PlantsModel.calculate_turnover
+ # function works in testing. Once that function has been replaced with something
+ # more realistic this should be deleted
+ data["elevation"] = DataArray(
+ data=np.full((n_cells), fill_value=437.5),
+ coords={
+ "cell_id": fixture_core_components.grid.cell_id,
+ },
+ )
+
# Canopy layer specific forcing variables from abiotic model
- layer_roles = set_layer_roles(10, [-0.25, -1.0])
- layer_shape = (len(layer_roles), data.grid.n_cells)
+ layer_roles = fixture_core_components.layer_structure.layer_roles
+ layer_shape = (
+ fixture_core_components.layer_structure.n_layers,
+ fixture_core_components.grid.n_cells,
+ )
# Setup the layers
forcing_vars = (
@@ -58,7 +70,7 @@ def plants_data():
coords={
"layers": np.arange(len(layer_roles)),
"layer_roles": ("layers", layer_roles),
- "cell_id": data.grid.cell_id,
+ "cell_id": fixture_core_components.grid.cell_id,
},
)
@@ -76,3 +88,49 @@ def fxt_plants_model(plants_data, flora, fixture_core_components):
core_components=fixture_core_components,
flora=flora,
)
+
+
+@pytest.fixture
+def fixture_canopy_layer_data(fixture_core_components):
+ """Shared canopy layer data.
+
+ The fixture supplies tuples of layer name, test values and the indices of the
+ vertical layer dimension to insert test values.
+
+ TODO: This is currently convoluted because of the way in which layer_heights is set
+ within the plants model.
+ """
+ lyr_strct = fixture_core_components.layer_structure
+
+ return {
+ "layer_heights_full": (
+ "layer_heights",
+ np.array([32, 30, 20, 10, 0.1, -0.5, -1]),
+ np.logical_or(lyr_strct.index_filled_atmosphere, lyr_strct.index_all_soil),
+ ),
+ "layer_heights_canopy": (
+ "layer_heights",
+ np.array([32, 30, 20, 10]),
+ np.logical_or(lyr_strct.index_above, lyr_strct.index_filled_canopy),
+ ),
+ "leaf_area_index": (
+ "leaf_area_index",
+ np.array([1, 1, 1]),
+ lyr_strct.index_filled_canopy,
+ ),
+ "layer_fapar": (
+ "layer_fapar",
+ np.array([0.4, 0.2, 0.1]),
+ lyr_strct.index_filled_canopy,
+ ),
+ "canopy_absorption": (
+ "canopy_absorption",
+ np.array([400, 200, 100, 300]),
+ np.logical_or(lyr_strct.index_filled_canopy, lyr_strct.index_surface),
+ ),
+ "layer_leaf_mass": (
+ "layer_leaf_mass",
+ np.array([10000, 10000, 10000]),
+ lyr_strct.index_filled_canopy,
+ ),
+ }
diff --git a/tests/models/plants/test_canopy.py b/tests/models/plants/test_canopy.py
index eb4312d03..e47417a83 100644
--- a/tests/models/plants/test_canopy.py
+++ b/tests/models/plants/test_canopy.py
@@ -105,16 +105,18 @@ def test_initialise_canopy_layers(plants_data, fixture_core_components):
"leaf_area_index",
"layer_fapar",
"layer_leaf_mass",
- "layer_absorbed_irradiation",
+ "canopy_absorption",
)
- n_layer = 1 + 10 + 2 + 2
- exp_shape = (n_layer, data.grid.n_cells)
+ exp_shape = (
+ fixture_core_components.layer_structure.n_layers,
+ fixture_core_components.grid.n_cells,
+ )
exp_dims = {
- "layers": (True, n_layer),
- "layer_roles": (False, n_layer),
- "cell_id": (True, data.grid.n_cells),
+ "layers": (True, fixture_core_components.layer_structure.n_layers),
+ "layer_roles": (False, fixture_core_components.layer_structure.n_layers),
+ "cell_id": (True, fixture_core_components.grid.n_cells),
}
# Check each layer is i) in the data object, ii) has the right shape, iii) has the
@@ -133,7 +135,7 @@ def test_initialise_canopy_layers(plants_data, fixture_core_components):
# Specifically for layer heights, check that the fixed layer heights are as expected
assert np.allclose(
- data["layer_heights"].mean(dim="cell_id").to_numpy(),
- np.array([np.nan] * 11 + [1.5, 0.1, -0.25, -1.0]),
+ data["layer_heights"].to_numpy(),
+ np.tile(np.array([[np.nan] * 11 + [0.1, -0.5, -1.0]]).T, 4),
equal_nan=True,
)
diff --git a/tests/models/plants/test_plants_model.py b/tests/models/plants/test_plants_model.py
index 4c41dc19e..07ea45613 100644
--- a/tests/models/plants/test_plants_model.py
+++ b/tests/models/plants/test_plants_model.py
@@ -1,11 +1,14 @@
"""Tests for the model.plants.plants_model submodule."""
import numpy as np
+import xarray
# TODO: A lot of duplication in these tests, work out how to share code to make it DRYer
-def test_PlantsModel__init__(plants_data, flora, fixture_core_components):
+def test_PlantsModel__init__(
+ plants_data, flora, fixture_core_components, fixture_canopy_layer_data
+):
"""Test the PlantsModel.__init__ method."""
from virtual_ecosystem.models.plants.plants_model import PlantsModel
@@ -17,23 +20,26 @@ def test_PlantsModel__init__(plants_data, flora, fixture_core_components):
)
# Test the flora and community are as expected
+ n_cells = fixture_core_components.grid.n_cells
assert len(plants_model.flora) == len(flora)
- assert len(plants_model.communities) == plants_data.grid.n_cells
+ assert len(plants_model.communities) == n_cells
- # Check the canopy has been initialised and updated with some simple test sums
- expected_layers = [
- ("layer_heights", (32 + 30 + 20 + 10 + 1.5 + 0.1 - 0.25 - 1) * 4),
- ("leaf_area_index", 3 * 4),
- ("layer_fapar", (0.4 + 0.2 + 0.1) * 4),
- ("layer_absorbed_irradiation", 1000 * 4),
- ]
+ # Check the canopy has been initialised and updated, using the full layer heights
+ # data
+ # TODO - amend this as and when layer heights gets centralised
+ del fixture_canopy_layer_data["layer_heights_canopy"]
+ del fixture_canopy_layer_data["layer_leaf_mass"]
- for layer_name, layer_sum in expected_layers:
+ for layer_name, layer_vals, layer_indices in fixture_canopy_layer_data.values():
assert layer_name in plants_data
- assert np.allclose(plants_data[layer_name].sum(), layer_sum)
+ expected = fixture_core_components.layer_structure.from_template()
+ expected[layer_indices] = layer_vals[:, None]
+ xarray.testing.assert_allclose(plants_data[layer_name], expected)
-def test_PlantsModel_from_config(plants_data, fixture_config, fixture_core_components):
+def test_PlantsModel_from_config(
+ plants_data, fixture_config, fixture_core_components, fixture_canopy_layer_data
+):
"""Test the PlantsModel.from_config factory method."""
from virtual_ecosystem.models.plants.plants_model import PlantsModel
@@ -43,101 +49,119 @@ def test_PlantsModel_from_config(plants_data, fixture_config, fixture_core_compo
)
# Currently trivial test.
+ n_cells = fixture_core_components.grid.n_cells
assert isinstance(plants_model, PlantsModel)
- assert len(plants_model.communities) == plants_data.grid.n_cells
-
- # Check the canopy has been initialised and updated with some simple test sums
- expected_layers = (
- ("layer_heights", (32 + 30 + 20 + 10 + 1.5 + 0.1 - 0.25 - 1) * 4),
- ("leaf_area_index", 3 * 4),
- ("layer_fapar", (0.4 + 0.2 + 0.1) * 4),
- ("layer_absorbed_irradiation", 1000 * 4),
- )
+ assert len(plants_model.communities) == n_cells
+
+ # Check the canopy has been initialised and updated, using the full layer heights
+ # data
+ # TODO - amend this as and when layer heights gets centralised
+ del fixture_canopy_layer_data["layer_heights_canopy"]
+ del fixture_canopy_layer_data["layer_leaf_mass"]
- for layer_name, layer_sum in expected_layers:
+ for layer_name, layer_vals, layer_indices in fixture_canopy_layer_data.values():
assert layer_name in plants_data
- assert np.allclose(plants_data[layer_name].sum(), layer_sum)
+ expected = fixture_core_components.layer_structure.from_template()
+ expected[layer_indices] = layer_vals[:, None]
+ xarray.testing.assert_allclose(plants_data[layer_name], expected)
-def test_PlantsModel_update_canopy_layers(fxt_plants_model):
+def test_PlantsModel_update_canopy_layers(
+ fixture_core_components, fxt_plants_model, fixture_canopy_layer_data
+):
"""Simple test that update canopy layers restores overwritten data."""
- expected_layers = (
- ("layer_heights", (32 + 30 + 20 + 10) * 4),
- ("leaf_area_index", 3 * 4),
- ("layer_fapar", (0.4 + 0.2 + 0.1) * 4),
- ("layer_absorbed_irradiation", 0), # Note that this layer should not be updated
- )
+ from_template = fixture_core_components.layer_structure.from_template
- # Overwrite the existing data in each layer
- for layer, _ in expected_layers:
- fxt_plants_model.data[layer][:] = np.full_like(
- fxt_plants_model.data[layer].data, fill_value=np.nan
- )
+ # Overwrite the existing canopy derived data in each layer - this also nukes the
+ # soil and surface depths _which_ are not correctly regenerated in this test, so the
+ # test makes use of the canopy only layer heights in the fixture_canopy_layer_data
+ #
+ # TODO - amend this as and when layer heights gets centralised
+ del fixture_canopy_layer_data["layer_heights_full"]
+ del fixture_canopy_layer_data["layer_leaf_mass"]
- # Check that calling the method resets to the expected values
+ for layer, _, _ in fixture_canopy_layer_data.values():
+ fxt_plants_model.data[layer] = from_template()
+
+ # Calling the method resets to the expected values
fxt_plants_model.update_canopy_layers()
- for layer, value in expected_layers:
- assert np.allclose(fxt_plants_model.data[layer].sum(), value)
+ # Check the resulting repopulated canopy data, but omitting the
+ # canopy_absorption, which should not have been regenerated yet
+ del fixture_canopy_layer_data["canopy_absorption"]
+ for layer_name, layer_vals, layer_indices in fixture_canopy_layer_data.values():
+ expected = from_template()
+ expected[layer_indices] = layer_vals[:, None]
+ xarray.testing.assert_allclose(fxt_plants_model.data[layer_name], expected)
+
+ # Check canopy_absorption is indeed still empty
+ xarray.testing.assert_allclose(
+ fxt_plants_model.data["canopy_absorption"], from_template()
+ )
-def test_PlantsModel_set_absorbed_irradiance(fxt_plants_model):
+def test_PlantsModel_set_canopy_absorption(
+ fxt_plants_model, fixture_core_components, fixture_canopy_layer_data
+):
"""Simple test that update canopy layers restores overwritten data."""
- expected_layers = (
- ("layer_heights", (32 + 30 + 20 + 10) * 4),
- ("leaf_area_index", 3 * 4),
- ("layer_fapar", (0.4 + 0.2 + 0.1) * 4),
- ("layer_absorbed_irradiation", 1000 * 4), # Is restored by additional call.
- )
- # Overwrite the existing data in each layer
- for layer, _ in expected_layers:
- fxt_plants_model.data[layer][:] = np.full_like(
- fxt_plants_model.data[layer].data, fill_value=np.nan
- )
+ from_template = fixture_core_components.layer_structure.from_template
+
+ # Overwrite the existing canopy derived data in each layer - this also nukes the
+ # soil and surface depths _which_ are not correctly regenerated in this test, so the
+ # test makes use of the canopy only layer heights in the fixture_canopy_layer_data
+ #
+ # TODO - amend this as and when layer heights gets centralised
+ del fixture_canopy_layer_data["layer_heights_full"]
+ del fixture_canopy_layer_data["layer_leaf_mass"]
+
+ for layer, _, _ in fixture_canopy_layer_data.values():
+ fxt_plants_model.data[layer] = from_template()
# Check that calling the method after update resets to the expected values
fxt_plants_model.update_canopy_layers()
- fxt_plants_model.set_absorbed_irradiance(time_index=0)
+ fxt_plants_model.set_canopy_absorption(time_index=0)
- for layer, value in expected_layers:
- assert np.allclose(fxt_plants_model.data[layer].sum(), value)
+ for layer_name, layer_vals, layer_indices in fixture_canopy_layer_data.values():
+ expected = from_template()
+ expected[layer_indices] = layer_vals[:, None]
+ xarray.testing.assert_allclose(fxt_plants_model.data[layer_name], expected)
-def test_PlantsModel_estimate_gpp(fxt_plants_model):
+def test_PlantsModel_estimate_gpp(fxt_plants_model, fixture_core_components):
"""Test the estimate_gpp method."""
+ lyr_str = fixture_core_components.layer_structure
+
# Set the canopy and absorbed irradiance
fxt_plants_model.update_canopy_layers()
- fxt_plants_model.set_absorbed_irradiance(time_index=0)
+ fxt_plants_model.set_canopy_absorption(time_index=0)
# Calculate GPP
fxt_plants_model.estimate_gpp(time_index=0)
- # Check calculate quantities - this is currently very basic.
+ # Check calculated quantities - this is currently very basic.
# - Light use efficiency: currently asserted fixed value
- exp_lue = np.full((15, 4), fill_value=np.nan)
- exp_lue[1:4, :] = 0.3
- assert np.allclose(
- fxt_plants_model.data["layer_light_use_efficiency"].to_numpy(),
+ exp_lue = lyr_str.from_template()
+ exp_lue[lyr_str.index_filled_canopy] = 0.3
+ xarray.testing.assert_allclose(
+ fxt_plants_model.data["layer_light_use_efficiency"],
exp_lue,
- equal_nan=True,
)
# Same for evapotranspiration
- exp_evapo = np.full((15, 4), fill_value=np.nan)
- exp_evapo[1:4, :] = 20
- assert np.allclose(
- fxt_plants_model.data["evapotranspiration"].to_numpy(),
+ exp_evapo = lyr_str.from_template()
+ exp_evapo[lyr_str.index_filled_canopy] = 20
+ xarray.testing.assert_allclose(
+ fxt_plants_model.data["evapotranspiration"],
exp_evapo,
- equal_nan=True,
)
# - Canopy fapar to expected gpp per m2
- exp_fapar = np.full((15, 1), fill_value=np.nan)
- exp_fapar[[1, 2, 3, 12]] = [[0.4], [0.2], [0.1], [0.3]]
+ exp_fapar = lyr_str.from_template()
+ exp_fapar[lyr_str.index_flux_layers] = [[0.4], [0.2], [0.1], [0.3]]
exp_gpp_per_m2 = exp_lue * 1000 * exp_fapar
assert np.allclose(
@@ -154,34 +178,58 @@ def test_PlantsModel_estimate_gpp(fxt_plants_model):
)
-def test_PlantsModel_update(fxt_plants_model):
+def test_PlantsModel_update(
+ fxt_plants_model, fixture_core_components, fixture_canopy_layer_data
+):
"""Test the update method."""
- # The update method runs both update_canopy_layers and set_absorbed_irradiance so
+ # The update method runs both update_canopy_layers and set_canopy_absorption so
# should restore all of the layers below.
- expected_layers = (
- ("layer_heights", (32 + 30 + 20 + 10) * 4),
- ("leaf_area_index", 3 * 4),
- ("layer_fapar", (0.4 + 0.2 + 0.1) * 4),
- ("layer_leaf_mass", 30000 * 4),
- ("layer_absorbed_irradiation", 1000 * 4),
- )
+ # TODO - amend this as and when layer heights gets centralised
+ del fixture_canopy_layer_data["layer_heights_full"]
- # Overwrite the existing data in each layer
- for layer, _ in expected_layers:
- fxt_plants_model.data[layer][:] = np.full_like(
- fxt_plants_model.data[layer].data, fill_value=np.nan
- )
+ from_template = fixture_core_components.layer_structure.from_template
+
+ for layer, _, _ in fixture_canopy_layer_data.values():
+ fxt_plants_model.data[layer] = from_template()
# Check reset
fxt_plants_model.update(time_index=0)
- # Check the canopy has been initialised and updated with some simple test sums
- for layer, value in expected_layers:
- assert np.allclose(fxt_plants_model.data[layer].sum(), value)
+ # Check the canopy has been initialised and updated
+ for layer_name, layer_vals, layer_indices in fixture_canopy_layer_data.values():
+ expected = from_template()
+ expected[layer_indices] = layer_vals[:, None]
+ xarray.testing.assert_allclose(fxt_plants_model.data[layer_name], expected)
# Check the growth of the cohorts
for community in fxt_plants_model.communities.values():
for cohort in community:
# Original 0.1 + 0.03 cm from current arbitrary increment
assert np.allclose(cohort.dbh, 0.13)
+
+
+def test_PlantsModel_calculate_turnover(fxt_plants_model, fixture_core_components):
+ """Test the calculate_turnover method of the plants model."""
+
+ # Check reset
+ fxt_plants_model.calculate_turnover()
+
+ # Check that all expected variables are generated and have the correct value
+ assert np.allclose(fxt_plants_model.data["deadwood_production"], 0.075)
+ assert np.allclose(fxt_plants_model.data["leaf_turnover"], 0.027)
+ assert np.allclose(
+ fxt_plants_model.data["plant_reproductive_tissue_turnover"], 0.003
+ )
+ assert np.allclose(fxt_plants_model.data["root_turnover"], 0.027)
+ assert np.allclose(fxt_plants_model.data["deadwood_lignin"], 0.545)
+ assert np.allclose(fxt_plants_model.data["leaf_turnover_lignin"], 0.05)
+ assert np.allclose(
+ fxt_plants_model.data["plant_reproductive_tissue_turnover_lignin"], 0.01
+ )
+ assert np.allclose(fxt_plants_model.data["root_turnover_lignin"], 0.2)
+ assert np.allclose(fxt_plants_model.data["leaf_turnover_c_n_ratio"], 25.5)
+ assert np.allclose(
+ fxt_plants_model.data["plant_reproductive_tissue_turnover_c_n_ratio"], 12.5
+ )
+ assert np.allclose(fxt_plants_model.data["root_turnover_c_n_ratio"], 45.6)
diff --git a/tests/models/soil/conftest.py b/tests/models/soil/conftest.py
index 75dff6e43..1c70e99c4 100644
--- a/tests/models/soil/conftest.py
+++ b/tests/models/soil/conftest.py
@@ -2,6 +2,8 @@
import pytest
+from virtual_ecosystem.models.soil.env_factors import EnvironmentalEffectFactors
+
@pytest.fixture
def fixture_soil_config():
@@ -36,12 +38,11 @@ def fixture_soil_model(
@pytest.fixture
-def environmental_factors(dummy_carbon_data, top_soil_layer_index):
+def environmental_factors(dummy_carbon_data, fixture_core_components):
"""Environmental factors based on dummy carbon data."""
from virtual_ecosystem.models.soil.constants import SoilConsts
from virtual_ecosystem.models.soil.env_factors import (
calculate_clay_impact_on_enzyme_saturation,
- calculate_clay_impact_on_necromass_decay,
calculate_pH_suitability,
calculate_water_potential_impact_on_microbes,
)
@@ -50,7 +51,7 @@ def environmental_factors(dummy_carbon_data, top_soil_layer_index):
water_factors = calculate_water_potential_impact_on_microbes(
water_potential=dummy_carbon_data["matric_potential"][
- top_soil_layer_index
+ fixture_core_components.layer_structure.index_topsoil_scalar
].to_numpy(),
water_potential_halt=soil_constants.soil_microbe_water_potential_halt,
water_potential_opt=soil_constants.soil_microbe_water_potential_optimum,
@@ -71,14 +72,6 @@ def environmental_factors(dummy_carbon_data, top_soil_layer_index):
protection_with_clay=soil_constants.soil_protection_with_clay,
)
- clay_decay_factors = calculate_clay_impact_on_necromass_decay(
- clay_fraction=dummy_carbon_data["clay_fraction"].to_numpy(),
- decay_exponent=soil_constants.clay_necromass_decay_exponent,
+ return EnvironmentalEffectFactors(
+ water=water_factors, pH=pH_factors, clay_saturation=clay_saturation_factors
)
-
- return {
- "water": water_factors,
- "pH": pH_factors,
- "clay_saturation": clay_saturation_factors,
- "clay_decay": clay_decay_factors,
- }
diff --git a/tests/models/soil/test_carbon.py b/tests/models/soil/test_carbon.py
index 9354e2d7f..76f5a81c2 100644
--- a/tests/models/soil/test_carbon.py
+++ b/tests/models/soil/test_carbon.py
@@ -9,16 +9,17 @@
from virtual_ecosystem.models.soil.constants import SoilConsts
-def test_calculate_soil_carbon_updates(dummy_carbon_data, top_soil_layer_index):
+def test_calculate_soil_carbon_updates(dummy_carbon_data, fixture_core_components):
"""Test that the two pool update functions work correctly."""
from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.models.soil.carbon import calculate_soil_carbon_updates
change_in_pools = {
- "soil_c_pool_lmwc": [-0.00371115, 0.00278502, -0.01849181, 0.00089995],
- "soil_c_pool_maom": [-1.28996257e-3, 2.35822401e-3, 1.5570399e-3, 1.2082886e-5],
+ "soil_c_pool_lmwc": [0.0022585928, 0.0060483065, -0.019175058, 0.024247214],
+ "soil_c_pool_maom": [0.038767651, 0.00829848, 0.05982197, 0.07277182],
"soil_c_pool_microbe": [-0.04978105, -0.02020101, -0.10280967, -0.00719517],
- "soil_c_pool_pom": [0.04809165, 0.01023544, 0.07853728, 0.01167564],
+ "soil_c_pool_pom": [0.00178122, -0.00785937, -0.01201551, 0.00545857],
+ "soil_c_pool_necromass": [0.001137474, 0.009172067, 0.033573266, -0.08978050],
"soil_enzyme_pom": [1.18e-8, 1.67e-8, 1.8e-9, -1.12e-8],
"soil_enzyme_maom": [-0.00031009, -5.09593e-5, 0.0005990658, -3.72112e-5],
}
@@ -33,18 +34,21 @@ def test_calculate_soil_carbon_updates(dummy_carbon_data, top_soil_layer_index):
soil_c_pool_maom=dummy_carbon_data["soil_c_pool_maom"].to_numpy(),
soil_c_pool_microbe=dummy_carbon_data["soil_c_pool_microbe"].to_numpy(),
soil_c_pool_pom=dummy_carbon_data["soil_c_pool_pom"].to_numpy(),
+ soil_c_pool_necromass=dummy_carbon_data["soil_c_pool_necromass"].to_numpy(),
soil_enzyme_pom=dummy_carbon_data["soil_enzyme_pom"].to_numpy(),
soil_enzyme_maom=dummy_carbon_data["soil_enzyme_maom"].to_numpy(),
pH=dummy_carbon_data["pH"],
bulk_density=dummy_carbon_data["bulk_density"],
soil_moisture=dummy_carbon_data["soil_moisture"][
- top_soil_layer_index
+ fixture_core_components.layer_structure.index_topsoil_scalar
].to_numpy(),
soil_water_potential=dummy_carbon_data["matric_potential"][
- top_soil_layer_index
+ fixture_core_components.layer_structure.index_topsoil_scalar
].to_numpy(),
vertical_flow_rate=dummy_carbon_data["vertical_flow"],
- soil_temp=dummy_carbon_data["soil_temperature"][top_soil_layer_index],
+ soil_temp=dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
clay_fraction=dummy_carbon_data["clay_fraction"],
mineralisation_rate=dummy_carbon_data["litter_C_mineralisation_rate"],
delta_pools_ordered=pool_order,
@@ -58,45 +62,90 @@ def test_calculate_soil_carbon_updates(dummy_carbon_data, top_soil_layer_index):
assert np.allclose(delta_pools[i * 4 : (i + 1) * 4], change_in_pools[pool])
-def test_determine_microbial_biomass_losses(
- dummy_carbon_data, top_soil_layer_index, environmental_factors
+def test_calculate_microbial_changes(
+ dummy_carbon_data, fixture_core_components, environmental_factors
):
- """Check that the determination of microbial biomass losses works correctly."""
- from virtual_ecosystem.models.soil.carbon import determine_microbial_biomass_losses
+ """Check that calculation of microbe related changes works correctly."""
+
+ from virtual_ecosystem.models.soil.carbon import calculate_microbial_changes
- expected_maintenance = [0.05443078, 0.02298407, 0.12012258, 0.00722288]
- expected_pom_enzyme = [0.0005443078, 0.0002298407, 0.0012012258, 7.22288e-5]
- expected_maom_enzyme = [0.0005443078, 0.0002298407, 0.0012012258, 7.22288e-5]
- expected_decay_to_pom = [0.04631043, 0.01809481, 0.09055279, 0.00621707]
- expected_decay_to_lmwc = [0.007031729, 0.004429577, 0.027167343, 8.613595e-4]
+ expected_lmwc_uptake = [1.29159055e-2, 8.43352433e-3, 5.77096991e-2, 5.77363558e-5]
+ expected_microbe = [-0.04978105, -0.02020101, -0.10280967, -0.00719517]
+ expected_pom_enzyme = [1.17571917e-8, 1.67442231e-8, 1.83311362e-9, -1.11675865e-8]
+ expected_maom_enzyme = [-3.1009224e-4, -5.0959256e-5, 5.9906583e-4, -3.7211168e-5]
+ expected_necromass = [0.05474086, 0.02303502, 0.11952352, 0.00726011]
- losses = determine_microbial_biomass_losses(
+ mic_changes = calculate_microbial_changes(
+ soil_c_pool_lmwc=dummy_carbon_data["soil_c_pool_lmwc"],
soil_c_pool_microbe=dummy_carbon_data["soil_c_pool_microbe"],
- soil_temp=dummy_carbon_data["soil_temperature"][top_soil_layer_index],
- clay_factor_decay=environmental_factors["clay_decay"],
+ soil_enzyme_pom=dummy_carbon_data["soil_enzyme_pom"],
+ soil_enzyme_maom=dummy_carbon_data["soil_enzyme_maom"],
+ soil_temp=dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ env_factors=environmental_factors,
constants=SoilConsts,
)
# Check that each rate matches expectation
- assert np.allclose(losses.maintenance_synthesis, expected_maintenance)
- assert np.allclose(losses.pom_enzyme_production, expected_pom_enzyme)
- assert np.allclose(losses.maom_enzyme_production, expected_maom_enzyme)
- assert np.allclose(losses.necromass_decay_to_lmwc, expected_decay_to_lmwc)
- assert np.allclose(losses.necromass_decay_to_pom, expected_decay_to_pom)
-
- # Then check that sum of other rates is the same as the overall
- # maintenance_synthesis rate
- assert np.allclose(
- losses.maintenance_synthesis,
- losses.pom_enzyme_production
- + losses.maom_enzyme_production
- + losses.necromass_decay_to_lmwc
- + losses.necromass_decay_to_pom,
+ assert np.allclose(mic_changes.lmwc_uptake, expected_lmwc_uptake)
+ assert np.allclose(mic_changes.microbe_change, expected_microbe)
+ assert np.allclose(mic_changes.pom_enzyme_change, expected_pom_enzyme)
+ assert np.allclose(mic_changes.maom_enzyme_change, expected_maom_enzyme)
+ assert np.allclose(mic_changes.necromass_generation, expected_necromass)
+
+
+def test_calculate_enzyme_mediated_rates(
+ dummy_carbon_data, environmental_factors, fixture_core_components
+):
+ """Check that calculation of enzyme mediated rates works as expected."""
+
+ from virtual_ecosystem.models.soil.carbon import calculate_enzyme_mediated_rates
+
+ expected_pom_to_lmwc = [3.39844565e-4, 8.91990315e-3, 1.25055119e-2, 4.14247999e-5]
+ expected_maom_to_lmwc = [1.45988485e-3, 2.10172756e-3, 4.69571604e-3, 8.62951373e-6]
+
+ actual_rates = calculate_enzyme_mediated_rates(
+ soil_enzyme_pom=dummy_carbon_data["soil_enzyme_pom"],
+ soil_enzyme_maom=dummy_carbon_data["soil_enzyme_maom"],
+ soil_c_pool_pom=dummy_carbon_data["soil_c_pool_pom"],
+ soil_c_pool_maom=dummy_carbon_data["soil_c_pool_maom"],
+ soil_temp=dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ env_factors=environmental_factors,
+ constants=SoilConsts,
)
+ assert np.allclose(actual_rates.pom_to_lmwc, expected_pom_to_lmwc)
+ assert np.allclose(actual_rates.maom_to_lmwc, expected_maom_to_lmwc)
+
+
+def test_calculate_enzyme_changes(dummy_carbon_data):
+ """Check that the determination of enzyme pool changes works correctly."""
+
+ from virtual_ecosystem.models.soil.carbon import calculate_enzyme_changes
+
+ biomass_loss = np.array([0.05443078, 0.02298407, 0.12012258, 0.00722288])
+
+ expected_pom = [1.17571917e-8, 1.67442231e-8, 1.83311362e-9, -1.11675865e-8]
+ expected_maom = [-3.10092243e-4, -5.09592558e-5, 5.99065833e-4, -3.72111676e-5]
+ expected_denat = [0.0013987, 0.00051062, 0.00180338, 0.00018168]
+
+ actual_pom, actual_maom, actual_denat = calculate_enzyme_changes(
+ soil_enzyme_pom=dummy_carbon_data["soil_enzyme_pom"],
+ soil_enzyme_maom=dummy_carbon_data["soil_enzyme_maom"],
+ biomass_loss=biomass_loss,
+ constants=SoilConsts,
+ )
+
+ assert np.allclose(actual_pom, expected_pom)
+ assert np.allclose(actual_maom, expected_maom)
+ assert np.allclose(actual_denat, expected_denat)
+
def test_calculate_maintenance_biomass_synthesis(
- dummy_carbon_data, top_soil_layer_index
+ dummy_carbon_data, fixture_core_components
):
"""Check maintenance respiration cost calculates correctly."""
from virtual_ecosystem.models.soil.carbon import (
@@ -107,21 +156,25 @@ def test_calculate_maintenance_biomass_synthesis(
actual_loss = calculate_maintenance_biomass_synthesis(
soil_c_pool_microbe=dummy_carbon_data["soil_c_pool_microbe"],
- soil_temp=dummy_carbon_data["soil_temperature"][top_soil_layer_index],
+ soil_temp=dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
constants=SoilConsts,
)
assert np.allclose(actual_loss, expected_loss)
-def test_calculate_carbon_use_efficiency(dummy_carbon_data, top_soil_layer_index):
+def test_calculate_carbon_use_efficiency(dummy_carbon_data, fixture_core_components):
"""Check carbon use efficiency calculates correctly."""
from virtual_ecosystem.models.soil.carbon import calculate_carbon_use_efficiency
expected_cues = [0.36, 0.33, 0.3, 0.48]
actual_cues = calculate_carbon_use_efficiency(
- dummy_carbon_data["soil_temperature"][top_soil_layer_index],
+ dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
SoilConsts.reference_cue,
SoilConsts.cue_reference_temp,
SoilConsts.cue_with_temperature,
@@ -159,7 +212,7 @@ def test_calculate_enzyme_turnover(dummy_carbon_data, turnover, expected_decay):
def test_calculate_microbial_carbon_uptake(
- dummy_carbon_data, top_soil_layer_index, environmental_factors
+ dummy_carbon_data, fixture_core_components, environmental_factors
):
"""Check microbial carbon uptake calculates correctly."""
from virtual_ecosystem.models.soil.carbon import calculate_microbial_carbon_uptake
@@ -170,10 +223,10 @@ def test_calculate_microbial_carbon_uptake(
actual_uptake, actual_assimilation = calculate_microbial_carbon_uptake(
soil_c_pool_lmwc=dummy_carbon_data["soil_c_pool_lmwc"],
soil_c_pool_microbe=dummy_carbon_data["soil_c_pool_microbe"],
- water_factor=environmental_factors["water"],
- pH_factor=environmental_factors["pH"],
+ water_factor=environmental_factors.water,
+ pH_factor=environmental_factors.pH,
soil_temp=dummy_carbon_data["soil_temperature"][
- top_soil_layer_index
+ fixture_core_components.layer_structure.index_topsoil_scalar
].to_numpy(),
constants=SoilConsts,
)
@@ -183,7 +236,7 @@ def test_calculate_microbial_carbon_uptake(
def test_calculate_enzyme_mediated_decomposition(
- dummy_carbon_data, top_soil_layer_index, environmental_factors
+ dummy_carbon_data, fixture_core_components, environmental_factors
):
"""Check that particulate organic matter decomposition is calculated correctly."""
from virtual_ecosystem.models.soil.carbon import (
@@ -195,10 +248,10 @@ def test_calculate_enzyme_mediated_decomposition(
actual_decomp = calculate_enzyme_mediated_decomposition(
soil_c_pool=dummy_carbon_data["soil_c_pool_pom"],
soil_enzyme=dummy_carbon_data["soil_enzyme_pom"],
- water_factor=environmental_factors["water"],
- pH_factor=environmental_factors["pH"],
- clay_factor_saturation=environmental_factors["clay_saturation"],
- soil_temp=dummy_carbon_data["soil_temperature"][top_soil_layer_index],
+ soil_temp=dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ env_factors=environmental_factors,
reference_temp=SoilConsts.arrhenius_reference_temp,
max_decomp_rate=SoilConsts.max_decomp_rate_pom,
activation_energy_rate=SoilConsts.activation_energy_pom_decomp_rate,
@@ -207,3 +260,63 @@ def test_calculate_enzyme_mediated_decomposition(
)
assert np.allclose(actual_decomp, expected_decomp)
+
+
+def test_calculate_maom_desorption(dummy_carbon_data):
+ """Check that mineral associated matter desorption is calculated correctly."""
+
+ from virtual_ecosystem.models.soil.carbon import calculate_maom_desorption
+
+ expected_desorption = [2.5e-5, 1.7e-5, 4.5e-5, 5.0e-6]
+
+ actual_desorption = calculate_maom_desorption(
+ soil_c_pool_maom=dummy_carbon_data["soil_c_pool_maom"],
+ desorption_rate_constant=SoilConsts.maom_desorption_rate,
+ )
+
+ assert np.allclose(actual_desorption, expected_desorption)
+
+
+@pytest.mark.parametrize(
+ "pool_name,sorption_rate_constant,expected_sorption",
+ [
+ (
+ "soil_c_pool_lmwc",
+ SoilConsts.lmwc_sorption_rate,
+ [5.0e-5, 2.0e-5, 0.0001, 5.0e-6],
+ ),
+ (
+ "soil_c_pool_necromass",
+ SoilConsts.necromass_sorption_rate,
+ [0.04020253647, 0.01039720771, 0.06446268779, 0.07278045396],
+ ),
+ ],
+)
+def test_calculate_sorption_to_maom(
+ dummy_carbon_data, pool_name, sorption_rate_constant, expected_sorption
+):
+ """Check that sorption to mineral associated matter is calculated correctly."""
+
+ from virtual_ecosystem.models.soil.carbon import calculate_sorption_to_maom
+
+ actual_sorption = calculate_sorption_to_maom(
+ soil_c_pool=dummy_carbon_data[pool_name],
+ sorption_rate_constant=sorption_rate_constant,
+ )
+
+ assert np.allclose(actual_sorption, expected_sorption)
+
+
+def test_calculate_necromass_breakdown(dummy_carbon_data):
+ """Check that necromass breakdown to lmwc is calculated correctly."""
+
+ from virtual_ecosystem.models.soil.carbon import calculate_necromass_breakdown
+
+ expected_breakdown = [0.0134008455, 0.0034657359, 0.0214875626, 0.0242601513]
+
+ actual_breakdown = calculate_necromass_breakdown(
+ soil_c_pool_necromass=dummy_carbon_data["soil_c_pool_necromass"],
+ necromass_decay_rate=SoilConsts.necromass_decay_rate,
+ )
+
+ assert np.allclose(actual_breakdown, expected_breakdown)
diff --git a/tests/models/soil/test_env_factors.py b/tests/models/soil/test_env_factors.py
index 764e28d95..28bfc5dda 100644
--- a/tests/models/soil/test_env_factors.py
+++ b/tests/models/soil/test_env_factors.py
@@ -7,23 +7,28 @@
import pytest
-def test_top_soil_data_extraction(dummy_carbon_data, top_soil_layer_index):
+def test_top_soil_data_extraction(dummy_carbon_data, fixture_core_components):
"""Test that top soil data can be extracted from the data object correctly."""
top_soil_temps = [35.0, 37.5, 40.0, 25.0]
top_soil_water_potentials = [-3.0, -10.0, -250.0, -10000.0]
assert np.allclose(
- dummy_carbon_data["soil_temperature"][top_soil_layer_index], top_soil_temps
+ dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
+ top_soil_temps,
)
assert np.allclose(
- dummy_carbon_data["matric_potential"][top_soil_layer_index],
+ dummy_carbon_data["matric_potential"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
top_soil_water_potentials,
)
def test_calculate_environmental_effect_factors(
- dummy_carbon_data, top_soil_layer_index
+ dummy_carbon_data, fixture_core_components
):
"""Test that function to calculate all set of environmental factors works."""
from virtual_ecosystem.models.soil.constants import SoilConsts
@@ -34,11 +39,10 @@ def test_calculate_environmental_effect_factors(
expected_water = [1.0, 0.94414168, 0.62176357, 0.07747536]
expected_pH = [0.25, 1.0, 0.428571428, 1.0]
expected_clay_sat = [1.782, 1.102, 0.83, 1.918]
- expected_clay_decay = [0.52729242, 0.78662786, 0.92311634, 0.48675225]
env_factors = calculate_environmental_effect_factors(
soil_water_potential=dummy_carbon_data["matric_potential"][
- top_soil_layer_index
+ fixture_core_components.layer_structure.index_topsoil_scalar
],
pH=dummy_carbon_data["pH"],
clay_fraction=dummy_carbon_data["clay_fraction"],
@@ -48,7 +52,6 @@ def test_calculate_environmental_effect_factors(
assert np.allclose(env_factors.water, expected_water)
assert np.allclose(env_factors.pH, expected_pH)
assert np.allclose(env_factors.clay_saturation, expected_clay_sat)
- assert np.allclose(env_factors.clay_decay, expected_clay_decay)
@pytest.mark.parametrize(
@@ -60,7 +63,7 @@ def test_calculate_environmental_effect_factors(
],
)
def calculate_temperature_effect_on_microbes(
- dummy_carbon_data, top_soil_layer_index, activation_energy, expected_factors
+ dummy_carbon_data, fixture_core_components, activation_energy, expected_factors
):
"""Test function to calculate microbial temperature response."""
from virtual_ecosystem.models.soil.constants import SoilConsts
@@ -69,7 +72,9 @@ def calculate_temperature_effect_on_microbes(
)
actual_factors = calculate_temperature_effect_on_microbes(
- soil_temperature=dummy_carbon_data["soil_temperature"][top_soil_layer_index],
+ soil_temperature=dummy_carbon_data["soil_temperature"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
activation_energy=activation_energy,
reference_temperature=SoilConsts.arrhenius_reference_temp,
gas_constant=SoilConsts.universal_gas_constant,
@@ -79,7 +84,7 @@ def calculate_temperature_effect_on_microbes(
def test_calculate_water_potential_impact_on_microbes(
- dummy_carbon_data, top_soil_layer_index
+ dummy_carbon_data, fixture_core_components
):
"""Test the calculation of the impact of soil water on microbial rates."""
from virtual_ecosystem.models.soil.constants import SoilConsts
@@ -90,7 +95,9 @@ def test_calculate_water_potential_impact_on_microbes(
expected_factor = [1.0, 0.94414168, 0.62176357, 0.07747536]
actual_factor = calculate_water_potential_impact_on_microbes(
- water_potential=dummy_carbon_data["matric_potential"][top_soil_layer_index],
+ water_potential=dummy_carbon_data["matric_potential"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
water_potential_halt=SoilConsts.soil_microbe_water_potential_halt,
water_potential_opt=SoilConsts.soil_microbe_water_potential_optimum,
response_curvature=SoilConsts.microbial_water_response_curvature,
@@ -99,7 +106,7 @@ def test_calculate_water_potential_impact_on_microbes(
assert np.allclose(actual_factor, expected_factor)
-def test_soil_water_potential_too_high(dummy_carbon_data, top_soil_layer_index):
+def test_soil_water_potential_too_high(dummy_carbon_data):
"""Test that too high soil water potential results in an error."""
from virtual_ecosystem.models.soil.constants import SoilConsts
from virtual_ecosystem.models.soil.env_factors import (
@@ -196,26 +203,8 @@ def test_calculate_clay_impact_on_enzyme_saturation(dummy_carbon_data):
assert np.allclose(expected_factor, actual_factor)
-def test_calculate_clay_impact_on_necromass_decay(dummy_carbon_data):
- """Test calculation of the effect of soil clay fraction on necromass decay."""
- from virtual_ecosystem.models.soil.constants import SoilConsts
- from virtual_ecosystem.models.soil.env_factors import (
- calculate_clay_impact_on_necromass_decay,
- )
-
- expected_factor = [0.52729242, 0.78662786, 0.92311634, 0.48675225]
-
- actual_factor = calculate_clay_impact_on_necromass_decay(
- clay_fraction=dummy_carbon_data["clay_fraction"],
- decay_exponent=SoilConsts.clay_necromass_decay_exponent,
- )
-
- assert np.allclose(expected_factor, actual_factor)
-
-
-def test_calculate_leaching_rate(dummy_carbon_data, top_soil_layer_index):
+def test_calculate_leaching_rate(dummy_carbon_data, fixture_core_components):
"""Test calculation of solute leaching rates."""
- from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.models.soil.constants import SoilConsts
from virtual_ecosystem.models.soil.env_factors import calculate_leaching_rate
@@ -225,9 +214,10 @@ def test_calculate_leaching_rate(dummy_carbon_data, top_soil_layer_index):
actual_rate = calculate_leaching_rate(
solute_density=dummy_carbon_data["soil_c_pool_lmwc"],
vertical_flow_rate=vertical_flow_per_day,
- soil_moisture=dummy_carbon_data["soil_moisture"][top_soil_layer_index],
+ soil_moisture=dummy_carbon_data["soil_moisture"][
+ fixture_core_components.layer_structure.index_topsoil_scalar
+ ],
solubility_coefficient=SoilConsts.solubility_coefficient_lmwc,
- soil_layer_thickness=CoreConsts.depth_of_active_soil_layer,
)
assert np.allclose(expected_rate, actual_rate)
diff --git a/tests/models/soil/test_soil_model.py b/tests/models/soil/test_soil_model.py
index 3282b9b9a..77b56d950 100644
--- a/tests/models/soil/test_soil_model.py
+++ b/tests/models/soil/test_soil_model.py
@@ -12,6 +12,20 @@
from virtual_ecosystem.core.exceptions import ConfigurationError, InitialisationError
from virtual_ecosystem.models.soil.soil_model import IntegrationError
+# Shared log entries from model initialisation
+REQUIRED_INIT_VAR_LOG = (
+ (DEBUG, "soil model: required var 'soil_c_pool_maom' checked"),
+ (DEBUG, "soil model: required var 'soil_c_pool_lmwc' checked"),
+ (DEBUG, "soil model: required var 'soil_c_pool_microbe' checked"),
+ (DEBUG, "soil model: required var 'soil_c_pool_pom' checked"),
+ (DEBUG, "soil model: required var 'soil_enzyme_pom' checked"),
+ (DEBUG, "soil model: required var 'soil_enzyme_maom' checked"),
+ (DEBUG, "soil model: required var 'soil_c_pool_necromass' checked"),
+ (DEBUG, "soil model: required var 'pH' checked"),
+ (DEBUG, "soil model: required var 'bulk_density' checked"),
+ (DEBUG, "soil model: required var 'clay_fraction' checked"),
+)
+
def test_soil_model_initialization(
caplog, dummy_carbon_data, fixture_soil_core_components
@@ -37,15 +51,7 @@ def test_soil_model_initialization(
# Final check that expected logging entries are produced
log_check(
caplog,
- expected_log=(
- (DEBUG, "soil model: required var 'soil_c_pool_maom' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_lmwc' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_microbe' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_pom' checked"),
- (DEBUG, "soil model: required var 'pH' checked"),
- (DEBUG, "soil model: required var 'bulk_density' checked"),
- (DEBUG, "soil model: required var 'clay_fraction' checked"),
- ),
+ expected_log=REQUIRED_INIT_VAR_LOG,
)
@@ -71,19 +77,24 @@ def test_soil_model_initialization_no_data(
model_constants=SoilConsts(),
)
- # Final check that expected logging entries are produced
+ # Final check that expected logging entries are produced: modify shared
+ # REQUIRED_INIT_VAR_LOG to use shared list of variables
+ missing_log = list(
+ (
+ (
+ ERROR,
+ log_str.replace(":", ": init data missing").removesuffix(" checked"),
+ )
+ for _, log_str in REQUIRED_INIT_VAR_LOG
+ ),
+ )
+ missing_log.append(
+ (ERROR, "soil model: error checking vars_required_for_init, see log."),
+ )
+
log_check(
caplog,
- expected_log=(
- (ERROR, "soil model: init data missing required var 'soil_c_pool_maom'"),
- (ERROR, "soil model: init data missing required var 'soil_c_pool_lmwc'"),
- (ERROR, "soil model: init data missing required var 'soil_c_pool_microbe'"),
- (ERROR, "soil model: init data missing required var 'soil_c_pool_pom'"),
- (ERROR, "soil model: init data missing required var 'pH'"),
- (ERROR, "soil model: init data missing required var 'bulk_density'"),
- (ERROR, "soil model: init data missing required var 'clay_fraction'"),
- (ERROR, "soil model: error checking required_init_vars, see log."),
- ),
+ expected_log=missing_log,
)
@@ -113,13 +124,7 @@ def test_soil_model_initialization_bounds_error(
caplog,
expected_log=(
(INFO, "Replacing data array for 'soil_c_pool_lmwc'"),
- (DEBUG, "soil model: required var 'soil_c_pool_maom' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_lmwc' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_microbe' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_pom' checked"),
- (DEBUG, "soil model: required var 'pH' checked"),
- (DEBUG, "soil model: required var 'bulk_density' checked"),
- (DEBUG, "soil model: required var 'clay_fraction' checked"),
+ *REQUIRED_INIT_VAR_LOG,
(ERROR, "Initial carbon pools contain at least one negative value!"),
),
)
@@ -139,13 +144,7 @@ def test_soil_model_initialization_bounds_error(
"Information required to initialise the soil model successfully "
"extracted.",
),
- (DEBUG, "soil model: required var 'soil_c_pool_maom' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_lmwc' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_microbe' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_pom' checked"),
- (DEBUG, "soil model: required var 'pH' checked"),
- (DEBUG, "soil model: required var 'bulk_density' checked"),
- (DEBUG, "soil model: required var 'clay_fraction' checked"),
+ *REQUIRED_INIT_VAR_LOG,
),
id="default_config",
),
@@ -161,13 +160,7 @@ def test_soil_model_initialization_bounds_error(
"Information required to initialise the soil model successfully "
"extracted.",
),
- (DEBUG, "soil model: required var 'soil_c_pool_maom' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_lmwc' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_microbe' checked"),
- (DEBUG, "soil model: required var 'soil_c_pool_pom' checked"),
- (DEBUG, "soil model: required var 'pH' checked"),
- (DEBUG, "soil model: required var 'bulk_density' checked"),
- (DEBUG, "soil model: required var 'clay_fraction' checked"),
+ *REQUIRED_INIT_VAR_LOG,
),
id="modified_config_correct",
),
@@ -229,6 +222,7 @@ def test_update(mocker, fixture_soil_model, dummy_carbon_data):
end_maom = [2.50019883, 1.70000589, 4.50007171, 0.50000014]
end_microbe = [5.8, 2.3, 11.3, 1.0]
end_pom = [0.25, 2.34, 0.746, 0.3467]
+ end_necromass = [0.058, 0.015, 0.093, 0.105]
mock_integrate = mocker.patch.object(fixture_soil_model, "integrate")
@@ -238,6 +232,7 @@ def test_update(mocker, fixture_soil_model, dummy_carbon_data):
soil_c_pool_maom=DataArray(end_maom, dims="cell_id"),
soil_c_pool_microbe=DataArray(end_microbe, dims="cell_id"),
soil_c_pool_pom=DataArray(end_pom, dims="cell_id"),
+ soil_c_pool_necromass=DataArray(end_necromass, dims="cell_id"),
)
)
@@ -251,6 +246,7 @@ def test_update(mocker, fixture_soil_model, dummy_carbon_data):
assert np.allclose(dummy_carbon_data["soil_c_pool_maom"], end_maom)
assert np.allclose(dummy_carbon_data["soil_c_pool_microbe"], end_microbe)
assert np.allclose(dummy_carbon_data["soil_c_pool_pom"], end_pom)
+ assert np.allclose(dummy_carbon_data["soil_c_pool_necromass"], end_necromass)
@pytest.mark.parametrize(
@@ -262,16 +258,20 @@ def test_update(mocker, fixture_soil_model, dummy_carbon_data):
Dataset(
data_vars=dict(
lmwc=DataArray(
- [0.04826774, 0.02126701, 0.09200601, 0.00544793], dims="cell_id"
+ [0.05110324, 0.0229453, 0.09239938, 0.01485271], dims="cell_id"
),
maom=DataArray(
- [2.49936689, 1.70118553, 4.50085129, 0.50000614], dims="cell_id"
+ [2.5194618, 1.70483236, 4.53238116, 0.52968038], dims="cell_id"
),
microbe=DataArray(
- [5.77512315, 2.2899636, 11.24827514, 0.99640928], dims="cell_id"
+ [5.7752035, 2.29002929, 11.24843316, 0.99642482],
+ dims="cell_id",
),
pom=DataArray(
- [0.12397575, 1.00508662, 0.7389913, 0.35583206], dims="cell_id"
+ [0.10088985, 0.99607906, 0.69401895, 0.35272921], dims="cell_id"
+ ),
+ necromass=DataArray(
+ [0.05840539, 0.01865113, 0.10632815, 0.06904724], dims="cell_id"
),
enzyme_pom=DataArray(
[0.02267842, 0.00957576, 0.05004963, 0.00300993], dims="cell_id"
@@ -317,6 +317,7 @@ def test_integrate_soil_model(
assert np.allclose(new_pools["soil_c_pool_maom"], final_pools["maom"])
assert np.allclose(new_pools["soil_c_pool_microbe"], final_pools["microbe"])
assert np.allclose(new_pools["soil_c_pool_pom"], final_pools["pom"])
+ assert np.allclose(new_pools["soil_c_pool_necromass"], final_pools["necromass"])
assert np.allclose(new_pools["soil_enzyme_pom"], final_pools["enzyme_pom"])
assert np.allclose(new_pools["soil_enzyme_maom"], final_pools["enzyme_maom"])
@@ -390,29 +391,33 @@ def test_order_independance(
assert np.allclose(output[pool_name], output_reversed[pool_name])
-def test_construct_full_soil_model(dummy_carbon_data, top_soil_layer_index):
+def test_construct_full_soil_model(dummy_carbon_data, fixture_core_components):
"""Test that the function that creates the object to integrate exists and works."""
from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.models.soil.constants import SoilConsts
from virtual_ecosystem.models.soil.soil_model import construct_full_soil_model
delta_pools = [
- -0.00371115,
- 0.00278502,
- -0.01849181,
- 0.00089995,
- -1.28996257e-3,
- 2.35822401e-3,
- 1.5570399e-3,
- 1.2082886e-5,
+ 0.0022585928,
+ 0.0060483065,
+ -0.019175058,
+ 0.024247214,
+ 0.038767651,
+ 0.00829848,
+ 0.05982197,
+ 0.07277182,
-0.04978105,
-0.02020101,
-0.10280967,
-0.00719517,
- 4.80916464e-2,
- 1.02354410e-2,
- 7.85372753e-2,
- 1.16756409e-2,
+ 0.00178122,
+ -0.00785937,
+ -0.01201551,
+ 0.00545857,
+ 0.001137474,
+ 0.009172067,
+ 0.033573266,
+ -0.08978050,
1.17571917e-8,
1.67442231e-8,
1.83311362e-9,
@@ -445,7 +450,7 @@ def test_construct_full_soil_model(dummy_carbon_data, top_soil_layer_index):
pools=pools,
data=dummy_carbon_data,
no_cells=4,
- top_soil_layer_index=top_soil_layer_index,
+ top_soil_layer_index=fixture_core_components.layer_structure.index_topsoil_scalar,
delta_pools_ordered=delta_pools_ordered,
model_constants=SoilConsts,
core_constants=CoreConsts,
diff --git a/tests/test_cli_integration.py b/tests/test_cli_integration.py
index 06f448e8d..f0789ea9f 100644
--- a/tests/test_cli_integration.py
+++ b/tests/test_cli_integration.py
@@ -18,17 +18,22 @@ def test_ve_run_install_example(capsys):
assert captured.out.startswith(expected)
-def test_ve_run(capsys):
+def test_ve_run(capsys, mocker):
"""Test that the CLI can successfully run with example data.
Note that this does not currently test the various CLI options independently. We
could do with a fast running minimal test or a mocker to do that.
"""
- # import virtual_ecosystem.core # noqa #F401
+ # import virtual_ecosystem.core #F401
from virtual_ecosystem.core.logger import remove_file_logger
from virtual_ecosystem.entry_points import ve_run_cli
+ # TODO: Once models are adapted, this should be removed, probably
+ mocker.patch("virtual_ecosystem.core.variables.register_all_variables")
+ mocker.patch("virtual_ecosystem.core.variables.setup_variables")
+ mocker.patch("virtual_ecosystem.core.variables.verify_variables_axis")
+
with TemporaryDirectory() as tempdir:
try:
# Install the example directory to run it - tested above - and consume the
diff --git a/tests/test_entry_points.py b/tests/test_entry_points.py
index 5c429adc4..40006ff6a 100644
--- a/tests/test_entry_points.py
+++ b/tests/test_entry_points.py
@@ -3,7 +3,6 @@
This module check that the model entry points exist and function as expected
"""
-import os
import shutil
import subprocess
@@ -13,8 +12,11 @@
def test_entry_point_existence():
"""Check that the entry points exist."""
- exit_status = os.system("ve_run --help")
- assert exit_status == 0
+ result = subprocess.run(
+ [shutil.which("ve_run"), "--help"], capture_output=True, text=True
+ )
+
+ assert result.returncode == 0
def test_version():
diff --git a/tests/test_main.py b/tests/test_main.py
index dd8d08ee4..df431f02b 100644
--- a/tests/test_main.py
+++ b/tests/test_main.py
@@ -25,6 +25,9 @@
(DEBUG, "soil model: required var 'soil_c_pool_lmwc' checked"),
(DEBUG, "soil model: required var 'soil_c_pool_microbe' checked"),
(DEBUG, "soil model: required var 'soil_c_pool_pom' checked"),
+ (DEBUG, "soil model: required var 'soil_enzyme_pom' checked"),
+ (DEBUG, "soil model: required var 'soil_enzyme_maom' checked"),
+ (DEBUG, "soil model: required var 'soil_c_pool_necromass' checked"),
(DEBUG, "soil model: required var 'pH' checked"),
(DEBUG, "soil model: required var 'bulk_density' checked"),
(DEBUG, "soil model: required var 'clay_fraction' checked"),
@@ -46,8 +49,8 @@
None,
pytest.raises(InitialisationError),
tuple(
- INITIALISATION_LOG
- + [
+ [
+ *INITIALISATION_LOG,
(
ERROR,
"The update interval is faster than the soil "
@@ -63,8 +66,8 @@
None,
pytest.raises(InitialisationError),
tuple(
- INITIALISATION_LOG
- + [
+ [
+ *INITIALISATION_LOG,
(
ERROR,
"The update interval is slower than the soil "
@@ -142,13 +145,15 @@ def test_initialise_models(
),
],
)
-def test_ve_run_model_issues(caplog, config_content, expected_log_entries):
+def test_ve_run_model_issues(caplog, config_content, expected_log_entries, mocker):
"""Test the main `ve_run` function handles bad model configurations correctly.
Note that some of this is also safeguarded by the config validation. Unknown model
names should not pass schema validation, but incorrect config data can still pass
schema validation.
"""
+ # TODO: Once models are adapted, this can be removed
+ mocker.patch("virtual_ecosystem.core.variables.register_all_variables")
with pytest.raises(ConfigurationError):
ve_run(cfg_strings=config_content)
diff --git a/virtual_ecosystem/__init__.py b/virtual_ecosystem/__init__.py
index 760fb56fe..66858b958 100644
--- a/virtual_ecosystem/__init__.py
+++ b/virtual_ecosystem/__init__.py
@@ -1,3 +1,5 @@
+"""The base initialisation of the Virtual Ecosystem model."""
+
import importlib.metadata
from . import example_data
diff --git a/virtual_ecosystem/core/__init__.py b/virtual_ecosystem/core/__init__.py
index cf0152671..66a40946b 100644
--- a/virtual_ecosystem/core/__init__.py
+++ b/virtual_ecosystem/core/__init__.py
@@ -31,4 +31,4 @@
The :mod:`~virtual_ecosystem.core` module itself is only responsible for loading the
configuration schema for the core submodules.
-""" # noqa: D205, D415
+""" # noqa: D205
diff --git a/virtual_ecosystem/core/axes.py b/virtual_ecosystem/core/axes.py
index 812c56301..1de9abdcd 100644
--- a/virtual_ecosystem/core/axes.py
+++ b/virtual_ecosystem/core/axes.py
@@ -42,7 +42,7 @@
'spatial' axis standardise the spatial structure of the input data to use a single
``cell_id`` spatial axis, which maps data onto the cell IDs used for indexing in the
:class:`~virtual_ecosystem.core.grid.Grid` instance for the simulation. `x`
-""" # noqa: D205, D415
+""" # noqa: D205
from abc import ABC, abstractmethod
from typing import Any
@@ -76,7 +76,7 @@ class AxisValidator(ABC):
core_axis: str
"""Class attribute giving the name of the core axis for an AxisValidator."""
- dim_names: set[str]
+ dim_names: frozenset[str]
"""Class attribute giving the dimension names for an AxisValidator."""
def __init__(self) -> None:
@@ -108,10 +108,10 @@ class attribute.
if not hasattr(cls, "dim_names"):
raise ValueError("Class attribute dim_names not set.")
- if not isinstance(cls.dim_names, set) or any(
+ if not isinstance(cls.dim_names, frozenset) or any(
[not isinstance(x, str) for x in cls.dim_names]
):
- raise ValueError("Class attribute dim_names is not a set of strings.")
+ raise ValueError("Class attribute dim_names is not a frozenset of strings.")
if cls.core_axis in AXIS_VALIDATORS:
AXIS_VALIDATORS[cls.core_axis].append(cls)
@@ -135,7 +135,7 @@ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Returns:
A boolean showing if the `run_validation` method of the subclass can be
@@ -155,7 +155,7 @@ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArr
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Returns:
A DataArray that passes validation, possibly modified to align with internal
@@ -194,7 +194,7 @@ def validate_dataarray(
Args:
value: An input DataArray for validation
grid: A Grid object giving the spatial configuration.
- kwargs: Further configuration details to be passed to AxisValidators
+ **kwargs: Further configuration details to be passed to AxisValidators
Returns:
The function returns the validated data array and a dictionary recording which
@@ -214,7 +214,7 @@ def validate_dataarray(
validators: list[type[AxisValidator]] = AXIS_VALIDATORS[axis]
# Get the set of dim names across all of the validators for this axis
- validator_dims = set.union(*[v.dim_names for v in validators])
+ validator_dims = frozenset.union(*[v.dim_names for v in validators])
# If the dataarray includes any of those dimension names, one of the validators
# for that axis must be able to validate the array, otherwise we can skip
@@ -270,7 +270,7 @@ class Spat_CellId_Coord_Any(AxisValidator):
"""
core_axis = "spatial"
- dim_names = {"cell_id"}
+ dim_names = frozenset(["cell_id"])
def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
"""Check the validator applies to the inputs.
@@ -278,7 +278,7 @@ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Returns:
A boolean showing if this subclass can be applied to the inputs.
@@ -299,7 +299,7 @@ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArr
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Raises:
ValueError: when ``cell_id`` values are not congruent with the ``Grid``.
@@ -341,7 +341,7 @@ class Spat_CellId_Dim_Any(AxisValidator):
"""
core_axis = "spatial"
- dim_names = {"cell_id"}
+ dim_names = frozenset(["cell_id"])
def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
"""Check the validator applies to the inputs.
@@ -349,7 +349,7 @@ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Returns:
A boolean showing if this subclass can be applied to the inputs.
@@ -370,7 +370,7 @@ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArr
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Raises:
ValueError: when ``cell_id`` values are not congruent with the ``Grid``.
@@ -406,7 +406,7 @@ class Spat_XY_Coord_Square(AxisValidator):
"""
core_axis = "spatial"
- dim_names = {"x", "y"}
+ dim_names = frozenset(["x", "y"])
def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
"""Check the validator applies to the inputs.
@@ -414,7 +414,7 @@ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Returns:
A boolean showing if this subclass can be applied to the inputs.
@@ -437,7 +437,7 @@ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArr
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Raises:
ValueError: when ``x`` and ``y`` values are not congruent with the ``Grid``.
@@ -494,7 +494,7 @@ class Spat_XY_Dim_Square(AxisValidator):
"""
core_axis = "spatial"
- dim_names = {"x", "y"}
+ dim_names = frozenset(["x", "y"])
def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
"""Check the validator applies to the inputs.
@@ -502,7 +502,7 @@ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Returns:
A boolean showing if this subclass can be applied to the inputs.
@@ -522,7 +522,7 @@ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArr
Args:
value: An input DataArray to check
grid: A Grid object giving the spatial configuration of the simulation.
- kwargs: Other configuration details to be used.
+ **kwargs: Other configuration details to be used.
Raises:
ValueError: when ``x`` and ``y`` values are not congruent with the ``Grid``.
@@ -546,3 +546,52 @@ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArr
x=DataArray(darray_stack.coords["x"].values, dims=["cell_id"]),
y=DataArray(darray_stack.coords["y"].values, dims=["cell_id"]),
)
+
+
+class Time(AxisValidator):
+ """Validate temporal coordinates on the *time* core axis.
+
+ Applies to:
+ An input DataArray that provides coordinate values along a ``time`` dimension.
+
+ TODO: this is just a placeholder at present to establish the ``time`` axis name.
+
+ """
+
+ core_axis = "time"
+ dim_names = frozenset(["time"])
+
+ def can_validate(self, value: DataArray, grid: Grid, **kwargs: Any) -> bool:
+ """Check the validator applies to the inputs.
+
+ Args:
+ value: An input DataArray to check
+ grid: A Grid object giving the spatial configuration of the simulation.
+ **kwargs: Other configuration details to be used.
+
+ Returns:
+ A boolean showing if this subclass can be applied to the inputs.
+ """
+ return self.dim_names.issubset(value.dims) and self.dim_names.issubset(
+ value.coords
+ )
+
+ def run_validation(self, value: DataArray, grid: Grid, **kwargs: Any) -> DataArray:
+ """Run validation on the inputs.
+
+ Does nothing at present.
+
+ Args:
+ value: An input DataArray to check
+ grid: A Grid object giving the spatial configuration of the simulation.
+ **kwargs: Other configuration details to be used.
+
+ Raises:
+ ValueError: when the time coordinates are not congruent with the model
+ timing steps.
+
+ Returns:
+ A DataArray, possibly truncated to the steps defined in the model timing.
+ """
+
+ return value
diff --git a/virtual_ecosystem/core/base_model.py b/virtual_ecosystem/core/base_model.py
index 810ba40dc..eed00cee6 100644
--- a/virtual_ecosystem/core/base_model.py
+++ b/virtual_ecosystem/core/base_model.py
@@ -23,23 +23,27 @@
Declaring new subclasses
------------------------
-The :class:`~virtual_ecosystem.core.base_model.BaseModel` has four class attributes
-that must be specified as arguments to the subclass declaration:
-:attr:`~virtual_ecosystem.core.base_model.BaseModel.model_name`,
-:attr:`~virtual_ecosystem.core.base_model.BaseModel.required_init_vars`,
-:attr:`~virtual_ecosystem.core.base_model.BaseModel.model_update_bounds` and
-:attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_updated`. This behaviour is
-defined in the :meth:`BaseModel.__init_subclass__()
+The :class:`~virtual_ecosystem.core.base_model.BaseModel` has the following class
+attributes that must be specified as arguments to the subclass declaration:
+
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.model_name`,
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_required_for_init`,
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_populated_by_init`,
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_required_for_update`,
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_updated`,
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.model_update_bounds` and
+* :attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_updated`.
+
+This behaviour is defined in the :meth:`BaseModel.__init_subclass__()
` method, which also
gives example code for declaring a new subclass.
-The usage of these four attributes is described in their docstrings and each is
-validated when a new subclass is created using the following private methods of the
-class:
-:meth:`~virtual_ecosystem.core.base_model.BaseModel._check_model_name`,
-:meth:`~virtual_ecosystem.core.base_model.BaseModel._check_required_init_vars`,
-:meth:`~virtual_ecosystem.core.base_model.BaseModel._check_model_update_bounds` and
-:meth:`~virtual_ecosystem.core.base_model.BaseModel._check_vars_updated`.
+The usage of these attributes is described in their docstrings and each is validated
+when a new subclass is created using the following private methods of the class:
+
+* :meth:`~virtual_ecosystem.core.base_model.BaseModel._check_model_name`,
+* :meth:`~virtual_ecosystem.core.base_model.BaseModel._check_variables_attribute` and
+* :meth:`~virtual_ecosystem.core.base_model.BaseModel._check_model_update_bounds`.
Model checking
--------------
@@ -99,7 +103,6 @@
import pint
-from virtual_ecosystem.core.axes import AXIS_VALIDATORS
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.core.core_components import (
@@ -107,7 +110,7 @@
LayerStructure,
ModelTiming,
)
-from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.core.data import Data, Grid
from virtual_ecosystem.core.exceptions import ConfigurationError
from virtual_ecosystem.core.logger import LOGGER
@@ -149,7 +152,7 @@ class BaseModel(ABC):
patterns.
"""
- required_init_vars: tuple[tuple[str, tuple[str, ...]], ...]
+ vars_required_for_init: tuple[str, ...]
"""Required variables for model initialisation.
This class property defines a set of variable names that must be present in the
@@ -166,8 +169,32 @@ class BaseModel(ABC):
At the moment, this tuple is used to decide which variables to output from the
:class:`~virtual_ecosystem.core.data.Data` object, i.e. every variable updated
- by a model used in the specific simulation. In future, this could also be used
- to prevent multiple models from updating the same variable and similar problems.
+ by a model used in the specific simulation. It is also be used warn if multiple
+ models will be updating the same variable and to verify that these variables are
+ indeed initialised by another model, and therefore will be available.
+ """
+
+ vars_required_for_update: tuple[str, ...]
+ """Variables that are required by the update method of the model.
+
+ These variables should have been initialised by another model or loaded from
+ external sources, but in either case they will be available in the data object.
+ """
+
+ vars_populated_by_init: tuple[str, ...]
+ """Variables that are initialised by the model during the setup.
+
+ These are the variables that are initialised by the model and stored in the data
+ object when running the setup method and that will be available for other models to
+ use in their own setup or update methods.
+ """
+
+ vars_populated_by_first_update: tuple[str, ...]
+ """Variables that are initialised by the model during the first update.
+
+ These are the variables that are initialised by the model and stored in the data
+ object when running the update method for the first time. They will be available for
+ other models to use in their update methods but not in the setup methos.
"""
def __init__(
@@ -186,14 +213,15 @@ def __init__(
* ``data``: the provided :class:`~virtual_ecosystem.core.data.Data` instance,
* ``model_timing``: the
- :class:`~virtual_ecosystem.core.core_components.ModelTiming` instance from
- the ``core_components`` argument.
+ :class:`~virtual_ecosystem.core.core_components.ModelTiming` instance from the
+ ``core_components`` argument.
+ * ``grid``: the :class:`~virtual_ecosystem.core.grid.Grid` instance from the
+ ``core_components`` argument.
* ``layer_structure``: the
:class:`~virtual_ecosystem.core.core_components.LayerStructure` instance from
the ``core_components`` argument.
- * ``core_constants``: the
- :class:`~virtual_ecosystem.core.constants.CoreConsts` instance from
- the ``core_components`` argument.
+ * ``core_constants``: the :class:`~virtual_ecosystem.core.constants.CoreConsts`
+ instance from the ``core_components`` argument.
It then uses the
:meth:`~virtual_ecosystem.core.base_model.BaseModel.check_init_data` method to
@@ -204,6 +232,8 @@ def __init__(
"""A Data instance providing access to the shared simulation data."""
self.model_timing: ModelTiming = core_components.model_timing
"""The ModelTiming details used in the model."""
+ self.grid: Grid = core_components.grid
+ """The Grid details used in the model."""
self.layer_structure: LayerStructure = core_components.layer_structure
"""The LayerStructure details used in the model."""
self.core_constants: CoreConsts = core_components.core_constants
@@ -230,6 +260,7 @@ def update(self, time_index: int, **kwargs: Any) -> None:
Args:
time_index: The index representing the current time step in the data object.
+ **kwargs: Further arguments to the update method.
"""
@abstractmethod
@@ -269,73 +300,48 @@ def _check_model_name(cls, model_name: str) -> str:
return model_name
@classmethod
- def _check_required_init_vars(
- cls, required_init_vars: tuple[tuple[str, tuple[str, ...]], ...]
- ) -> tuple[tuple[str, tuple[str, ...]], ...]:
- """Check the required_init_vars property is valid.
+ def _check_variables_attribute(
+ cls,
+ variables_attribute_name: str,
+ variables_attribute_value: tuple[str, ...],
+ ) -> tuple[str, ...]:
+ """Check a model variables attribute property is valid.
+
+ Creating an instance of the BaseModel class requires that several variables
+ attributes are set. Each of these provides a list of variable names that are
+ required or updated by the model at various points. This method is used to
+ validate the structure of the new instance and ensure the resulting model
+ structure is consistent.
Args:
- required_init_vars: The
- :attr:`~virtual_ecosystem.core.base_model.BaseModel.required_init_vars`
- attribute to be used for a subclass.
+ variables_attribute_name: The name of the variables attribute
+ variables_attribute_value: The provided value for the variables attribute
Raises:
- TypeError: the value of required_init_vars has the wrong type structure.
- ValueError: required_init_vars uses unknown core axis names.
+ TypeError: the value of the model variables attribute has the wrong type
+ structure.
Returns:
- The provided ``required_init_vars`` if valid
+ The validated variables attribute value
"""
- to_raise: Exception
-
# Check the structure
- required_init_vars_ok = True
- unknown_axes: list[str] = []
-
- if not isinstance(required_init_vars, tuple):
- required_init_vars_ok = False
- else:
- for entry in required_init_vars:
- # entry is a 2 tuple
- if not (isinstance(entry, tuple) and len(entry) == 2):
- required_init_vars_ok = False
- continue
-
- # and entry contains (str, tuple(str,...))
- vname, axes = entry
- if not (
- isinstance(vname, str)
- and isinstance(axes, tuple)
- and all([isinstance(a, str) for a in axes])
- ):
- required_init_vars_ok = False
- else:
- # Add any unknown axes
- unknown_axes.extend(set(axes).difference(AXIS_VALIDATORS))
-
- if not required_init_vars_ok:
- to_raise = TypeError(
- f"Class attribute required_init_vars has the wrong "
- f"structure in {cls.__name__}"
- )
- LOGGER.error(to_raise)
- raise to_raise
-
- if unknown_axes:
- to_raise = ValueError(
- f"Class attribute required_init_vars uses unknown core "
- f"axes in {cls.__name__}: {','.join(unknown_axes)}"
- )
- LOGGER.error(to_raise)
- raise to_raise
-
- return required_init_vars
+ if isinstance(variables_attribute_value, tuple) and all(
+ isinstance(vname, str) for vname in variables_attribute_value
+ ):
+ return variables_attribute_value
+
+ to_raise = TypeError(
+ f"Class attribute {variables_attribute_name} has the wrong "
+ f"structure in {cls.__name__}"
+ )
+ LOGGER.error(to_raise)
+ raise to_raise
@classmethod
def _check_model_update_bounds(
cls, model_update_bounds: tuple[str, str]
- ) -> tuple[pint.util.Quantity, pint.util.Quantity]:
+ ) -> tuple[pint.Quantity, pint.Quantity]:
"""Check that the model_update_bounds attribute is valid.
This is used to validate the class attribute
@@ -360,7 +366,7 @@ def _check_model_update_bounds(
# Check the conversion
try:
- model_update_bounds_pint: tuple[pint.util.Quantity, pint.util.Quantity] = (
+ model_update_bounds_pint: tuple[pint.Quantity, pint.Quantity] = (
pint.Quantity(model_update_bounds[0]),
pint.Quantity(model_update_bounds[1]),
)
@@ -417,23 +423,16 @@ def _check_update_speed(self) -> None:
LOGGER.error(to_raise)
raise to_raise
- @classmethod
- def _check_vars_updated(cls, vars_updated: tuple[str, ...]) -> tuple[str, ...]:
- """Check that vars_updated is valid.
-
- Returns:
- The provided value if valid.
- """
- # TODO - currently no validation.
- return vars_updated
-
@classmethod
def __init_subclass__(
cls,
model_name: str,
model_update_bounds: tuple[str, str],
- required_init_vars: tuple[tuple[str, tuple[str, ...]], ...],
+ vars_required_for_init: tuple[str, ...],
vars_updated: tuple[str, ...],
+ vars_required_for_update: tuple[str, ...],
+ vars_populated_by_init: tuple[str, ...],
+ vars_populated_by_first_update: tuple[str, ...],
) -> None:
"""Initialise subclasses deriving from BaseModel.
@@ -453,7 +452,7 @@ class ExampleModel(
BaseModel,
model_name='example',
model_update_bounds= ("30 minutes", "3 months"),
- required_init_vars=(("required_variable", ("spatial",)),),
+ vars_required_for_init=(("required_variable", ("spatial",)),),
vars_updated=("updated_variable"),
):
...
@@ -461,22 +460,35 @@ class ExampleModel(
Args:
model_name: The model name to be used
model_update_bounds: Bounds on update intervals handled by the model
- required_init_vars: A tuple of the variables required to create a model
+ vars_required_for_init: A tuple of the variables required to create a model
instance.
+ vars_populated_by_init: A tuple of the variables initialised when a model
+ instance is created.
+ vars_populated_by_first_update: A tuple of the variables initialised when a
+ model update method first run.
+ vars_required_for_update: A tuple of the variables required to update a
+ model instance.
vars_updated: A tuple of the variable names updated by the model.
Raises:
- ValueError: If the model_name or required_init_vars properties are not
+ ValueError: If the model_name or vars_required_for_init properties are not
defined
TypeError: If model_name is not a string
"""
try:
cls.model_name = cls._check_model_name(model_name=model_name)
- cls.required_init_vars = cls._check_required_init_vars(
- required_init_vars=required_init_vars
- )
- cls.vars_updated = cls._check_vars_updated(vars_updated=vars_updated)
+
+ # Validate the structure of the variables attributes
+ for name, attr in (
+ ("vars_required_for_init", vars_required_for_init),
+ ("vars_populated_by_init", vars_populated_by_init),
+ ("vars_required_for_update", vars_required_for_update),
+ ("vars_updated", vars_updated),
+ ("vars_populated_by_first_update", vars_populated_by_first_update),
+ ):
+ setattr(cls, name, cls._check_variables_attribute(name, attr))
+
cls.model_update_bounds = cls._check_model_update_bounds(
model_update_bounds=model_update_bounds
)
@@ -515,9 +527,9 @@ def check_init_data(self) -> None:
"""Check the init data contains the required variables.
This method is used to check that the set of variables defined in the
- :attr:`~virtual_ecosystem.core.base_model.BaseModel.required_init_vars` class
- attribute are present in the :attr:`~virtual_ecosystem.core.data.Data` instance
- used to create a new instance of the class.
+ :attr:`~virtual_ecosystem.core.base_model.BaseModel.vars_required_for_init`
+ class attribute are present in the :attr:`~virtual_ecosystem.core.data.Data`
+ instance used to create a new instance of the class.
Raises:
ValueError: If the Data instance does not contain all the required variables
@@ -525,11 +537,11 @@ def check_init_data(self) -> None:
"""
# Sentinel variables
- all_axes_ok: bool = True
+ # all_axes_ok: bool = True
all_vars_found: bool = True
# Loop over the required and axes
- for var, axes in self.required_init_vars:
+ for var in self.vars_required_for_init:
# Record when a variable is missing
if var not in self.data:
LOGGER.error(
@@ -538,28 +550,30 @@ def check_init_data(self) -> None:
all_vars_found = False
continue
- # Get a list of missing axes
- bad_axes = []
- # Could use try: here and let on_core_axis report errors but easier to
- # provide more clearly structured feedback this way
- for axis in axes:
- if not self.data.on_core_axis(var, axis):
- bad_axes.append(axis)
+ # # Get a list of missing axes
+ # bad_axes = []
+ # # Could use try: here and let on_core_axis report errors but easier to
+ # # provide more clearly structured feedback this way
+ # for axis in axes:
+ # if not self.data.on_core_axis(var, axis):
+ # bad_axes.append(axis)
# Log the outcome
- if bad_axes:
- LOGGER.error(
- f"{self.model_name} model: required var '{var}' "
- f"not on required axes: {','.join(bad_axes)}"
- )
- all_axes_ok = False
- else:
- LOGGER.debug(f"{self.model_name} model: required var '{var}' checked")
+ # if bad_axes:
+ # LOGGER.error(
+ # f"{self.model_name} model: required var '{var}' "
+ # f"not on required axes: {','.join(bad_axes)}"
+ # )
+ # all_axes_ok = False
+ # else:
+
+ LOGGER.debug(f"{self.model_name} model: required var '{var}' checked")
# Raise if any problems found
- if not (all_axes_ok and all_vars_found):
+ if not (all_vars_found):
error = ValueError(
- f"{self.model_name} model: error checking required_init_vars, see log."
+ f"{self.model_name} model: error checking vars_required_for_init, "
+ "see log."
)
LOGGER.error(error)
raise error
diff --git a/virtual_ecosystem/core/config.py b/virtual_ecosystem/core/config.py
index 074739c4a..2181546a0 100644
--- a/virtual_ecosystem/core/config.py
+++ b/virtual_ecosystem/core/config.py
@@ -1,12 +1,12 @@
"""The :mod:`~virtual_ecosystem.core.config` module is used to read in the various
configuration files, validate their contents, and then configure a ready to run instance
of the virtual ecosystem model. The basic details of how this system is used can be
-found :doc:`here `.
+found :doc:`here `.
The validation of configuration documents is done using JSONSchema documents associated
with the different model components. See the :mod:`~virtual_ecosystem.core.schema`
module for details.
-""" # noqa: D205, D415
+""" # noqa: D205
import sys
from collections.abc import Sequence
@@ -237,7 +237,7 @@ def __init__(
self.from_cfg_strings = True
if cfg_paths:
# Standardise cfg_paths to list of Paths
- if isinstance(cfg_paths, (str, Path)):
+ if isinstance(cfg_paths, str | Path):
self.cfg_paths = [Path(cfg_paths)]
else:
self.cfg_paths = [Path(p) for p in cfg_paths]
@@ -338,7 +338,7 @@ def load_config_toml(self) -> None:
self.toml_contents[this_file] = tomllib.load(file_io)
except tomllib.TOMLDecodeError as err:
failed_inputs = True
- LOGGER.error(f"Config TOML parsing error in {this_file}: {str(err)}")
+ LOGGER.error(f"Config TOML parsing error in {this_file}: {err!s}")
else:
LOGGER.info(f"Config TOML loaded from {this_file}")
@@ -364,7 +364,7 @@ def load_config_toml_string(self) -> None:
self.toml_contents[f"cfg_string_{index}"] = tomllib.loads(cfg_string)
except tomllib.TOMLDecodeError as err:
to_raise = ConfigurationError(
- f"TOML parsing error in cfg_strings: {str(err)}"
+ f"TOML parsing error in cfg_strings: {err!s}"
)
LOGGER.critical(to_raise)
raise to_raise
diff --git a/virtual_ecosystem/core/constants.py b/virtual_ecosystem/core/constants.py
index 694d381f0..41b08df2e 100644
--- a/virtual_ecosystem/core/constants.py
+++ b/virtual_ecosystem/core/constants.py
@@ -4,7 +4,7 @@
Note that true universal constants are defined as class variables of dataclasses. This
prevents them being changed by user specified configuration.
-""" # noqa: D205, D415
+""" # noqa: D205
from dataclasses import dataclass
from typing import ClassVar
@@ -16,16 +16,71 @@
@dataclass(frozen=True)
class CoreConsts(ConstantsDataclass):
- """Core constants for use across the Virtual Ecosystem modules."""
+ """Core constants for use across the Virtual Ecosystem modules.
+
+ An instance of the CoreConsts dataclass provides definitions of the core constants
+ used across an entire simulation. The core constants can be changed, as shown below,
+ although for many this would likely generate nonsensical results.
+
+ Example:
+ >>> consts = CoreConsts()
+ >>> consts.max_depth_of_microbial_activity
+ 0.25
+ >>> consts = CoreConsts(max_depth_of_microbial_activity=0.75)
+ >>> consts.max_depth_of_microbial_activity
+ 0.75
+ """
+
+ placeholder: float = 123.4
+ """A placeholder configurable constant."""
zero_Celsius: ClassVar[float] = constants.zero_Celsius
"""Conversion constant from Kelvin to Celsius (°)."""
- depth_of_active_soil_layer: float = 0.25
- """Depth of the biogeochemically active soil layer [m].
+ standard_pressure: float = constants.atmosphere / 1000
+ """Standard atmospheric pressure, [kPa]"""
+
+ standard_mole: float = 44.642
+ """Moles of ideal gas in 1 m^3 air at standard atmosphere."""
+
+ molar_heat_capacity_air: float = 29.19
+ """Molar heat capacity of air, [J mol-1 K-1]."""
+
+ gravity: float = constants.gravitational_constant
+ """Newtonian constant of gravitation, [m s-1]."""
+
+ stefan_boltzmann_constant: float = constants.Stefan_Boltzmann
+ """Stefan-Boltzmann constant, [W m-2 K-4].
+
+ The Stefan-Boltzmann constant relates the energy radiated by a black body to its
+ temperature."""
- The soil model considered a homogenous layer in which all significant nutrient
- processes take place. This is a major assumption of the model. The value is taken
- from :cite:t:`fatichi_mechanistic_2019`. No empirical source is provided for this
- value.
+ von_karmans_constant: float = 0.4
+ """Von Karman's constant, [unitless].
+
+ The von Karman's constant describes the logarithmic velocity profile of a turbulent
+ fluid near a no-slip boundary."""
+
+ max_depth_of_microbial_activity: float = 0.25
+ """Maximum depth of microbial activity in the soil layers [m].
+
+ The soil model needs to identify which of the configured soil layers are
+ sufficiently close to the surface to contain significant microbial activity that
+ drives nutrient processes. The default value is taken from
+ :cite:t:`fatichi_mechanistic_2019`. No empirical source is provided for this value.
"""
+
+ meters_to_mm: float = 1000.0
+ """Factor to convert variable unit from meters to millimeters."""
+
+ molecular_weight_air: float = 28.96
+ """Molecular weight of air, [g mol-1]."""
+
+ gas_constant_water_vapour: float = 461.51
+ """Gas constant for water vapour, [J kg-1 K-1]"""
+
+ seconds_to_day: float = 86400.0
+ """Factor to convert variable unit from seconds to day."""
+
+ characteristic_dimension_leaf: float = 0.01
+ """Characteristic dimension of leaf, typically around 0.7 * leaf width, [m]."""
diff --git a/virtual_ecosystem/core/constants_class.py b/virtual_ecosystem/core/constants_class.py
index 79ea19d78..f4adaae02 100644
--- a/virtual_ecosystem/core/constants_class.py
+++ b/virtual_ecosystem/core/constants_class.py
@@ -14,7 +14,7 @@ class :mod:`~virtual_ecosystem.core.constants_class.ConstantsDataclass` and the
dataclass with the required constant values. See
:mod:`~virtual_ecosystem.core.constants_class.ConstantsDataclass` for syntax
details.
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
@@ -85,7 +85,7 @@ def from_config(cls, config: dict[str, Any]) -> ConstantsDataclass:
f'not configurable: {", ".join(unconfigurable_names)}'
)
LOGGER.error(msg)
- LOGGER.info("Valid names are: %s" % (", ".join(valid_names)))
+ LOGGER.info("Valid names are: {}".format(", ".join(valid_names)))
raise ConfigurationError(msg)
if unexpected_names:
@@ -94,7 +94,7 @@ def from_config(cls, config: dict[str, Any]) -> ConstantsDataclass:
f'for {cls.__name__}: {", ".join(unexpected_names)}'
)
LOGGER.error(msg)
- LOGGER.info("Valid names are: %s" % (", ".join(valid_names)))
+ LOGGER.info("Valid names are: {}".format(", ".join(valid_names)))
raise ConfigurationError(msg)
return cls(**config)
diff --git a/virtual_ecosystem/core/constants_loader.py b/virtual_ecosystem/core/constants_loader.py
index c7c740401..2f72ae61a 100644
--- a/virtual_ecosystem/core/constants_loader.py
+++ b/virtual_ecosystem/core/constants_loader.py
@@ -4,7 +4,7 @@
:data:`~virtual_ecosystem.core.registry.MODULE_REGISTRY` and then extracts any
configuration details for that constants dataclass from a
:mod:`~virtual_ecosystem.core.config.Config` instance.
-""" # noqa: D205, D415
+""" # noqa: D205
from typing import Any
diff --git a/virtual_ecosystem/core/core_components.py b/virtual_ecosystem/core/core_components.py
index 92b110caa..8f1d9e352 100644
--- a/virtual_ecosystem/core/core_components.py
+++ b/virtual_ecosystem/core/core_components.py
@@ -3,20 +3,23 @@
:class:`~virtual_ecosystem.core.base_model.BaseModel`, allowing single instances of
these components to be cascaded down to individual model subclass instances via the
``__init__`` method of the base model..
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
from dataclasses import InitVar, dataclass, field
import numpy as np
+from numpy.typing import NDArray
from pint import Quantity
from pint.errors import DimensionalityError, UndefinedUnitError
+from xarray import DataArray
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.core.constants_loader import load_constants
from virtual_ecosystem.core.exceptions import ConfigurationError
+from virtual_ecosystem.core.grid import Grid
from virtual_ecosystem.core.logger import LOGGER
@@ -30,6 +33,8 @@ class CoreComponents:
specific model subclasses.
"""
+ grid: Grid = field(init=False)
+ """A grid structure for the simulation."""
layer_structure: LayerStructure = field(init=False)
"""The vertical layer structure for the simulation."""
model_timing: ModelTiming = field(init=False)
@@ -41,9 +46,14 @@ class CoreComponents:
def __post_init__(self, config: Config) -> None:
"""Populate the core components from the config."""
- self.layer_structure = LayerStructure(config=config)
- self.model_timing = ModelTiming(config=config)
+ self.grid = Grid.from_config(config=config)
self.core_constants = load_constants(config, "core", "CoreConsts")
+ self.layer_structure = LayerStructure(
+ config=config,
+ n_cells=self.grid.n_cells,
+ max_depth_of_microbial_activity=self.core_constants.max_depth_of_microbial_activity,
+ )
+ self.model_timing = ModelTiming(config=config)
@dataclass
@@ -143,29 +153,38 @@ def __post_init__(self, config: Config) -> None:
# Log the completed timing creation.
LOGGER.info(
- "Timing details built from model configuration: "
- "start - %s, end - %s, run length - %s"
- % (self.start_time, self.end_time, self.reconciled_run_length)
+ "Timing details built from model configuration: " # noqa: UP032
+ "start - {}, end - {}, run length - {}".format(
+ self.start_time, self.end_time, self.reconciled_run_length
+ )
)
@dataclass
class LayerStructure:
- """Simulation vertical layer structure.
-
- This class defines the structure of the vertical dimension of the Virtual Ecosystem
- from a model configuration. Five values from the ``core.layers`` configuration
- section are used to define a set of vertical layers and their heights (or relative
- heights): ``canopy_layers``, ``soil_layers``, ``above_canopy_height_offset``,
- ``surface_layer_height`` and``subcanopy_layer_height``. These values are validatated
- and then assigned to attributes of this class. The ``n_layers`` and ``layer_roles``
- attributes report the total number of layers in the vertical dimension and a tuple
- of the role of each layer within that dimension.
-
- The layer structure is shown below, along with values from the default
- configuration. All heights are in metres relative to ground level and the canopy
- layer heights are defined dynamically by the
- :class:`~virtual_ecosystem.models.plants.plants_model.PlantsModel`.
+ """Vertical layer structure of the Virtual Ecosystem.
+
+ This class defines the structure of the vertical dimension of a simulation using the
+ Virtual Ecosystem. The vertical dimension is divided into a series of layers,
+ ordered from above the canopy to the bottom of the soil, that perform different
+ roles in the simulation. The layers are defined using the following five
+ configuration settings from the ``[core.layers]`` section.
+
+ * ``above_canopy_height_offset``: the height above the canopy top of the first layer
+ role ``above``, which is used as the measurement height of reference climate data.
+ * ``canopy_layers``: a fixed number of layers with the ``canopy`` role. Not all of
+ these necessarily contain canopy during a simulation as the canopy structure
+ within these layers is dynamic.
+ * ``surface_layer_height``: the height above ground level of the ground surface
+ atmospheric layer.
+ * ``soil_layers``: this provides the depths of the soil horizons to be used in the
+ simulation and so sets the number of soil layers and the horizon depth for each
+ layer relative to the surface.
+ * ``max_depth_of_microbial_activity``: the depth limit of significant microbial
+ activity.
+
+ The layer structure is shown below, along with the default configured height values
+ in metres relative to ground level.
.. csv-table::
:header: "Index", "Role", "Description", "Set by", "Default"
@@ -175,77 +194,463 @@ class LayerStructure:
1, "canopy", "Height of first canopy layer", "``PlantsModel``", "--"
"...", "canopy", "Height of other canopy layers", "``PlantsModel``", "--"
10, "canopy", "Height of the last canopy layer ", "``PlantsModel``", "--"
- 11, "subcanopy", "Subcanopy height", ``subcanopy_layer_height``, "1.5 m"
- 12, "surface", "Near surface conditions", ``surface_layer_height``, "0.1 m"
- 13, "soil", "Upper soil layer depth", ``soil_layers``, "-0.25 m"
- 14, "soil", "Lower soil layer depth", ``soil_layers``, "-1.25 m"
+ 11, "surface", "Near surface conditions", ``surface_layer_height``, "0.1 m"
+ 12, "topsoil", "Top soil layer depth", ``soil_layers``, "-0.25 m"
+ 13, "subsoil", "First subsoil layer depth", ``soil_layers``, "-1.00 m"
+
+ .. role:: python(code)
+ :language: python
+
+ **Additional Roles**:
+ The following additional roles and attributes are also defined when the instance
+ is created and are constant through the runtime of the model.
+
+ 1. The ``active_soil`` role indicates soil layers that fall even partially above
+ the configured `max_depth_of_microbial_activity`. The `soil_layer_thickness`
+ attribute provides the thickness of each soil layer - including both top- and
+ sub-soil layers - and the `soil_layer_active_thickness` records the thickness
+ of biologically active soil within each layer. Note that the ``soil_layers``
+ provides the sequence of depths of soil horizons relative to the surface and
+ these values provide the thickness of individual layers: the default
+ ``soil_layers`` values of ``[-0.25, -1.00]`` give thickness values of
+ ``[0.25, 0.75]``.
+
+ 2. The ``all_soil`` role is the combination of the ``topsoil`` and ``subsoil``
+ layers.
+
+ 3. The ``atmosphere`` role is the combination of ``above``, ``canopy`` and
+ ``surface`` layers.
+
+ **Dynamic roles**:
+
+ The following roles are set when the instance is initialised but are can be
+ updated during the model run using the :meth:`.set_filled_canopy`
+ method.
+
+ 1. The ``filled_canopy`` role indicates canopy layers that contain any canopy
+ across all of the grid cells. No grid cell contains actual canopy in any of
+ the canopy layers below the filled canopy layers. This is initialised to show
+ no filled canopy layers.
+
+ 2, The ``filled_atmosphere`` role includes the above canopy layer, all filled
+ canopy layer indices and the surface layer.
+
+ 3. The ``flux_layers`` role includes the filled canopy layers and the topsoil
+ layer.
+
+ In addition, the :attr:`.lowest_canopy_filled` attribute provides an array
+ giving the vertical index of the lowest filled canopy layer in each grid cell.
+ It contains ``np.nan`` when there is no canopy in a grid cell and is initalised
+ as an array of ``np.nan`` values.
+
+ **Getting layer indices**:
+
+ The :attr:`._role_indices_bool` and :attr:`._role_indices_int` attributes
+ contain dictionaries keyed by role name of the boolean or integer indices of the
+ different defined roles. However, all of the role indices should be accessed
+ using the specific instance properties e.g. :attr:`.index_above`.
+
+ Note that the standard index properties like :attr:`.index_above` will return an
+ array index, which extracts a two dimensional slice of the vertical structure.
+ It is sometimes more convenient to extract a 1 dimensional slice across cells,
+ dropping the vertical dimension. This only makes sense for the role layers that
+ are by definition a single layer thick (``above``, ``surface`` and ``topsoil``),
+ and for these three layers, additional properties (e.g.
+ :attr:`.index_above_scalar`) are defined that will return a scalar index that
+ extracts a one-dimensional slice.
+
+ **Methods overview**:
+
+ * :meth:`.from_template`: this returns an empty DataArray with
+ the standard vertical layer structure and grid cell dimensions used across the
+ Virtual Ecosystem models.
+
+ * :meth:`.set_filled_canopy`: this method is used to update the
+ ``filled_canopy`` role indices, the related ``filled_atmosphere`` and
+ ``flux_layers`` roles, and the :attr:`.lowest_canopy_filled` attribute.
Raises:
ConfigurationError: If the configuration elements are incorrect for defining
- the model timing.
+ the layer structure.
"""
- canopy_layers: int = field(init=False)
+ config: InitVar[Config]
+ """A configuration object instance."""
+
+ # These two init arguments could also be accessed directly from the config, but
+ # this allows for the core components flow from Grid and CoreConstants to validate
+ # these values rather than doing it internally.
+ n_cells: InitVar[int]
+ """The number of grid cells in the simulation."""
+ max_depth_of_microbial_activity: float
+ """The maximum soil depth of significant microbial activity."""
+
+ # Attributes populated by __post_init__
+ n_canopy_layers: int = field(init=False)
"""The maximum number of canopy layers."""
- soil_layers: list[float] = field(init=False)
+ soil_layer_depths: NDArray[np.float32] = field(init=False)
"""A list of the depths of soil layer boundaries."""
+ n_soil_layers: int = field(init=False)
+ """The number of soil layers."""
above_canopy_height_offset: float = field(init=False)
"""The height above the canopy of the provided reference climate variables."""
surface_layer_height: float = field(init=False)
"""The height above ground used to represent surface conditions."""
- subcanopy_layer_height: float = field(init=False)
- """The height above ground used to represent subcanopy conditions."""
- layer_roles: list[str] = field(init=False)
- """An tuple of the roles of the vertical layers within the model from top to
- bottom."""
+ _n_cells: int = field(init=False)
+ """Private record of the number of grid cells in simulation."""
+ layer_roles: NDArray[np.str_] = field(init=False)
+ """An array of vertical layer role names from top to bottom."""
n_layers: int = field(init=False)
"""The total number of vertical layers in the model."""
- config: InitVar[Config]
- """A validated model configuration."""
-
- def __post_init__(self, config: Config) -> None:
+ layer_indices: NDArray[np.int_] = field(init=False)
+ """An array of the integer indices of the vertical layers in the model."""
+ _role_indices_bool: dict[str, NDArray[np.bool_]] = field(
+ init=False, default_factory=lambda: {}
+ )
+ """A dictionary of boolean layer role indices within the vertical structure."""
+ _role_indices_int: dict[str, NDArray[np.int_]] = field(
+ init=False, default_factory=lambda: {}
+ )
+ """A dictionary of integer layer role indices within the vertical structure."""
+ _role_indices_scalar: dict[str, int] = field(init=False, default_factory=lambda: {})
+ """A dictionary of scalar role indices within the vertical structure for single
+ layer roles."""
+ lowest_canopy_filled: NDArray[np.int_] = field(init=False)
+ """An integer index showing the lowest filled canopy layer for each grid cell"""
+ n_canopy_layers_filled: int = field(init=False)
+ """The current number of filled canopy layers across grid cells"""
+ soil_layer_thickness: NDArray[np.float32] = field(init=False)
+ """Thickness of each soil layer (m)"""
+ soil_layer_active_thickness: NDArray[np.float32] = field(init=False)
+ """Thickness of the microbially active soil in each soil layer (m)"""
+ _array_template: DataArray = field(init=False)
+ """A private data array template. Access copies using get_template."""
+
+ def __post_init__(self, config: Config, n_cells: int) -> None:
"""Populate the ``LayerStructure`` instance.
- This method populates the ``LayerStructure`` attributes from the provided
- :class:`~virtual_ecosystem.core.config.Config` instance.
+ This method populates the ``LayerStructure`` attributes from the dataclass init
+ arguments.
Args:
config: A Config instance.
+ n_cells: The number of grid cells in the simulation.
"""
- lyr_config = config["core"]["layers"]
+ # Store the number of grid cells privately
+ self._n_cells = n_cells
+
+ # Validates the configuration inputs and sets the layer structure attributes
+ self._validate_and_initialise_layer_config(config)
+
+ # Now populate the initial role indices and create the layer data template
+ self._populate_role_indices()
+
+ # Set the layer structure DataArray template
+ self._set_layer_data_array_template()
+
+ LOGGER.info("Layer structure built from model configuration")
+
+ def _validate_and_initialise_layer_config(self, config: Config):
+ """Layer structure config validation and attribute setting.
+
+ Args:
+ config: A Config instance.
+ """
+
+ lcfg = config["core"]["layers"]
# Validate configuration
- self.canopy_layers = _validate_positive_integer(lyr_config["canopy_layers"])
- self.soil_layers = _validate_soil_layers(lyr_config["soil_layers"])
+ self.n_canopy_layers = _validate_positive_integer(lcfg["canopy_layers"])
+
+ # Soil layers are negative floats
+ self.soil_layer_depths = np.array(_validate_soil_layers(lcfg["soil_layers"]))
+ self.n_soil_layers = len(self.soil_layer_depths)
# Other heights should all be positive floats
- for attr, value in (
- ("above_canopy_height_offset", lyr_config["above_canopy_height_offset"]),
- ("surface_layer_height", lyr_config["surface_layer_height"]),
- ("subcanopy_layer_height", lyr_config["subcanopy_layer_height"]),
- ):
- setattr(self, attr, _validate_positive_finite_numeric(value, attr))
-
- self.layer_roles = (
+ self.above_canopy_height_offset = _validate_positive_finite_numeric(
+ lcfg["above_canopy_height_offset"], "above_canopy_height_offset"
+ )
+ self.surface_layer_height = _validate_positive_finite_numeric(
+ lcfg["surface_layer_height"], "surface_layer_height"
+ )
+
+ # Set the layer role sequence
+ self.layer_roles: NDArray[np.str_] = np.array(
["above"]
- + ["canopy"] * int(self.canopy_layers)
- + ["subcanopy"]
+ + ["canopy"] * self.n_canopy_layers
+ ["surface"]
- + ["soil"] * len(self.soil_layers)
+ + ["topsoil"]
+ + ["subsoil"] * (self.n_soil_layers - 1)
)
+ # Record the number of layers and layer indices
self.n_layers = len(self.layer_roles)
+ self.layer_indices = np.arange(0, self.n_layers)
- LOGGER.info("Layer structure built from model configuration")
+ # Default values for lowest canopy filled and n filled canopy
+ self.lowest_canopy_filled = np.repeat(np.nan, self._n_cells)
+ self.n_canopy_layers_filled = 0
+
+ # Check that the maximum depth of the last layer is greater than the max depth
+ # of microbial activity.
+ if self.soil_layer_depths[-1] > -self.max_depth_of_microbial_activity:
+ to_raise = ConfigurationError(
+ "Maximum depth of soil layers is less than the maximum depth "
+ "of microbial activity"
+ )
+ LOGGER.error(to_raise)
+ raise to_raise
+
+ # Set up soil layer thickness and the thickness of microbially active soil
+ soil_layer_boundaries = np.array([0, *self.soil_layer_depths])
+ self.soil_layer_thickness = -np.diff(soil_layer_boundaries)
+ self.soil_layer_active_thickness = np.clip(
+ np.minimum(
+ self.soil_layer_thickness,
+ (soil_layer_boundaries + self.max_depth_of_microbial_activity)[:-1],
+ ),
+ a_min=0,
+ a_max=np.inf,
+ )
+
+ def _populate_role_indices(self):
+ """Populate the initial values for the layer role indices."""
+
+ # The five core role names
+ for layer_role in ("above", "canopy", "surface", "topsoil", "subsoil"):
+ self._set_base_index(layer_role, self.layer_roles == layer_role)
+
+ # Add the `all_soil` and `atmospheric` indices
+ self._set_base_index(
+ "all_soil",
+ np.logical_or(
+ self._role_indices_bool["topsoil"], self._role_indices_bool["subsoil"]
+ ),
+ )
+
+ self._set_base_index("atmosphere", ~self._role_indices_bool["all_soil"])
+
+ self._set_base_index(
+ "active_soil",
+ np.concatenate(
+ [
+ np.repeat(False, self.n_canopy_layers + 2),
+ self.soil_layer_active_thickness > 0,
+ ]
+ ),
+ )
+
+ # Set the default filled canopy indices to an empty canopy
+ self._set_base_index("filled_canopy", np.repeat(False, self.n_layers))
+
+ # Set two additional widely used indices
+ self._set_base_index(
+ "filled_atmosphere",
+ np.logical_or.reduce(
+ (
+ self._role_indices_bool["above"],
+ self._role_indices_bool["filled_canopy"],
+ self._role_indices_bool["surface"],
+ )
+ ),
+ )
+
+ self._set_base_index(
+ "flux_layers",
+ np.logical_or(
+ self._role_indices_bool["filled_canopy"],
+ self._role_indices_bool["topsoil"],
+ ),
+ )
+
+ # Set the scalar indices - using item here as a deliberate trap for accidental
+ # definition of these layers as being more than a single layer.
+ self._role_indices_scalar["above"] = self._role_indices_int["above"].item()
+ self._role_indices_scalar["surface"] = self._role_indices_int["surface"].item()
+ self._role_indices_scalar["topsoil"] = self._role_indices_int["topsoil"].item()
+
+ def _set_layer_data_array_template(self):
+ """Sets the template data array with the simulation vertical structure.
+
+ This data array structure is widely used across the Virtual Ecosystem and this
+ method sets up a template that can be copied via the
+ :meth:`LayerStructure.from_template`
+ method. The private attribute itself should not be accessed directly to avoid
+ accidental modification of the template.
+ """
+
+ # PERFORMANCE - does deepcopy of a store template provide any real benefit over
+ # from_template creating it when called.
+
+ self._array_template = DataArray(
+ np.full((self.n_layers, self._n_cells), np.nan),
+ dims=("layers", "cell_id"),
+ coords={
+ "layers": self.layer_indices,
+ "layer_roles": ("layers", self.layer_roles),
+ "cell_id": np.arange(self._n_cells),
+ },
+ )
+
+ def _set_base_index(self, name: str, bool_values: NDArray[np.bool_]) -> None:
+ """Helper method to populate the boolean and integer indices for base roles.
+
+ Args:
+ name: the name of the base role
+ bool_values: the boolean representation of the index data.
+ """
+ self._role_indices_bool[name] = bool_values
+ self._role_indices_int[name] = np.nonzero(bool_values)[0]
+
+ def set_filled_canopy(self, canopy_heights: NDArray[np.float32]) -> None:
+ """Set the dynamic canopy indices and attributes.
+
+ The layer structure includes a fixed number of canopy layers but these layers
+ are not all necessarily occupied. This method takes an array of canopy heights
+ across the grid cells of the simulation and populates the "filled_canopy"
+ indices, which are the canopy layers that contain at least one filled canopy
+ layer. It also populates the "lowest_canopy_filled" attribute.
+
+ Args:
+ canopy_heights: A n_canopy_layers by n_grid_cells array of canopy layer
+ heights.
+ """
+
+ if canopy_heights.shape != (self.n_canopy_layers, self._n_cells):
+ to_raise = ValueError("canopy_heights array has wrong dimensions.")
+ LOGGER.error(to_raise)
+ raise to_raise
+
+ # Update the filled canopy index
+ canopy_present = ~np.isnan(canopy_heights)
+ filled_canopy_bool = np.repeat(False, self.n_layers)
+ filled_canopy_bool[1 : (self.n_canopy_layers + 1)] = np.any(
+ canopy_present, axis=1
+ )
+ self._set_base_index("filled_canopy", filled_canopy_bool)
+
+ # Set the lowest filled attribute and number of layers
+ lowest_filled = np.nansum(canopy_present, axis=0)
+ self.lowest_canopy_filled = np.where(lowest_filled > 0, lowest_filled, np.nan)
+ self.n_canopy_layers_filled = np.sum(filled_canopy_bool)
+
+ # Update indices that rely on filled canopy
+ self._set_base_index(
+ "filled_atmosphere",
+ np.logical_or.reduce(
+ (
+ self._role_indices_bool["above"],
+ self._role_indices_bool["filled_canopy"],
+ self._role_indices_bool["surface"],
+ )
+ ),
+ )
+
+ self._set_base_index(
+ "flux_layers",
+ np.logical_or(
+ self._role_indices_bool["filled_canopy"],
+ self._role_indices_bool["topsoil"],
+ ),
+ )
+
+ def from_template(self, array_name: str | None = None) -> DataArray:
+ """Get a DataArray with the simulation vertical structure.
+
+ This method returns two dimensional :class:`xarray.DataArray` with coordinates
+ set to match the layer roles and number of grid cells for the current
+ simulation. The array is filled with ``np.nan`` values and the array name is set
+ if a name is provided.
+
+ Args:
+ array_name: An optional variable name to assign to the returned data array.
+ """
+
+ # Note that copy defaults to a deep copy, which is what is needed.
+ template_copy = self._array_template.copy()
+ if array_name:
+ template_copy.name = array_name
+
+ return template_copy
+
+ @property
+ def index_above(self) -> NDArray:
+ """Layer indices for the above layer."""
+ return self._role_indices_bool["above"]
+
+ @property
+ def index_canopy(self) -> NDArray:
+ """Layer indices for the above canopy layers."""
+ return self._role_indices_bool["canopy"]
+
+ @property
+ def index_surface(self) -> NDArray:
+ """Layer indices for the surface layer."""
+ return self._role_indices_bool["surface"]
+
+ @property
+ def index_topsoil(self) -> NDArray:
+ """Layer indices for the topsoil layer."""
+ return self._role_indices_bool["topsoil"]
+
+ @property
+ def index_subsoil(self) -> NDArray:
+ """Layer indices for the subsoil layers."""
+ return self._role_indices_bool["subsoil"]
+
+ @property
+ def index_all_soil(self) -> NDArray:
+ """Layer indices for all soil layers."""
+ return self._role_indices_bool["all_soil"]
+
+ @property
+ def index_atmosphere(self) -> NDArray:
+ """Layer indices for all atmospheric layers."""
+ return self._role_indices_bool["atmosphere"]
+
+ @property
+ def index_active_soil(self) -> NDArray:
+ """Layer indices for microbially active soil layers."""
+ return self._role_indices_bool["active_soil"]
+
+ @property
+ def index_filled_canopy(self) -> NDArray:
+ """Layer indices for the filled canopy layers."""
+ return self._role_indices_bool["filled_canopy"]
+
+ @property
+ def index_filled_atmosphere(self) -> NDArray:
+ """Layer indices for the filled atmospheric layers."""
+ return self._role_indices_bool["filled_atmosphere"]
+
+ @property
+ def index_flux_layers(self) -> NDArray:
+ """Layer indices for the flux layers."""
+ return self._role_indices_bool["flux_layers"]
+
+ @property
+ def index_above_scalar(self) -> int:
+ """Layer indices for the flux layers."""
+ return self._role_indices_scalar["above"]
+
+ @property
+ def index_topsoil_scalar(self) -> int:
+ """Layer indices for the flux layers."""
+ return self._role_indices_scalar["topsoil"]
+
+ @property
+ def index_surface_scalar(self) -> int:
+ """Layer indices for the flux layers."""
+ return self._role_indices_scalar["surface"]
def _validate_positive_integer(value: float | int) -> int:
"""Validation function for positive integer values including integer floats."""
- # Note that float.is_integer() traps np.infty and np.nan, both of which are floats
+ # Note that float.is_integer() traps np.inf and np.nan, both of which are floats
if (
- (not isinstance(value, (float, int)))
+ (not isinstance(value, float | int))
or (isinstance(value, int) and value < 1)
or (isinstance(value, float) and (not value.is_integer() or value < 1))
):
@@ -271,7 +676,7 @@ def _validate_soil_layers(soil_layers: list[int | float]) -> list[int | float]:
LOGGER.error(to_raise)
raise to_raise
- if not all([isinstance(v, (float, int)) for v in soil_layers]):
+ if not all([isinstance(v, float | int) for v in soil_layers]):
to_raise = ConfigurationError("The soil layer depths are not all numeric.")
LOGGER.error(to_raise)
raise to_raise
@@ -291,7 +696,7 @@ def _validate_positive_finite_numeric(value: float | int, label: str) -> float |
"""Validation function for positive numeric values."""
if (
- not isinstance(value, (float, int))
+ not isinstance(value, float | int)
or np.isinf(value)
or np.isnan(value)
or value < 0
diff --git a/virtual_ecosystem/core/data.py b/virtual_ecosystem/core/data.py
index 33abd3d71..bb0409357 100644
--- a/virtual_ecosystem/core/data.py
+++ b/virtual_ecosystem/core/data.py
@@ -118,11 +118,12 @@
# Load configured datasets
data.load_data_config(config)
-""" # noqa: D205, D415
+""" # noqa: D205
from pathlib import Path
from typing import Any
+import dask
import numpy as np
from xarray import DataArray, Dataset, open_mfdataset
@@ -133,6 +134,16 @@
from virtual_ecosystem.core.readers import load_to_dataarray
from virtual_ecosystem.core.utils import check_outfile
+# There are ongoing xarray issues with NetCDF not being thread safe and this causes
+# segfaults on different architectures in testing using `xarray.open_mfdataset`
+# See:
+# - https://github.com/pydata/xarray/issues/7079
+# - https://github.com/pydata/xarray/issues/3961
+#
+# Following advice on both those issues, we currently explicitly stop dask from trying
+# to use parallel file processing and use open_mfdataset(..., lock=False)
+dask.config.set(scheduler="single-threaded")
+
class Data:
"""The Virtual Ecosystem data object.
diff --git a/virtual_ecosystem/core/exceptions.py b/virtual_ecosystem/core/exceptions.py
index a525a3d66..fd25b4363 100644
--- a/virtual_ecosystem/core/exceptions.py
+++ b/virtual_ecosystem/core/exceptions.py
@@ -1,6 +1,6 @@
"""The ``core.exceptions`` module stores custom exceptions that are used within the core
module or used across multiple modules.
-""" # noqa: D205, D415
+""" # noqa: D205
class ConfigurationError(Exception):
diff --git a/virtual_ecosystem/core/grid.py b/virtual_ecosystem/core/grid.py
index 9a0b93553..67b691ddc 100644
--- a/virtual_ecosystem/core/grid.py
+++ b/virtual_ecosystem/core/grid.py
@@ -8,7 +8,7 @@
defining mappings though.
- maybe look at libpysal if we end up needing more weights/spatial analysis stuff?
https://pysal.org/libpysal/
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
@@ -326,7 +326,7 @@ def dumps(self, dp: int = 2, **kwargs: Any) -> str:
Args:
dp: The decimal place precision for exported coordinates
- kwargs: Arguments to json.dumps
+ **kwargs: Arguments to json.dumps
"""
content = self._get_geojson(dp=dp)
@@ -344,7 +344,7 @@ def dump(self, outfile: str, dp: int = 2, **kwargs: Any) -> None:
Args:
outfile: A path used to export GeoJSON data.
dp: The decimal place precision for exported coordinates
- kwargs: Arguments to json.dump
+ **kwargs: Arguments to json.dump
"""
content = self._get_geojson(dp=dp)
diff --git a/virtual_ecosystem/core/logger.py b/virtual_ecosystem/core/logger.py
index f7168106e..529d70c1c 100644
--- a/virtual_ecosystem/core/logger.py
+++ b/virtual_ecosystem/core/logger.py
@@ -73,7 +73,7 @@
except ValueError as excep:
LOGGER.critical(excep)
raise ValueError("Bad input") from excep
-""" # noqa: D205, D415
+""" # noqa: D205
import logging
from pathlib import Path
diff --git a/virtual_ecosystem/core/readers.py b/virtual_ecosystem/core/readers.py
index e5e7460c6..ee0dce21f 100644
--- a/virtual_ecosystem/core/readers.py
+++ b/virtual_ecosystem/core/readers.py
@@ -29,7 +29,7 @@
@register_file_format_loader(('.tif', '.tiff'))
def new_function_to_load_tif_data(...):
# code to turn tif file into a data array
-""" # noqa: D205, D415
+""" # noqa: D205
from collections.abc import Callable
from pathlib import Path
diff --git a/virtual_ecosystem/core/registry.py b/virtual_ecosystem/core/registry.py
index 9f4dec2ca..03c9eaa2c 100644
--- a/virtual_ecosystem/core/registry.py
+++ b/virtual_ecosystem/core/registry.py
@@ -9,7 +9,7 @@
The module also provides the :func:`~virtual_ecosystem.core.registry.register_module`
function, which is used to populate the registry with the components of a given module.
-""" # noqa: D205, D415
+""" # noqa: D205
from dataclasses import dataclass, is_dataclass
from importlib import import_module, resources
@@ -34,12 +34,17 @@ class ModuleInfo:
BaseModel subclass and the ``model`` attribute for the ``core`` module will be None.
"""
- model: Any # FIXME Optional[type[BaseModel]]
+ # FIXME The typing below for model should be `None | type[BaseModel]`, but this is
+ # circular. When core.base_model is imported, that imports core.config.Config, which
+ # imports core.registry, which would then need to import core.base_model to use this
+ # type. Not sure how to break out of this one, so for the moment, leaving as Any.
+
+ model: Any
"""The BaseModel subclass associated with the module."""
schema: dict[str, Any]
"""The module JSON schema as a dictionary, used to validate configuration data for
running a simulation."""
- constants_classes: dict[str, ConstantsDataclass]
+ constants_classes: dict[str, type[ConstantsDataclass]]
"""A dictionary of module constants classes. The individual ConstantsDataclass
objects are keyed by their name."""
is_core: bool
@@ -74,7 +79,7 @@ def register_module(module_name: str) -> None:
Args:
module_name: The full name of the module to be registered (e.g.
- 'virtual_ecosystem.model.animals').
+ 'virtual_ecosystem.model.animal').
Raises:
RuntimeError: if the requested module cannot be found or where a module does not
diff --git a/virtual_ecosystem/core/schema.py b/virtual_ecosystem/core/schema.py
index b771061be..628ec3ea8 100644
--- a/virtual_ecosystem/core/schema.py
+++ b/virtual_ecosystem/core/schema.py
@@ -20,7 +20,7 @@
The JSONSchema documents for a module should be loaded when a model is imported into the
:data:`~virtual_ecosystem.core.registry.MODULE_REGISTRY`. See the
:mod:`~virtual_ecosystem.core.registry` module for details.
-""" # noqa: D205, D415
+""" # noqa: D205
import json
from collections.abc import Iterator
diff --git a/virtual_ecosystem/core/utils.py b/virtual_ecosystem/core/utils.py
index 17ffce777..1204bc69e 100644
--- a/virtual_ecosystem/core/utils.py
+++ b/virtual_ecosystem/core/utils.py
@@ -2,13 +2,11 @@
Virtual Ecosystem, but which don't have a natural home in a specific module. Adding
functions here can be a good way to reduce the amount boiler plate code generated for
tasks that are repeated across modules.
-""" # noqa: D205, D415
+""" # noqa: D205
from pathlib import Path
-import numpy as np
-
-from virtual_ecosystem.core.exceptions import ConfigurationError, InitialisationError
+from virtual_ecosystem.core.exceptions import ConfigurationError
from virtual_ecosystem.core.logger import LOGGER
@@ -58,110 +56,3 @@ def check_outfile(merge_file_path: Path) -> None:
raise to_raise
return None
-
-
-def set_layer_roles(
- canopy_layers: int = 10, soil_layers: list[float] = [-0.5, -1.0]
-) -> list[str]:
- """Create a list of layer roles.
-
- This function creates a list of strings describing the layer roles for the vertical
- dimension of the Virtual Ecosystem. These roles are used with data arrays that have
- that vertical dimension: the roles then show what information is being captured at
- different heights through that vertical dimension. Within the model, ground level is
- at height 0 metres: above ground heights are positive and below ground heights are
- negative. At present, models are expecting two soil layers: the top layer being
- where microbial activity happens (usually around 0.5 metres below ground) and the
- second layer where soil temperature equals annual mean air temperature (usually
- around 1 metre below ground).
-
- There are five layer roles capture data:
-
- * ``above``: at ~2 metres above the top of the canopy.
- * ``canopy``: within each canopy layer. The maximum number of canopy layers is set
- by the ``canopy_layers`` argument and is a configurable part of the model. The
- heights of these layers are modelled from the plant community data.
- * ``subcanopy``: at ~1.5 metres above ground level.
- * ``surface``: at ~0.1 metres above ground level.
- * ``soil``: at fixed depths within the soil. These depths are set in the
- ``soil_layers`` argument and are a configurable part of the model.
-
- With the default values, this function gives the following layer roles.
-
- .. csv-table::
- :header: "Index", "Role", "Description"
- :widths: 5, 10, 30
-
- 0, "above", "Canopy top height + 2 metres"
- 1, "canopy", "Height of top of the canopy (1)"
- "...", "canopy", "Height of canopy layer ``i``"
- 10, "canopy", "Height of the bottom canopy layer (10)"
- 11, "subcanopy", "1.5 metres above ground level"
- 12, "surface", "0.1 metres above ground level"
- 13, "soil", "First soil layer at -0.5 metres"
- 14, "soil", "First soil layer at -1.0 metres"
-
- Args:
- canopy_layers: the number of canopy layers
- soil_layers: a list giving the depth of each soil layer as a sequence of
- negative and strictly decreasing values.
-
- Raises:
- InitialisationError: If the number of canopy layers is not a positive
- integer or the soil depths are not a list of strictly decreasing, negative
- float values.
-
- Returns:
- A list of vertical layer role names
- """
-
- # sanity checks for soil and canopy layers
- if not isinstance(soil_layers, list):
- to_raise = InitialisationError(
- "The soil layers must be a list of layer depths."
- )
- LOGGER.error(to_raise)
- raise to_raise
-
- if len(soil_layers) < 1:
- to_raise = InitialisationError(
- "The number of soil layers must be greater than zero."
- )
- LOGGER.error(to_raise)
- raise to_raise
-
- if not all([isinstance(v, (float, int)) for v in soil_layers]):
- to_raise = InitialisationError("The soil layer depths are not all numeric.")
- LOGGER.error(to_raise)
- raise to_raise
-
- np_soil_layer = np.array(soil_layers)
- if not (np.all(np_soil_layer < 0) and np.all(np.diff(np_soil_layer) < 0)):
- to_raise = InitialisationError(
- "Soil layer depths must be strictly decreasing and negative."
- )
- LOGGER.error(to_raise)
- raise to_raise
-
- if not isinstance(canopy_layers, int) and not (
- isinstance(canopy_layers, float) and canopy_layers.is_integer()
- ):
- to_raise = InitialisationError("The number of canopy layers is not an integer.")
- LOGGER.error(to_raise)
- raise to_raise
-
- if canopy_layers < 1:
- to_raise = InitialisationError(
- "The number of canopy layer must be greater than zero."
- )
- LOGGER.error(to_raise)
- raise to_raise
-
- layer_roles = (
- ["above"]
- + ["canopy"] * int(canopy_layers)
- + ["subcanopy"]
- + ["surface"]
- + ["soil"] * len(soil_layers)
- )
- return layer_roles
diff --git a/virtual_ecosystem/core/variables.py b/virtual_ecosystem/core/variables.py
new file mode 100644
index 000000000..175c5fd79
--- /dev/null
+++ b/virtual_ecosystem/core/variables.py
@@ -0,0 +1,456 @@
+"""Module for all variables.
+
+Variables are defined in the `data_variables.toml` file, in the root folder of
+`virtual_ecosystem `, which is loaded at runtime and validated. Variables are then
+registered in the `KNOWN_VARIABLES` registry. The usage of the variables is then
+discovered by checking the models for the different methods that the variables are
+used (initialisation, update, etc.).
+
+The variables actually used by the models in a run are then registered in the global
+`RUN_VARIABLES_REGISTRY` registry. The subset of the variables are checked to ensure
+the consistency of the simulation (eg. all variables required by a model are initialised
+by another model, all axis needed by the variables are defined, etc.).
+
+To add a new variable, simply edit the `data_variables.toml` file and add the variable
+as:
+
+.. code-block:: toml
+
+ [[variable]]
+ name = "variable_name"
+ description = "Description of the variable."
+ unit = "Unit of the variable."
+ variable_type = "Type of the variable."
+ axis = ["axis1", "axis2"]
+
+where `axis1` and `axis2` are the name of axis validators defined
+on :mod:`~virtual_ecosystem.core.axes`.
+"""
+
+import json
+import pkgutil
+import sys
+from collections.abc import Hashable
+from dataclasses import asdict, dataclass, field
+from importlib import import_module, resources
+from pathlib import Path
+from typing import cast
+
+from jsonschema import FormatChecker
+from tabulate import tabulate
+
+import virtual_ecosystem.core.axes as axes
+import virtual_ecosystem.core.base_model as base_model
+from virtual_ecosystem.core.logger import LOGGER
+from virtual_ecosystem.core.schema import ValidatorWithDefaults
+
+if sys.version_info[:2] >= (3, 11):
+ import tomllib
+else:
+ import tomli as tomllib
+
+
+def to_camel_case(snake_str: str) -> str:
+ """Convert a snake_case string to CamelCase.
+
+ Args:
+ snake_str: The snake case string to convert.
+
+ Returns:
+ The camel case string.
+ """
+ return "".join(x.capitalize() for x in snake_str.lower().split("_"))
+
+
+@dataclass
+class Variable:
+ """Simulation variable, containing static and runtime metadata."""
+
+ name: str
+ """Name of the variable. Must be unique."""
+ description: str
+ """Description of what the variable represents."""
+ unit: str
+ """Units the variable should be represented in."""
+ variable_type: str
+ """Type of the variable."""
+ axis: tuple[str, ...]
+ """Axes the variable is defined on."""
+ populated_by_init: list[str] = field(default_factory=list, init=False)
+ """Model that initialised the variable either in init or by input data."""
+ populated_by_update: list[str] = field(default_factory=list, init=False)
+ """Model that initialised the variable in its update method."""
+ required_by_init: list[str] = field(default_factory=list, init=False)
+ """Models that require the variable to be initialised."""
+ updated_by: list[str] = field(default_factory=list, init=False)
+ """Models that update the variable."""
+ required_by_update: list[str] = field(default_factory=list, init=False)
+ """Models that use the variable."""
+
+ def __post_init__(self) -> None:
+ """Register the variable in the known variables.
+
+ Raises:
+ ValueError: If a variable is already in the known variables registry.
+ """
+ if self.name in KNOWN_VARIABLES:
+ raise ValueError(
+ f"Variable {self.name} already in the known variables registry."
+ )
+
+ KNOWN_VARIABLES[self.name] = self
+
+
+RUN_VARIABLES_REGISTRY: dict[str, Variable] = {}
+"""The global registry of variables used in a run."""
+
+KNOWN_VARIABLES: dict[str, Variable] = {}
+"""The global known variable registry."""
+
+
+def register_all_variables() -> None:
+ """Registers all variables provided by the models."""
+ with open(
+ str(resources.files("virtual_ecosystem") / "data_variables.toml"), "rb"
+ ) as f:
+ known_vars = tomllib.load(f).get("variable", [])
+
+ with (resources.files("virtual_ecosystem.core") / "variables_schema.json").open(
+ "r"
+ ) as f:
+ schema = json.load(f)
+
+ val = ValidatorWithDefaults(schema, format_checker=FormatChecker())
+ val.validate(known_vars)
+
+ for var in known_vars:
+ Variable(**var)
+
+
+def _discover_models() -> list[type[base_model.BaseModel]]:
+ """Discover all the models in Virtual Ecosystem."""
+ import virtual_ecosystem.models as models
+
+ models_found = []
+ for mod in pkgutil.iter_modules(models.__path__):
+ if not mod.ispkg:
+ continue
+
+ try:
+ module = import_module(f"{models.__name__}.{mod.name}.{mod.name}_model")
+ except ImportError:
+ LOGGER.warning(
+ f"No model file found for model {models.__name__}.{mod.name}."
+ )
+ continue
+
+ mod_class_name = to_camel_case(mod.name) + "Model"
+ if hasattr(module, mod_class_name):
+ models_found.append(getattr(module, mod_class_name))
+ else:
+ LOGGER.warning(
+ f"No model class '{mod_class_name}' found in module "
+ f"'{models.__name__}.{mod.name}.{mod.name}_model'."
+ )
+ continue
+
+ return models_found
+
+
+def output_known_variables(output_file: Path) -> None:
+ """Output the known variables to a file.
+
+ For the variables to be output, the variables must be registered and the usage of
+ the variables must be discovered, assigning the appropriate models to the variables.
+
+ Args:
+ output_file: The file to output the known variables to.
+ """
+ register_all_variables()
+
+ models = _discover_models()
+ _collect_vars_populated_by_init(models, check_unique_initialisation=False)
+ _collect_vars_populated_by_first_update(models, check_unique_initialisation=False)
+
+ # Add any variables that are not yet in the run registry to account for those
+ # that would have been initialised by the data object.
+ for name, var in KNOWN_VARIABLES.items():
+ if name not in RUN_VARIABLES_REGISTRY:
+ RUN_VARIABLES_REGISTRY[name] = var
+
+ _collect_vars_required_for_init(models)
+ _collect_updated_by_vars(models)
+ _collect_vars_required_for_update(models)
+
+ vars = {
+ var.name: asdict(var)
+ for var in sorted(KNOWN_VARIABLES.values(), key=lambda x: x.name)
+ }
+
+ Path(output_file).with_suffix(".rst").write_text(_format_varriables_list(vars))
+
+
+def _format_varriables_list(vars: dict[str, dict]) -> str:
+ """Format the variables list for the RST output.
+
+ Args:
+ vars: The variables to format.
+
+ Returns:
+ The flist of variables and atrributes formated as a sequence of tables
+ in RST format.
+ """
+ out = []
+ for i, v in enumerate(vars.values()):
+ title = f"{i+1}- {v['name']}"
+ out.append(title)
+ out.append(f"{'=' * len(title)}")
+ out.append("")
+ out.append(tabulate(list(zip(v.keys(), v.values())), tablefmt="rst"))
+ out.append("")
+
+ return "\n".join(out)
+
+
+def _collect_vars_populated_by_init(
+ models: list[type[base_model.BaseModel]], check_unique_initialisation: bool = True
+) -> None:
+ """Initialise the runtime variable registry.
+
+ It is a runtime error if a variable is initialised by more than one model. However,
+ when this function is used to populate variable descriptions across known model - as
+ in :func:`virtual_ecosystem.core.variables.output_known_variables` - alternative
+ models may report initialising the same variable. The `check_unique_initialisation`
+ flag is used to switch between these use cases.
+
+ Args:
+ models: The list of models that are initialising the variables.
+ check_unique_initialisation: Fail on duplicate intialisation.
+
+ Raises:
+ ValueError: If a variable required by a model is not in the known variables
+ registry or if it is already initialised by another model.
+ """
+ for model in models:
+ for var in model.vars_populated_by_init:
+ if var not in KNOWN_VARIABLES:
+ raise ValueError(
+ f"Variable {var} initialised by {model.model_name} is not in the"
+ " known variables registry."
+ )
+ if var in RUN_VARIABLES_REGISTRY and check_unique_initialisation:
+ raise ValueError(
+ f"Variable {var} initialised by {model.model_name} already in "
+ f"registry as initialised by "
+ f"{RUN_VARIABLES_REGISTRY[var].populated_by_init}."
+ )
+
+ KNOWN_VARIABLES[var].populated_by_init.append(model.model_name)
+ RUN_VARIABLES_REGISTRY[var] = KNOWN_VARIABLES[var]
+
+
+def _collect_vars_populated_by_first_update(
+ models: list[type[base_model.BaseModel]], check_unique_initialisation: bool = True
+) -> None:
+ """Initialise the runtime variable registry.
+
+ It is a runtime error if a variable is initialised by more than one model. However,
+ when this function is used to populate variable descriptions across known model - as
+ in :func:`virtual_ecosystem.core.variables.output_known_variables` - alternative
+ models may report initialising the same variable. The `check_unique_initialisation`
+ flag is used to switch between these use cases.
+
+ Args:
+ models: The list of models that are initialising the variables.
+ check_unique_initialisation: Fail on duplicate intialisation.
+
+ Raises:
+ ValueError: If a variable required by a model is not in the known variables
+ registry or if it is already initialised by another model.
+ """
+ for model in models:
+ for var in model.vars_populated_by_first_update:
+ if var not in KNOWN_VARIABLES:
+ raise ValueError(
+ f"Variable {var} initialised by {model.model_name} is not in the"
+ " known variables registry."
+ )
+ if var in RUN_VARIABLES_REGISTRY and check_unique_initialisation:
+ v = RUN_VARIABLES_REGISTRY[var]
+ initialiser = (
+ v.populated_by_init[0]
+ if v.populated_by_init
+ else v.populated_by_update[0]
+ )
+ raise ValueError(
+ f"Variable {var} initialised by {model.model_name} already in "
+ f"registry as initialised by {initialiser}."
+ )
+
+ KNOWN_VARIABLES[var].populated_by_update.append(model.model_name)
+ RUN_VARIABLES_REGISTRY[var] = KNOWN_VARIABLES[var]
+
+
+def _collect_updated_by_vars(models: list[type[base_model.BaseModel]]) -> None:
+ """Verify that all variables updated by models are in the runtime registry.
+
+ Args:
+ models: The list of models to check.
+
+ Raises:
+ ValueError: If a variable required by a model is not in the known variables
+ registry or the runtime registry.
+ """
+ for model in models:
+ for var in model.vars_updated:
+ if var not in KNOWN_VARIABLES:
+ raise ValueError(
+ f"Variable {var} required by {model.model_name} is not in the known"
+ " variables registry."
+ )
+ if var not in RUN_VARIABLES_REGISTRY:
+ raise ValueError(
+ f"Variable {var} required by {model.model_name} is not initialised"
+ " by any model."
+ )
+ if len(RUN_VARIABLES_REGISTRY[var].updated_by):
+ LOGGER.warning(
+ f"Variable {var} updated by {model.model_name} is already updated"
+ f" by {RUN_VARIABLES_REGISTRY[var].updated_by}."
+ )
+ RUN_VARIABLES_REGISTRY[var].updated_by.append(model.model_name)
+
+
+def _collect_vars_required_for_update(models: list[type[base_model.BaseModel]]) -> None:
+ """Verify that all variables required by the update methods are in the registry.
+
+ Args:
+ models: The list of models to check.
+
+ Raises:
+ ValueError: If a variable required by a model is not in the known variables
+ registry or the runtime registry.
+ """
+ for model in models:
+ for var in model.vars_required_for_update:
+ if var not in KNOWN_VARIABLES:
+ raise ValueError(
+ f"Variable {var} required by {model.model_name} is not in the known"
+ " variables registry."
+ )
+ if var not in RUN_VARIABLES_REGISTRY:
+ raise ValueError(
+ f"Variable {var} required by {model.model_name} is not initialised"
+ " by any model neither provided as input."
+ )
+ RUN_VARIABLES_REGISTRY[var].required_by_update.append(model.model_name)
+
+
+def _collect_vars_required_for_init(models: list[type[base_model.BaseModel]]) -> None:
+ """Verify that all variables required by the init methods are in the registry.
+
+ Args:
+ models: The list of models to check.
+
+ Raises:
+ ValueError: If a variable required by a model is not in the known variables
+ registry or the runtime registry.
+ """
+ for model in models:
+ for var in model.vars_required_for_init:
+ # TODO In the future, var will be a string, so this won't be necessary
+ # var = v[0]
+ if var not in KNOWN_VARIABLES:
+ raise ValueError(
+ f"Variable {var} required by {model.model_name} is not in the known"
+ " variables registry."
+ )
+ if var not in RUN_VARIABLES_REGISTRY:
+ raise ValueError(
+ f"Variable {var} required by {model.model_name} during "
+ "initialisation is not initialised by any model neither provided as"
+ " input."
+ )
+ RUN_VARIABLES_REGISTRY[var].required_by_init.append(model.model_name)
+
+
+def _collect_initial_data_vars(vars: list[str]) -> None:
+ """Collects the variables defined in the data object.
+
+ Args:
+ vars: The list of variables defined in the data object.
+ """
+ for var in vars:
+ if var not in KNOWN_VARIABLES:
+ raise ValueError(f"Variable {var} defined in data object is not known.")
+
+ if var in RUN_VARIABLES_REGISTRY:
+ raise ValueError(
+ f"Variable {var} already in registry, initialised by"
+ f"{RUN_VARIABLES_REGISTRY[var].populated_by_init}."
+ )
+
+ KNOWN_VARIABLES[var].populated_by_init.append("data")
+ RUN_VARIABLES_REGISTRY[var] = KNOWN_VARIABLES[var]
+
+
+def setup_variables(
+ models: list[type[base_model.BaseModel]], data_vars: list[Hashable]
+) -> None:
+ """Setup the runtime variable registry, running some validation.
+
+ Args:
+ models: The list of models to setup the registry for.
+ data_vars: The list of variables defined in the data object.
+
+ Raises:
+ ValueError: If a variable required by a model is not in the known variables
+ registry or the runtime registry.
+ """
+ # Variables related to the initialisation step
+ _collect_initial_data_vars(cast(list[str], data_vars))
+ _collect_vars_populated_by_init(models)
+ _collect_vars_required_for_init(models)
+
+ # Variables related to the update step
+ _collect_vars_populated_by_first_update(models)
+ _collect_updated_by_vars(models)
+ _collect_vars_required_for_update(models)
+
+
+def verify_variables_axis() -> None:
+ """Verify that all required variables have valid, available axis."""
+ for var in RUN_VARIABLES_REGISTRY.values():
+ unknown_axes = sorted(set(var.axis).difference(axes.AXIS_VALIDATORS.keys()))
+
+ if unknown_axes:
+ to_raise = ValueError(
+ f"Variable {var.name} uses unknown axis: {','.join(unknown_axes)}"
+ )
+ LOGGER.error(to_raise)
+ raise to_raise
+
+
+def get_variable(name: str) -> Variable:
+ """Get the variable by name.
+
+ Args:
+ name: The name of the variable to get.
+
+ Returns:
+ The variable with the given name.
+
+ Raises:
+ KeyError: If the variable is not in the run variables registry, whether known
+ or unknown to Virtual Ecosystem.
+ """
+ if var := RUN_VARIABLES_REGISTRY.get(name):
+ return var
+
+ if name in KNOWN_VARIABLES:
+ raise KeyError(
+ f"Variable '{name}' is a known variable but is not initialised by any model"
+ " or provided as input data in this run."
+ )
+ else:
+ raise KeyError(f"Variable '{name}' is not a known variable.")
diff --git a/virtual_ecosystem/core/variables_schema.json b/virtual_ecosystem/core/variables_schema.json
new file mode 100644
index 000000000..513235b30
--- /dev/null
+++ b/virtual_ecosystem/core/variables_schema.json
@@ -0,0 +1,42 @@
+{
+ "type": "array",
+ "description": "Variables available in Virtual Ecosystem",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the variable. Must be unique.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of what the variable represents.",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Units the variable should be represented in.",
+ "type": "string"
+ },
+ "variable_type": {
+ "description": "Type of the variable.",
+ "type": "string"
+ },
+ "axis": {
+ "description": "Axes the variable is defined on.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ },
+ "required": [
+ "name",
+ "description",
+ "unit",
+ "variable_type",
+ "axis"
+ ]
+ },
+ "minItems": 1,
+ "uniqueItems": true
+}
\ No newline at end of file
diff --git a/virtual_ecosystem/data_variables.toml b/virtual_ecosystem/data_variables.toml
index 75e66f4f4..9ec4df306 100644
--- a/virtual_ecosystem/data_variables.toml
+++ b/virtual_ecosystem/data_variables.toml
@@ -1,550 +1,853 @@
[[variable]]
-name = "air_temperature"
-description = "Air temperature profile"
-unit = "C"
-initialised_by = ["abiotic", "abiotic_simple"]
-updated_by = ["abiotic", "abiotic_simple"]
-used_by = [ "abiotic", "abiotic_simple", "plants", "animals"]
+axis = [] # ["community_id", "functional_group_id"]
+description = "Density of animal populations."
+name = "population_densities"
+unit = "???"
+variable_type = "float"
[[variable]]
-name = "air_temperature_ref"
-description = "Air temperature at reference height (2m)"
-unit = "C"
-initialised_by = "external"
-updated_by = ""
-used_by = ["abiotic", "abiotic_simple"]
+axis = ["spatial"]
+description = "Air heat conductivity between layers"
+name = "air_heat_conductivity"
+unit = "mol m-2 s-1"
+variable_type = "float"
[[variable]]
-name = "albedo_shortwave"
-description = "Shortwave light albedo"
-unit = "-"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Air temperature profile"
+name = "air_temperature"
+unit = "C"
+variable_type = "float"
[[variable]]
-name = "albedo_vis"
-description = "Visible light albedo"
-unit = "-"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "abiotic"]
+axis = ["spatial", "time"]
+description = "Air temperature at reference height (2m)"
+name = "air_temperature_ref"
+unit = "C"
+variable_type = "float"
[[variable]]
-name = "animal_respiration"
+axis = ["spatial"]
description = "Animal respiration aggregated over all functional types"
+name = "total_animal_respiration"
unit = "ppm"
-initialised_by = "animals"
-updated_by = "animals"
-used_by = [ "abiotic", "animals"]
+variable_type = "float"
[[variable]]
-name = "atmospheric_co2"
+axis = ["spatial"]
description = "Atmospheric CO2 concentration profile"
+name = "atmospheric_co2"
unit = "ppm"
-initialised_by = ["abiotic", "abiotic_simple"]
-updated_by = ["abiotic", "abiotic_simple"]
-used_by = ["abiotic", "abiotic_simple", "plants"]
+variable_type = "float"
[[variable]]
-name = "atmospheric_co2_ref"
+axis = ["spatial", "time"]
description = "Atmospheric CO2 concentration at reference height (above canopy)"
+name = "atmospheric_co2_ref"
unit = "ppm"
-initialised_by = "external"
-updated_by = ""
-used_by = ["abiotic", "abiotic_simple"]
+variable_type = "float"
[[variable]]
-name = "atmospheric_pressure"
+axis = ["spatial"]
description = "Atmospheric pressure profile"
+name = "atmospheric_pressure"
unit = "kPa"
-initialised_by = ["abiotic", "abiotic_simple"]
-updated_by = ["abiotic", "abiotic_simple"]
-used_by = ["abiotic", "abiotic_simple", "hydrology", "plants"]
+variable_type = "float"
[[variable]]
-name = "atmospheric_pressure_ref"
+axis = ["spatial", "time"]
description = "Atmospheric pressure at reference height (2m)"
+name = "atmospheric_pressure_ref"
unit = "kPa"
-initialised_by = "external"
-updated_by = ""
-used_by = ["abiotic", "abiotic_simple", "hydrology"]
+variable_type = "float"
[[variable]]
-name = "bulk_aerodynamic_resistance"
-description = "Bulk aerodynamic resistance"
-unit = "s m-1"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Wind attenuation coefficient"
+name = "attenuation_coefficient"
+unit = "-"
+variable_type = "float"
[[variable]]
-name = "canopy_absorption"
-description = "Shortwave radiation absorbed by individual canopy layers"
-unit = "J m-2"
-initialised_by = "plants"
-updated_by = "plants"
-used_by = [ "abiotic", "plants"]
+axis = ["spatial"]
+description = "Baseflow"
+name = "baseflow"
+unit = "mm"
+variable_type = "float"
[[variable]]
-name = "canopy_height"
-description = "Canopy height"
-unit = "m"
-initialised_by = "plants"
-updated_by = "plants"
-used_by = ["abiotic", "abiotic_simple", "plants"]
+axis = ["spatial"]
+description = "Bypass flow"
+name = "bypass_flow"
+unit = "mm"
+variable_type = "float"
[[variable]]
-name = "layer_heights"
-description = "Heights of canopy layers"
+axis = ["spatial"]
+description = "Shortwave radiation absorbed by individual canopy layers"
+name = "canopy_absorption"
+unit = ""
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Canopy height"
+name = "canopy_height"
unit = "m"
-initialised_by = "plants"
-updated_by = "plants"
-used_by = ["abiotic", "abiotic_simple", "plants"]
+variable_type = "float"
[[variable]]
-name = "canopy_temperature"
+axis = ["spatial"]
description = "Canopy temperature of individual layers"
+name = "canopy_temperature"
unit = "C"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+variable_type = "float"
[[variable]]
-name = "elevation"
+axis = ["spatial"]
+description = "Conductivity from reference height"
+name = "conductivity_from_ref_height"
+unit = "mol m-2 s-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Conductivity from soil"
+name = "conductivity_from_soil"
+unit = "mol m-2 s-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Diabatic correction factor for heat above canopy"
+name = "diabatic_correction_heat_above"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Diabatic correction factor for heat in canopy"
+name = "diabatic_correction_heat_canopy"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Diabatic correction factor for momentum above canopy"
+name = "diabatic_correction_momentum_above"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Diabatic correction factor for momentum in canopy"
+name = "diabatic_correction_momentum_canopy"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Elevation above sea level"
+name = "elevation"
unit = "m"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "hydrology"]
+variable_type = "float"
[[variable]]
-name = "evapotranspiration"
+axis = ["spatial"]
description = "Evapotranspiration"
-initialised_by = "plants"
-updated_by = "plants"
-used_by = ["abiotic", "abiotic_simple", "hydrology", "plants"]
+name = "evapotranspiration"
+unit = "mm"
+variable_type = "float"
[[variable]]
-name = "friction_velocity"
+axis = ["spatial"]
description = "Friction velocity"
+name = "friction_velocity"
unit = "m s-1"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "abiotic"]
+variable_type = "float"
[[variable]]
-name = "ground_heat_flux"
+axis = ["spatial"]
description = "Ground heat flux"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+name = "ground_heat_flux"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "latent_heat_flux_canopy"
-description = "Latent heat flux from canopy layers"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Groundwater Storage"
+name = "groundwater_storage"
+unit = "mm"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Latent heat flux profile"
+name = "latent_heat_flux"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Latent heat flux from topsoil layer"
name = "latent_heat_flux_soil"
-description = "Latent heat flux from surface layer"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "leaf_area_index"
+axis = ["spatial"]
+description = "Latent heat of vapourisation"
+name = "latent_heat_vapourisation"
+unit = "kJ kg-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Heights of model layers"
+name = "layer_heights"
+unit = "m"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Leaf air heat conductivity"
+name = "leaf_air_heat_conductivity"
+unit = "mol m-2 s-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Leaf area index"
-unit = "m m"
-initialised_by = "plants"
-updated_by = "plants"
-used_by = ["abiotic", "abiotic_simple", "hydrology", "plants"]
+name = "leaf_area_index"
+unit = "m m-1"
+variable_type = "float"
[[variable]]
-name = "longwave_canopy"
+axis = ["spatial"]
+description = "Leaf vapour conductivity"
+name = "leaf_vapour_conductivity"
+unit = "mol m-2 s-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Longwave radiation from individual canopy layers"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+name = "longwave_canopy"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "longwave_soil"
-description = "Longwave radiation from surface layer"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Longwave radiation from topsoil layer"
+name = "longwave_emission_soil"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "mean_annual_temperature"
+axis = ["spatial"]
+description = "Matric potential"
+name = "matric_potential"
+unit = "kPa"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial", "time"]
description = "Mean annual temperature = temperature of deepest soil layer"
+name = "mean_annual_temperature"
unit = "C"
-initialised_by = "external"
-updated_by = ""
-used_by = ["abiotic", "abiotic_simple"]
+variable_type = "float"
[[variable]]
-name = "molar_density_air"
-description = "Temperature-dependent molar density of air"
-unit = "kg m-3"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Mean mixing length"
+name = "mean_mixing_length"
+unit = "m"
+variable_type = "float"
[[variable]]
-name = "netradiation_surface"
-description = "Net shortwave radiation at the surface"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Temperature-dependent molar density of air"
+name = "molar_density_air"
+unit = "kg m-3"
+variable_type = "float"
[[variable]]
-name = "plant_net_co2_assimilation"
+axis = []
description = "Plant net CO2 assimilation"
+name = "plant_net_co2_assimilation"
unit = "ppm"
-initialised_by = "plants"
-updated_by = "plants"
-used_by = [ "abiotic", "plants"]
+variable_type = ""
[[variable]]
-name = "ppfd"
-description = "Top of canopy photosynthetic photon flux density"
-unit = "mol m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic", "plants"]
+axis = ["spatial", "time"]
+description = "Top of canopy photosynthetic photon flux density (PPFD)"
+name = "photosynthetic_photon_flux_density"
+unit = "umol m-2 s-1"
+variable_type = "float"
[[variable]]
+axis = ["spatial", "time"]
+description = "Precipitation input at the top of the canopy"
name = "precipitation"
-description = "Precipitation"
unit = "mm"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "hydrology"]
+variable_type = "float"
[[variable]]
-name = "precipitation_surface"
+axis = ["spatial"]
description = "Precipitation that reaches surface"
+name = "precipitation_surface"
unit = "mm"
-initialised_by = "hydrology"
-updated_by = ""
-used_by = [ "hydrology", "plants]
+variable_type = "float"
[[variable]]
-name = "relative_humidity"
+axis = ["spatial"]
description = "Relative humidity profile"
+name = "relative_humidity"
unit = "%"
-initialised_by = ["abiotic", "abiotic_simple"]
-updated_by = ["abiotic", "abiotic_simple"]
-used_by = ["abiotic", "abiotic_simple", "hydrology", "plants"]
+variable_type = "float"
[[variable]]
-name = "relative_humidity_ref"
+axis = ["spatial", "time"]
description = "Relative humidity at reference height (2m)"
+name = "relative_humidity_ref"
unit = "%"
-initialised_by = "external"
-updated_by = ""
-used_by = ["abiotic", "abiotic_simple", "hydrology"]
+variable_type = "float"
[[variable]]
-name = "river_discharge"
-description = "River discharge"
+axis = ["spatial"]
+description = "Relative turbulence intensity"
+name = "relative_turbulence_intensity"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "River discharge rate"
+name = "river_discharge_rate"
unit = "m3 s-1"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology"]
+variable_type = "float"
[[variable]]
-name = "stream_flow"
-description = "Estimated stream flow"
-unit = "mm per time step"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology"]
+axis = ["spatial"]
+description = "Aerodynamic resistance surface"
+name = "aerodynamic_resistance_surface"
+unit = "kg m2 s-3"
+variable_type = "float"
[[variable]]
-name = "roughness_length_momentum"
+axis = ["spatial"]
description = "Roughness length for momentum"
+name = "roughness_length_momentum"
unit = "m"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+variable_type = "float"
[[variable]]
-name = "sensible_heat_flux"
-description = "Sensible heat flux from canopy and surface"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial", "time"]
+description = "Saturated vapour pressure at reference height (2m)"
+name = "saturated_vapour_pressure_ref"
+unit = "kPa"
+variable_type = "float"
[[variable]]
-name = "sensible_heat_flux_canopy"
-description = "Sensible heat flux from canopy"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Sensible heat flux profile"
+name = "sensible_heat_flux"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Sensible heat flux from topsoil layer"
name = "sensible_heat_flux_soil"
-description = "Sensible heat flux from surface layer"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "shortwave_in"
-description = "Downward shortwave radiation"
-unit = "J m-2"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Shortwave radiation at the surface"
+name = "shortwave_radiation_surface"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "soil_evaporation"
+axis = ["spatial"]
+description = "Shortwave radiation absorbed by topsoil layer"
+name = "soil_absorption"
+unit = "W m-2"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Soil vapour pressure"
+name = "soil_vapour_pressure"
+unit = "kPa"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Accumulated subsurface flow"
+name = "subsurface_flow_accumulated"
+unit = "mm"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Soil evaporation"
+name = "soil_evaporation"
unit = "mm"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = ["abiotic", "hydrology"]
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Soil moisture"
name = "soil_moisture"
-description = "Soil moisture as volumetric relative water content"
-unit = "-"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = ["abiotic", "abiotic_simple", "hydrology", "soil"]
+unit = "mm"
+variable_type = "float"
[[variable]]
-name = "soil_respiration"
+axis = ["spatial"]
description = "Soil respiration"
+name = "soil_respiration"
unit = "ppm"
-initialised_by = "soil"
-updated_by = "soil"
-used_by = [ "abiotic", "soil"]
+variable_type = ""
[[variable]]
-name = "soil_temperature"
+axis = ["spatial"]
description = "Soil temperature profile"
+name = "soil_temperature"
unit = "C"
-initialised_by = ["abiotic", "abiotic_simple]
-updated_by = ["abiotic", "abiotic_simple"]
-used_by = ["abiotic", "abiotic_simple", "soil"]
+variable_type = "float"
[[variable]]
-name = "specific_heat_air"
+axis = ["spatial"]
description = "Specific heat of air"
+name = "specific_heat_air"
unit = "kJ kg-1"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = ["abiotic"]
+variable_type = "float"
[[variable]]
-name = "specific_humidity"
+axis = ["spatial"]
description = "Specific humidity of air"
+name = "specific_humidity"
unit = "g kg-1"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic", "plants"]
+variable_type = ""
[[variable]]
-name = "subsurface_runoff"
-description = "Subsurface runoff"
-unit = "mm"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology", "soil"]
+axis = ["spatial"]
+description = "Stomatal conductance"
+name = "stomatal_conductance"
+unit = "mol m-2 s-1"
+variable_type = "float"
[[variable]]
-name = "sunshine_fraction"
-description = "Fraction of sunshine hours, between 0 and 1"
-unit = "-"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Estimated stream flow"
+name = "stream_flow"
+unit = "mm per time step"
+variable_type = "float"
[[variable]]
-name = "surface_runoff"
+axis = ["spatial"]
+description = "Subsurface flow"
+name = "subsurface_flow"
+unit = "mm"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Surface runoff generated in each grid cell"
+name = "surface_runoff"
unit = "mm"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology", "soil"]
+variable_type = "float"
[[variable]]
-name = "surface_runoff_accumulated"
+axis = ["spatial"]
description = "Accumlated surface runoff"
+name = "surface_runoff_accumulated"
unit = "mm"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology"]
+variable_type = "float"
[[variable]]
-name = "surface_water"
-description = "Searchable surface water"
-unit = "%"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology", "soil", "animal"]
+axis = ["spatial"]
+description = "Top of canopy downward shortwave radiation"
+name = "topofcanopy_radiation"
+unit = "W m-2"
+variable_type = "float"
[[variable]]
-name = "topofcanopy_radiation"
-description = "Top of canopy downward shortwave radiation"
-unit = "J m-2"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial"]
+description = "Total river discharge"
+name = "total_river_discharge"
+unit = "mm"
+variable_type = "float"
[[variable]]
-name = "vertical_flow"
-description = "Vertical flow of water through soil column"
-unit = "mm per time step"
-initialised_by = "hydrology"
-updated_by = "hydrology"
-used_by = [ "hydrology", "soil"]
+axis = ["spatial"]
+description = "Vapour pressure profile"
+name = "vapour_pressure"
+unit = "kPa"
+variable_type = "float"
[[variable]]
-name = "wind_above_canopy"
-description = "Wind above canopy"
-unit = "m s-1"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic"]
+axis = ["spatial", "time"]
+description = "Vapour pressure at reference height (2m)"
+name = "vapour_pressure_ref"
+unit = "kPa"
+variable_type = "float"
[[variable]]
-name = "wind_below_canopy"
+axis = ["spatial"]
+description = "Vapour pressure deficit profile"
+name = "vapour_pressure_deficit"
+unit = "kPa"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial", "time"]
+description = "Vapour pressure deficit at reference height (2m)"
+name = "vapour_pressure_deficit_ref"
+unit = "kPa"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Vertical flow of water through soil column"
+name = "vertical_flow"
+unit = "mm per time step (currently day)"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Wind profile within and below canopy"
+name = "wind_speed"
unit = "m s-1"
-initialised_by = "abiotic"
-updated_by = "abiotic"
-used_by = [ "abiotic", "hydrology"]
+variable_type = "float"
[[variable]]
-name = "wind_speed_ref"
+axis = ["spatial", "time"]
description = "Wind speed at reference height (10m)"
+name = "wind_speed_ref"
unit = "m s-1"
-initialised_by = "external"
-updated_by = ""
-used_by = [ "abiotic", "hydrology"]
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Zero displacement height"
+name = "zero_displacement_height"
+unit = "m"
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Soil low molecular weight carbon pool"
name = "soil_c_pool_lmwc"
-description = "Size of low molecular weight carbon pool"
unit = "kg C m-3"
-initialised_by = "soil"
-updated_by = "soil"
-used_by = [ "plants", "soil"]
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Soil mineral associated organic matter pool "
name = "soil_c_pool_maom"
-description = "Size of mineral associated organic matter pool"
unit = "kg C m-3"
-initialised_by = "soil"
-updated_by = "soil"
-used_by = [ "soil"]
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Soil microbial biomass (carbon) pool"
name = "soil_c_pool_microbe"
-description = "Size of microbial biomass pool"
unit = "kg C m-3"
-initialised_by = "soil"
-updated_by = "soil"
-used_by = [ "soil"]
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Particulate organic matter pool"
name = "soil_c_pool_pom"
-description = "Size of microbial biomass pool"
unit = "kg C m-3"
-initialised_by = "soil"
-updated_by = "soil"
-used_by = ["soil"]
+variable_type = "float"
[[variable]]
-name = "bulk_density"
+axis = ["spatial"]
+description = "Necrotic organic matter pool"
+name = "soil_c_pool_necromass"
+unit = "kg C m-3"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Bulk density of soil"
+name = "bulk_density"
unit = "kg m-3"
-initialised_by = "external"
-updated_by = "soil"
-used_by = [ "abiotic", "soil"]
+variable_type = "float"
[[variable]]
+axis = ["spatial"]
+description = "Soil pH values for each grid cell"
name = "pH"
-description = "Soil pH"
unit = "pH"
-initialised_by = "external"
-updated_by = "soil"
-used_by = [ "soil"]
+variable_type = "float"
[[variable]]
-name = "litter_pool_above_metabolic"
+axis = ["spatial"]
description = "Above ground metabolic litter pool"
+name = "litter_pool_above_metabolic"
unit = "kg C m^-2"
-initialised_by = "litter"
-updated_by = "litter"
-used_by = [ "litter"]
+variable_type = "float"
[[variable]]
-name = "litter_pool_above_structural"
+axis = ["spatial"]
description = "Above ground structural litter pool"
+name = "litter_pool_above_structural"
unit = "kg C m^-2"
-initialised_by = "litter"
-updated_by = "litter"
-used_by = [ "litter"]
+variable_type = "float"
[[variable]]
-name = "litter_pool_woody"
+axis = ["spatial"]
description = "Woody litter pool"
+name = "litter_pool_woody"
unit = "kg C m^-2"
-initialised_by = "litter"
-updated_by = "litter"
-used_by = [ "litter"]
+variable_type = "float"
[[variable]]
-name = "litter_pool_below_metabolic"
+axis = ["spatial"]
description = "Below ground metabolic litter pool"
+name = "litter_pool_below_metabolic"
unit = "kg C m^-2"
-initialised_by = "litter"
-updated_by = "litter"
-used_by = [ "litter"]
+variable_type = "float"
[[variable]]
-name = "litter_pool_below_structural"
+axis = ["spatial"]
description = "Below ground structural litter pool"
+name = "litter_pool_below_structural"
unit = "kg C m^-2"
-initialised_by = "litter"
-updated_by = "litter"
-used_by = [ "litter"]
+variable_type = "float"
[[variable]]
-name = "litter_C_mineralisation_rate"
+axis = ["spatial"]
description = "Rate of carbon addition to soil from litter"
+name = "litter_C_mineralisation_rate"
unit = "kg C m^-3 day^-1"
-initialised_by = "litter"
-updated_by = "litter"
-used_by = [ "soil"]
+variable_type = "float"
[[variable]]
-name = "decomposed_excrement"
+axis = ["spatial"]
+description = "Rate of nitrogen addition to soil from litter"
+name = "litter_N_mineralisation_rate"
+unit = "kg N m^-3 day^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Proportion of above ground structural pool which is lignin"
+name = "lignin_above_structural"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Proportion of below ground structural pool which is lignin"
+name = "lignin_below_structural"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Proportion of dead wood pool which is lignin"
+name = "lignin_woody"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon nitrogen ratio of above ground metabolic pool"
+name = "c_n_ratio_above_metabolic"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon nitrogen ratio of above ground structural pool"
+name = "c_n_ratio_above_structural"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon nitrogen ratio of below ground metabolic pool"
+name = "c_n_ratio_below_metabolic"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon nitrogen ratio of below ground structural pool"
+name = "c_n_ratio_below_structural"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon nitrogen ratio of woody litter pool"
+name = "c_n_ratio_woody"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
description = "Rate of excrement flow from animals into litter"
+name = "decomposed_excrement"
unit = "kg C m^-3 day^-1"
-initialised_by = "animals"
-updated_by = "animals"
-used_by = [ "litter"]
+variable_type = "float"
[[variable]]
-name = "decomposed_carcasses"
+axis = ["spatial"]
description = "Rate of decomposed carcass biomass flow from animals into litter"
+name = "decomposed_carcasses"
unit = "kg C m^-3 day^-1"
-initialised_by = "animals"
-updated_by = "animals"
-used_by = [ "litter"]
\ No newline at end of file
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Amount of dead wood produced since last update"
+name = "deadwood_production"
+unit = "kg C m^-2"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Leaf turnover since last update"
+name = "leaf_turnover"
+unit = "kg C m^-2"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Plant reproductive tissue (fruits and flowers) turnover since last update"
+name = "plant_reproductive_tissue_turnover"
+unit = "kg C m^-2"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Root turnover since last update"
+name = "root_turnover"
+unit = "kg C m^-2"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Lignin proportion of deadwood"
+name = "deadwood_lignin"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Lignin proportion of leaf turnover"
+name = "leaf_turnover_lignin"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Lignin proportion of plant reproductive tissue turnover"
+name = "plant_reproductive_tissue_turnover_lignin"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Lignin proportion of root turnover"
+name = "root_turnover_lignin"
+unit = "kg lignin kg C^-1"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon:nitrogen ratio of deadwood"
+name = "deadwood_c_n_ratio"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon:nitrogen ratio of leaf turnover"
+name = "leaf_turnover_c_n_ratio"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon:nitrogen ratio of plant reproductive tissue turnover"
+name = "plant_reproductive_tissue_turnover_c_n_ratio"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Carbon:nitrogen ratio of root turnover"
+name = "root_turnover_c_n_ratio"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = [] # as_yet_undefined_cohort_setup_axis
+description = "Cell ID of plant cohorts"
+name = "plant_cohorts_cell_id"
+unit = "-"
+variable_type = "int"
+
+[[variable]]
+axis = [] # as_yet_undefined_cohort_setup_axis
+description = "Plant functional type of plant cohorts"
+name = "plant_cohorts_pft"
+unit = "-"
+variable_type = "str"
+
+[[variable]]
+axis = [] # as_yet_undefined_cohort_setup_axis
+description = "Number of individuals in a plant cohort"
+name = "plant_cohorts_n"
+unit = "-"
+variable_type = "int"
+
+[[variable]]
+axis = [] # as_yet_undefined_cohort_setup_axis
+description = "Diameter at breast height of individuals in plant cohorts"
+name = "plant_cohorts_dbh"
+unit = "m"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "The fraction of clay in soil"
+name = "clay_fraction"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "The fraction of absorbed photosynthetically active radiation (f_APAR) in each model layer."
+name = "layer_fapar"
+unit = "-"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "The leaf mass within each canopy layer."
+name = "layer_leaf_mass"
+unit = "kg"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Amount of enzyme class which breaks down particulate organic matter"
+name = "soil_enzyme_pom"
+unit = "kg C m^-3"
+variable_type = "float"
+
+[[variable]]
+axis = ["spatial"]
+description = "Amount of enzyme class which breaks down mineral associated organic matter"
+name = "soil_enzyme_maom"
+unit = "kg C m^-3"
+variable_type = "float"
diff --git a/virtual_ecosystem/example_data/__init__.py b/virtual_ecosystem/example_data/__init__.py
index c6ac0b3f3..e9eb9bae6 100644
--- a/virtual_ecosystem/example_data/__init__.py
+++ b/virtual_ecosystem/example_data/__init__.py
@@ -1,3 +1,3 @@
"""The :mod:`~virtual_ecosystem.example_data` module contains an example data set for
testing out Virtual Ecosystem.
-""" # noqa: D205, D415
+""" # noqa: D205
diff --git a/virtual_ecosystem/example_data/config/animal_functional_groups.toml b/virtual_ecosystem/example_data/config/animal_functional_groups.toml
index 72979e892..8da162d89 100644
--- a/virtual_ecosystem/example_data/config/animal_functional_groups.toml
+++ b/virtual_ecosystem/example_data/config/animal_functional_groups.toml
@@ -1,49 +1,105 @@
# animal_functional_groups.toml
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "carnivorous_bird"
taxa = "bird"
diet = "carnivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_bird"
+excretion_type = "uricotelic"
birth_mass = 0.1
adult_mass = 1.0
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "herbivorous_bird"
taxa = "bird"
diet = "herbivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_bird"
+excretion_type = "uricotelic"
birth_mass = 0.05
adult_mass = 0.5
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "carnivorous_mammal"
taxa = "mammal"
diet = "carnivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_mammal"
+excretion_type = "ureotelic"
birth_mass = 4.0
adult_mass = 40.0
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "herbivorous_mammal"
taxa = "mammal"
diet = "herbivore"
metabolic_type = "endothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_mammal"
+excretion_type = "ureotelic"
birth_mass = 1.0
adult_mass = 10.0
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "carnivorous_insect"
taxa = "insect"
diet = "carnivore"
metabolic_type = "ectothermic"
+reproductive_type = "iteroparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "carnivorous_insect"
+excretion_type = "uricotelic"
birth_mass = 0.001
adult_mass = 0.01
-[[animals.functional_groups]]
+[[animal.functional_groups]]
name = "herbivorous_insect"
taxa = "insect"
diet = "herbivore"
metabolic_type = "ectothermic"
+reproductive_type = "semelparous"
+development_type = "direct"
+development_status = "adult"
+offspring_functional_group = "herbivorous_insect"
+excretion_type = "uricotelic"
birth_mass = 0.0005
adult_mass = 0.005
+
+[[animal.functional_groups]]
+name = "butterfly"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "semelparous"
+development_type = "indirect"
+development_status = "adult"
+offspring_functional_group = "caterpillar"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
+
+[[animal.functional_groups]]
+name = "caterpillar"
+taxa = "insect"
+diet = "herbivore"
+metabolic_type = "ectothermic"
+reproductive_type = "nonreproductive"
+development_type = "indirect"
+development_status = "larval"
+offspring_functional_group = "butterfly"
+excretion_type = "uricotelic"
+birth_mass = 0.0005
+adult_mass = 0.005
\ No newline at end of file
diff --git a/virtual_ecosystem/example_data/config/data_config.toml b/virtual_ecosystem/example_data/config/data_config.toml
index c9d7572d9..4994758d5 100644
--- a/virtual_ecosystem/example_data/config/data_config.toml
+++ b/virtual_ecosystem/example_data/config/data_config.toml
@@ -1,5 +1,5 @@
[core.data_output_options]
-save_initial_state = false
+save_initial_state = true
# Climate data
[[core.data.variable]]
@@ -20,16 +20,19 @@ var_name = "atmospheric_co2_ref"
[[core.data.variable]]
file = "../data/example_climate_data.nc"
var_name = "mean_annual_temperature"
+[[core.data.variable]]
+file = "../data/example_climate_data.nc"
+var_name = "wind_speed_ref"
# Elevation
[[core.data.variable]]
file = "../data/example_elevation_data.nc"
var_name = "elevation"
-# Hydrology
-[[core.data.variable]]
-file = "../data/example_surface_runoff_data.nc"
-var_name = "surface_runoff"
+# # Hydrology
+# [[core.data.variable]]
+# file = "../data/example_surface_runoff_data.nc"
+# var_name = "surface_runoff"
# Soil
[[core.data.variable]]
@@ -55,6 +58,9 @@ file = "../data/example_soil_data.nc"
var_name = "soil_c_pool_pom"
[[core.data.variable]]
file = "../data/example_soil_data.nc"
+var_name = "soil_c_pool_necromass"
+[[core.data.variable]]
+file = "../data/example_soil_data.nc"
var_name = "soil_enzyme_pom"
[[core.data.variable]]
file = "../data/example_soil_data.nc"
@@ -85,6 +91,21 @@ var_name = "lignin_woody"
[[core.data.variable]]
file = "../data/example_litter_data.nc"
var_name = "lignin_below_structural"
+[[core.data.variable]]
+file = "../data/example_litter_data.nc"
+var_name = "c_n_ratio_above_metabolic"
+[[core.data.variable]]
+file = "../data/example_litter_data.nc"
+var_name = "c_n_ratio_above_structural"
+[[core.data.variable]]
+file = "../data/example_litter_data.nc"
+var_name = "c_n_ratio_woody"
+[[core.data.variable]]
+file = "../data/example_litter_data.nc"
+var_name = "c_n_ratio_below_metabolic"
+[[core.data.variable]]
+file = "../data/example_litter_data.nc"
+var_name = "c_n_ratio_below_structural"
# Plants
[[core.data.variable]]
diff --git a/virtual_ecosystem/example_data/config/ve_run.toml b/virtual_ecosystem/example_data/config/ve_run.toml
index 874af1c71..8575df698 100644
--- a/virtual_ecosystem/example_data/config/ve_run.toml
+++ b/virtual_ecosystem/example_data/config/ve_run.toml
@@ -3,9 +3,9 @@
init = ['plants']
update = ['plants', 'abiotic_simple']
[abiotic_simple]
-[animals]
+[animal]
[litter.depends]
-update = ['hydrology', 'abiotic_simple']
+update = ['plants', 'hydrology', 'abiotic_simple']
[soil.depends]
init = ['hydrology', 'abiotic_simple']
-update = ['hydrology', 'abiotic_simple']
+update = ['litter', 'hydrology', 'abiotic_simple']
diff --git a/virtual_ecosystem/example_data/data/example_climate_data.nc b/virtual_ecosystem/example_data/data/example_climate_data.nc
index 2e421051f..416d7f31a 100644
Binary files a/virtual_ecosystem/example_data/data/example_climate_data.nc and b/virtual_ecosystem/example_data/data/example_climate_data.nc differ
diff --git a/virtual_ecosystem/example_data/data/example_litter_data.nc b/virtual_ecosystem/example_data/data/example_litter_data.nc
index 44f5d5157..321626342 100644
Binary files a/virtual_ecosystem/example_data/data/example_litter_data.nc and b/virtual_ecosystem/example_data/data/example_litter_data.nc differ
diff --git a/virtual_ecosystem/example_data/data/example_soil_data.nc b/virtual_ecosystem/example_data/data/example_soil_data.nc
index ba2cee666..1426655da 100644
Binary files a/virtual_ecosystem/example_data/data/example_soil_data.nc and b/virtual_ecosystem/example_data/data/example_soil_data.nc differ
diff --git a/virtual_ecosystem/example_data/data/example_topofcanopy_radiation.nc b/virtual_ecosystem/example_data/data/example_topofcanopy_radiation.nc
new file mode 100644
index 000000000..215c874bc
Binary files /dev/null and b/virtual_ecosystem/example_data/data/example_topofcanopy_radiation.nc differ
diff --git a/virtual_ecosystem/example_data/generation_scripts/__init__.py b/virtual_ecosystem/example_data/generation_scripts/__init__.py
index e69de29bb..a009e3fc5 100644
--- a/virtual_ecosystem/example_data/generation_scripts/__init__.py
+++ b/virtual_ecosystem/example_data/generation_scripts/__init__.py
@@ -0,0 +1 @@
+"""Python scripts to generate example datasets."""
diff --git a/virtual_ecosystem/example_data/generation_scripts/climate_example_data.py b/virtual_ecosystem/example_data/generation_scripts/climate_example_data.py
index 2da46b73f..6ffdf3551 100644
--- a/virtual_ecosystem/example_data/generation_scripts/climate_example_data.py
+++ b/virtual_ecosystem/example_data/generation_scripts/climate_example_data.py
@@ -107,10 +107,15 @@
np.full_like(dataset_renamed["air_temperature_ref"], 400),
dims=["time", "latitude", "longitude"],
)
+dataset_renamed["wind_speed_ref"] = DataArray(
+ np.full_like(dataset_renamed["air_temperature_ref"], 0.1),
+ dims=["time", "latitude", "longitude"],
+)
dataset_renamed["mean_annual_temperature"] = dataset_renamed[
"air_temperature_ref"
].mean(dim="time")
+
# 8. Change coordinates to x-y in meters
# The following code segment changes the coordinate names from `longitude/latitude` to
# `x/y` and the units from `minutes` to `meters`. The ERA5-Land coordinates are treated
diff --git a/virtual_ecosystem/example_data/generation_scripts/elevation_example_data.py b/virtual_ecosystem/example_data/generation_scripts/elevation_example_data.py
index 86556b941..ef949ef1b 100644
--- a/virtual_ecosystem/example_data/generation_scripts/elevation_example_data.py
+++ b/virtual_ecosystem/example_data/generation_scripts/elevation_example_data.py
@@ -33,16 +33,16 @@
# dem = rioxarray.open_rasterio("SRTM_UTM50N_processed.tif")
# # Specify the original grid coordinates
-# x = dem.coords["x"] # type: ignore # noqa
-# y = dem.coords["y"] # type: ignore # noqa
+# x = dem.coords["x"] # type: ignore
+# y = dem.coords["y"] # type: ignore
# # Create a new grid of longitude and latitude coordinates with higher resolution
# new_resolution = 26000
-# new_x = np.arange(x.min(), x.max(), new_resolution) # type: ignore # noqa
-# new_y = np.arange(y.min(), y.max(), new_resolution) # type: ignore # noqa
+# new_x = np.arange(x.min(), x.max(), new_resolution) # type: ignore
+# new_y = np.arange(y.min(), y.max(), new_resolution) # type: ignore
# # Project DEM to new mesh
-# dem_9x9 = dem.interp(x=new_x, y=new_y) # type: ignore # noqa
+# dem_9x9 = dem.interp(x=new_x, y=new_y) # type: ignore
# # Reduce the data to reuired information for netcdf
# dem_cleaned = (
diff --git a/virtual_ecosystem/example_data/generation_scripts/litter_example_data.py b/virtual_ecosystem/example_data/generation_scripts/litter_example_data.py
index 4c63314fb..4a77dd43b 100644
--- a/virtual_ecosystem/example_data/generation_scripts/litter_example_data.py
+++ b/virtual_ecosystem/example_data/generation_scripts/litter_example_data.py
@@ -17,25 +17,34 @@
# Generate a range of plausible values (0.05-0.5) for the above ground metabolic litter
# pools [kg C m^-2].
-above_metabolic_values = 0.05 + 0.45 * (gradient) / (64)
+above_metabolic_values = 0.05 + 0.45 * gradient / 64.0
# Generate a range of plausible values (0.05-0.5) for the above ground structural litter
# pools [kg C m^-2].
-above_structural_values = 0.05 + 0.45 * (gradient) / (64)
+above_structural_values = 0.05 + 0.45 * gradient / 64.0
# Generate range of plausible values (4.75-12.0) for the woody litter pools [kg C m^-2].
-woody_values = 4.75 + 7.25 * (gradient) / (64)
+woody_values = 4.75 + 7.25 * gradient / 64.0
# Generate a range of plausible values (0.03-0.08) for the below ground metabolic litter
# pools [kg C m^-2].
-below_metabolic_values = 0.03 + 0.05 * (gradient) / (64)
+below_metabolic_values = 0.03 + 0.05 * gradient / 64.0
# Generate range of plausible values (0.05-0.125) for the below ground structural litter
# pools [kg C m^-2].
-below_structural_values = 0.05 + 0.075 * (gradient) / (64)
+below_structural_values = 0.05 + 0.075 * gradient / 64.0
# Generate a range of plausible values (0.01-0.9) for lignin proportions of the pools.
-lignin_values = 0.01 + 0.89 * (gradient) / (64)
+lignin_values = 0.01 + 0.89 * gradient / 64.0
+
+# Generate a range of plausible values (5.0-12.0) for metabolic litter C:N ratio
+c_n_metabolic_values = 5.0 + 7.0 * gradient / 64.0
+
+# Generate a range of plausible values (25.0-60.0) for structural litter C:N ratio
+c_n_structural_values = 25.0 + 35.0 * gradient / 64.0
+
+# Generate a range of plausible values (30.0-70.0) for woody litter C:N ratio
+c_n_woody_values = 30.0 + 40.0 * gradient / 64.0
# Make example litter dataset
example_litter_data = Dataset(
@@ -48,6 +57,11 @@
lignin_above_structural=(["x", "y"], lignin_values),
lignin_woody=(["x", "y"], lignin_values),
lignin_below_structural=(["x", "y"], lignin_values),
+ c_n_ratio_above_metabolic=(["x", "y"], c_n_metabolic_values),
+ c_n_ratio_above_structural=(["x", "y"], c_n_structural_values),
+ c_n_ratio_woody=(["x", "y"], c_n_woody_values),
+ c_n_ratio_below_metabolic=(["x", "y"], c_n_metabolic_values),
+ c_n_ratio_below_structural=(["x", "y"], c_n_structural_values),
),
coords=dict(
x=(["x"], cell_displacements),
diff --git a/virtual_ecosystem/example_data/generation_scripts/soil_example_data.py b/virtual_ecosystem/example_data/generation_scripts/soil_example_data.py
index 593b3dfa3..89092eb25 100644
--- a/virtual_ecosystem/example_data/generation_scripts/soil_example_data.py
+++ b/virtual_ecosystem/example_data/generation_scripts/soil_example_data.py
@@ -14,32 +14,36 @@
gradient = np.outer(cell_displacements / 90, cell_displacements / 90)
# Generate a range of plausible values (3.5-4.5) for the soil pH [unitless].
-pH_values = 3.5 + 1.00 * (gradient) / (64)
+pH_values = 3.5 + 1.00 * gradient / 64.0
# Generate a range of plausible values (1200-1800) for the bulk density [kg m^-3].
-bulk_density_values = 1200.0 + 600.0 * (gradient) / (64)
+bulk_density_values = 1200.0 + 600.0 * gradient / 64.0
# Generate a range of plausible values (0.27-0.40) for the clay fraction [fraction].
-clay_fraction_values = 0.27 + 0.13 * (gradient) / (64)
+clay_fraction_values = 0.27 + 0.13 * gradient / 64.0
# Generate a range of plausible values (0.005-0.01) for the lmwc pool [kg C m^-3].
-lmwc_values = 0.005 + 0.005 * (gradient) / (64)
+lmwc_values = 0.005 + 0.005 * gradient / 64.0
# Generate a range of plausible values (1.0-3.0) for the maom pool [kg C m^-3].
-maom_values = 1.0 + 2.0 * (gradient) / (64)
+maom_values = 1.0 + 2.0 * gradient / 64.0
# Generate a range of plausible values (0.0015-0.005) for the microbial C pool
# [kg C m^-3].
-microbial_C_values = 0.0015 + 0.0035 * (gradient) / (64)
+microbial_C_values = 0.0015 + 0.0035 * gradient / 64.0
# Generate a range of plausible values (0.1-1.0) for the POM pool [kg C m^-3].
-pom_values = 0.1 + 0.9 * (gradient) / (64)
+pom_values = 0.1 + 0.9 * gradient / 64.0
+
+# Generate a range of plausible values (0.00015-0.0005) for the microbial necromass pool
+# [kg C m^-3].
+necromass_values = 0.00015 + 0.00035 * gradient / 64.0
# Generate a range of plausible values (0.01-0.5) for the POM enzyme pool [kg C m^-3].
-pom_enzyme_values = 0.01 + 0.49 * (gradient) / (64)
+pom_enzyme_values = 0.01 + 0.49 * gradient / 64.0
# Generate a range of plausible values (0.01-0.5) for the MAOM enzyme pool [kg C m^-3].
-maom_enzyme_values = 0.01 + 0.49 * (gradient) / (64)
+maom_enzyme_values = 0.01 + 0.49 * gradient / 64.0
# Make example soil dataset
example_soil_data = Dataset(
@@ -51,6 +55,7 @@
soil_c_pool_maom=(["x", "y"], maom_values),
soil_c_pool_microbe=(["x", "y"], microbial_C_values),
soil_c_pool_pom=(["x", "y"], pom_values),
+ soil_c_pool_necromass=(["x", "y"], necromass_values),
soil_enzyme_pom=(["x", "y"], pom_enzyme_values),
soil_enzyme_maom=(["x", "y"], maom_enzyme_values),
),
diff --git a/virtual_ecosystem/example_data/generation_scripts/topofcanopy_radiation_example_data.py b/virtual_ecosystem/example_data/generation_scripts/topofcanopy_radiation_example_data.py
new file mode 100644
index 000000000..753830139
--- /dev/null
+++ b/virtual_ecosystem/example_data/generation_scripts/topofcanopy_radiation_example_data.py
@@ -0,0 +1,40 @@
+"""Simple top of canopy shortwave radiation for `ve_run` example data.
+
+This code creates top of canopy shortwave radiation data as input to setup the abiotic
+model. The current values are typical hourly averages for tropical regions.
+
+Once the new netcdf file is created, the final step is to add the grid information to
+the grid config `TOML` to load this data correctly when setting up a Virtual Ecosystem
+Simulation. Here, we can also add the 45 m offset to position the coordinated at the
+centre of the grid cell.
+
+[core.grid]
+cell_nx = 9
+cell_ny = 9
+cell_area = 8100
+xoff = -45.0
+yoff = -45.0
+"""
+
+import numpy as np
+from xarray import DataArray, Dataset
+
+from virtual_ecosystem.example_data.generation_scripts.common import (
+ cell_id,
+ n_cells,
+ n_dates,
+ time,
+ time_index,
+)
+
+data = Dataset()
+
+# Spatio-temporal shortwave radiation flux data [W m-2]
+data["topofcanopy_radiation"] = DataArray(
+ data=np.full((n_cells, n_dates), fill_value=250),
+ coords={"cell_id": cell_id, "time_index": time_index},
+)
+
+data["time"] = DataArray(time, coords={"time_index": time_index})
+
+data.to_netcdf("../data/example_topofcanopy_radiation.nc", format="NETCDF3_64BIT")
diff --git a/virtual_ecosystem/main.py b/virtual_ecosystem/main.py
index c62543ca0..31f0a9a16 100644
--- a/virtual_ecosystem/main.py
+++ b/virtual_ecosystem/main.py
@@ -1,7 +1,7 @@
"""The :mod:`~virtual_ecosystem.main` module defines the function used to run a full
simulation of the model, along with helper functions to validate and configure the
model.
-""" # noqa: D205, D415
+""" # noqa: D205
import os
from collections.abc import Sequence
@@ -12,6 +12,7 @@
from tqdm import tqdm
+from virtual_ecosystem.core import variables
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.core_components import CoreComponents
from virtual_ecosystem.core.data import Data, merge_continuous_data_files
@@ -32,13 +33,13 @@ def initialise_models(
config: A validated Virtual Ecosystem model configuration object.
data: A Data instance.
core_components: A CoreComponents instance.
- modules: A dictionary of models to be configured.
+ models: A dictionary of models to be configured.
Raises:
InitialisationError: If one or more models cannot be properly configured
"""
- LOGGER.info("Initialising models: %s" % ",".join(models.keys()))
+ LOGGER.info("Initialising models: {}".format(",".join(models.keys())))
# Use factory methods to configure the desired models
failed_models = []
@@ -173,6 +174,7 @@ def ve_run(
if progress:
print("* Loading configuration")
+ variables.register_all_variables()
config = Config(
cfg_paths=cfg_paths, cfg_strings=cfg_strings, override_params=override_params
)
@@ -196,6 +198,14 @@ def ve_run(
if progress:
print("* Initial data loaded")
+ # Setup the variables for the requested modules and verify consistency
+ variables.setup_variables(
+ list(config.model_classes.values()), list(data.data.keys())
+ )
+
+ # Verify that all variables have the correct axis
+ variables.verify_variables_axis()
+
LOGGER.info("All models found in the registry, now attempting to configure them.")
# Get the model initialisation sequence and initialise
diff --git a/virtual_ecosystem/models/__init__.py b/virtual_ecosystem/models/__init__.py
index e69de29bb..35c03098f 100644
--- a/virtual_ecosystem/models/__init__.py
+++ b/virtual_ecosystem/models/__init__.py
@@ -0,0 +1 @@
+"""A module providing the different model components of the Virtual Ecosystem."""
diff --git a/virtual_ecosystem/models/abiotic/__init__.py b/virtual_ecosystem/models/abiotic/__init__.py
new file mode 100644
index 000000000..4ac789230
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/__init__.py
@@ -0,0 +1,42 @@
+r"""The :mod:`~virtual_ecosystem.models.abiotic` module is one of the component
+models of the Virtual Ecosystem. It is comprised of several submodules that calculate
+the microclimate for the Virtual Ecosystem.
+
+Each of the abiotic sub-modules has its own API reference page:
+
+* The :mod:`~virtual_ecosystem.models.abiotic.abiotic_model` submodule
+ instantiates the AbioticModel class which consolidates the functionality of the
+ abiotic model into a single class, which the high level functions of the
+ Virtual Ecosystem can then use.
+
+* The :mod:`~virtual_ecosystem.models.abiotic.constants` submodule provides a
+ set of dataclasses containing the constants required by the broader abiotic model.
+
+* The :mod:`~virtual_ecosystem.models.abiotic.abiotic_tools` submodule contains a set
+ of general functions that are shared across submodules in the
+ :mod:`~virtual_ecosystem.models.abiotic` model.
+
+* The :mod:`~virtual_ecosystem.models.abiotic.wind` submodule calculates the
+ above- and within-canopy wind profiles for the Virtual Ecosystem. These profiles will
+ determine the exchange of heat, water, and :math:`\ce{CO_{2}}` between soil and
+ atmosphere below the canopy as well as the exchange with the atmsophere above the
+ canopy.
+
+* The :mod:`~virtual_ecosystem.models.abiotic.energy_balance` submodule calculates the
+ energy balance of the Virtual Ecosystem. The module returns vertical profiles of air
+ temperature, relative humidity, and vapour pressure deficit as well as the partitioned
+ energy and radiation fluxes at the leaf surface.
+
+* The :mod:`~virtual_ecosystem.models.abiotic.soil_energy_balance` submodule calculates
+ the soil energy balance of the Virtual Ecosystem. The module returns vertical
+ profiles of soil temperature and the partitioned energy and radiation fluxes at the
+ surface.
+
+* The :mod:`~virtual_ecosystem.models.abiotic.conductivities` submodule calculates
+ the conductivities for the energy balance of the Virtual Ecosystem. Conductivities
+ describe how well heat or vapour are transferred by a medium such as air, water, or
+ leaves in mol m-2 s-1. We consider heat conductivity by turbulent convection in air,
+ leaf-air heat conductivity, and leaf-air vapour conductivity.
+""" # noqa: D205
+
+from virtual_ecosystem.models.abiotic.abiotic_model import AbioticModel # noqa: F401
diff --git a/virtual_ecosystem/models/abiotic/abiotic_model.py b/virtual_ecosystem/models/abiotic/abiotic_model.py
new file mode 100644
index 000000000..fc67874d8
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/abiotic_model.py
@@ -0,0 +1,393 @@
+"""The :mod:`~virtual_ecosystem.models.abiotic.abiotic_model` module creates a
+:class:`~virtual_ecosystem.models.abiotic.abiotic_model.AbioticModel`
+class as a child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` class.
+This implements the full complexity abiotic model.
+
+TODO There are currently a number of unresolved/not implemented processes which require
+further advancement in other models of the Virtual Ecosystem or potentially some changes
+to the vertical layer structure:
+
+* add process based calculation of soil temperature
+* change temperatures to Kelvin
+* adjust for soil moisture default in mm (once updated in hydrology model)
+* coordinate latent heat flux/evapotranspiration processes between plants and abiotic
+* add soil fluxes to lower atmosphere (might need to drop 'subcanopy' layer)
+* introducte 'metaconstants' to support sharing of constants between models
+* add self.model_timing.update_interval in seconds as input to soil balance
+* expand tests to cover different atmospheric conditions
+* expand use of LayerStructure and shape for more compact concatenating
+
+""" # noqa: D205
+
+from __future__ import annotations
+
+from typing import Any
+
+from xarray import DataArray
+
+from virtual_ecosystem.core.base_model import BaseModel
+from virtual_ecosystem.core.config import Config
+from virtual_ecosystem.core.constants_loader import load_constants
+from virtual_ecosystem.core.core_components import CoreComponents
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.core.logger import LOGGER
+from virtual_ecosystem.models.abiotic import (
+ conductivities,
+ energy_balance,
+ soil_energy_balance,
+ wind,
+)
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+from virtual_ecosystem.models.abiotic_simple import microclimate
+from virtual_ecosystem.models.abiotic_simple.constants import (
+ AbioticSimpleBounds,
+ AbioticSimpleConsts,
+)
+
+
+class AbioticModel(
+ BaseModel,
+ model_name="abiotic",
+ model_update_bounds=("1 hour", "1 month"),
+ vars_required_for_init=(
+ "air_temperature_ref",
+ "relative_humidity_ref",
+ "topofcanopy_radiation",
+ "leaf_area_index",
+ "layer_heights",
+ ),
+ vars_updated=(
+ "air_temperature",
+ "canopy_temperature",
+ "soil_temperature",
+ "vapour_pressure",
+ "vapour_pressure_deficit",
+ "air_heat_conductivity",
+ "conductivity_from_ref_height",
+ "leaf_air_heat_conductivity",
+ "leaf_vapour_conductivity",
+ "wind_speed",
+ "friction_velocity",
+ "zero_displacement_height",
+ "attenuation_coefficient",
+ "mean_mixing_length",
+ "relative_turbulence_intensity",
+ "diabatic_correction_heat_above",
+ "diabatic_correction_momentum_above",
+ "diabatic_correction_heat_canopy",
+ "diabatic_correction_momentum_canopy",
+ "sensible_heat_flux",
+ "sensible_heat_flux_soil",
+ "latent_heat_flux",
+ "latent_heat_flux_soil",
+ "ground_heat_flux",
+ "soil_absorption",
+ "longwave_emission_soil",
+ "molar_density_air",
+ "specific_heat_air",
+ ),
+ vars_required_for_update=(
+ "air_temperature_ref",
+ "relative_humidity_ref",
+ "vapour_pressure_deficit_ref",
+ "atmospheric_pressure_ref",
+ "atmospheric_co2_ref",
+ "wind_speed_ref",
+ "leaf_area_index",
+ "layer_heights",
+ "topofcanopy_radiation",
+ "stomatal_conductance",
+ "canopy_absorption",
+ ),
+ vars_populated_by_init=( # TODO move functions from setup() to __init__
+ "soil_temperature",
+ "vapour_pressure_ref",
+ "vapour_pressure_deficit_ref",
+ "air_temperature",
+ "relative_humidity",
+ "vapour_pressure_deficit",
+ "atmospheric_pressure",
+ "atmospheric_co2",
+ "canopy_absorption", # DAVID This is assuming that abiotic runs before plants
+ "canopy_temperature",
+ "sensible_heat_flux",
+ "latent_heat_flux",
+ "ground_heat_flux",
+ "air_heat_conductivity",
+ "leaf_vapour_conductivity",
+ "leaf_air_heat_conductivity",
+ ),
+ vars_populated_by_first_update=(
+ "conductivity_from_ref_height",
+ "vapour_pressure",
+ "wind_speed",
+ "friction_velocity",
+ "zero_displacement_height",
+ "attenuation_coefficient",
+ "mean_mixing_length",
+ "relative_turbulence_intensity",
+ "diabatic_correction_heat_above",
+ "diabatic_correction_momentum_above",
+ "diabatic_correction_heat_canopy",
+ "diabatic_correction_momentum_canopy",
+ "sensible_heat_flux_soil",
+ "latent_heat_flux_soil",
+ "soil_absorption",
+ "longwave_emission_soil",
+ "molar_density_air",
+ "specific_heat_air",
+ ),
+):
+ """A class describing the abiotic model.
+
+ Args:
+ data: The data object to be used in the model.
+ core_components: The core components used across models.
+ model_constants: Set of constants for the abiotic model.
+ """
+
+ def __init__(
+ self,
+ data: Data,
+ core_components: CoreComponents,
+ model_constants: AbioticConsts = AbioticConsts(),
+ **kwargs: Any,
+ ):
+ super().__init__(data=data, core_components=core_components, **kwargs)
+
+ self.model_constants = model_constants
+ """Set of constants for the abiotic model."""
+ self.simple_constants = AbioticSimpleConsts()
+ """Set of constants for simple abiotic model.""" # TODO metaconstants
+
+ self._setup()
+
+ @classmethod
+ def from_config(
+ cls, data: Data, core_components: CoreComponents, config: Config
+ ) -> AbioticModel:
+ """Factory function to initialise the abiotic model from configuration.
+
+ This function unpacks the relevant information from the configuration file, and
+ then uses it to initialise the model. If any information from the config is
+ invalid rather than returning an initialised model instance an error is raised.
+
+ Args:
+ data: A :class:`~virtual_ecosystem.core.data.Data` instance.
+ core_components: The core components used across models.
+ config: A validated Virtual Ecosystem model configuration object.
+ """
+
+ # Load in the relevant constants
+ model_constants = load_constants(config, "abiotic", "AbioticConsts")
+
+ LOGGER.info(
+ "Information required to initialise the abiotic model successfully "
+ "extracted."
+ )
+ return cls(
+ data,
+ core_components=core_components,
+ model_constants=model_constants,
+ )
+
+ def setup(self) -> None:
+ """No longer in use.
+
+ TODO: Remove when the base model is updated.
+ """
+
+ def _setup(self) -> None:
+ """Function to set up the abiotic model.
+
+ This function initializes soil temperature and canopy temperature for all
+ corresponding layers and calculates the reference vapour pressure deficit for
+ all time steps of the simulation. All variables are added directly to the
+ self.data object.
+ """
+
+ # create soil temperature array
+ self.data["soil_temperature"] = self.layer_structure.from_template()
+
+ # Calculate vapour pressure deficit at reference height for all time steps
+ vapour_pressure_and_deficit = microclimate.calculate_vapour_pressure_deficit(
+ temperature=self.data["air_temperature_ref"],
+ relative_humidity=self.data["relative_humidity_ref"],
+ saturation_vapour_pressure_factors=(
+ self.simple_constants.saturation_vapour_pressure_factors
+ ),
+ )
+ self.data["vapour_pressure_deficit_ref"] = (
+ vapour_pressure_and_deficit["vapour_pressure_deficit"]
+ ).rename("vapour_pressure_deficit_ref")
+
+ self.data["vapour_pressure_ref"] = (
+ vapour_pressure_and_deficit["vapour_pressure"]
+ ).rename("vapour_pressure_ref")
+
+ # Generate initial profiles of air temperature [C], relative humidity [-],
+ # vapour pressure deficit [kPa], soil temperature [C], atmospheric pressure
+ # [kPa], and atmospheric :math:`\ce{CO2}` [ppm]
+ initial_microclimate = microclimate.run_microclimate(
+ data=self.data,
+ layer_structure=self.layer_structure,
+ time_index=0,
+ constants=self.simple_constants,
+ bounds=AbioticSimpleBounds(),
+ )
+
+ initial_canopy_and_soil = energy_balance.initialise_canopy_and_soil_fluxes(
+ air_temperature=initial_microclimate["air_temperature"],
+ topofcanopy_radiation=self.data["topofcanopy_radiation"].isel(time_index=0),
+ leaf_area_index=self.data["leaf_area_index"],
+ layer_heights=self.data["layer_heights"],
+ layer_structure=self.layer_structure,
+ light_extinction_coefficient=(
+ self.model_constants.light_extinction_coefficient
+ ),
+ canopy_temperature_ini_factor=(
+ self.model_constants.canopy_temperature_ini_factor
+ ),
+ )
+
+ initial_conductivities = conductivities.initialise_conductivities(
+ layer_structure=self.layer_structure,
+ layer_heights=self.data["layer_heights"],
+ initial_air_conductivity=self.model_constants.initial_air_conductivity,
+ top_leaf_vapour_conductivity=(
+ self.model_constants.top_leaf_vapour_conductivity
+ ),
+ bottom_leaf_vapour_conductivity=(
+ self.model_constants.bottom_leaf_vapour_conductivity
+ ),
+ top_leaf_air_conductivity=self.model_constants.top_leaf_air_conductivity,
+ bottom_leaf_air_conductivity=(
+ self.model_constants.bottom_leaf_air_conductivity
+ ),
+ )
+
+ # Update data object
+ for output_dict in (
+ initial_microclimate,
+ initial_canopy_and_soil,
+ initial_conductivities,
+ ):
+ self.data.add_from_dict(output_dict=output_dict)
+
+ def spinup(self) -> None:
+ """Placeholder function to spin up the abiotic model."""
+
+ def update(self, time_index: int, **kwargs: Any) -> None:
+ """Function to update the abiotic model.
+
+ The function updates the microclimate in the following order:
+
+ * wind profiles
+ * soil energy balance
+ * conductivities
+ * canopy energy balance for each layer
+ * TODO representation of turbulent fluxes is inconsistent
+ * TODO add all soil fluxes to atmosphere
+ * TODO update soil temperatures
+
+ Args:
+ time_index: The index of the current time step in the data object.
+ **kwargs: Further arguments to the update method.
+ """
+
+ # TODO This selection of layers should be included in LayerStructure at the
+ # start of the simulation and updated at each time step (except topsoil index)
+ # At the moment this is duplicated in setup() and other parts of the Virtual
+ # Ecosystem
+
+ # Wind profiles
+
+ # Reduce input variables to true above ground rows
+ # TODO: this type-ignore is because our Data interface doesn't currently accept
+ # list[str] indices, which it should.
+ wind_update_inputs = self.data[
+ ["layer_heights", "leaf_area_index", "air_temperature"] # type: ignore [index]
+ ].isel(layers=self.layer_structure.index_filled_atmosphere)
+
+ wind_update = wind.calculate_wind_profile(
+ canopy_height=self.data["layer_heights"][1].to_numpy(),
+ wind_height_above=self.data["layer_heights"][0:2].to_numpy(),
+ wind_layer_heights=wind_update_inputs["layer_heights"].to_numpy(),
+ leaf_area_index=wind_update_inputs["leaf_area_index"].to_numpy(),
+ air_temperature=wind_update_inputs["air_temperature"].to_numpy(),
+ atmospheric_pressure=self.data["atmospheric_pressure"][0].to_numpy(),
+ sensible_heat_flux_topofcanopy=(
+ self.data["sensible_heat_flux"][1].to_numpy()
+ ),
+ wind_speed_ref=(
+ self.data["wind_speed_ref"].isel(time_index=time_index).to_numpy()
+ ),
+ wind_reference_height=(
+ self.data["layer_heights"][1]
+ + self.model_constants.wind_reference_height
+ ).to_numpy(),
+ abiotic_constants=self.model_constants,
+ core_constants=self.core_constants,
+ ) # TODO wind height above in constants, cross-check with LayerStructure setup
+
+ # Store 2D wind outputs using the full vertical structure
+ for var in ["wind_speed", "molar_density_air", "specific_heat_air"]:
+ var_out = self.layer_structure.from_template()
+ var_out[self.layer_structure.index_filled_atmosphere] = wind_update[var]
+ self.data[var] = var_out
+
+ # Store 1D outputs by cell id
+ for var in [
+ "friction_velocity",
+ "diabatic_correction_heat_above",
+ "diabatic_correction_momentum_above",
+ "diabatic_correction_heat_canopy",
+ "diabatic_correction_momentum_canopy",
+ ]:
+ self.data[var] = DataArray(
+ wind_update[var], coords={"cell_id": self.data["cell_id"]}
+ )
+
+ # Soil energy balance
+ soil_heat_balance = soil_energy_balance.calculate_soil_heat_balance(
+ data=self.data,
+ time_index=time_index,
+ layer_structure=self.layer_structure,
+ update_interval=43200, # TODO self.model_timing.update_interval
+ abiotic_consts=self.model_constants,
+ core_consts=self.core_constants,
+ )
+
+ # Store 1D outputs by cell id
+ for var in (
+ "soil_absorption",
+ "longwave_emission_soil",
+ "sensible_heat_flux_soil",
+ "latent_heat_flux_soil",
+ "ground_heat_flux",
+ ):
+ self.data[var] = DataArray(
+ soil_heat_balance[var], coords={"cell_id": self.data["cell_id"]}
+ )
+
+ # Update topsoil temperature
+ self.data["soil_temperature"][self.layer_structure.index_topsoil] = (
+ soil_heat_balance["new_surface_temperature"]
+ )
+
+ # TODO Update lower soil temperatures
+
+ # Update air temperature, leaf temperature, vapour pressure, vapour pressure
+ # deficit and turbulent fluxes
+ new_microclimate = energy_balance.calculate_leaf_and_air_temperature(
+ data=self.data,
+ time_index=time_index,
+ layer_structure=self.layer_structure,
+ abiotic_constants=self.model_constants,
+ abiotic_simple_constants=self.simple_constants,
+ core_constants=self.core_constants,
+ )
+ self.data.add_from_dict(output_dict=new_microclimate)
+
+ def cleanup(self) -> None:
+ """Placeholder function for abiotic model cleanup."""
diff --git a/virtual_ecosystem/models/abiotic/abiotic_tools.py b/virtual_ecosystem/models/abiotic/abiotic_tools.py
new file mode 100644
index 000000000..c7c64852c
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/abiotic_tools.py
@@ -0,0 +1,124 @@
+"""The ``models.abiotic.abiotic_tools`` module contains a set of general functions that
+are shared across submodules in the
+:mod:`~virtual_ecosystem.models.abiotic.abiotic_model` model.
+
+TODO cross-check with pyrealm for duplication/ different implementation
+TODO change temperatures to Kelvin
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+
+
+def calculate_molar_density_air(
+ temperature: NDArray[np.float32],
+ atmospheric_pressure: NDArray[np.float32],
+ standard_mole: float,
+ standard_pressure: float,
+ celsius_to_kelvin: float,
+) -> NDArray[np.float32]:
+ """Calculate temperature-dependent molar density of air.
+
+ Implementation after :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ temperature: Air temperature, [C]
+ atmospheric_pressure: Atmospheric pressure, [kPa]
+ standard_mole: Moles of ideal gas in 1 m^3 air at standard atmosphere
+ standard_pressure: Standard atmospheric pressure, [kPa]
+ celsius_to_kelvin: Factor to convert temperature in Celsius to absolute
+ temperature in Kelvin
+
+ Returns:
+ molar density of air, [mol m-3]
+ """
+
+ temperature_kelvin = temperature + celsius_to_kelvin
+
+ return (
+ standard_mole
+ * (atmospheric_pressure / standard_pressure)
+ * (celsius_to_kelvin / temperature_kelvin)
+ )
+
+
+def calculate_specific_heat_air(
+ temperature: NDArray[np.float32],
+ molar_heat_capacity_air: float,
+ specific_heat_equ_factors: list[float],
+) -> NDArray[np.float32]:
+ """Calculate temperature-dependent specific heat of air.
+
+ Implementation after :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ temperature: Air temperature, [C]
+ molar_heat_capacity_air: Molar heat capacity of air, [J mol-1 C-1]
+ specific_heat_equ_factors: Factors in calculation of molar specific heat of air
+
+ Returns:
+ specific heat of air at constant pressure, [J mol-1 K-1]
+ """
+ return (
+ specific_heat_equ_factors[0] * temperature**2
+ + specific_heat_equ_factors[1] * temperature
+ + molar_heat_capacity_air
+ )
+
+
+def calculate_latent_heat_vapourisation(
+ temperature: NDArray[np.float32],
+ celsius_to_kelvin: float,
+ latent_heat_vap_equ_factors: list[float],
+) -> NDArray[np.float32]:
+ """Calculate latent heat of vapourisation.
+
+ Implementation after Eq. 8, :cite:t:`henderson-sellers_new_1984`.
+
+ Args:
+ temperature: Air temperature, [C]
+ celsius_to_kelvin: Factor to convert temperature in Celsius to absolute
+ temperature in Kelvin
+ latent_heat_vap_equ_factors: Factors in calculation of latent heat of
+ vapourisation
+
+ Returns:
+ latent heat of vapourisation, [kJ kg-1]
+ """
+ temperature_kelvin = temperature + celsius_to_kelvin
+ return (
+ latent_heat_vap_equ_factors[0]
+ * (temperature_kelvin / (temperature_kelvin - latent_heat_vap_equ_factors[1]))
+ ** 2
+ ) / 1000.0
+
+
+def find_last_valid_row(array: NDArray[np.float32]) -> NDArray[np.float32]:
+ """Find last valid value in array for each column.
+
+ This function looks for the last valid value in each column of a 2-dimensional
+ array. If the previous value is nan, it moved up the array. If all values are nan,
+ the value is set to nan, too.
+
+ Args:
+ array: Two-dimesional array for which last valid values should be found
+
+ Returns:
+ Array that contains last valid values
+ """
+ # Initialize an empty list to store the last valid value from each column
+ new_row = []
+
+ # Loop through each column
+ for column in range(array.shape[1]):
+ # Scan from the last row to the first in the current column
+ for i in range(array.shape[0] - 1, -1, -1):
+ if not np.isnan(array[i, column]):
+ # Append the last valid value found in the column to the new_row list
+ new_row.append(array[i, column])
+ break
+ else:
+ # If no valid value is found in the column, append NaN
+ new_row.append(np.nan)
+
+ return np.array(new_row)
diff --git a/virtual_ecosystem/models/abiotic/conductivities.py b/virtual_ecosystem/models/abiotic/conductivities.py
new file mode 100644
index 000000000..63df2f933
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/conductivities.py
@@ -0,0 +1,504 @@
+r"""The ``models.abiotic.conductivities`` module calculates the conductivities for the
+energy balance of the Virtual Ecosystem based on :cite:t:`maclean_microclimc_2021`.
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+from xarray import DataArray
+
+from virtual_ecosystem.core.core_components import LayerStructure
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def interpolate_along_heights(
+ start_height: NDArray[np.float32],
+ end_height: NDArray[np.float32],
+ target_heights: NDArray[np.float32],
+ start_value: float | NDArray[np.float32],
+ end_value: float | NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Linear interpolation for given start and end values along a height axis.
+
+ This function can be used to lineraly interpolate atmospheric or soil variables such
+ as temperature or humidity for a set of user specified heights based on the top and
+ bottom values. Note that the start value has to be the surface and the end value has
+ to be above ground.
+
+ Args:
+ start_height: Starting heights of the interpolation range, [m].
+ end_height: Ending heights of the interpolation range, [m]
+ target_heights: Array of target heights with the first column representing
+ heights and subsequent columns representing additional dimensions, here
+ `cell_id`.
+ start_value: The value at the starting height.
+ end_value: The value at the ending height.
+
+ Returns:
+ Interpolated values corresponding to the target heights
+ """
+ # Ensure the target heights are within the range [start_height, end_height]
+ target_heights = np.clip(target_heights, start_height, end_height)
+
+ # Calculate the interpolation slope and intercept
+ slope = (end_value - start_value) / (end_height - start_height)
+ intercept = start_value - slope * start_height
+
+ # Interpolate values at the target heights
+ interpolated_values = slope * target_heights + intercept
+
+ return interpolated_values
+
+
+def initialise_conductivities(
+ layer_structure: LayerStructure,
+ layer_heights: DataArray,
+ initial_air_conductivity: float,
+ top_leaf_vapour_conductivity: float,
+ bottom_leaf_vapour_conductivity: float,
+ top_leaf_air_conductivity: float,
+ bottom_leaf_air_conductivity: float,
+) -> dict[str, DataArray]:
+ r"""Initialise conductivities for first model time step, [mol m-2 s-1].
+
+ Air heat conductivity by turbulent convection (:math:`g_{t}`) is scaled by canopy
+ height and number of canopy layers (and hence distance between nodes). Leaf-air
+ vapour conductivity (:math:`g_{v}`) and leaf-air heat conductivity (:math:`g_{Ha}`)
+ are linearly interpolated between intial values.
+
+ The first value in each output represents conductivity between the air at 2 m above
+ canopy and the highest canopy layer. The last (above ground) value represents
+ conductivity between the ground and the lowest canopy node.
+ TODO account for variable layer depths
+ TODO account for variable layer depths
+
+ Args:
+ layer_structure: the model layer structure instance.
+ layer_heights: layer heights, [m]
+ initial_air_conductivity: Initial value for heat conductivity by turbulent
+ convection in air, [mol m-2 s-1]
+ top_leaf_vapour_conductivity: Initial leaf vapour conductivity at the top of the
+ canopy, [mol m-2 s-1]
+ bottom_leaf_vapour_conductivity: Initial leaf vapour conductivity at the bottom
+ of the canopy, [mol m-2 s-1]
+ top_leaf_air_conductivity: Initial leaf air heat conductivity at the top of the
+ canopy, [mol m-2 s-1]
+ bottom_leaf_air_conductivity: Initial leaf air heat conductivity at the surface,
+ [mol m-2 s-1]
+
+ Returns:
+ Heat conductivity in air of each canopy layer node, [mol m-2 s-1],
+ Leaf conductivity to vapour loss for each canopy layer node, [mol m-2 s-1],
+ Heat conductivity between air and leaf for each canopy layer node, [mol m-2 s-1]
+ """
+
+ # TODO - this [1] indexes the first canopy layer - that's poorly defined at the
+ # moment (canopy top? first canopy layer closure? representative midpoint
+ # height of the first canopy layer) and we don't have a firm structure to
+ # index this properly yet.
+ canopy_height = layer_heights[1].to_numpy()
+ atmosphere_layers = layer_heights[layer_structure.index_atmosphere]
+ canopy_layers = layer_heights[layer_structure.index_canopy]
+ soil_layers = layer_heights[layer_structure.index_all_soil]
+
+ output = {}
+
+ # Initialise conductivity between air layers
+ air_conductivity = (
+ np.full((len(atmosphere_layers), len(canopy_height)), initial_air_conductivity)
+ * (len(atmosphere_layers) / canopy_height)
+ * 2
+ / len(atmosphere_layers)
+ )
+ air_conductivity[-1] *= 2
+ air_conductivity[0] *= (canopy_height / len(atmosphere_layers)) * 0.5
+
+ output["air_heat_conductivity"] = layer_structure.from_template()
+ output["air_heat_conductivity"][layer_structure.index_atmosphere] = air_conductivity
+
+ # Initialise leaf vapour conductivity
+ leaf_vapour_conductivity = interpolate_along_heights(
+ start_height=layer_heights[-(len(soil_layers) + 1)].to_numpy(),
+ end_height=layer_heights[0].to_numpy(),
+ target_heights=layer_heights[canopy_layers.indexes].to_numpy(),
+ start_value=top_leaf_vapour_conductivity,
+ end_value=bottom_leaf_vapour_conductivity,
+ )
+ output["leaf_vapour_conductivity"] = layer_structure.from_template()
+ output["leaf_vapour_conductivity"][layer_structure.index_canopy] = (
+ leaf_vapour_conductivity
+ )
+
+ # Initialise leaf air heat conductivity
+ leaf_air_conductivity = interpolate_along_heights(
+ start_height=layer_heights[-(len(soil_layers) + 1)].to_numpy(),
+ end_height=layer_heights[0].to_numpy(),
+ target_heights=layer_heights[canopy_layers.indexes].to_numpy(),
+ start_value=top_leaf_air_conductivity,
+ end_value=bottom_leaf_air_conductivity,
+ )
+ output["leaf_air_heat_conductivity"] = layer_structure.from_template()
+ output["leaf_air_heat_conductivity"][layer_structure.index_canopy] = (
+ leaf_air_conductivity
+ )
+
+ return output
+
+
+def calculate_air_heat_conductivity_above(
+ height_above_canopy: NDArray[np.float32],
+ zero_displacement_height: NDArray[np.float32],
+ canopy_height: NDArray[np.float32],
+ friction_velocity: NDArray[np.float32],
+ molar_density_air: NDArray[np.float32],
+ diabatic_correction_heat: NDArray[np.float32],
+ von_karmans_constant: float,
+) -> NDArray[np.float32]:
+ r"""Calculate air heat conductivity by turbulent convection above canopy.
+
+ Heat conductance, :math:`g_{t}` between any two heights :math:`z_{1}` and
+ :math:`z_{0}` above-canopy is given by
+
+ .. math::
+ g_{t} = \frac {0.4 \hat{\rho} u^{*}}{ln(\frac{z_{1} - d}{z_{0} - d}) + \Psi_{H}}
+
+ where :math:`\hat{\rho}` is the molar density or air, :math:`u^{*}` is the friction
+ velocity, :math:`d` is the zero displacement height, and :math:`\Psi_{H}` is the
+ diabatic correction factor for heat.
+
+ Args:
+ height_above_canopy: Height above canopy, [m]
+ zero_displacement_height: Zero displacement height, [m]
+ canopy_height: Canopy height, [m]
+ friction_velocity: Friction velocity, dimensionless
+ molar_density_air: Molar density of air, [mole m-3]
+ diabatic_correction_heat: Diabatic correction factor for heat, dimensionless
+ von_karmans_constant: Von Karman constant, unitless
+
+ Returns:
+ Air heat conductivity by turbulent convection above canopy, [mol m-2 s-1]
+ """
+
+ return (von_karmans_constant * molar_density_air * friction_velocity) / (
+ np.log(height_above_canopy - zero_displacement_height)
+ / (canopy_height - zero_displacement_height)
+ + diabatic_correction_heat
+ )
+
+
+def calculate_air_heat_conductivity_canopy(
+ attenuation_coefficient: NDArray[np.float32],
+ mean_mixing_length: NDArray[np.float32],
+ molar_density_air: NDArray[np.float32],
+ upper_height: NDArray[np.float32],
+ lower_height: NDArray[np.float32],
+ relative_turbulence_intensity: NDArray[np.float32],
+ top_of_canopy_wind_speed: NDArray[np.float32],
+ diabatic_correction_momentum: NDArray[np.float32],
+ canopy_height: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ r"""Calculate air heat conductivity by turbulent convection in canopy,[mol m-2 s-1].
+
+ Within-canopy heat conductance (:math:`g_{t}`) between any two heights :math:`z_{1}`
+ and :math:`z_{0}` below-canopy is given by
+
+ .. math::
+ g_{t} = \frac{u_{h}l_{m}i_{w}a}
+ {(exp(\frac{-a_{z_{0}}}{h-1}) - exp(\frac{-a_{z_{1}}}{h-1})) \Phi_{H}}
+
+
+ where :math:`u_{h}` is wind speed at the top of the canopy at height :math:`h`,
+ :math:`a` is a wind attenuation coefficient, :math:`i_{w}` is a coefficient
+ describing relative turbulence intensity, :math:`l_{m}` is the mean mixing length,
+ equivalent to the free space between the leaves and stems, and :math:`\Phi_{H}` is a
+ within-canopy diabatic correction factor for heat.
+
+ TODO better tests for different conditions
+
+ Args:
+ attenuation_coefficient: Wind attenuation coefficient, dimensionless
+ mean_mixing_length: Mixing length for canopy air transport, [m]
+ molar_density_air: Molar density of air, [mol m-3]
+ upper_height: Height of upper layer, [m]
+ lower_height: Height of lower layer, [m]
+ relative_turbulence_intensity: Relative turbulence intensity, dimensionless
+ top_of_canopy_wind_speed: Top of canopy wind speed, [m s-1]
+ diabatic_correction_momentum: Diabatic correction factor for momentum,
+ dimensionless
+ canopy_height: Canopy height, [m]
+
+ Returns:
+ air heat conductivity by turbulent convection in the canopy, [mol m-2 s-1]
+ """
+ term1 = (
+ mean_mixing_length
+ * relative_turbulence_intensity
+ * molar_density_air
+ * top_of_canopy_wind_speed
+ * attenuation_coefficient
+ ) / diabatic_correction_momentum
+
+ term2 = np.exp(-attenuation_coefficient * (lower_height / canopy_height - 1))
+ term3 = np.exp(-attenuation_coefficient * (upper_height / canopy_height - 1))
+ return term1 / (term2 - term3)
+
+
+def calculate_leaf_air_heat_conductivity(
+ temperature: NDArray[np.float32],
+ wind_speed: NDArray[np.float32],
+ characteristic_dimension_leaf: float | NDArray[np.float32],
+ temperature_difference: NDArray[np.float32],
+ molar_density_air: NDArray[np.float32],
+ kinematic_viscosity_parameters: list[float],
+ thermal_diffusivity_parameters: list[float],
+ grashof_parameter: float,
+ forced_conductance_parameter: float,
+ positive_free_conductance_parameter: float,
+ negative_free_conductance_parameter: float,
+) -> NDArray[np.float32]:
+ r"""Calculate forced or free laminer conductance between leaf and air,[mol m-2 s-1].
+
+ When wind speeds are moderate to high, conduction between the leaf and air
+ :math:`g_{Ha}` is predominantly under laminar forced convection and from e.g.
+ :cite:t:`campbell_introduction_2012` is given by
+
+ .. math:: g_{Ha} = \frac {0.664 \hat{\rho} D_{H} R_{e}^{0.5} P_{r}^{0.5}}{x_{d}}
+
+ where :math:`D_{H}` is thermal diffusivity, :math:`x_{d}` is the characteristic
+ dimension of the leaf, :math:`\hat{\rho}` is the molar density of air,
+ :math:`R_{e}` is the Reynolds number, and :math:`P_{r}` is the Prandtl number.
+
+ When wind speeds are low, an expression that is adequate for leaves is given by
+ (Campbell and Norman, 2012)
+
+ .. math:: g_{Ha} = \frac{0.54 \hat{\rho} D_{H} (G_{r}P_{r})^{0.25}}{x_{d}}
+
+ where :math:`G_{r}` is the Grashof number. When the leaf is cooler than the air, the
+ heat transfer is only half as efficient so the constant 0.54 becomes 0.26.
+
+ TODO better tests for different conditions
+
+ Args:
+ temperature: Temperature, [C]
+ wind_speed: Wind speed, [m s-1]
+ characteristic_dimension_leaf: Chacteristic dimension of leaf, typically around
+ 0.7 * leaf width, [m]. This parameter can be a float, a 2D-array with one
+ value per grid cell, or a 3D-array with one value for each layer.
+ temperature_difference: Estimate of temperature differences of surface and air,
+ e.g. from previous time step, see notes in :cite:t:`maclean_microclimc_2021`
+ molar_density_air: Molar density of air, [mol m-3]
+ kinematic_viscosity_parameters: Parameters in calculation of kinematic viscosity
+ thermal_diffusivity_parameters: Parameters in calculation of thermal diffusivity
+ grashof_parameter: Parameter in calculation of Grashof number
+ forced_conductance_parameter: Parameter in calculation of forced conductance
+ positive_free_conductance_parameter: Parameter in calculation of free
+ conductance for positive temperature difference
+ negative_free_conductance_parameter: Parameter in calculation of free
+ conductance for negative temperature difference
+
+ Returns:
+ Leaf air heat conductance, [mol m-2 s-1]
+ """
+
+ temperature_k = temperature + 273.15
+ kinematic_viscosity = (
+ kinematic_viscosity_parameters[0] * temperature_k
+ - kinematic_viscosity_parameters[1]
+ ) / 10**6
+ thermal_diffusivity = (
+ thermal_diffusivity_parameters[0] * temperature_k
+ - thermal_diffusivity_parameters[1]
+ ) / 10**6
+ grashof_number = (
+ grashof_parameter
+ * characteristic_dimension_leaf**3
+ * np.abs(temperature_difference)
+ ) / (temperature_k * kinematic_viscosity**2)
+ reyolds_number = wind_speed * characteristic_dimension_leaf / kinematic_viscosity
+ prandtl_number = kinematic_viscosity / thermal_diffusivity
+
+ # Forced conductance
+ forced_conductance = (
+ forced_conductance_parameter
+ * thermal_diffusivity
+ * molar_density_air
+ * reyolds_number**0.5
+ * prandtl_number ** (1 / 3)
+ ) / characteristic_dimension_leaf
+
+ # Free conductance
+ m = np.where(
+ temperature_difference > 0,
+ positive_free_conductance_parameter,
+ negative_free_conductance_parameter,
+ )
+ free_conductance = (
+ m
+ * molar_density_air
+ * thermal_diffusivity
+ * (grashof_number * prandtl_number) ** (1 / 4)
+ ) / characteristic_dimension_leaf
+
+ # Set to whichever is higher
+ conductance = np.where(
+ forced_conductance > free_conductance, forced_conductance, free_conductance
+ )
+
+ return conductance
+
+
+def calculate_leaf_vapour_conductivity(
+ leaf_air_conductivity: NDArray[np.float32],
+ stomatal_conductance: float | NDArray[np.float32],
+) -> NDArray[np.float32]:
+ r"""Calculate leaf air conductivity for vapour, [mol m-2 s-1].
+
+ The conductance for vapour loss from leaves :math:`g_{v}` depends on stomatal
+ conductance :math:`g_{c}` and heat conductivity between air and leaf :math:`g_{Ha}`:
+
+ .. math:: g_{v} = \frac{1}{(\frac{1}{g_{Ha}} + \frac{1}{g_{c}})
+
+ :cite:p:`maclean_microclimc_2021`.
+
+ Args:
+ leaf_air_conductivity: Heat conductivity between air and leaf, [mol m-2 s-1]
+ stomatal_conductance: Stomatal conductance, [mol m-2 s-1]
+
+ Returns:
+ Leaf vapour conductivity, [mol m-2 s-1]
+ """
+ return 1 / ((1 / leaf_air_conductivity) + (1 / stomatal_conductance))
+
+
+def calculate_current_conductivities(
+ data: Data,
+ characteristic_dimension_leaf: float | NDArray[np.float32],
+ von_karmans_constant: float,
+ abiotic_constants: AbioticConsts,
+) -> dict[str, NDArray[np.float32]]:
+ """Calculate conductivities based on current reference data.
+
+ This function calculates the conductivites for heat and vapour between air layers
+ and the leaf and surrounding atmosphere for the current time step. The first value
+ on the vertical axis is 2m above the canopy, the second value corresponds to the top
+ of the canopy.
+
+ The data object must provide the following variables:
+
+ * layer_heights: layer heights, [m]
+ * air_temperature, [C]
+ * canopy_temperature, [C]
+ * attenuation_coefficient: Wind attenuation coefficient, dimensionless
+ * mean_mixing_length: Mixing length for canopy air transport, [m]
+ * molar_density_air: Molar density of air, [mol m-3]
+ * relative_turbulence_intensity: Relative turbulence intensity, dimensionless
+ * wind_speed: wind speed, [m s-1]
+ * stomatal_conductance: Stomatal conductance, [mmol m-2 s-1]
+ * zero_displacement_height: Zero displacement height, [m]
+ * friction_velocity: Friction velocity
+ * diabatic_correction_heat: Diabatic correction for heat in canopy
+
+ Args:
+ data: The core data object.
+ characteristic_dimension_leaf: Chacteristic dimension of leaf, typically around
+ 0.7 * leaf width, [m]. This parameter can be a float, a 2D-array with one
+ value per grid cell, or a 3D-array with one value for each layer.
+ von_karmans_constant: Von Karman constant
+ abiotic_constants: set of abiotic constants
+
+ Returns:
+ dictionnary of conductivities, [mol m-2 s-1]
+ """
+
+ output = {}
+
+ # Air heat conductivity, gt
+ air_heat_conductivity_above = calculate_air_heat_conductivity_above(
+ height_above_canopy=data["layer_heights"].isel(layers=0).to_numpy(),
+ zero_displacement_height=data["zero_displacement_height"].to_numpy(),
+ canopy_height=data["layer_heights"].isel(layers=1).to_numpy(),
+ friction_velocity=data["friction_velocity"].to_numpy(),
+ molar_density_air=data["molar_density_air"][0].to_numpy(),
+ diabatic_correction_heat=data["diabatic_correction_heat_canopy"].to_numpy(),
+ von_karmans_constant=von_karmans_constant,
+ )
+ current_air_heat_conductivity = []
+ for layer in np.arange(0, len(data["layer_heights"]) - 1):
+ result = calculate_air_heat_conductivity_canopy(
+ attenuation_coefficient=data["attenuation_coefficient"][layer].to_numpy(),
+ mean_mixing_length=data["mean_mixing_length"].to_numpy(),
+ molar_density_air=data["molar_density_air"][layer].to_numpy(),
+ upper_height=data["layer_heights"].isel(layers=layer).to_numpy(),
+ lower_height=data["layer_heights"].isel(layers=layer + 1).to_numpy(),
+ relative_turbulence_intensity=(
+ data["relative_turbulence_intensity"][layer].to_numpy()
+ ),
+ top_of_canopy_wind_speed=data["wind_speed"].isel(layers=1).to_numpy(),
+ diabatic_correction_momentum=(
+ data["diabatic_correction_momentum_canopy"].to_numpy()
+ ),
+ canopy_height=data["layer_heights"].isel(layers=1).to_numpy(),
+ )
+ current_air_heat_conductivity.append(result)
+
+ output["air_heat_conductivity"] = np.vstack(
+ [air_heat_conductivity_above, np.vstack(current_air_heat_conductivity)]
+ )
+
+ # Air heat conductivity between layers and reference height
+ current_air_heat_conductivity_ref = []
+ for layer in np.arange(0, len(data["layer_heights"]) - 1):
+ result = calculate_air_heat_conductivity_canopy(
+ attenuation_coefficient=data["attenuation_coefficient"][layer].to_numpy(),
+ mean_mixing_length=data["mean_mixing_length"].to_numpy(),
+ molar_density_air=data["molar_density_air"][layer].to_numpy(),
+ upper_height=data["layer_heights"].isel(layers=0).to_numpy(),
+ lower_height=data["layer_heights"].isel(layers=layer + 1).to_numpy(),
+ relative_turbulence_intensity=(
+ data["relative_turbulence_intensity"][layer].to_numpy()
+ ),
+ top_of_canopy_wind_speed=data["wind_speed"].isel(layers=1).to_numpy(),
+ diabatic_correction_momentum=(
+ data["diabatic_correction_momentum_canopy"].to_numpy()
+ ),
+ canopy_height=data["layer_heights"].isel(layers=1).to_numpy(),
+ )
+ current_air_heat_conductivity_ref.append(result)
+
+ output["conductivity_from_ref_height"] = np.vstack(
+ [
+ np.repeat(np.nan, data.grid.n_cells),
+ np.vstack(current_air_heat_conductivity_ref),
+ ]
+ )
+
+ # Leaf air heat conductivity, gha
+ current_leaf_air_heat_conductivity = calculate_leaf_air_heat_conductivity(
+ temperature=data["air_temperature"].to_numpy(),
+ wind_speed=data["wind_speed"].to_numpy(),
+ characteristic_dimension_leaf=characteristic_dimension_leaf,
+ temperature_difference=(
+ data["canopy_temperature"] - data["air_temperature"]
+ ).to_numpy(),
+ molar_density_air=data["molar_density_air"].to_numpy(),
+ kinematic_viscosity_parameters=abiotic_constants.kinematic_viscosity_parameters,
+ thermal_diffusivity_parameters=abiotic_constants.thermal_diffusivity_parameters,
+ grashof_parameter=abiotic_constants.grashof_parameter,
+ forced_conductance_parameter=abiotic_constants.forced_conductance_parameter,
+ positive_free_conductance_parameter=(
+ abiotic_constants.positive_free_conductance_parameter
+ ),
+ negative_free_conductance_parameter=(
+ abiotic_constants.negative_free_conductance_parameter
+ ),
+ )
+ output["leaf_air_heat_conductivity"] = current_leaf_air_heat_conductivity
+
+ # Leaf vapour conductivity, gv
+ current_leaf_vapour_conductivity = calculate_leaf_vapour_conductivity(
+ leaf_air_conductivity=current_leaf_air_heat_conductivity,
+ stomatal_conductance=data["stomatal_conductance"].to_numpy(),
+ )
+ output["leaf_vapour_conductivity"] = current_leaf_vapour_conductivity
+
+ return output
diff --git a/virtual_ecosystem/models/abiotic/constants.py b/virtual_ecosystem/models/abiotic/constants.py
new file mode 100644
index 000000000..cdf37150a
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/constants.py
@@ -0,0 +1,279 @@
+"""The ``models.abiotic.constants`` module contains a set of dataclasses which contain
+parameters required by the broader
+:mod:`~virtual_ecosystem.models.abiotic.abiotic_model` model.
+These parameters are constants in that they should not be changed during a particular
+simulation.
+""" # noqa: D205
+
+from dataclasses import dataclass, field
+
+from virtual_ecosystem.core.constants_class import ConstantsDataclass
+
+
+@dataclass(frozen=True)
+class AbioticConsts(ConstantsDataclass):
+ """Dataclass to store all constants for the `abiotic` model."""
+
+ wind_reference_height: float = 10.0
+ """Reference height for wind speed above the canopy.
+ The reference height for horizontal wind is typically 10m above ground compared to
+ 2m for other atmospheric variables such as temperature and relative humidity. We
+ assume here that the reference height is above the canopy, please check the input
+ data carefully and be aware of limitations."""
+
+ specific_heat_equ_factors: list[float] = field(
+ default_factory=lambda: [2e-05, 0.0002]
+ )
+ """Factors in calculation of molar specific heat of air.
+
+ Implementation after :cite:t:`maclean_microclimc_2021`."""
+
+ latent_heat_vap_equ_factors: list[float] = field(
+ default_factory=lambda: [1.91846e6, 33.91]
+ )
+ """Factors in calculation of latent heat of vapourisation.
+
+ Implementation after :cite:t:`maclean_microclimc_2021`, value is taken from
+ :cite:t:`henderson-sellers_new_1984`.
+ """
+
+ zero_plane_scaling_parameter: float = 7.5
+ """Control parameter for scaling zero displacement to height, dimensionless.
+
+ Implementation after :cite:t:`maclean_microclimc_2021`, value is taken from
+ :cite:t:`raupach_simplified_1994`."""
+
+ substrate_surface_drag_coefficient: float = 0.003
+ """Substrate-surface drag coefficient, dimensionless.
+
+ The substrate-surface drag coefficient represents the resistance encountered by an
+ object moving on or through a surface and varies based on the nature of the surface
+ and the object's properties. Here, it affects how wind speed is altered by a surface
+ . Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ roughness_element_drag_coefficient: float = 0.3
+ """Roughness-element drag coefficient, dimensionless.
+
+ The roughness-element drag coefficient refers to the dimensionless coefficient used
+ to quantify the drag force exerted by individual roughness elements (such as
+ buildings, trees, or surface irregularities) on airflow, influencing the overall
+ aerodynamic characteristics of a surface within the atmospheric boundary layer.
+ Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ roughness_sublayer_depth_parameter: float = 0.193
+ """Parameter characterizes the roughness sublayer depth.
+
+ The roughness sublayer depth refers to the layer near the surface where the effects
+ of surface roughness significantly influence airflow, turbulence, and momentum
+ transfer, typically extending up to about 10% of the height of the roughness
+ elements or features on the surface. This layer is characterized by intense
+ turbulence and rapid velocity changes due to surface irregularities.
+ Implentation and value taken from :cite:p:`maclean_microclimc_2021`."""
+
+ max_ratio_wind_to_friction_velocity: float = 0.3
+ """Maximum ratio of wind velocity to friction velocity, dimensionless.
+
+ Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ drag_coefficient: float = 0.2
+ """Drag coefficient, dimensionless.
+
+ The drag coefficient is a dimensionless quantity that characterizes the drag or
+ resistance experienced by an object moving through a fluid (here the atmosphere) and
+ is defined as the ratio of the drag force on the object to the dynamic pressure of
+ the fluid flow and the reference area of the object.
+ Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ relative_turbulence_intensity: float = 0.5
+ """Relative turbulence intensity, dimensionless.
+
+ The relative turbulence intensity is a proportionality factor that relates the mean
+ eddy velocity is assumed to the local wind speed below the canopy. Implementation
+ and value from :cite:t:`maclean_microclimc_2021`."""
+
+ diabatic_correction_factor_below: float = 1
+ """Diabatic correction factor below canopy, dimensionless.
+
+ The diabatic correction factor is a scaling adjustment used to compensate for the
+ effects of vertical heat transfer or thermal non-adiabaticity on atmospheric
+ variables or processes, particularly when estimating or interpreting measurements
+ across different heights or conditions. This factor is used to adjust wind profiles
+ below the canopy. Implementation and value from :cite:t:`maclean_microclimc_2021`.
+ """
+
+ mixing_length_factor: float = 0.32
+ """Factor in calculation of mixing length, dimensionless.
+
+ Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ min_relative_turbulence_intensity: float = 0.36
+ """Minimum relative turbulence intensity, dimensionless.
+
+ See :attr:`relative_turbulence_intensity`.
+ The default value is taken from Shaw et al (1974) Agricultural Meteorology, 13:
+ 419-425. TODO this is not representative of a rainforest environment and needs to be
+ adjusted.
+ """
+
+ max_relative_turbulence_intensity: float = 0.9
+ """Maximum relative turbulence intensity, dimensionless.
+
+ See :attr:`relative_turbulence_intensity`.
+ The default value from Shaw et al (1974) Agricultural Meteorology, 13: 419-425.
+ TODO this is not representative of a rainforest environment and needs to be
+ adjusted."""
+
+ min_wind_speed_above_canopy: float = 0.1
+ """Minimum wind speed above the canopy, [m s-1].
+
+ Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ min_windspeed_below_canopy: float = 0.001
+ """Minimum wind speed below the canopy or in absence of vegetation, [m s-1]."""
+
+ min_friction_velocity: float = 0.001
+ """Minimum friction velocity, [m s-1]."""
+
+ min_roughness_length: float = 0.01
+ """Minimum roughness length, [m].
+
+ The minimum roughness length represents the lowest height at which the surface
+ roughness significantly affects the wind flow over a particular terrain or surface.
+ Implementation and value from :cite:t:`maclean_microclimc_2021`."""
+
+ yasuda_stability_parameters: list[float] = field(
+ default_factory=lambda: [6.0, 2.0, 16.0]
+ )
+ """Parameters to approximate diabatic correction factors for heat and momentum.
+
+ Dimenionless parameter, implementation after :cite:t:`maclean_microclimc_2021` and
+ values taken from :cite:t:`yasuda_turbulent_1988`."""
+
+ diabatic_heat_momentum_ratio: float = 0.6
+ """Factor that relates diabatic correction factors for heat and momentum.
+
+ Dimenionless parameter, implementation after :cite:t:`maclean_microclimc_2021` and
+ values taken from :cite:t:`yasuda_turbulent_1988`."""
+
+ turbulence_sign: bool = True
+ """Flag indicating if turbulence increases or decreases with height."""
+
+ canopy_temperature_ini_factor: float = 0.01
+ """Factor used to initialise canopy temperature as a function of air temperature and
+ absorbed shortwave radiation."""
+
+ light_extinction_coefficient: float = 0.01
+ """Light extinction coefficient for canopy."""
+
+ gas_constant_water_vapour: float = 461.51
+ """Gas constant for water vapour, [J kg -1 K-1]."""
+
+ specific_heat_capacity_leaf: float = 2760.0
+ """Specific heat capacity of leaf, [J kg-1 K-1], :cite:p:`aston_heat_1985`.
+ """
+
+ leaf_heat_transfer_coefficient: float = 50.0
+ """Leaf heat transfer coefficient, [s^1/2 m^-1/2],
+ :cite:p:`linacre_determinations_1964`.
+ """
+
+ stomatal_resistance: float = 200.0
+ """Default stomatal resistance, [s m2 mumol-1]."""
+
+ soil_thermal_conductivity: float = 0.7
+ """Soil thermal conductivity, [W m-1 K-1], :cite:p:`monteith_principles_1990`.
+ """
+
+ specific_heat_capacity_soil: float = 2.7e6
+ """Specific heat capacity of soil, [J kg-1 K-1], :cite:p:`monteith_principles_1990`.
+ """
+
+ initial_air_conductivity: float = 50.0
+ """Initial air conductivity, [mol m-2 s-1]."""
+
+ top_leaf_vapour_conductivity: float = 0.32
+ """Initial leaf vapour conductivity at the top of the canopy, [mol m-2 s-1]."""
+
+ bottom_leaf_vapour_conductivity: float = 0.25
+ """Initial leaf vapour conductivity at the bottom of the canopy, [mol m-2 s-1]."""
+
+ top_leaf_air_conductivity: float = 0.19
+ """Initial leaf air heat conductivity at the top of the canopy, [mol m-2 s-1]."""
+
+ bottom_leaf_air_conductivity: float = 0.13
+ """Initial leaf air heat conductivity at the bottom of the canopy, [mol m-2 s-1]."""
+
+ surface_albedo: float = 0.125
+ """Mean surface albedo of a tropical rainforest in South East Asia, dimensionless.
+
+ The value is takes from a study that compares changes in surface albedo before and
+ after deforestation in South East Asia :cite:p:`wilson_role_2020`."""
+
+ soil_emissivity: float = 0.8
+ """Soil emissivity, dimensionless."""
+
+ surface_layer_depth: float = 0.1
+ """Surface layer depth, [m].
+
+ This depth defines the soil depth that is directly involved in the surface energy
+ balance.
+ """
+
+ volume_to_weight_conversion: float = 1000.0
+ """Factor to convert between soil volume and weight in kilograms."""
+
+ kinematic_viscosity_parameters: list[float] = field(
+ default_factory=lambda: [0.0908, 11.531]
+ )
+ """Parameters in calculation of kinematic viscosity
+ :cite:p:`campbell_introduction_2012`.
+ """
+
+ thermal_diffusivity_parameters: list[float] = field(
+ default_factory=lambda: [0.1285, 16.247]
+ )
+ """Parameter in calculation of thermal diffusivity
+ :cite:p:`campbell_introduction_2012`.
+ """
+
+ grashof_parameter: float = 9.807
+ """Parameter in calculation of Grashof number
+ :cite:p:`campbell_introduction_2012`.
+ """
+
+ forced_conductance_parameter: float = 0.34
+ """Parameter in calculation of forced conductance
+ :cite:p:`campbell_introduction_2012`.
+ """
+
+ positive_free_conductance_parameter: float = 0.54
+ """Parameter in calculation of free conductance for positive temperature difference
+ :cite:p:`campbell_introduction_2012`.
+ """
+
+ negative_free_conductance_parameter: float = 0.26
+ """Parameter in calculation of free conductance for negative temperature difference
+ :cite:p:`campbell_introduction_2012`.
+ """
+
+ leaf_emissivity: float = 0.8
+ """Leaf emissivity, dimensionless."""
+
+ saturated_pressure_slope_parameters: list[float] = field(
+ default_factory=lambda: [4098.0, 0.6108, 17.27, 237.3]
+ )
+ """List of parameters to calcualte the slope of saturated vapour pressure curve."""
+
+ wind_profile_parameters: list[float] = field(
+ default_factory=lambda: [4.87, 67.8, 5.42]
+ )
+ """Factors in calculation of logarithmic wind profile above canopy."""
+
+ richardson_bounds: list[float] = field(default_factory=lambda: [0.15, -0.1120323])
+ """Minimum and maximum value for Richardson number."""
+
+ stable_wind_shear_slope: float = 4.7
+ """Wind shear slope under stable conditions after Gourdiaan (1977)."""
+
+ stable_temperature_gradient_intercept: float = 0.74
+ """Temperature gradient intercept under stable conditions after Goudriaan (1977)."""
diff --git a/virtual_ecosystem/models/abiotic/energy_balance.py b/virtual_ecosystem/models/abiotic/energy_balance.py
new file mode 100644
index 000000000..d0b23b24d
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/energy_balance.py
@@ -0,0 +1,808 @@
+r"""The ``models.abiotic.energy_balance`` module calculates the energy balance for the
+Virtual Ecosystem. Given that the time increments of the model are an hour or longer,
+we can assume that below-canopy heat and vapour exchange attain steady state and heat
+storage in the canopy does not need to be simulated explicitly.
+(For application where very fine-temporal resolution data might be needed, heat and
+vapour exchange must be modelled as transient processes, and heat storage by the canopy,
+and the exchange of heat between different layers of the canopy, must be considered
+explicitly, see :cite:t:`maclean_microclimc_2021`. This is currently not implemented.)
+
+Under steady-state, the balance equation for the leaves in each canopy layer is as
+follows (after :cite:t:`maclean_microclimc_2021`):
+
+.. math::
+ R_{abs} - R_{em} - H - \lambda E
+ = R_{abs} - \epsilon_{s} \sigma T_{L}^{4} - c_{P}g_{Ha}(T_{L} - T_{A})
+ - \lambda g_{v} \frac {e_{L} - e_{A}}{p_{A}} = 0
+
+where :math:`R_{abs}` is absorbed radiation, :math:`R_{em}` emitted radiation, :math:`H`
+the sensible heat flux, :math:`\lambda E` the latent heat flux, :math:`\epsilon_{s}` the
+emissivity of the leaf, :math:`\sigma` the Stefan-Boltzmann constant, :math:`T_{L}` the
+absolute temperature of the leaf, :math:`T_{A}` the absolute temperature of the air
+surrounding the leaf, :math:`\lambda` the latent heat of vapourisation of water,
+:math:`e_{L}` the effective vapour pressure of the leaf, :math:`e_{A}` the vapour
+pressure of air and :math:`p_{A}` atmospheric pressure. :math:`g_{Ha}` is the heat
+conductance between leaf and atmosphere, :math:`g_{v}` represents the conductance
+for vapour loss from the leaves as a function of the stomatal conductance :math:`g_{c}`.
+
+A challenge in solving this equation is the dependency of latent heat and emitted
+radiation on leaf temperature. We use a linearisation approach to solve the equation for
+leaf temperature and air temperature simultaneously after
+:cite:t:`maclean_microclimc_2021`.
+
+The soil energy balance functions are described in
+:mod:`~virtual_ecosystem.models.abiotic.soil_energy_balance`.
+
+The conductivities are calculated as described in
+:mod:`~virtual_ecosystem.models.abiotic.conductivities`.
+""" # noqa: D205, D415
+
+import numpy as np
+from numpy.typing import NDArray
+from xarray import DataArray
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.core.core_components import LayerStructure
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.models.abiotic.conductivities import (
+ calculate_current_conductivities,
+ interpolate_along_heights,
+)
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
+from virtual_ecosystem.models.abiotic_simple.microclimate import (
+ calculate_saturation_vapour_pressure,
+)
+
+
+def initialise_absorbed_radiation(
+ topofcanopy_radiation: NDArray[np.float32],
+ leaf_area_index: NDArray[np.float32],
+ layer_heights: NDArray[np.float32],
+ light_extinction_coefficient: float,
+) -> NDArray[np.float32]:
+ r"""Calculate initial light absorption profile.
+
+ This function calculates the fraction of radiation absorbed by a multi-layered
+ canopy based on its leaf area index (:math:`LAI`) and extinction coefficient
+ (:math:`k`) at each layer, the depth of each measurement (:math:`z`), and the
+ incoming light intensity at the top of the canopy (:math:`I_{0}`). The
+ implementation based on Beer's law:
+
+ .. math:: I(z) = I_{0} * e^{(-k * LAI * z)}
+
+ Args:
+ topofcanopy_radiation: Top of canopy radiation shortwave radiation, [W m-2]
+ leaf_area_index: Leaf area index of each canopy layer, [m m-1]
+ layer_heights: Layer heights, [m]
+ light_extinction_coefficient: Light extinction coefficient, [m-1]
+
+ Returns:
+ Shortwave radiation absorbed by canopy layers, [W m-2]
+ """
+ # Calculate the depth of each layer, [m]
+ layer_depths = np.abs(np.diff(layer_heights, axis=0, append=0))
+
+ # Calculate the light extinction for each layer
+ layer_extinction = np.exp(
+ -0.01 * light_extinction_coefficient * layer_depths * leaf_area_index
+ )
+
+ # Calculate how much light penetrates through the canopy, [W m-2]
+ cumulative_extinction = np.cumprod(layer_extinction, axis=0)
+ penetrating_radiation = cumulative_extinction * topofcanopy_radiation
+
+ # Calculate how much light is absorbed in each layer, [W m-2]
+ absorbed_radiation = np.abs(
+ np.diff(
+ penetrating_radiation,
+ prepend=np.expand_dims(topofcanopy_radiation, axis=0),
+ axis=0,
+ )
+ )
+
+ return absorbed_radiation
+
+
+def initialise_canopy_temperature(
+ air_temperature: NDArray[np.float32],
+ absorbed_radiation: NDArray[np.float32],
+ canopy_temperature_ini_factor: float,
+) -> NDArray[np.float32]:
+ """Initialise canopy temperature.
+
+ Args:
+ air_temperature: Air temperature, [C]
+ canopy_temperature_ini_factor: Factor used to initialise canopy temperature as a
+ function of air temperature and absorbed shortwave radiation
+ absorbed_radiation: Shortwave radiation absorbed by canopy, [W m-2]
+
+ Returns:
+ Initial canopy temperature, [C]
+ """
+ return air_temperature + canopy_temperature_ini_factor * absorbed_radiation
+
+
+def initialise_canopy_and_soil_fluxes(
+ air_temperature: DataArray,
+ topofcanopy_radiation: DataArray,
+ leaf_area_index: DataArray,
+ layer_heights: DataArray,
+ layer_structure: LayerStructure,
+ light_extinction_coefficient: float,
+ canopy_temperature_ini_factor: float,
+) -> dict[str, DataArray]:
+ """Initialise canopy temperature and energy fluxes.
+
+ This function initializes the following variables to run the first step of the
+ energy balance routine: absorbed radiation (canopy), canopy temperature, sensible
+ and latent heat flux (canopy and soil), and ground heat flux.
+
+ Args:
+ air_temperature: Air temperature, [C]
+ topofcanopy_radiation: Top of canopy radiation, [W m-2]
+ leaf_area_index: Leaf area index, [m m-2]
+ layer_heights: Layer heights, [m]
+ layer_structure: Instance of LayerStructure
+ light_extinction_coefficient: Light extinction coefficient for canopy
+ canopy_temperature_ini_factor: Factor used to initialise canopy temperature as a
+ function of air temperature and absorbed shortwave radiation
+
+ Returns:
+ Dictionary with absorbed radiation (canopy), canopy temperature, sensible
+ and latent heat flux (canopy and soil), and ground heat flux [W m-2].
+ """
+
+ output = {}
+
+ # Get variables within filled canopy layers
+ leaf_area_index_true = leaf_area_index[layer_structure.index_filled_canopy]
+ layer_heights_canopy = layer_heights[layer_structure.index_filled_canopy]
+ air_temperature_canopy = air_temperature[layer_structure.index_filled_canopy]
+
+ # Initialize absorbed radiation DataArray
+ absorbed_radiation = DataArray(
+ np.full_like(layer_heights, np.nan),
+ dims=layer_heights.dims,
+ coords=layer_heights.coords,
+ name="canopy_absorption",
+ )
+
+ # Calculate absorbed radiation
+ initial_absorbed_radiation = initialise_absorbed_radiation(
+ topofcanopy_radiation=topofcanopy_radiation.to_numpy(),
+ leaf_area_index=leaf_area_index_true.to_numpy(),
+ layer_heights=layer_heights_canopy.to_numpy(),
+ light_extinction_coefficient=light_extinction_coefficient,
+ )
+
+ # Replace np.nan with new values and write in output dict
+ absorbed_radiation[layer_heights_canopy.indexes] = initial_absorbed_radiation
+ output["canopy_absorption"] = absorbed_radiation
+
+ # Initialize canopy temperature DataArray
+ canopy_temperature = DataArray(
+ np.full_like(layer_heights, np.nan),
+ dims=layer_heights.dims,
+ coords=layer_heights.coords,
+ name="canopy_temperature",
+ )
+
+ # Calculate initial temperature and write in output dict
+ initial_canopy_temperature = initialise_canopy_temperature(
+ air_temperature=air_temperature_canopy.to_numpy(),
+ absorbed_radiation=initial_absorbed_radiation,
+ canopy_temperature_ini_factor=canopy_temperature_ini_factor,
+ )
+ canopy_temperature[layer_structure.index_filled_canopy] = initial_canopy_temperature
+ output["canopy_temperature"] = canopy_temperature
+
+ # Initialise sensible heat flux with zeros and write in output dict
+ sensible_heat_flux = DataArray(
+ np.full_like(layer_heights, np.nan),
+ dims=layer_heights.dims,
+ coords=layer_heights.coords,
+ name="sensible_heat_flux",
+ )
+ sensible_heat_flux[layer_structure.index_filled_canopy] = 0
+ sensible_heat_flux[layer_structure.index_topsoil] = 0
+ output["sensible_heat_flux"] = sensible_heat_flux
+
+ # Initialise latent heat flux with zeros and write in output dict
+ output["latent_heat_flux"] = sensible_heat_flux.copy().rename("latent_heat_flux")
+
+ # Initialise latent heat flux with zeros and write in output dict
+ ground_heat_flux = DataArray(
+ np.full_like(layer_heights, np.nan),
+ dims=layer_heights.dims,
+ coords=layer_heights.coords,
+ name="ground_heat_flux",
+ )
+ ground_heat_flux[layer_structure.index_topsoil] = 0
+ output["ground_heat_flux"] = ground_heat_flux
+
+ return output
+
+
+def calculate_longwave_emission(
+ temperature: NDArray[np.float32],
+ emissivity: float | NDArray[np.float32],
+ stefan_boltzmann: float,
+) -> NDArray[np.float32]:
+ """Calculate longwave emission using the Stefan Boltzmann law, [W m-2].
+
+ According to the Stefan Boltzmann law, the amount of radiation emitted per unit time
+ from the area of a black body at absolute temperature is directly proportional to
+ the fourth power of the temperature. Emissivity (which is equal to absorptive power)
+ lies between 0 to 1.
+
+ Args:
+ temperature: Temperature, [K]
+ emissivity: Emissivity, dimensionless
+ stefan_boltzmann: Stefan Boltzmann constant, [W m-2 K-4]
+
+ Returns:
+ Longwave emission, [W m-2]
+ """
+ return emissivity * stefan_boltzmann * temperature**4
+
+
+def calculate_slope_of_saturated_pressure_curve(
+ temperature: NDArray[np.float32],
+ saturated_pressure_slope_parameters: list[float],
+) -> NDArray[np.float32]:
+ r"""Calculate slope of the saturated pressure curve.
+
+ Args:
+ temperature: Temperature, [C]
+ saturated_pressure_slope_parameters: List of parameters to calcualte
+ the slope of the saturated vapour pressure curve
+
+ Returns:
+ Slope of the saturated pressure curve, :math:`\Delta_{v}`
+ """
+
+ return (
+ saturated_pressure_slope_parameters[0]
+ * (
+ saturated_pressure_slope_parameters[1]
+ * np.exp(
+ saturated_pressure_slope_parameters[2]
+ * temperature
+ / (temperature + saturated_pressure_slope_parameters[3])
+ )
+ )
+ / (temperature + saturated_pressure_slope_parameters[3]) ** 2
+ )
+
+
+def calculate_leaf_and_air_temperature(
+ data: Data,
+ time_index: int,
+ layer_structure: LayerStructure,
+ abiotic_constants: AbioticConsts,
+ abiotic_simple_constants: AbioticSimpleConsts,
+ core_constants: CoreConsts,
+) -> dict[str, DataArray]:
+ r"""Calculate leaf and air temperature under steady state.
+
+ The air temperature surrounding the leaf :math:`T_{A}` is assumed to be influenced
+ by leaf temperature :math:`T_{L}`, soil temperature :math:`T_{0}`, and reference air
+ temperature :math:`T_{R}` as follows:
+
+ .. math::
+ g_{tR} c_{p} (T_{R} - T_{A})
+ + g_{t0} c_{p} (T_{0} - T_{A})
+ + g_{L} c_{p} (T_{L} - T_{A}) = 0
+
+ where :math:`c_{p}` is the specific heat of air at constant pressure and
+ :math:`g_{tR}`, :math:`g_{t0}` and :math:`g_{L}` are conductance from reference
+ height, the ground and from the leaf, respectively.
+ :math:`g_{L} = 1/(1/g_{HA} + 1/g_{z})` where :math:`g_{HA}` is leaf boundary layer
+ conductance and :math:`g_{z}` is the sub-canopy turbulent conductance at the height
+ of the leaf over the mean distance between the leaf and the air.
+
+ Defining :math:`T_{L} - T_{A}` as :math:`\Delta T` and rearranging gives:
+
+ .. math:: T_{A} = a_{A} + b_{A} \Delta T_{L}
+
+ where :math:`a_{A} = \frac{(g_{tR} T_{R} + g_{t0} T_{0})}{(g_{tR} + g_{t0})}` and
+ :math:`b_{A} = \frac{g_{L}}{(g_{tR} + g_{t0})}` .
+
+ The sensible heat flux between the leaf and the air is given by
+
+ .. math:: g_{Ha} c_{p} (T_{L} - T_{A}) = b_{H} \Delta T_{L}
+
+ where :math:`b_{H} = g_{Ha} c_{p}`. The equivalent vapour flux equation is
+
+ .. math:: g_{tR}(e_{R} - e_{a}) + g_{t0} (e_{0} - e_{a}) + g_{v} (e_{L} - e_{a}) = 0
+
+ where :math:`e_{L}`, :math:`e_{A}`, :math:`e_{0}` and :math:`e_{R}` are the vapour
+ pressure of the leaf, air, soil and air at reference height, respectively, and
+ :math:`g_{v}` is leaf conductance for vapour given by
+ :math:`g_{v} = \frac{1}{(\frac{1}{g_{c} + g_{L})}}` where :math:`g_{c}` is stomatal
+ conductance. Assuming the leaf to be saturated, and approximated by
+ :math:`e_{s} [T_{R}]+\Delta_{v} [T_{R}]\Delta T_{L}` where :math:`\Delta_{v}` is the
+ slope of the saturated pressure curve at temperature :math:`T_{R}`, and rearranging
+ gives
+
+ .. math:: e_{a} = a_{E} + b_{E} \Delta T_{L}
+
+ where :math:`a_{E} = \frac{(g_{tR} e_{R} + g_{t0} e_{0} + g_{v} e_{s}[T_{R}])}
+ {(g_{tR} + g_{t0} + g_{v})}` and
+ :math:`b_{E} = \frac{\Delta_{V} [T_{R}])}{(g_{tR} + g_{t0} + g_{v})}`.
+
+ The latent heat term is given by
+
+ .. math:: \lambda E = \frac{\lambda g_{v}}{p_{a}} (e_{L} - e_{A})
+
+ Substituting :math:`e_{A}` for its linearized form, again assuming :math:`e_{L}`
+ is approximated by :math:`e_{s} [T_{R}]+\Delta_{v} [T_{R}]\Delta T_{L}`, and
+ rearranging gives:
+
+ .. math:: \lambda E = a_{L} + b_{L} \Delta T_{L},
+
+ where :math:`a_{L} = \frac{\lambda g_{v}}{p_{a}} (e_{s} [T_{R}] - a_{E})` and
+ :math:`b_{L} = \frac{\lambda g_{v}}{p_{a}} (\Delta_{V} [T_{R}] - b_{E})`.
+
+ The radiation emitted by the leaf :math:`R_{em}` is given by the Stefan Boltzmann
+ law and can be linearised as follows:
+
+ .. math:: R_{em} = a_{R} + b_{R} \Delta T_{L}
+
+ where :math:`a_{R} = \epsilon_{s} \sigma a_{A}^{4}` and
+ :math:`b_{R} = 4 \epsilon_{s} \sigma (a_{A}^{3} b_{A} + T_{R}^{3})`.
+
+ The full heat balance equation for the difference between leaf and canopy air
+ temperature becomes
+
+ .. math:: \Delta T_{L} = \frac{R_{abs} - a_{R} - a_{L}}{(1 + b_{R} + b_{L} + b_{H})}
+
+ The equation is then used to calculate air and leaf temperature as follows:
+
+ .. math:: T_{A} = a_{A} + b_{A} \Delta T_{L}
+
+ and
+
+ .. math:: T_{L} = T_{A} + \Delta T_{L}.
+
+ the data object has to contain the previous and current values for the following:
+
+ * air_temperature_ref: Air temperature at reference height 2m above canopy, [C]
+ * vapour_pressure_ref: vapour pressure at reference height 2m above canopy, [kPa]
+ * soil_temperature: Soil temperature, [C]
+ * soil_moisture: Soil moisture, [mm]
+ * layer_heights: Layer heights, [mm]
+ * atmospheric_pressure_ref: Atmospheric pressure at reference height, [kPa]
+ * air_temperature: Air temperature, [C]
+ * canopy_temperature: Leaf temperature, [C]
+ * latent_heat_vapourisation: Latent heat of vapourisation, [J kg-1]
+ * absorbed_radiation: Absorbed radiation, [W m-2]
+ * specific_heat_air: Specific heat of air, [J mol-1 K-1]
+
+ Todo:
+ * add latent heat flux from soil to atmosphere (-> VPD)
+ * check time integration
+ * set limits to temperature and VPD
+
+ Args:
+ data: Instance of data object
+ time_index: Time index
+ layer_structure: Instance of LayerStructure that countains details about layers
+ abiotic_constants: Set of abiotic constants
+ abiotic_simple_constants: Set of abiotic constants
+ core_constants: Set of core constants
+
+ Returns:
+ air temperature, [C], canopy temperature, [C], vapour pressure [kPa], vapour
+ pressure deficit, [kPa]
+ """
+
+ output = {}
+
+ # Select variables for current time step and relevant layers
+ topsoil_temperature = data["soil_temperature"][layer_structure.index_topsoil_scalar]
+ topsoil_moisture = (
+ data["soil_moisture"][layer_structure.index_topsoil_scalar]
+ / -data["layer_heights"][layer_structure.index_topsoil_scalar]
+ / core_constants.meters_to_mm
+ )
+ air_temperature_ref = data["air_temperature_ref"].isel(time_index=time_index)
+ vapour_pressure_ref = data["vapour_pressure_ref"].isel(time_index=time_index)
+ atmospheric_pressure_ref = data["atmospheric_pressure_ref"].isel(
+ time_index=time_index
+ )
+
+ # Calculate vapour pressures
+ soil_saturated_vapour_pressure = calculate_saturation_vapour_pressure(
+ temperature=topsoil_temperature,
+ saturation_vapour_pressure_factors=(
+ abiotic_simple_constants.saturation_vapour_pressure_factors
+ ),
+ )
+ soil_vapour_pressure = topsoil_moisture * soil_saturated_vapour_pressure
+ saturated_vapour_pressure_ref = calculate_saturation_vapour_pressure(
+ temperature=air_temperature_ref,
+ saturation_vapour_pressure_factors=(
+ abiotic_simple_constants.saturation_vapour_pressure_factors
+ ),
+ )
+
+ # Calculate current conductivities for atmosphere and soil
+ current_conductivities = calculate_current_conductivities(
+ data=data,
+ characteristic_dimension_leaf=core_constants.characteristic_dimension_leaf,
+ von_karmans_constant=core_constants.von_karmans_constant,
+ abiotic_constants=abiotic_constants,
+ )
+
+ conductivity_from_soil = (
+ topsoil_moisture * soil_saturated_vapour_pressure
+ ).to_numpy()
+
+ # Factors from leaf and air temperature linearisation
+ a_A, b_A = leaf_and_air_temperature_linearisation(
+ conductivity_from_ref_height=(
+ current_conductivities["conductivity_from_ref_height"][
+ layer_structure.index_filled_canopy
+ ]
+ ),
+ conductivity_from_soil=conductivity_from_soil,
+ leaf_air_heat_conductivity=(
+ current_conductivities["leaf_air_heat_conductivity"][
+ layer_structure.index_filled_canopy
+ ]
+ ),
+ air_temperature_ref=air_temperature_ref.to_numpy(),
+ top_soil_temperature=topsoil_temperature.to_numpy(),
+ )
+
+ # Factors from longwave radiative flux linearisation
+ a_R, b_R = longwave_radiation_flux_linearisation(
+ a_A=a_A,
+ b_A=b_A,
+ air_temperature_ref=air_temperature_ref.to_numpy(),
+ leaf_emissivity=abiotic_constants.leaf_emissivity,
+ stefan_boltzmann_constant=core_constants.stefan_boltzmann_constant,
+ )
+
+ # Factors from vapour pressure linearisation
+ delta_v_ref = calculate_slope_of_saturated_pressure_curve(
+ air_temperature_ref.to_numpy(),
+ saturated_pressure_slope_parameters=(
+ abiotic_constants.saturated_pressure_slope_parameters
+ ),
+ )
+
+ a_E, b_E = vapour_pressure_linearisation(
+ vapour_pressure_ref=vapour_pressure_ref.to_numpy(),
+ saturated_vapour_pressure_ref=saturated_vapour_pressure_ref.to_numpy(),
+ soil_vapour_pressure=soil_vapour_pressure.to_numpy(),
+ conductivity_from_soil=conductivity_from_soil,
+ leaf_vapour_conductivity=(
+ current_conductivities["leaf_vapour_conductivity"][
+ layer_structure.index_filled_canopy
+ ]
+ ),
+ conductivity_from_ref_height=(
+ current_conductivities["conductivity_from_ref_height"][
+ layer_structure.index_filled_canopy
+ ]
+ ),
+ delta_v_ref=delta_v_ref,
+ )
+
+ # Factors from latent heat flux linearisation
+ a_L, b_L = latent_heat_flux_linearisation(
+ latent_heat_vapourisation=(
+ data["latent_heat_vapourisation"][
+ layer_structure.index_filled_canopy
+ ].to_numpy()
+ ),
+ leaf_vapour_conductivity=(
+ current_conductivities["leaf_vapour_conductivity"][
+ layer_structure.index_filled_canopy
+ ]
+ ),
+ atmospheric_pressure_ref=atmospheric_pressure_ref.to_numpy(),
+ saturated_vapour_pressure_ref=saturated_vapour_pressure_ref.to_numpy(),
+ a_E=a_E,
+ b_E=b_E,
+ delta_v_ref=delta_v_ref,
+ )
+
+ # Factor from sensible heat flux linearisation
+ b_H = (
+ current_conductivities["leaf_air_heat_conductivity"][
+ layer_structure.index_filled_canopy
+ ]
+ * data["specific_heat_air"][layer_structure.index_filled_canopy].to_numpy()
+ )
+
+ # Calculate new leaf and air temperature
+ delta_canopy_temperature = calculate_delta_canopy_temperature(
+ absorbed_radiation=data["absorbed_radiation"][
+ layer_structure.index_filled_canopy
+ ].to_numpy(),
+ a_R=a_R,
+ a_L=a_L,
+ b_R=b_R,
+ b_L=b_L,
+ b_H=b_H,
+ )
+ new_air_temperature = a_A + b_A * delta_canopy_temperature
+ new_canopy_temperature = (
+ (data["air_temperature"][layer_structure.index_filled_canopy]).to_numpy()
+ + delta_canopy_temperature
+ )
+
+ # Interpolate temperature below canopy
+
+ # TODO - This only uses the index of the _last_ filled layer, which works with the
+ # current test where the canopy layers are consistent across cells, but will
+ # break with uneven canopy layers.
+
+ target_heights = data["layer_heights"][layer_structure.index_surface].to_numpy()
+
+ below_canopy_temperature = interpolate_along_heights(
+ start_height=np.repeat(0.0, data.grid.n_cells),
+ end_height=data["layer_heights"][
+ layer_structure.n_canopy_layers_filled
+ ].to_numpy(),
+ target_heights=target_heights,
+ start_value=topsoil_temperature.to_numpy(),
+ end_value=new_air_temperature[-1],
+ )
+
+ # Create arrays and return for data object
+ new_temperature_profile = layer_structure.from_template()
+ new_temperature_profile[layer_structure.index_filled_atmosphere] = np.vstack(
+ [
+ air_temperature_ref.to_numpy(),
+ new_air_temperature,
+ below_canopy_temperature,
+ ]
+ )
+ output["air_temperature"] = new_temperature_profile
+
+ canopy_temperature = layer_structure.from_template()
+ canopy_temperature[layer_structure.index_filled_canopy] = new_canopy_temperature
+ output["canopy_temperature"] = canopy_temperature
+
+ # Calculate vapour pressure
+ vapour_pressure_mean = a_E + b_E * delta_canopy_temperature
+ vapour_pressure_new = vapour_pressure_ref.to_numpy() + 2 * (
+ vapour_pressure_mean - vapour_pressure_ref.to_numpy()
+ )
+
+ saturation_vapour_pressure_new = calculate_saturation_vapour_pressure(
+ DataArray(new_temperature_profile),
+ saturation_vapour_pressure_factors=(
+ abiotic_simple_constants.saturation_vapour_pressure_factors
+ ),
+ )
+ saturation_vapour_pressure_new_canopy = (
+ saturation_vapour_pressure_new[layer_structure.index_filled_canopy]
+ ).to_numpy()
+
+ canopy_vapour_pressure = np.where(
+ vapour_pressure_new > saturation_vapour_pressure_new_canopy,
+ saturation_vapour_pressure_new_canopy,
+ vapour_pressure_new,
+ )
+ below_canopy_vapour_pressure = interpolate_along_heights(
+ start_height=np.repeat(0.0, data.grid.n_cells),
+ end_height=data["layer_heights"][
+ layer_structure.n_canopy_layers_filled
+ ].to_numpy(),
+ target_heights=target_heights,
+ start_value=soil_vapour_pressure.to_numpy(),
+ end_value=canopy_vapour_pressure[-1],
+ )
+ output["vapour_pressure"] = DataArray(
+ np.vstack(
+ [
+ vapour_pressure_ref.to_numpy(),
+ canopy_vapour_pressure,
+ np.full((7, data.grid.n_cells), np.nan),
+ below_canopy_vapour_pressure,
+ np.full((2, data.grid.n_cells), np.nan),
+ ]
+ ),
+ dims=["layers", "cell_id"],
+ )
+
+ output["vapour_pressure_deficit"] = output["vapour_pressure"] / DataArray(
+ saturation_vapour_pressure_new, dims=["layers", "cell_id"]
+ )
+
+ # Return current conductivities as DataArrays
+ for var in [
+ "conductivity_from_ref_height",
+ "leaf_air_heat_conductivity",
+ "leaf_vapour_conductivity",
+ ]:
+ output[var] = DataArray(
+ current_conductivities[var],
+ dims=data["air_temperature"].dims,
+ coords=data["air_temperature"].coords,
+ name=var,
+ )
+
+ # Return latent and sensible heat flux from canopy
+ sensible_heat_flux = data["sensible_heat_flux"].copy()
+ sensible_heat_flux_canopy = b_H * delta_canopy_temperature
+ sensible_heat_flux[layer_structure.index_topsoil] = data["sensible_heat_flux_soil"]
+ sensible_heat_flux[layer_structure.index_filled_canopy] = sensible_heat_flux_canopy
+ output["sensible_heat_flux"] = sensible_heat_flux
+
+ latent_heat_flux = data["latent_heat_flux"].copy()
+ latent_heat_flux_canopy = a_L + b_L * delta_canopy_temperature
+ latent_heat_flux[layer_structure.index_topsoil] = data["latent_heat_flux_soil"]
+ latent_heat_flux[layer_structure.index_filled_canopy] = latent_heat_flux_canopy
+ output["latent_heat_flux"] = latent_heat_flux
+
+ return output
+
+
+def leaf_and_air_temperature_linearisation(
+ conductivity_from_ref_height: NDArray[np.float32],
+ conductivity_from_soil: NDArray[np.float32],
+ leaf_air_heat_conductivity: NDArray[np.float32],
+ air_temperature_ref: NDArray[np.float32],
+ top_soil_temperature: NDArray[np.float32],
+) -> tuple[NDArray[np.float32], NDArray[np.float32]]:
+ """Calculate factors for leaf and air temperature linearisation.
+
+ Args:
+ conductivity_from_ref_height: Conductivity from reference height, [mol m-2 s-1]
+ conductivity_from_soil: Conductivity from soil, [mol m-2 s-1]
+ leaf_air_heat_conductivity: Leaf air heat conductivity, [mol m-2 s-1]
+ air_temperature_ref: Air temperature at reference height 2m above the canopy,[C]
+ top_soil_temperature: Top soil temperature, [C]
+
+ Returns:
+ Factors a_A and b_A for leaf and air temperature linearisation
+ """
+
+ a_A = (
+ (conductivity_from_ref_height * air_temperature_ref)
+ + (conductivity_from_soil * top_soil_temperature)
+ ) / (conductivity_from_ref_height + conductivity_from_soil)
+
+ b_A = leaf_air_heat_conductivity / (
+ conductivity_from_ref_height + conductivity_from_soil
+ )
+ return a_A, b_A
+
+
+def longwave_radiation_flux_linearisation(
+ a_A: NDArray[np.float32],
+ b_A: NDArray[np.float32],
+ air_temperature_ref: NDArray[np.float32],
+ leaf_emissivity: float,
+ stefan_boltzmann_constant: float,
+) -> tuple[NDArray[np.float32], NDArray[np.float32]]:
+ """Calculate factors for longwave radiative flux linearisation.
+
+ Args:
+ a_A: Factor for leaf and air temperature linearisation
+ b_A: Factor for leaf and air temperature linearisation
+ air_temperature_ref: Air temperature at reference height 2m above the canopy,[C]
+ leaf_emissivity: Leaf emissivity, dimensionless
+ stefan_boltzmann_constant: Stefan Boltzmann constant, [W m-2 K-4]
+
+ Returns:
+ Factors a_R and b_R for longwave radiative flux linearisation
+ """
+
+ a_R = leaf_emissivity * stefan_boltzmann_constant * a_A**4
+
+ b_R = (
+ 4
+ * leaf_emissivity
+ * stefan_boltzmann_constant
+ * (a_A**3 * b_A + air_temperature_ref**3)
+ )
+ return a_R, b_R
+
+
+def vapour_pressure_linearisation(
+ vapour_pressure_ref: NDArray[np.float32],
+ saturated_vapour_pressure_ref: NDArray[np.float32],
+ soil_vapour_pressure: NDArray[np.float32],
+ conductivity_from_soil: NDArray[np.float32],
+ leaf_vapour_conductivity: NDArray[np.float32],
+ conductivity_from_ref_height: NDArray[np.float32],
+ delta_v_ref: NDArray[np.float32],
+) -> tuple[NDArray[np.float32], NDArray[np.float32]]:
+ """Calculate factors for vapour pressure linearisation.
+
+ Args:
+ vapour_pressure_ref: Vapour pressure at reference height 2 m above canopy, [kPa]
+ saturated_vapour_pressure_ref: Saturated vapour pressure at reference height 2 m
+ above canopy, [kPa]
+ soil_vapour_pressure: Soil vapour pressure, [kPa]
+ conductivity_from_soil: Conductivity from soil, [mol m-2 s-1]
+ leaf_vapour_conductivity: Leaf vapour conductivity, [mol m-2 s-1]
+ conductivity_from_ref_height: Conductivity frm reference height, [mol m-2 s-1]
+ delta_v_ref: Slope of saturated vapour pressure curve
+
+ Returns:
+ Factors a_E and b_E for vapour pressure linearisation
+ """
+
+ a_E = (
+ conductivity_from_ref_height * vapour_pressure_ref
+ + conductivity_from_soil * soil_vapour_pressure
+ + leaf_vapour_conductivity * saturated_vapour_pressure_ref
+ ) / (
+ conductivity_from_ref_height + conductivity_from_soil + leaf_vapour_conductivity
+ )
+
+ b_E = delta_v_ref / (
+ conductivity_from_ref_height + conductivity_from_soil + leaf_vapour_conductivity
+ )
+ return a_E, b_E
+
+
+def latent_heat_flux_linearisation(
+ latent_heat_vapourisation: NDArray[np.float32],
+ leaf_vapour_conductivity: NDArray[np.float32],
+ atmospheric_pressure_ref: NDArray[np.float32],
+ saturated_vapour_pressure_ref: NDArray[np.float32],
+ a_E: NDArray[np.float32],
+ b_E: NDArray[np.float32],
+ delta_v_ref: NDArray[np.float32],
+) -> tuple[NDArray[np.float32], NDArray[np.float32]]:
+ """Calculate factors for latent heat flux linearisation.
+
+ Args:
+ latent_heat_vapourisation: latent heat of vapourisation
+ leaf_vapour_conductivity: leaf vapour conductivity, [mol m-2 s-1]
+ atmospheric_pressure_ref: Atmospheric pressure at reference height 2 m above
+ canopy, [kPa]
+ saturated_vapour_pressure_ref: Satuated vapour pressure at reference height 2 m
+ above canopy, [kPa]
+ a_E: Factor for vapour pressure linearisation
+ b_E: Factor for vapour pressure linearisation
+ delta_v_ref: Slope of saturated vapour pressure curve
+
+ Returns:
+ Factors a_L and b_L for latent heat flux linearisation
+ """
+
+ a_L = (latent_heat_vapourisation * leaf_vapour_conductivity) / (
+ atmospheric_pressure_ref * (saturated_vapour_pressure_ref - a_E)
+ )
+
+ b_L = (latent_heat_vapourisation * leaf_vapour_conductivity) / (
+ atmospheric_pressure_ref * (delta_v_ref - b_E)
+ )
+
+ return a_L, b_L
+
+
+def calculate_delta_canopy_temperature(
+ absorbed_radiation: NDArray[np.float32],
+ a_R: NDArray[np.float32],
+ a_L: NDArray[np.float32],
+ b_R: NDArray[np.float32],
+ b_L: NDArray[np.float32],
+ b_H: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate change in canopy temperature (delta).
+
+ Args:
+ absorbed_radiation: Radiation (shortwave) absorved by canopy, [W m-2]
+ a_R: Factor for longwave radiation emission linearisation
+ a_L: Factor for latent heat flux linearisation
+ b_R: Factor for longwave radiation emission linearisation
+ b_L: Factor for latent heat flux linearisation
+ b_H: Factor for sensible heat flux linearisation
+
+ Returns:
+ Change in canopy temperature, [C]
+ """
+
+ return (absorbed_radiation - a_R - a_L) / (1 + b_R + b_L + b_H)
diff --git a/virtual_ecosystem/models/abiotic/module_schema.json b/virtual_ecosystem/models/abiotic/module_schema.json
new file mode 100644
index 000000000..209686dd3
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/module_schema.json
@@ -0,0 +1,50 @@
+{
+ "type": "object",
+ "properties": {
+ "abiotic": {
+ "description": "Configuration settings for the abiotic model",
+ "type": "object",
+ "properties": {
+ "constants": {
+ "description": "Constants for the abiotic model",
+ "type": "object",
+ "properties": {
+ "AbioticConsts": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "AbioticConsts"
+ ]
+ },
+ "depends": {
+ "type": "object",
+ "default": {},
+ "properties": {
+ "init": {
+ "type": "array",
+ "default": [
+ "plants"
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "update": {
+ "type": "array",
+ "default": [],
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "default": {},
+ "required": []
+ }
+ },
+ "required": [
+ "abiotic"
+ ]
+}
\ No newline at end of file
diff --git a/virtual_ecosystem/models/abiotic/soil_energy_balance.py b/virtual_ecosystem/models/abiotic/soil_energy_balance.py
new file mode 100644
index 000000000..652b6e557
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/soil_energy_balance.py
@@ -0,0 +1,344 @@
+r"""The ``models.abiotic.soil_energy_balance`` module calculates the soil energy balance
+for the Virtual Ecosystem.
+
+The first part of this module determines the energy balance at the surface.
+:func:`~virtual_ecosystem.models.abiotic.soil_energy_balance.calculate_soil_heat_balance`
+calculates how incoming solar radiation that reaches the surface is partitioned in
+sensible, latent, and ground heat flux. Further, longwave emission is calculated and the
+topsoil temperature is updated.
+
+The second part determines the soil temperature profile at different depths. We
+divide the soil into discrete layers to numerically solve the time-dependent
+differential equation that describes soil temperature as a function of depth
+and time (see TODO THIS FUNCTION for details).
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+from pint import Quantity
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.core.core_components import LayerStructure
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+from virtual_ecosystem.models.abiotic.energy_balance import calculate_longwave_emission
+
+
+def calculate_soil_absorption(
+ shortwave_radiation_surface: NDArray[np.float32],
+ surface_albedo: float | NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate soil absorption of shortwave radiation.
+
+ The amount of shortwave radiation that is absorbed by the topsoil layer is a
+ function of incoming radiation and surface albedo. In reality, surface albedo is
+ modulated by soil moisture. The current implementation of soil absorption assumes a
+ constant albedo within each grid cell because the radiation that reaches the surface
+ below the canopy is typically quite small (<5%).
+
+ Args:
+ shortwave_radiation_surface: Shortwave radiation that reaches surface, [W m-2]
+ surface_albedo: Surface albedo, dimensionless.
+
+ Returns:
+ shortwave radiation absorbed by soil surface, [W m-2]
+ """
+
+ return shortwave_radiation_surface * (1 - surface_albedo)
+
+
+def calculate_sensible_heat_flux_soil(
+ air_temperature_surface: NDArray[np.float32],
+ topsoil_temperature: NDArray[np.float32],
+ molar_density_air: NDArray[np.float32],
+ specific_heat_air: NDArray[np.float32],
+ aerodynamic_resistance: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ r"""Calculate sensible heat flux from soil surface.
+
+ The sensible heat flux from the soil surface is given by:
+
+ :math:`H_{S} = \frac {\rho_{air} C_{air} (T_{S} - T_{b}^{A})}{r_{A}}`
+
+ Where :math:`T_{S}` is the soil surface temperature, :math:`T_{b}^{A}` is the
+ temperature of the bottom air layer and :math:`r_{A}` is the aerodynamic resistance
+ of the soil surface, given by
+
+ :math:`r_{A} = \frac {C_{S}}{u_{b}}`
+
+ Where :math:`u_{b}` is the wind speed in the bottom air layer and :math:`C_{S}` is
+ the soil surface heat transfer coefficient.
+
+ Args:
+ air_temperature_surface: Air temperature near the surface, [K]
+ topsoil_temperature: Topsoil temperature, [K]
+ molar_density_air: Molar density of air, [mol m-3]
+ specific_heat_air: Specific heat of air, [J mol-1 K-1]
+ aerodynamic_resistance: Aerodynamic resistance near the surface
+
+ Returns:
+ Sensible heat flux from topsoil, [W m-2]
+ """
+
+ return (
+ molar_density_air
+ * specific_heat_air
+ * (topsoil_temperature - air_temperature_surface)
+ ) / aerodynamic_resistance
+
+
+def calculate_latent_heat_flux_from_soil_evaporation(
+ soil_evaporation: NDArray[np.float32],
+ latent_heat_vapourisation: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate latent heat flux from soil evaporation.
+
+ We assume that 1 mm of evaporated water is equivalent to 1 kg of water.
+
+ Args:
+ soil_evaporation: Soil evaporation, [mm]
+ latent_heat_vapourisation: Latent heat of vapourisation, [J kg-1]
+
+ Returns:
+ latent heat flux from topsoil, [W m-2]
+ """
+
+ return soil_evaporation * latent_heat_vapourisation
+
+
+def calculate_ground_heat_flux(
+ soil_absorbed_radiation: NDArray[np.float32],
+ topsoil_longwave_emission: NDArray[np.float32],
+ topsoil_sensible_heat_flux: NDArray[np.float32],
+ topsoil_latent_heat_flux: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate ground heat flux.
+
+ The ground heat flux is calculated as the residual of splitting incoming raditaion
+ into emitted longwave radiation, and sensible and latent heat flux. A positive
+ ground heat flux means a warming of the soil, a negative flux indicates a cooling of
+ the soil.
+
+ Args:
+ soil_absorbed_radiation: Shortwave radiation absorbed by topsoil, [W m-2]
+ topsoil_longwave_emission: Longwave radiation emitted by topsoil, [W m-2]
+ topsoil_sensible_heat_flux: Sensible heat flux from topsoil, [W m-2]
+ topsoil_latent_heat_flux: Latent heat flux from topsoil, [W m-2]
+
+ Returns:
+ ground heat flux, [W m-2]
+ """
+
+ return (
+ soil_absorbed_radiation
+ - topsoil_longwave_emission
+ - topsoil_sensible_heat_flux
+ - topsoil_latent_heat_flux
+ )
+
+
+def update_surface_temperature(
+ topsoil_temperature: NDArray[np.float32],
+ surface_net_radiation: NDArray[np.float32],
+ surface_layer_depth: float | NDArray[np.float32],
+ grid_cell_area: float,
+ update_interval: Quantity,
+ specific_heat_capacity_soil: float | NDArray[np.float32],
+ volume_to_weight_conversion: float | NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Update surface temperature after exchange of radiation.
+
+ This function calculates the surface temperature after absorption of
+ shortwave radiation, emission of longwave radiation, and surface fluxes. This
+ process usually happens in the top few centimeters of the soil column, which is much
+ less than the thickness of the upper soil layer of the current layer implementation.
+ In the simulation flow, we therefore set the topsoil layer depth to 0.05, TODO merge
+ this into temperature profile.
+
+ Args:
+ topsoil_temperature: Topsoil temperature
+ surface_net_radiation: Longwave or shortwave radiation that enters
+ (positive) or leaves (negative) the topsoil, [W m-2]
+ surface_layer_depth: Topsoil layer depth, [m]
+ grid_cell_area: Grid cell area, [m2]
+ update_interval: Update interval to convert between W and J, [s]
+ specific_heat_capacity_soil: Soil specific heat capacity, [J kg-1 K-1]
+ volume_to_weight_conversion: Factor to convert between soil volume and weight in
+ kilograms
+
+ Returns:
+ topsoil temperature, [C]
+ """
+ # Calculate the mass of the soil that is absorbing the radiation
+ topsoil_mass = surface_layer_depth * grid_cell_area * volume_to_weight_conversion
+
+ # Convert radiation to energy stored in soil in Kelvin
+ temperature_change = (surface_net_radiation * update_interval) / (
+ topsoil_mass * specific_heat_capacity_soil
+ )
+
+ # Add temperature change to current top soil temperature
+ return topsoil_temperature + temperature_change
+
+
+def calculate_soil_heat_balance(
+ data: Data,
+ time_index: int,
+ layer_structure: LayerStructure,
+ update_interval: Quantity,
+ abiotic_consts: AbioticConsts,
+ core_consts: CoreConsts,
+) -> dict[str, NDArray[np.float32]]:
+ """Calculate soil heat balance.
+
+ This function performs a series of calculations to solve the energy balance at the
+ surface at the interface between soil and atmoshere:
+
+ * calculate soil absorption (:math:`R_{N{} * (1-albedo)`)
+ * calculate sensible heat flux (convective flux from soil to atmosphere above)
+ * calculate latent heat flux (conversion of soil evaporation)
+ * calculate ground heat flux (conductive flux)
+ * update topsoil temperature
+
+ The function takes an instance of data object, AbioticConsts and CoreConsts which
+ must provide the following inputs:
+
+ * soil_temperature: Soil temperature, [C]
+ * air_temperature: Air temperature, [C]
+ * topofcanopy_radiation: Shortwave radiation that reaches canopy, [W m-2]
+ * soil_evaporation: Soil evaporation, [mm]
+ * soil_emissivity: Soil emissivity, dimensionless
+ * surface_albedo: Surface albedo, dimensionless
+ * molar_density_air: Molar density of air, [mol m-3]
+ * specific_heat_air: Specific heat of air, [J mol-1 K-1]
+ * aerodynamic_resistance_surface: Aerodynamic resistance near the surface
+ * stefan_boltzmann: Stefan Boltzmann constant, [W m-2 K-4]
+ * latent_heat_vapourisation: Latent heat of vapourisation, [kJ kg-1]
+ * surface_layer_depth: Topsoil layer depth, [m]
+ * grid_cell_area: Grid cell area, [m2]
+ * specific_heat_capacity_soil: Soil specific heat capacity, [J kg-1 K-1]
+ * volume_to_weight_conversion: Factor to convert between soil volume and weight [kg]
+
+ Args:
+ data: The core data object
+ time_index: time index
+ update_interval: Update interval, [s]
+ layer_structure: The LayerStructure instance for the simulation.
+ abiotic_consts: set of constants specific to abiotic model
+ core_consts: set of constants that are shared across the model
+
+ Returns:
+ A dictionary with soil shortwave absorption, soil longwave emission, sensible
+ and latent heat flux from the soil, ground heat flux, and updated topsoil
+ temperature
+ """
+
+ topsoil_layer_index = layer_structure.index_topsoil
+ surface_layer_index = layer_structure.index_surface
+
+ output = {}
+
+ # Calculate soil absorption of shortwave radiation, [W m-2]
+ shortwave_radiation_surface = data["topofcanopy_radiation"].isel(
+ time_index=time_index
+ ) - (data["canopy_absorption"].sum(dim="layers"))
+ soil_absorption = calculate_soil_absorption(
+ shortwave_radiation_surface=shortwave_radiation_surface.to_numpy(),
+ surface_albedo=abiotic_consts.surface_albedo,
+ )
+ output["soil_absorption"] = soil_absorption
+ output["shortwave_radiation_surface"] = shortwave_radiation_surface.to_numpy()
+
+ # Calculate longwave emission from topsoil, [W m-2]; note that this is the soil
+ # temperature of the previous time step
+ # VIVI - all of the subsets extract a 2D (1, n_cells) array, and they are intended
+ # to end up as a 1D (n_cells) array in the data, so I'm using squeeze() to simplify
+ # them to 1D. Could use [0] - it's shorter and maybe more efficient, but it's less
+ # obvious?
+ longwave_emission_soil = calculate_longwave_emission(
+ temperature=data["soil_temperature"][topsoil_layer_index].to_numpy().squeeze(),
+ emissivity=abiotic_consts.soil_emissivity,
+ stefan_boltzmann=core_consts.stefan_boltzmann_constant,
+ )
+ output["longwave_emission_soil"] = longwave_emission_soil
+
+ # Calculate sensible heat flux from soil to lowest atmosphere layer, [W m-2]
+ sensible_heat_flux_soil = calculate_sensible_heat_flux_soil(
+ air_temperature_surface=data["air_temperature"][surface_layer_index]
+ .to_numpy()
+ .squeeze(),
+ topsoil_temperature=data["soil_temperature"][topsoil_layer_index]
+ .to_numpy()
+ .squeeze(),
+ molar_density_air=data["molar_density_air"][surface_layer_index]
+ .to_numpy()
+ .squeeze(),
+ specific_heat_air=data["specific_heat_air"][surface_layer_index]
+ .to_numpy()
+ .squeeze(),
+ aerodynamic_resistance=data["aerodynamic_resistance_surface"].to_numpy(),
+ )
+ output["sensible_heat_flux_soil"] = sensible_heat_flux_soil
+
+ # Convert soil evaporation to latent heat flux to lowest atmosphere layer, [W m-2]
+ latent_heat_flux_soil = calculate_latent_heat_flux_from_soil_evaporation(
+ soil_evaporation=data["soil_evaporation"].to_numpy(),
+ latent_heat_vapourisation=(
+ data["latent_heat_vapourisation"][surface_layer_index].to_numpy().squeeze()
+ ),
+ )
+ output["latent_heat_flux_soil"] = latent_heat_flux_soil
+
+ # Determine ground heat flux as the difference as
+ # incoming radiation - sensible and latent heat flux - longwave emission
+ ground_heat_flux = calculate_ground_heat_flux(
+ soil_absorbed_radiation=soil_absorption,
+ topsoil_longwave_emission=longwave_emission_soil,
+ topsoil_sensible_heat_flux=sensible_heat_flux_soil,
+ topsoil_latent_heat_flux=latent_heat_flux_soil,
+ )
+ output["ground_heat_flux"] = ground_heat_flux
+
+ # Calculate net surface radiation, [W m-2]
+ surface_net_radiation = (
+ data["shortwave_radiation_surface"].to_numpy()
+ - longwave_emission_soil
+ - sensible_heat_flux_soil
+ - latent_heat_flux_soil
+ - ground_heat_flux
+ )
+
+ # Update surface temperature, [C]
+ new_surface_temperature = update_surface_temperature(
+ topsoil_temperature=data["soil_temperature"][topsoil_layer_index]
+ .to_numpy()
+ .squeeze(),
+ surface_net_radiation=surface_net_radiation,
+ surface_layer_depth=abiotic_consts.surface_layer_depth,
+ grid_cell_area=data.grid.cell_area,
+ update_interval=update_interval,
+ specific_heat_capacity_soil=abiotic_consts.specific_heat_capacity_soil,
+ volume_to_weight_conversion=abiotic_consts.volume_to_weight_conversion,
+ )
+ output["new_surface_temperature"] = new_surface_temperature
+
+ return output
+
+
+# def calculate_soil_temnperature_profile():
+# r"""
+# Each layer
+# is assigned a node, :math:`i`, at depth, :math:`z_{i}`, and with heat storage,
+# :math:`C_{h_{i}}`, and nodes are numbered sequentially downward such that node
+# :math:`i+1` represents the node for the soil layer immediately below. Conductivity,
+# :math:`k_{i}`, represents conductivity between nodes :math:`i` and :math:`i+1`.
+# The energy balance equation for node :math:`i` is then given by
+
+# .. math::
+# \kappa_{i}(T_{i+1} - T_{i})- \kappa_{i-1}(T_{i} - T_{i-1})
+# = \frac{C_{h_{i}}(T_{i}^{j+1} - T_{i}^{j})(z_{i+1} - z_{i-1})}{2 \Delta t}
+
+# where :math:`\Delta t` is the time increment, conductance,
+# :math:`\kappa_{i}=k_{i}/(z_{i+1} - z_{i})`, and superscript :math:`j` indicates
+# the time at which temperature is determined. This equation can be re-arranged and
+# solved for :math:`T_{j+1}` by Gaussian elimination using the Thomas algorithm."""
diff --git a/virtual_ecosystem/models/abiotic/wind.py b/virtual_ecosystem/models/abiotic/wind.py
new file mode 100644
index 000000000..30a853a83
--- /dev/null
+++ b/virtual_ecosystem/models/abiotic/wind.py
@@ -0,0 +1,812 @@
+r"""The wind module calculates the above- and within-canopy wind profile for the
+Virtual Ecosystem. The wind profile determines the exchange of heat, water, and
+:math:`CO_{2}` between soil and atmosphere below the canopy as well as the exchange with
+the atmosphere above the canopy.
+
+TODO replace leaf area index by plant area index when we have more info about vertical
+distribution of leaf and woody parts
+TODO change temperatures to Kelvin
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.models.abiotic.abiotic_tools import (
+ calculate_molar_density_air,
+ calculate_specific_heat_air,
+ find_last_valid_row,
+)
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+
+
+def calculate_zero_plane_displacement(
+ canopy_height: NDArray[np.float32],
+ leaf_area_index: NDArray[np.float32],
+ zero_plane_scaling_parameter: float,
+) -> NDArray[np.float32]:
+ """Calculate zero plane displacement height, [m].
+
+ The zero plane displacement height is a concept used in micrometeorology to describe
+ the flow of air near the ground or over surfaces like a forest canopy or crops. It
+ represents the height above the actual ground where the wind speed is theoretically
+ reduced to zero due to the obstruction caused by the roughness elements (like trees
+ or buildings). Implementation after :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ canopy_height: Canopy height, [m]
+ leaf_area_index: Total leaf area index, [m m-1]
+ zero_plane_scaling_parameter: Control parameter for scaling d/h, dimensionless
+ :cite:p:`raupach_simplified_1994`
+
+ Returns:
+ Zero plane displacement height, [m]
+ """
+
+ # Select grid cells where vegetation is present
+ displacement = np.where(leaf_area_index > 0, leaf_area_index, np.nan)
+
+ # Calculate zero displacement height
+ scale_displacement = np.sqrt(zero_plane_scaling_parameter * displacement)
+ zero_plane_displacement = (
+ (1 - (1 - np.exp(-scale_displacement)) / scale_displacement) * canopy_height,
+ )
+
+ # No displacement in absence of vegetation
+ return np.nan_to_num(zero_plane_displacement, nan=0.0).squeeze()
+
+
+def calculate_roughness_length_momentum(
+ canopy_height: NDArray[np.float32],
+ leaf_area_index: NDArray[np.float32],
+ zero_plane_displacement: NDArray[np.float32],
+ substrate_surface_drag_coefficient: float,
+ roughness_element_drag_coefficient: float,
+ roughness_sublayer_depth_parameter: float,
+ max_ratio_wind_to_friction_velocity: float,
+ min_roughness_length: float,
+ von_karman_constant: float,
+) -> NDArray[np.float32]:
+ """Calculate roughness length governing momentum transfer, [m].
+
+ Roughness length is defined as the height at which the mean velocity is zero due to
+ substrate roughness. Real surfaces such as the ground or vegetation are not smooth
+ and often have varying degrees of roughness. Roughness length accounts for that
+ effect. Implementation after :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ canopy_height: Canopy height, [m]
+ leaf_area_index: Total leaf area index, [m m-1]
+ zero_plane_displacement: Height above ground within the canopy where the wind
+ profile extrapolates to zero, [m]
+ substrate_surface_drag_coefficient: Substrate-surface drag coefficient,
+ dimensionless
+ roughness_element_drag_coefficient: Roughness-element drag coefficient
+ roughness_sublayer_depth_parameter: Parameter that characterizes the roughness
+ sublayer depth, dimensionless
+ max_ratio_wind_to_friction_velocity: Maximum ratio of wind velocity to friction
+ velocity, dimensionless
+ min_roughness_length: Minimum roughness length, [m]
+ von_karman_constant: Von Karman's constant, dimensionless constant describing
+ the logarithmic velocity profile of a turbulent fluid near a no-slip
+ boundary.
+
+ Returns:
+ Momentum roughness length, [m]
+ """
+
+ # Calculate ratio of wind velocity to friction velocity
+ ratio_wind_to_friction_velocity = np.sqrt(
+ substrate_surface_drag_coefficient
+ + (roughness_element_drag_coefficient * leaf_area_index) / 2
+ )
+
+ # If the ratio of wind velocity to friction velocity is larger than the set maximum,
+ # set the value to set maximum
+ set_maximum_ratio = np.where(
+ ratio_wind_to_friction_velocity > max_ratio_wind_to_friction_velocity,
+ max_ratio_wind_to_friction_velocity,
+ ratio_wind_to_friction_velocity,
+ )
+
+ # Calculate initial roughness length
+ initial_roughness_length = (canopy_height - zero_plane_displacement) * np.exp(
+ -von_karman_constant * (1 / set_maximum_ratio)
+ - roughness_sublayer_depth_parameter
+ )
+
+ # If roughness smaller than the substrate surface drag coefficient, set to value to
+ # the substrate surface drag coefficient
+ roughness_length = np.where(
+ initial_roughness_length < substrate_surface_drag_coefficient,
+ substrate_surface_drag_coefficient,
+ initial_roughness_length,
+ )
+
+ # If roughness length in nan, zero or below sero, set to minimum value
+ roughness_length = np.nan_to_num(roughness_length, nan=min_roughness_length)
+ return np.where(roughness_length <= 0, min_roughness_length, roughness_length)
+
+
+def calculate_diabatic_correction_above(
+ molar_density_air: float | NDArray[np.float32],
+ specific_heat_air: float | NDArray[np.float32],
+ temperature: NDArray[np.float32],
+ sensible_heat_flux: NDArray[np.float32],
+ friction_velocity: NDArray[np.float32],
+ wind_heights: NDArray[np.float32],
+ zero_plane_displacement: NDArray[np.float32],
+ celsius_to_kelvin: float,
+ von_karmans_constant: float,
+ yasuda_stability_parameters: list[float],
+ diabatic_heat_momentum_ratio: float,
+) -> dict[str, NDArray[np.float32]]:
+ r"""Calculate the diabatic correction factors for momentum and heat above canopy.
+
+ Diabatic correction factors for heat and momentum are used to adjust wind profiles
+ for surface heating and cooling :cite:p:`maclean_microclimc_2021`. When the surface
+ is strongly heated, the diabatic correction factor for momentum :math:`\Psi_{M}`
+ becomes negative and drops to values of around -1.5. In contrast, when the surface
+ is much cooler than the air above it, it increases to values around 4.
+
+ Args:
+ molar_density_air: Molar density of air above canopy, [mol m-3]
+ specific_heat_air: Specific heat of air above canopy, [J mol-1 K-1]
+ temperature: 2 m temperature above canopy, [C]
+ sensible_heat_flux: Sensible heat flux from canopy to atmosphere above, [W m-2]
+ friction_velocity: Friction velocity above canopy, [m s-1]
+ wind_heights: Height for which wind speed is calculated, [m]
+ zero_plane_displacement: Height above ground within the canopy where the wind
+ profile extrapolates to zero, [m]
+ celsius_to_kelvin: Factor to convert temperature in Celsius to absolute
+ temperature in Kelvin
+ von_karmans_constant: Von Karman's constant, dimensionless constant describing
+ the logarithmic velocity profile of a turbulent fluid near a no-slip
+ boundary.
+ yasuda_stability_parameters: Parameters to approximate diabatic correction
+ factors for heat and momentum after :cite:t:`yasuda_turbulent_1988`
+ diabatic_heat_momentum_ratio: Factor that relates diabatic correction
+ factors for heat and momentum after :cite:t:`yasuda_turbulent_1988`
+
+ Returns:
+ Diabatic correction factors for heat :math:`\Psi_{H}` and momentum
+ :math:`\Psi_{M}` transfer
+ """
+
+ # Calculate atmospheric stability
+ stability = (
+ von_karmans_constant
+ * (wind_heights - zero_plane_displacement)
+ * sensible_heat_flux
+ ) / (
+ molar_density_air
+ * specific_heat_air
+ * (temperature + celsius_to_kelvin)
+ * friction_velocity
+ )
+
+ stable_condition = yasuda_stability_parameters[0] * np.log(1 - stability)
+ unstable_condition = -yasuda_stability_parameters[1] * np.log(
+ (1 + np.sqrt(1 - yasuda_stability_parameters[2] * stability)) / 2
+ )
+
+ # Calculate diabatic correction factors for stable and unstable conditions
+ diabatic_correction_heat = np.where(
+ sensible_heat_flux < 0, stable_condition, unstable_condition
+ )
+
+ diabatic_correction_momentum = np.where(
+ sensible_heat_flux < 0,
+ diabatic_correction_heat,
+ diabatic_heat_momentum_ratio * diabatic_correction_heat,
+ )
+
+ return {"psi_m": diabatic_correction_momentum, "psi_h": diabatic_correction_heat}
+
+
+def calculate_diabatic_correction_canopy(
+ air_temperature: NDArray[np.float32],
+ wind_speed: NDArray[np.float32],
+ layer_heights: NDArray[np.float32],
+ mean_mixing_length: NDArray[np.float32],
+ stable_temperature_gradient_intercept: float,
+ stable_wind_shear_slope: float,
+ yasuda_stability_parameters: list[float],
+ richardson_bounds: list[float],
+ gravity: float,
+ celsius_to_kelvin: float,
+) -> dict[str, NDArray[np.float32]]:
+ r"""Calculate diabatic correction factors for momentum and heat in canopy.
+
+ This function calculates the diabatic correction factors for heat and momentum used
+ in adjustment of wind profiles and calculation of turbulent conductivity within the
+ canopy. Momentum and heat correction factors should be greater than or equal to 1
+ under stable conditions and smaller than 1 under unstable conditions. From
+ :cite:t:`goudriaan_crop_1977` it is assumed that :math:`\Phi_{H}` remains
+ relatively constant within the canopy. Thus, the function returns a mean value for
+ the whole canopy and below. Implementation after :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ air_temperature: Air temperature, [C]
+ wind_speed: Wind speed, [m s-1]
+ layer_heights: Layer heights, [m]
+ mean_mixing_length: Mean mixing length, [m]
+ stable_temperature_gradient_intercept: Temperature gradient intercept under
+ stable athmospheric conditions after :cite:t:`goudriaan_crop_1977`.
+ stable_wind_shear_slope: Wind shear slope under stable atmospheric conditions
+ after :cite:t:`goudriaan_crop_1977`.
+ richardson_bounds: Minimum and maximum value for Richardson number
+ yasuda_stability_parameters: Parameters to approximate diabatic correction
+ factors for heat and momentum after :cite:t:`yasuda_turbulent_1988`
+ gravity: Newtonian constant of gravitation, [m s-1]
+ celsius_to_kelvin: Factor to convert between Celsius and Kelvin
+
+ Returns:
+ diabatic correction factor for momentum :math:`\Phi_{M}` and heat
+ :math:`\Phi_{H}` transfer
+ """
+
+ # Calculate differences between consecutive elements along the vertical axis
+ temperature_differences = np.diff(air_temperature, axis=0)
+ height_differences = np.diff(layer_heights, axis=0)
+ temperature_gradient = temperature_differences / height_differences
+
+ # Calculate mean temperature in Kelvin
+ mean_temperature_kelvin = np.mean(air_temperature, axis=0) + celsius_to_kelvin
+ mean_wind_speed = np.mean(wind_speed, axis=0)
+
+ # Calculate Richardson number
+ richardson_number = (
+ (gravity / mean_temperature_kelvin)
+ * temperature_gradient
+ * (mean_mixing_length / mean_wind_speed) ** 2
+ )
+ richardson_number[richardson_number > richardson_bounds[0]] = richardson_bounds[0]
+ richardson_number[richardson_number <= richardson_bounds[1]] = richardson_bounds[1]
+
+ # Calculate stability term
+ stability_factor = (
+ 4
+ * stable_wind_shear_slope
+ * (1 - stable_temperature_gradient_intercept)
+ / (stable_temperature_gradient_intercept) ** 2
+ )
+ stability_term = (
+ stable_temperature_gradient_intercept
+ * (1 + stability_factor * richardson_number) ** 0.5
+ + 2 * stable_wind_shear_slope * richardson_number
+ - stable_temperature_gradient_intercept
+ ) / (
+ 2 * stable_wind_shear_slope * (1 - stable_wind_shear_slope * richardson_number)
+ )
+ sel = np.where(temperature_gradient <= 0) # Unstable conditions
+ stability_term[sel] = richardson_number[sel]
+
+ # Initialize phi_m and phi_h with values for stable conditions
+ phi_m = 1 + (yasuda_stability_parameters[0] * stability_term) / (1 + stability_term)
+ phi_h = phi_m.copy()
+
+ # Adjust for unstable conditions
+ phi_m[sel] = 1 / (1 - yasuda_stability_parameters[2] * stability_term[sel]) ** 0.25
+ phi_h[sel] = phi_m[sel] ** 2
+
+ # Calculate mean values across the vertical axis for phi_m and phi_h
+ phi_m_mean = np.mean(phi_m, axis=0)
+ phi_h_mean = np.mean(phi_h, axis=0)
+
+ return {"phi_m": phi_m_mean, "phi_h": phi_h_mean}
+
+
+def calculate_mean_mixing_length(
+ canopy_height: NDArray[np.float32],
+ zero_plane_displacement: NDArray[np.float32],
+ roughness_length_momentum: NDArray[np.float32],
+ mixing_length_factor: float,
+) -> NDArray[np.float32]:
+ """Calculate mixing length for canopy air transport, [m].
+
+ The mean mixing length is used to calculate turbulent air transport inside vegetated
+ canopies. It is made equivalent to the above canopy value at the canopy surface. In
+ absence of vegetation, it is set to zero. Implementation after
+ :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ canopy_height: Canopy height, [m]
+ zero_plane_displacement: Height above ground within the canopy where the wind
+ profile extrapolates to zero, [m]
+ roughness_length_momentum: Momentum roughness length, [m]
+ mixing_length_factor: Factor in calculation of mean mixing length, dimensionless
+
+ Returns:
+ Mixing length for canopy air transport, [m]
+ """
+
+ mean_mixing_length = (
+ mixing_length_factor * (canopy_height - zero_plane_displacement)
+ ) / np.log((canopy_height - zero_plane_displacement) / roughness_length_momentum)
+
+ return np.nan_to_num(mean_mixing_length, nan=0)
+
+
+def generate_relative_turbulence_intensity(
+ layer_heights: NDArray[np.float32],
+ min_relative_turbulence_intensity: float,
+ max_relative_turbulence_intensity: float,
+ increasing_with_height: bool,
+) -> NDArray[np.float32]:
+ """Generate relative turbulence intensity profile, dimensionless.
+
+ At the moment, default values are for a maize crop Shaw et al (1974)
+ Agricultural Meteorology, 13: 419-425. TODO adjust default to environment
+
+ Args:
+ layer_heights: Heights of above ground layers, [m]
+ min_relative_turbulence_intensity: Minimum relative turbulence intensity,
+ dimensionless
+ max_relative_turbulence_intensity: Maximum relative turbulence intensity,
+ dimensionless
+ increasing_with_height: Increasing logical indicating whether turbulence
+ intensity increases (TRUE) or decreases (FALSE) with height
+
+ Returns:
+ Relative turbulence intensity for each node, dimensionless
+ """
+
+ direction = 1 if increasing_with_height else -1
+
+ return (
+ min_relative_turbulence_intensity
+ + direction
+ * (max_relative_turbulence_intensity - min_relative_turbulence_intensity)
+ * layer_heights
+ )
+
+
+def calculate_wind_attenuation_coefficient(
+ canopy_height: NDArray[np.float32],
+ leaf_area_index: NDArray[np.float32],
+ mean_mixing_length: NDArray[np.float32],
+ drag_coefficient: float,
+ relative_turbulence_intensity: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate wind attenuation coefficient, dimensionless.
+
+ The wind attenuation coefficient describes how wind is slowed down by the presence
+ of vegetation. In absence of vegetation, the coefficient is set to zero.
+ Implementation after :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ canopy_height: Canopy height, [m]
+ leaf_area_index: Leaf area index, [m m-1]
+ mean_mixing_length: Mixing length for canopy air transport, [m]
+ drag_coefficient: Drag coefficient, dimensionless
+ relative_turbulence_intensity: Relative turbulence intensity, dimensionless
+
+ Returns:
+ Wind attenuation coefficient, dimensionless
+ """
+
+ # VIVI - this is operating on inputs containing all true aboveground rows. Because
+ # LAI is only defined for the canopy layers, the result of this operation is
+ # undefined for the top and bottom row and so can just be filled in rather than
+ # having to concatenate. We _could_ subset the inputs and then concatenate - those
+ # are more intuitive inputs - but handling those extra layers maintains the same
+ # calculation shape throughout the wind calculation stack.
+ attenuation_coefficient = (drag_coefficient * leaf_area_index * canopy_height) / (
+ 2 * mean_mixing_length * relative_turbulence_intensity
+ )
+
+ # Above the canopy is set to zero and the surface layer is set to the last valid
+ # canopy value
+ attenuation_coefficient[0] = 0
+ attenuation_coefficient[-1] = find_last_valid_row(attenuation_coefficient)
+
+ return attenuation_coefficient
+
+
+def wind_log_profile(
+ height: float | NDArray[np.float32],
+ zeroplane_displacement: float | NDArray[np.float32],
+ roughness_length_momentum: float | NDArray[np.float32],
+ diabatic_correction_momentum: float | NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate logarithmic wind profile.
+
+ Note that this function can return NaN, this is not corrected here because it might
+ cause division by zero later on in the work flow.
+
+ Args:
+ height: Array of heights for which wind speed is calculated, [m]
+ zeroplane_displacement: Height above ground within the canopy where the wind
+ profile extrapolates to zero, [m]
+ roughness_length_momentum: Momentum roughness length, [m]
+ diabatic_correction_momentum: Diabatic correction factor for momentum
+
+ Returns:
+ logarithmic wind profile
+ """
+
+ wind_profile = (
+ np.log((height - zeroplane_displacement) / roughness_length_momentum)
+ + diabatic_correction_momentum,
+ )
+
+ return np.where(wind_profile == 0.0, np.nan, wind_profile).squeeze()
+
+
+def calculate_friction_velocity_reference_height(
+ wind_speed_ref: NDArray[np.float32],
+ reference_height: float | NDArray[np.float32],
+ zeroplane_displacement: NDArray[np.float32],
+ roughness_length_momentum: NDArray[np.float32],
+ diabatic_correction_momentum: float | NDArray[np.float32],
+ von_karmans_constant: float,
+ min_friction_velocity: float,
+) -> NDArray[np.float32]:
+ """Calculate friction velocity from wind speed at reference height, [m s-1].
+
+ Args:
+ wind_speed_ref: Wind speed at reference height, [m s-1]
+ reference_height: Height of wind measurement, [m]
+ zeroplane_displacement: Height above ground within the canopy where the wind
+ profile extrapolates to zero, [m]
+ roughness_length_momentum: Momentum roughness length, [m]
+ diabatic_correction_momentum: Diabatic correction factor for momentum as
+ returned by
+ :func:`~virtual_ecosystem.models.abiotic.wind.calculate_diabatic_correction_above`
+ von_karmans_constant: Von Karman's constant, dimensionless constant describing
+ the logarithmic velocity profile of a turbulent fluid near a no-slip
+ boundary.
+ min_friction_velocity: Minimum friction velocity, [m s-1]
+
+ Returns:
+ Friction velocity, [m s-1]
+ """
+
+ wind_profile_reference = wind_log_profile(
+ height=reference_height,
+ zeroplane_displacement=zeroplane_displacement,
+ roughness_length_momentum=roughness_length_momentum,
+ diabatic_correction_momentum=diabatic_correction_momentum,
+ )
+
+ friction_velocity = von_karmans_constant * (wind_speed_ref / wind_profile_reference)
+
+ return np.where(
+ friction_velocity < min_friction_velocity,
+ min_friction_velocity,
+ friction_velocity,
+ )
+
+
+def calculate_wind_above_canopy(
+ friction_velocity: NDArray[np.float32],
+ wind_height_above: NDArray[np.float32],
+ zeroplane_displacement: NDArray[np.float32],
+ roughness_length_momentum: NDArray[np.float32],
+ diabatic_correction_momentum: NDArray[np.float32],
+ von_karmans_constant: float,
+ min_wind_speed_above_canopy: float,
+) -> NDArray[np.float32]:
+ """Calculate wind speed above canopy from wind speed at reference height, [m s-1].
+
+ Wind speed above the canopy dictates heat and vapour exchange between the canopy
+ and the air above it, and therefore ultimately determines temperature and vapour
+ profiles.
+ The wind profile above canopy typically follows a logarithmic height profile, which
+ extrapolates to zero roughly two thirds of the way to the top of the canopy. The
+ profile itself is thus dependent on the height of the canopy, but also on the
+ roughness of the vegetation layer, which causes wind shear. We follow the
+ implementation by :cite:t:`campbell_introduction_1998` as described in
+ :cite:t:`maclean_microclimc_2021`.
+
+ Args:
+ friction_velocity: friction velocity, [m s-1]
+ wind_height_above: Heights above canopy for which wind speed is required, [m].
+ For use in the calculation of the full wind profiles, this typically
+ includes two values: the height of the first layer ('above') and the first
+ canopy layer which corresponds to the canopy height.
+ zeroplane_displacement: Height above ground within the canopy where the wind
+ profile extrapolates to zero, [m]
+ roughness_length_momentum: Momentum roughness length, [m]
+ diabatic_correction_momentum: Diabatic correction factor for momentum as
+ returned by
+ :func:`~virtual_ecosystem.models.abiotic.wind.calculate_diabatic_correction_above`
+ von_karmans_constant: Von Karman's constant, dimensionless constant describing
+ the logarithmic velocity profile of a turbulent fluid near a no-slip
+ boundary.
+ min_wind_speed_above_canopy: Minimum wind speed above canopy, [m s-1]
+
+ Returns:
+ wind speed at required heights above canopy, [m s-1]
+ """
+
+ wind_profile_above = wind_log_profile(
+ height=wind_height_above,
+ zeroplane_displacement=zeroplane_displacement,
+ roughness_length_momentum=roughness_length_momentum,
+ diabatic_correction_momentum=diabatic_correction_momentum,
+ )
+ wind_profile = (friction_velocity / von_karmans_constant) * wind_profile_above
+
+ return np.where(
+ wind_profile < min_wind_speed_above_canopy,
+ min_wind_speed_above_canopy,
+ wind_profile,
+ )
+
+
+def calculate_wind_canopy(
+ top_of_canopy_wind_speed: NDArray[np.float32],
+ wind_layer_heights: NDArray[np.float32],
+ canopy_height: NDArray[np.float32],
+ attenuation_coefficient: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate wind speed in a multi-layer canopy, [m s-1].
+
+ This function can be extended to account for edge distance effects.
+
+ Args:
+ top_of_canopy_wind_speed: Wind speed at top of canopy layer, [m s-1]
+ wind_layer_heights: Heights of canopy layers, [m]
+ canopy_height: Height to top of canopy layer, [m]
+ attenuation_coefficient: Mean attenuation coefficient based on the profile
+ calculated by
+ :func:`~virtual_ecosystem.models.abiotic.wind.calculate_wind_attenuation_coefficient`
+ min_windspeed_below_canopy: Minimum wind speed below the canopy or in absence of
+ vegetation, [m/s]. This value is set to avoid dividion by zero.
+
+ Returns:
+ wind speed at height of canopy layers, [m s-1]
+ """
+
+ zero_displacement = top_of_canopy_wind_speed * np.exp(
+ attenuation_coefficient * ((wind_layer_heights / canopy_height) - 1)
+ )
+ return zero_displacement
+
+
+def calculate_wind_profile(
+ canopy_height: NDArray[np.float32],
+ wind_height_above: NDArray[np.float32],
+ wind_layer_heights: NDArray[np.float32],
+ leaf_area_index: NDArray[np.float32],
+ air_temperature: NDArray[np.float32],
+ atmospheric_pressure: NDArray[np.float32],
+ sensible_heat_flux_topofcanopy: NDArray[np.float32],
+ wind_speed_ref: NDArray[np.float32],
+ wind_reference_height: float | NDArray[np.float32],
+ abiotic_constants: AbioticConsts,
+ core_constants: CoreConsts,
+) -> dict[str, NDArray[np.float32]]:
+ r"""Calculate wind speed above and below the canopy, [m s-1].
+
+ The wind profile above the canopy is described as follows (based on
+ :cite:p:`campbell_introduction_1998` as implemented in
+ :cite:t:`maclean_microclimc_2021`):
+
+ :math:`u_z = \frac{u^{*}}{0.4} ln \frac{z-d}{z_M} + \Psi_M`
+
+ where :math:`u_z` is wind speed at height :math:`z` above the canopy, :math:`d` is
+ the height above ground within the canopy where the wind profile extrapolates to
+ zero, :math:`z_m` the roughness length for momentum, :math:`\Psi_M` is a diabatic
+ correction for momentum and :math:`u^{*}` is the friction velocity, which gives the
+ wind speed at height :math:`d + z_m`.
+
+ The wind profile below canopy is derived as follows:
+
+ :math:`u_z = u_h exp(a(\frac{z}{h} - 1))`
+
+ where :math:`u_z` is wind speed at height :math:`z` within the canopy, :math:`u_h`
+ is wind speed at the top of the canopy at height :math:`h`, and :math:`a` is a wind
+ attenuation coefficient given by :math:`a = 2 l_m i_w`, where :math:`c_d` is a drag
+ coefficient that varies with leaf inclination and shape, :math:`i_w` is a
+ coefficient describing relative turbulence intensity and :math:`l_m` is the mean
+ mixing length, equivalent to the free space between the leaves and stems. For
+ details, see :cite:t:`maclean_microclimc_2021`.
+
+ The following variables are returned:
+
+ * wind_speed
+ * friction_velocity
+ * molar_density_air
+ * specific_heat_air
+ * zero_plane_displacement
+ * roughness_length_momentum
+ * mean_mixing_length
+ * relative_turbulence_intensity
+ * attenuation_coefficient
+
+ Args:
+ canopy_height: Canopy height, [m]
+ wind_height_above: Heights above canopy for which wind speed is required, [m].
+ For use in the calculation of the full wind profiles, this typically
+ includes two values: the height of the first layer ('above') and the first
+ canopy layer which corresponds to the canopy height.
+ wind_layer_heights: Layer heights above ground, [m]
+ leaf_area_index: Leaf area index, [m m-1]
+ air_temperature: Air temperature, [C]
+ atmospheric_pressure: Atmospheric pressure, [kPa]
+ sensible_heat_flux_topofcanopy: Sensible heat flux from the top of the canopy to
+ the atmosphere, [W m-2],
+ wind_speed_ref: Wind speed at reference height, [m s-1]
+ wind_reference_height: Reference height for wind measurement, [m]
+ diabatic_correction_parameters: Set of parameters for diabatic correction
+ calculations in canopy
+ abiotic_constants: Specific constants for the abiotic model
+ core_constants: Universal constants shared across all models
+
+ Returns:
+ Dictionary that contains wind related outputs
+ """
+
+ output = {}
+
+ # Calculate molar density of air, [mol m-3]
+ molar_density_air = calculate_molar_density_air(
+ temperature=air_temperature,
+ atmospheric_pressure=atmospheric_pressure,
+ standard_mole=core_constants.standard_mole,
+ standard_pressure=core_constants.standard_pressure,
+ celsius_to_kelvin=core_constants.zero_Celsius,
+ )
+ output["molar_density_air"] = molar_density_air
+
+ # Calculate specific heat of air, [J mol-1 K-1]
+ specific_heat_air = calculate_specific_heat_air(
+ temperature=air_temperature,
+ molar_heat_capacity_air=core_constants.molar_heat_capacity_air,
+ specific_heat_equ_factors=abiotic_constants.specific_heat_equ_factors,
+ )
+ output["specific_heat_air"] = specific_heat_air
+
+ # Calculate the total leaf area index, [m2 m-2]
+ leaf_area_index_sum = np.nansum(leaf_area_index, axis=0)
+
+ zero_plane_displacement = calculate_zero_plane_displacement(
+ canopy_height=canopy_height,
+ leaf_area_index=leaf_area_index_sum,
+ zero_plane_scaling_parameter=abiotic_constants.zero_plane_scaling_parameter,
+ )
+ output["zero_plane_displacement"] = zero_plane_displacement
+
+ # Calculate zero plane displacement height, [m]
+ roughness_length_momentum = calculate_roughness_length_momentum(
+ canopy_height=canopy_height,
+ leaf_area_index=leaf_area_index_sum,
+ zero_plane_displacement=zero_plane_displacement,
+ substrate_surface_drag_coefficient=(
+ abiotic_constants.substrate_surface_drag_coefficient
+ ),
+ roughness_element_drag_coefficient=(
+ abiotic_constants.roughness_element_drag_coefficient
+ ),
+ roughness_sublayer_depth_parameter=(
+ abiotic_constants.roughness_sublayer_depth_parameter
+ ),
+ max_ratio_wind_to_friction_velocity=(
+ abiotic_constants.max_ratio_wind_to_friction_velocity
+ ),
+ min_roughness_length=abiotic_constants.min_roughness_length,
+ von_karman_constant=core_constants.von_karmans_constant,
+ )
+ output["roughness_length_momentum"] = roughness_length_momentum
+
+ friction_velocity_uncorrected = calculate_friction_velocity_reference_height(
+ wind_speed_ref=wind_speed_ref,
+ reference_height=wind_reference_height,
+ zeroplane_displacement=zero_plane_displacement,
+ roughness_length_momentum=roughness_length_momentum,
+ diabatic_correction_momentum=0.0,
+ von_karmans_constant=core_constants.von_karmans_constant,
+ min_friction_velocity=abiotic_constants.min_friction_velocity,
+ )
+
+ # Calculate diabatic correction factor above canopy (Psi)
+ diabatic_correction_above = calculate_diabatic_correction_above(
+ molar_density_air=molar_density_air[0],
+ specific_heat_air=specific_heat_air[0],
+ temperature=air_temperature[0],
+ sensible_heat_flux=sensible_heat_flux_topofcanopy,
+ friction_velocity=friction_velocity_uncorrected,
+ wind_heights=wind_layer_heights[0],
+ zero_plane_displacement=zero_plane_displacement,
+ celsius_to_kelvin=core_constants.zero_Celsius,
+ von_karmans_constant=core_constants.von_karmans_constant,
+ yasuda_stability_parameters=abiotic_constants.yasuda_stability_parameters,
+ diabatic_heat_momentum_ratio=abiotic_constants.diabatic_heat_momentum_ratio,
+ )
+ output["diabatic_correction_heat_above"] = diabatic_correction_above["psi_h"]
+ output["diabatic_correction_momentum_above"] = diabatic_correction_above["psi_m"]
+
+ # Update friction velocity with diabatic correction factor
+ friction_velocity = calculate_friction_velocity_reference_height(
+ wind_speed_ref=wind_speed_ref,
+ reference_height=wind_reference_height,
+ zeroplane_displacement=zero_plane_displacement,
+ roughness_length_momentum=roughness_length_momentum,
+ diabatic_correction_momentum=diabatic_correction_above["psi_m"],
+ von_karmans_constant=core_constants.von_karmans_constant,
+ min_friction_velocity=abiotic_constants.min_friction_velocity,
+ )
+ output["friction_velocity"] = friction_velocity
+
+ # Calculate mean mixing length, [m]
+ mean_mixing_length = calculate_mean_mixing_length(
+ canopy_height=canopy_height,
+ zero_plane_displacement=zero_plane_displacement,
+ roughness_length_momentum=roughness_length_momentum,
+ mixing_length_factor=abiotic_constants.mixing_length_factor,
+ )
+ output["mean_mixing_length"] = mean_mixing_length
+
+ # Calculate profile of turbulent mixing intensities, dimensionless
+ relative_turbulence_intensity = generate_relative_turbulence_intensity(
+ layer_heights=wind_layer_heights,
+ min_relative_turbulence_intensity=(
+ abiotic_constants.min_relative_turbulence_intensity
+ ),
+ max_relative_turbulence_intensity=(
+ abiotic_constants.max_relative_turbulence_intensity
+ ),
+ increasing_with_height=abiotic_constants.turbulence_sign,
+ )
+ output["relative_turbulence_intensity"] = relative_turbulence_intensity
+
+ # Calculate profile of attenuation coefficients, dimensionless
+ # VIVI - This might be wildly wrong, but at the moment this is taking in the full
+ # set of true aboveground rows and then appending a row above and below. I think it
+ # should operate by taking only the canopy data (dropping two rows) and then
+ # replacing them.
+ attennuation_coefficient = calculate_wind_attenuation_coefficient(
+ canopy_height=canopy_height,
+ leaf_area_index=leaf_area_index,
+ mean_mixing_length=mean_mixing_length,
+ drag_coefficient=abiotic_constants.drag_coefficient,
+ relative_turbulence_intensity=relative_turbulence_intensity,
+ )
+ output["attennuation_coefficient"] = attennuation_coefficient
+
+ # Calculate wind speed above canopy (2m above and top of canopy), [m s-1]
+ wind_speed_above_canopy = calculate_wind_above_canopy(
+ friction_velocity=friction_velocity,
+ wind_height_above=wind_height_above,
+ zeroplane_displacement=zero_plane_displacement,
+ roughness_length_momentum=roughness_length_momentum,
+ diabatic_correction_momentum=diabatic_correction_above["psi_m"],
+ von_karmans_constant=core_constants.von_karmans_constant,
+ min_wind_speed_above_canopy=abiotic_constants.min_wind_speed_above_canopy,
+ )
+
+ # Calculate wind speed in and below canopy, [m s-1]
+ wind_speed_canopy = calculate_wind_canopy(
+ top_of_canopy_wind_speed=wind_speed_above_canopy[1],
+ wind_layer_heights=wind_layer_heights,
+ canopy_height=canopy_height,
+ attenuation_coefficient=attennuation_coefficient,
+ )
+
+ # Combine wind speed above and in canopy to full profile
+ wind_speed_canopy[0:2] = wind_speed_above_canopy
+ output["wind_speed"] = wind_speed_canopy
+
+ # Calculate diabatic correction factors for heat and momentum below canopy
+ # (required for the calculation of conductivities)
+ diabatic_correction_canopy = calculate_diabatic_correction_canopy(
+ air_temperature=air_temperature,
+ wind_speed=wind_speed_canopy,
+ layer_heights=wind_layer_heights,
+ mean_mixing_length=mean_mixing_length,
+ stable_temperature_gradient_intercept=(
+ abiotic_constants.stable_temperature_gradient_intercept
+ ),
+ stable_wind_shear_slope=abiotic_constants.stable_wind_shear_slope,
+ yasuda_stability_parameters=abiotic_constants.yasuda_stability_parameters,
+ richardson_bounds=abiotic_constants.richardson_bounds,
+ gravity=core_constants.gravity,
+ celsius_to_kelvin=core_constants.zero_Celsius,
+ )
+ output["diabatic_correction_heat_canopy"] = diabatic_correction_canopy["phi_h"]
+ output["diabatic_correction_momentum_canopy"] = diabatic_correction_canopy["phi_m"]
+
+ return output
diff --git a/virtual_ecosystem/models/abiotic_simple/__init__.py b/virtual_ecosystem/models/abiotic_simple/__init__.py
index 359df0357..4fc251a29 100644
--- a/virtual_ecosystem/models/abiotic_simple/__init__.py
+++ b/virtual_ecosystem/models/abiotic_simple/__init__.py
@@ -2,7 +2,7 @@
models of the Virtual Ecosystem. It is comprised of several submodules that calculate
the microclimate for the Virtual Ecosystem.
-Each of the abiotic sub-modules has its own API reference page:
+Each of the abiotic simple sub-modules has its own API reference page:
* The :mod:`~virtual_ecosystem.models.abiotic_simple.abiotic_simple_model` submodule
instantiates the AbioticSimpleModel class which consolidates the functionality of the
@@ -11,14 +11,15 @@
* The :mod:`~virtual_ecosystem.models.abiotic_simple.microclimate` submodule
contains a set functions and parameters that are used to calculate atmospheric
- temperature, humidity, :math:`\ce{CO2}`, and atmospheric pressure profiles as well as
- soil temperature profiles.
+ temperature, relative humidity, vapour pressure deficit, :math:`\ce{CO2}`, and
+ atmospheric pressure profiles as well as soil temperature profiles.
* The :mod:`~virtual_ecosystem.models.abiotic_simple.constants` submodule provides a
- set of dataclasses containing the constants required by the broader soil model.
+ set of dataclasses containing the constants required by the broader abiotic model
+ including the regression parameters for deriving vertical profiles.
-""" # noqa: D205, D415
+""" # noqa: D205
-from virtual_ecosystem.models.abiotic_simple.abiotic_simple_model import ( # noqa: F401, E501
+from virtual_ecosystem.models.abiotic_simple.abiotic_simple_model import ( # noqa: F401
AbioticSimpleModel,
)
diff --git a/virtual_ecosystem/models/abiotic_simple/abiotic_simple_model.py b/virtual_ecosystem/models/abiotic_simple/abiotic_simple_model.py
index c9363121b..09aacdb8a 100644
--- a/virtual_ecosystem/models/abiotic_simple/abiotic_simple_model.py
+++ b/virtual_ecosystem/models/abiotic_simple/abiotic_simple_model.py
@@ -1,27 +1,17 @@
"""The :mod:`~virtual_ecosystem.models.abiotic_simple.abiotic_simple_model` module
creates a
:class:`~virtual_ecosystem.models.abiotic_simple.abiotic_simple_model.AbioticSimpleModel`
-class as a child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` class. At
-present a lot of the abstract methods of the parent class (e.g.
-:func:`~virtual_ecosystem.core.base_model.BaseModel.spinup`) are overwritten using
-placeholder functions that don't do anything. This will change as the Virtual Ecosystem
-model develops. The factory method
-:func:`~virtual_ecosystem.models.abiotic_simple.abiotic_simple_model.AbioticSimpleModel.from_config`
-exists in a more complete state, and unpacks a small number of parameters from our
-currently pretty minimal configuration dictionary. These parameters are then used to
-generate a class instance. If errors crop here when converting the information from the
-config dictionary to the required types they are caught and then logged, and at the end
-of the unpacking an error is thrown. This error should be caught and handled by
-downstream functions so that all model configuration failures can be reported as one.
-""" # noqa: D205, D415
+class as a child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` class.
+
+Todo:
+* update temperatures to Kelvin
+* pressure and CO2 profiles should only be filled for filled/true above ground layers
+""" # noqa: D205
from __future__ import annotations
from typing import Any
-import numpy as np
-from xarray import DataArray
-
from virtual_ecosystem.core.base_model import BaseModel
from virtual_ecosystem.core.config import Config
from virtual_ecosystem.core.constants_loader import load_constants
@@ -29,21 +19,19 @@ class as a child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` cl
from virtual_ecosystem.core.data import Data
from virtual_ecosystem.core.logger import LOGGER
from virtual_ecosystem.models.abiotic_simple import microclimate
-from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
+from virtual_ecosystem.models.abiotic_simple.constants import (
+ AbioticSimpleBounds,
+ AbioticSimpleConsts,
+)
class AbioticSimpleModel(
BaseModel,
model_name="abiotic_simple",
model_update_bounds=("1 day", "1 month"),
- required_init_vars=( # TODO add temporal axis
- ("air_temperature_ref", ("spatial",)),
- ("relative_humidity_ref", ("spatial",)),
- ("atmospheric_pressure_ref", ("spatial",)),
- ("atmospheric_co2_ref", ("spatial",)),
- ("mean_annual_temperature", ("spatial",)),
- ("leaf_area_index", ("spatial",)),
- ("layer_heights", ("spatial",)),
+ vars_required_for_init=(
+ "air_temperature_ref",
+ "relative_humidity_ref",
),
vars_updated=(
"air_temperature",
@@ -53,6 +41,27 @@ class AbioticSimpleModel(
"atmospheric_pressure",
"atmospheric_co2",
),
+ vars_required_for_update=(
+ "air_temperature_ref",
+ "relative_humidity_ref",
+ "vapour_pressure_deficit_ref",
+ "atmospheric_pressure_ref",
+ "atmospheric_co2_ref",
+ "leaf_area_index",
+ "layer_heights",
+ ),
+ vars_populated_by_init=( # TODO move functionality from setup() to __init__
+ "soil_temperature",
+ "vapour_pressure_ref",
+ "vapour_pressure_deficit_ref",
+ ),
+ vars_populated_by_first_update=(
+ "air_temperature",
+ "relative_humidity",
+ "vapour_pressure_deficit",
+ "atmospheric_pressure",
+ "atmospheric_co2",
+ ),
):
"""A class describing the abiotic simple model.
@@ -71,10 +80,12 @@ def __init__(
):
super().__init__(data=data, core_components=core_components, **kwargs)
- self.data
- """A Data instance providing access to the shared simulation data."""
self.model_constants = model_constants
"""Set of constants for the abiotic simple model"""
+ self.bounds = AbioticSimpleBounds()
+ """Upper and lower bounds for abiotic variables."""
+
+ self._setup()
@classmethod
def from_config(
@@ -108,36 +119,36 @@ def from_config(
)
def setup(self) -> None:
+ """No longer in use.
+
+ TODO: Remove when the base model is updated.
+ """
+
+ def _setup(self) -> None:
"""Function to set up the abiotic simple model.
- At the moment, this function only initializes soil temperature for all
- soil layers and calculates the reference vapour pressure deficit for all time
- steps. Both variables are added directly to the self.data object.
+ This function initializes soil temperature for all soil layers and calculates
+ the reference vapour pressure deficit for all time steps. Both variables are
+ added directly to the self.data object.
"""
# create soil temperature array
- self.data["soil_temperature"] = DataArray(
- np.full(
- (self.layer_structure.n_layers, self.data.grid.n_cells),
- np.nan,
- ),
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(0, self.layer_structure.n_layers),
- "layer_roles": ("layers", self.layer_structure.layer_roles),
- "cell_id": self.data.grid.cell_id,
- },
- name="soil_temperature",
- )
+ self.data["soil_temperature"] = self.layer_structure.from_template()
# calculate vapour pressure deficit at reference height for all time steps
- self.data["vapour_pressure_deficit_ref"] = (
- microclimate.calculate_vapour_pressure_deficit(
- temperature=self.data["air_temperature_ref"],
- relative_humidity=self.data["relative_humidity_ref"],
- constants=self.model_constants,
- ).rename("vapour_pressure_deficit_ref")
+ vapour_pressure_and_deficit = microclimate.calculate_vapour_pressure_deficit(
+ temperature=self.data["air_temperature_ref"],
+ relative_humidity=self.data["relative_humidity_ref"],
+ saturation_vapour_pressure_factors=(
+ self.model_constants.saturation_vapour_pressure_factors
+ ),
)
+ self.data["vapour_pressure_deficit_ref"] = vapour_pressure_and_deficit[
+ "vapour_pressure_deficit"
+ ]
+ self.data["vapour_pressure_ref"] = vapour_pressure_and_deficit[
+ "vapour_pressure"
+ ]
def spinup(self) -> None:
"""Placeholder function to spin up the abiotic simple model."""
@@ -147,16 +158,17 @@ def update(self, time_index: int, **kwargs: Any) -> None:
Args:
time_index: The index of the current time step in the data object.
+ **kwargs: Further arguments to the update method.
"""
# This section performs a series of calculations to update the variables in the
- # abiotic model. This could be moved to here and written directly to the data
- # object. For now, we leave it as a separate routine.
+ # abiotic model. The updated variables are then added to the data object.
output_variables = microclimate.run_microclimate(
data=self.data,
- layer_roles=self.layer_structure.layer_roles,
+ layer_structure=self.layer_structure,
time_index=time_index,
constants=self.model_constants,
+ bounds=self.bounds,
)
self.data.add_from_dict(output_dict=output_variables)
diff --git a/virtual_ecosystem/models/abiotic_simple/constants.py b/virtual_ecosystem/models/abiotic_simple/constants.py
index 0c78c6525..6370b9b2f 100644
--- a/virtual_ecosystem/models/abiotic_simple/constants.py
+++ b/virtual_ecosystem/models/abiotic_simple/constants.py
@@ -1,10 +1,10 @@
"""The ``models.abiotic_simple.constants`` module contains a set of dataclasses
-containing parameters required by the broader
-:mod:`~virtual_ecosystem.models.abiotic_simple` model. These parameters are constants
-in that they should not be changed during a particular simulation.
-""" # noqa: D205, D415
+containing parameters required by the :mod:`~virtual_ecosystem.models.abiotic_simple`
+model. These parameters are constants in that they should not be changed during a
+particular simulation.
+""" # noqa: D205
-from dataclasses import dataclass
+from dataclasses import dataclass, field
from virtual_ecosystem.core.constants_class import ConstantsDataclass
@@ -13,21 +13,41 @@
class AbioticSimpleConsts(ConstantsDataclass):
"""Dataclass to store all constants for the `abiotic_simple` model."""
- air_temperature_gradient: float = -1.27
- """Gradient for linear regression to calculate air temperature as a function of
- leaf area index from :cite:t:`hardwick_relationship_2015`"""
+ saturation_vapour_pressure_factors: list[float] = field(
+ default_factory=lambda: [0.61078, 7.5, 237.3]
+ )
+ """Factors for saturation vapour pressure calculation."""
- relative_humidity_gradient: float = 5.4
- """Gradient for linear regression to calculate relative humidity as a function of
- leaf area index from :cite:t:`hardwick_relationship_2015`"""
- vapour_pressure_deficit_gradient: float = -252.24
- """Gradient for linear regression to calculate vapour pressure deficit as a function
- of leaf area index from :cite:t:`hardwick_relationship_2015`"""
+@dataclass(frozen=True)
+class AbioticSimpleBounds(ConstantsDataclass):
+ """Upper and lower bounds for abiotic variables.
+
+ When a values falls outside these bounds, it is set to the bound value.
+ NOTE that this approach does not conserve energy and matter in the system.
+ This will be implemented at a later stage.
+ """
+
+ air_temperature: tuple[float, float, float] = (-20.0, 80.0, -1.27)
+ """Bounds and gradient for air temperature, [C].
+
+ Gradient for linear regression to calculate air temperature as a function of
+ leaf area index from :cite:t:`hardwick_relationship_2015`.
+ """
+
+ relative_humidity: tuple[float, float, float] = (0.0, 100.0, 5.4)
+ """Bounds and gradient for relative humidity, dimensionless.
+
+ Gradient for linear regression to calculate relative humidity as a function of
+ leaf area index from :cite:t:`hardwick_relationship_2015`.
+ """
+
+ vapour_pressure_deficit: tuple[float, float, float] = (0.0, 10.0, -252.24)
+ """Bounds and gradient for vapour pressure deficit, [kPa].
+
+ Gradient for linear regression to calculate vapour pressure deficit as a function of
+ leaf area index from :cite:t:`hardwick_relationship_2015`.
+ """
- saturation_vapour_pressure_factor1: float = 0.61078
- """factor 1 for saturation vapour pressure calculation."""
- saturation_vapour_pressure_factor2: float = 7.5
- """factor 2 for saturation vapour pressure calculation."""
- saturation_vapour_pressure_factor3: float = 237.3
- """factor 3 for saturation vapour pressure calculation."""
+ soil_temperature: tuple[float, float] = (-10.0, 50.0)
+ """Bounds for soil temperature, [C]."""
diff --git a/virtual_ecosystem/models/abiotic_simple/microclimate.py b/virtual_ecosystem/models/abiotic_simple/microclimate.py
index 2a05cc153..50bd7e5f4 100644
--- a/virtual_ecosystem/models/abiotic_simple/microclimate.py
+++ b/virtual_ecosystem/models/abiotic_simple/microclimate.py
@@ -8,39 +8,27 @@
1 m depth which equals the mean annual temperature.
The module also provides a constant vertical profile of atmospheric pressure and
:math:`\ce{CO2}`.
-""" # noqa: D205, D415
+
+TODO change temperatures to Kelvin
+""" # noqa: D205
import numpy as np
-import xarray as xr
from xarray import DataArray
+from virtual_ecosystem.core.core_components import LayerStructure
from virtual_ecosystem.core.data import Data
-from virtual_ecosystem.models.abiotic_simple.constants import AbioticSimpleConsts
-
-Bounds: dict[str, float] = {
- "air_temperature_min": -20,
- "air_temperature_max": 80,
- "relative_humidity_min": 0,
- "relative_humidity_max": 100,
- "vapour_pressure_deficit_min": 0,
- "vapour_pressure_deficit_max": 10,
- "soil_temperature_min": -10,
- "soil_temperature_max": 50,
-}
-"""Upper and lower bounds for abiotic variables. When a values falls outside these
-bounds, it is set to the bound value. Note that this approach does not conserve energy
-and matter in the system. This will be implemented at a later stage.
-"""
-# TODO move bounds to core.bound_checking once that is implemented and introduce method
-# to conserve energy and matter
+from virtual_ecosystem.models.abiotic_simple.constants import (
+ AbioticSimpleBounds,
+ AbioticSimpleConsts,
+)
def run_microclimate(
data: Data,
- layer_roles: list[str],
+ layer_structure: LayerStructure,
time_index: int, # could be datetime?
constants: AbioticSimpleConsts,
- Bounds: dict[str, float] = Bounds,
+ bounds: AbioticSimpleBounds,
) -> dict[str, DataArray]:
r"""Calculate simple microclimate.
@@ -62,17 +50,19 @@ def run_microclimate(
The other atmospheric layers are calculated by logarithmic regression and
interpolation between the input at the top of the canopy and the 1.5 m values.
Soil temperature is interpolated between the surface layer and the temperature at
- 1 m depth which equals the mean annual temperature.
- The function also provides constant atmospheric pressure and :math:`\ce{CO2}` for
- all atmospheric levels.
+ 1 m depth which which approximately equals the mean annual temperature, i.e. can
+ assumed to be constant over the year.
+
+ The function also broadcasts the reference values for atmospheric pressure and
+ :math:`\ce{CO2}` to all atmospheric levels as they are currently assumed to remain
+ constant during one time step.
The `layer_roles` list is composed of the following layers (index 0 above canopy):
- * above canopy (canopy height)
- * canopy layers (maximum of ten layers, minimum one layers)
- * subcanopy (1.5 m)
+ * above canopy (canopy height + 2 m)
+ * canopy layers
* surface layer
- * soil layers (currently one near surface layer and one layer at 1 m below ground)
+ * soil layers
The function expects a data object with the following variables:
@@ -86,11 +76,10 @@ def run_microclimate(
Args:
data: Data object
- layer_roles: list of layer roles (from top to bottom: above, canopy, subcanopy,
- surface, soil)
- time_index: time index, integer
+ layer_structure: The LayerStructure instance for the simulation.
+ time_index: Time index, integer
constants: Set of constants for the abiotic simple model
- Bounds: upper and lower allowed values for vertical profiles, used to constrain
+ bounds: Upper and lower allowed values for vertical profiles, used to constrain
log interpolation. Note that currently no conservation of water and energy!
Returns:
@@ -99,63 +88,51 @@ def run_microclimate(
atmospheric :math:`\ce{CO2}` [ppm]
"""
- # TODO make sure variables are representing correct time interval, e.g. mm per day
output = {}
- # sum leaf area index over all canopy layers
+ # Sum leaf area index over all canopy layers
leaf_area_index_sum = data["leaf_area_index"].sum(dim="layers")
- # interpolate atmospheric profiles
+ # Interpolate atmospheric profiles
for var in ["air_temperature", "relative_humidity", "vapour_pressure_deficit"]:
+ lower, upper, gradient = getattr(bounds, var)
+
output[var] = log_interpolation(
data=data,
reference_data=data[var + "_ref"].isel(time_index=time_index),
leaf_area_index_sum=leaf_area_index_sum,
- layer_roles=layer_roles,
+ layer_structure=layer_structure,
layer_heights=data["layer_heights"],
- upper_bound=Bounds[var + "_max"],
- lower_bound=Bounds[var + "_min"],
- gradient=getattr(constants, var + "_gradient"),
+ upper_bound=upper,
+ lower_bound=lower,
+ gradient=gradient,
).rename(var)
# Mean atmospheric pressure profile, [kPa]
- output["atmospheric_pressure"] = (
- (data["atmospheric_pressure_ref"])
- .isel(time_index=time_index)
- .where(output["air_temperature"].coords["layer_roles"] != "soil")
- .rename("atmospheric_pressure")
- .T
- )
+ # TODO: this should only be filled for filled/true above ground layers
+ output["atmospheric_pressure"] = layer_structure.from_template()
+ output["atmospheric_pressure"][layer_structure.index_atmosphere] = data[
+ "atmospheric_pressure_ref"
+ ].isel(time_index=time_index)
# Mean atmospheric C02 profile, [ppm]
- output["atmospheric_co2"] = (
- data["atmospheric_co2_ref"]
- .isel(time_index=0)
- .where(output["air_temperature"].coords["layer_roles"] != "soil")
- .rename("atmospheric_co2")
- .T
- )
+ # TODO: this should only be filled for filled/true above ground layers
+ output["atmospheric_co2"] = layer_structure.from_template()
+ output["atmospheric_co2"][layer_structure.index_atmosphere] = data[
+ "atmospheric_co2_ref"
+ ].isel(time_index=time_index)
# Calculate soil temperatures
- soil_temperature_only = interpolate_soil_temperature(
+ lower, upper = getattr(bounds, "soil_temperature")
+ output["soil_temperature"] = interpolate_soil_temperature(
layer_heights=data["layer_heights"],
surface_temperature=output["air_temperature"].isel(
- layers=len(layer_roles) - layer_roles.count("soil") - 1
+ layers=layer_structure.index_surface
),
mean_annual_temperature=data["mean_annual_temperature"],
- upper_bound=Bounds["soil_temperature_max"],
- lower_bound=Bounds["soil_temperature_min"],
- )
-
- # add above-ground vertical layers back
- output["soil_temperature"] = xr.concat(
- [
- data["soil_temperature"].isel(
- layers=np.arange(0, len(layer_roles) - layer_roles.count("soil"))
- ),
- soil_temperature_only,
- ],
- dim="layers",
+ layer_structure=layer_structure,
+ upper_bound=upper,
+ lower_bound=lower,
)
return output
@@ -165,7 +142,7 @@ def log_interpolation(
data: Data,
reference_data: DataArray,
leaf_area_index_sum: DataArray,
- layer_roles: list[str],
+ layer_structure: LayerStructure,
layer_heights: DataArray,
upper_bound: float,
lower_bound: float,
@@ -175,14 +152,14 @@ def log_interpolation(
Args:
data: Data object
- reference_data: input variable at reference height
- leaf_area_index_sum: leaf area index summed over all layers, [m m-1]
- layer_roles: list of layer roles (soil, surface, subcanopy, canopy, above)
- layer_heights: vertical layer heights, [m]
- lower_bound: minimum allowed value, used to constrain log interpolation. Note
+ reference_data: Input variable at reference height
+ leaf_area_index_sum: Leaf area index summed over all layers, [m m-1]
+ layer_structure: The LayerStructure instance for the simulation.
+ layer_heights: Vertical layer heights, [m]
+ lower_bound: Minimum allowed value, used to constrain log interpolation. Note
that currently no conservation of water and energy!
- upper_bound: maximum allowed value, used to constrain log interpolation.
- gradient: gradient of regression from :cite:t:`hardwick_relationship_2015`
+ upper_bound: Maximum allowed value, used to constrain log interpolation.
+ gradient: Gradient of regression from :cite:t:`hardwick_relationship_2015`
Returns:
vertical profile of provided variable
@@ -200,38 +177,23 @@ def log_interpolation(
intercept = lai_regression - slope * np.log(1.5)
# Calculate the values within cells by layer
- positive_layer_heights = DataArray(
- np.where(layer_heights > 0, layer_heights, np.nan),
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(0, len(layer_roles)),
- "layer_roles": ("layers", layer_roles),
- "cell_id": data.grid.cell_id,
- },
- )
-
- layer_values = np.where(
- np.logical_not(np.isnan(positive_layer_heights)),
- (np.log(positive_layer_heights) * slope + intercept),
- np.nan,
+ positive_layer_heights = np.where(layer_heights > 0, layer_heights, np.nan)
+ layer_values = (
+ np.log(positive_layer_heights) * slope.to_numpy() + intercept.to_numpy()
)
# set upper and lower bounds
- return DataArray(
- np.clip(layer_values, lower_bound, upper_bound),
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(0, len(layer_roles)),
- "layer_roles": ("layers", layer_roles),
- "cell_id": data.grid.cell_id,
- },
- )
+ return_array = layer_structure.from_template()
+ return_array[:] = np.clip(layer_values, lower_bound, upper_bound)
+
+ return return_array
def calculate_saturation_vapour_pressure(
- temperature: DataArray, factor1: float, factor2: float, factor3: float
+ temperature: DataArray,
+ saturation_vapour_pressure_factors: list[float],
) -> DataArray:
- r"""Calculate saturation vapour pressure.
+ r"""Calculate saturation vapour pressure, kPa.
Saturation vapour pressure :math:`e_{s} (T)` is here calculated as
@@ -240,15 +202,14 @@ def calculate_saturation_vapour_pressure(
where :math:`T` is temperature in degree C .
Args:
- temperature: air temperature, [C]
- factor1: factor 1 in saturation vapour pressure calculation
- factor2: factor 2 in saturation vapour pressure calculation
- factor3: factor 3 in saturation vapour pressure calculation
+ temperature: Air temperature, [C]
+ saturation_vapour_pressure_factors: Factors in saturation vapour pressure
+ calculation
Returns:
saturation vapour pressure, [kPa]
"""
-
+ factor1, factor2, factor3 = saturation_vapour_pressure_factors
return DataArray(
factor1 * np.exp((factor2 * temperature) / (temperature + factor3))
).rename("saturation_vapour_pressure")
@@ -257,9 +218,9 @@ def calculate_saturation_vapour_pressure(
def calculate_vapour_pressure_deficit(
temperature: DataArray,
relative_humidity: DataArray,
- constants: AbioticSimpleConsts,
-) -> DataArray:
- """Calculate vapour pressure deficit.
+ saturation_vapour_pressure_factors: list[float],
+) -> dict[str, DataArray]:
+ """Calculate vapour pressure and vapour pressure deficit, kPa.
Vapor pressure deficit is defined as the difference between saturated vapour
pressure and actual vapour pressure.
@@ -267,74 +228,73 @@ def calculate_vapour_pressure_deficit(
Args:
temperature: temperature, [C]
relative_humidity: relative humidity, []
- constants: Set of constants for the abiotic simple model
+ saturation_vapour_pressure_factors: Factors in saturation vapour pressure
+ calculation
Return:
- vapour pressure deficit, [kPa]
+ vapour pressure, [kPa], vapour pressure deficit, [kPa]
"""
+ output = {}
saturation_vapour_pressure = calculate_saturation_vapour_pressure(
temperature,
- factor1=constants.saturation_vapour_pressure_factor1,
- factor2=constants.saturation_vapour_pressure_factor2,
- factor3=constants.saturation_vapour_pressure_factor3,
+ saturation_vapour_pressure_factors=saturation_vapour_pressure_factors,
)
actual_vapour_pressure = saturation_vapour_pressure * (relative_humidity / 100)
-
- return saturation_vapour_pressure - actual_vapour_pressure
+ output["vapour_pressure"] = actual_vapour_pressure
+ output["vapour_pressure_deficit"] = (
+ saturation_vapour_pressure - actual_vapour_pressure
+ )
+ return output
def interpolate_soil_temperature(
layer_heights: DataArray,
surface_temperature: DataArray,
mean_annual_temperature: DataArray,
- upper_bound: float = Bounds["soil_temperature_max"],
- lower_bound: float = Bounds["soil_temperature_min"],
+ layer_structure: LayerStructure,
+ upper_bound: float,
+ lower_bound: float,
) -> DataArray:
"""Interpolate soil temperature using logarithmic function.
Args:
- layer_heights: vertical layer heights, [m]
- layer_roles: list of layer roles (from top to bottom: above, canopy, subcanopy,
+ layer_heights: Vertical layer heights, [m]
+ layer_roles: List of layer roles (from top to bottom: above, canopy, subcanopy,
surface, soil)
- surface_temperature: surface temperature, [C]
- mean_annual_temperature: mean annual temperature, [C]
- upper_bound: maximum allowed value, used to constrain log interpolation. Note
+ surface_temperature: Surface temperature, [C]
+ mean_annual_temperature: Mean annual temperature, [C]
+ layer_structure: The LayerStructure instance for the simulation.
+ upper_bound: Maximum allowed value, used to constrain log interpolation. Note
that currently no conservation of water and energy!
- lower_bound: minimum allowed value, used to constrain log interpolation.
+ lower_bound: Minimum allowed value, used to constrain log interpolation.
Returns:
soil temperature profile, [C]
"""
- # select surface layer (atmosphere)
- surface_layer = layer_heights[layer_heights.coords["layer_roles"] == "surface"]
-
- # create array of interpolation heights including surface layer and soil layers
- interpolation_heights = xr.concat(
- [
- surface_layer,
- layer_heights[layer_heights.coords["layer_roles"] == "soil"] * -1
- + surface_layer.values,
- ],
- dim="layers",
+ # Select surface layer (atmosphere) and generate interpolation heights
+ surface_layer = layer_heights[layer_structure.index_surface].to_numpy()
+ soil_depths = layer_heights[layer_structure.index_all_soil].to_numpy()
+ interpolation_heights = np.concatenate(
+ [surface_layer, -1 * soil_depths + surface_layer]
)
# Calculate per cell slope and intercept for logarithmic soil temperature profile
- slope = (surface_temperature - mean_annual_temperature) / (
- np.log(interpolation_heights.isel(layers=0))
- - np.log(interpolation_heights.isel(layers=-1))
+ slope = (surface_temperature.to_numpy() - mean_annual_temperature.to_numpy()) / (
+ np.log(interpolation_heights[0]) - np.log(interpolation_heights[-1])
)
- intercept = surface_temperature - slope * np.log(
- interpolation_heights.isel(layers=0)
+ intercept = surface_temperature.to_numpy() - slope * np.log(
+ interpolation_heights[0]
)
- # Calculate the values within cells by layer
- layer_values = np.log(interpolation_heights) * slope + intercept
+ # Calculate the values within cells by layer and clip by the bounds
+ layer_values = np.clip(
+ np.log(interpolation_heights) * slope + intercept, lower_bound, upper_bound
+ )
- # set upper and lower bounds and return soil and surface layers, further layers are
- # added in the 'run' function
- return DataArray(
- np.clip(layer_values, lower_bound, upper_bound),
- coords=interpolation_heights.coords,
- ).drop_isel(layers=0)
+ # return
+ return_xarray = layer_structure.from_template()
+ return_xarray[layer_structure.index_all_soil] = layer_values[1:]
+
+ return return_xarray
diff --git a/virtual_ecosystem/models/animal/__init__.py b/virtual_ecosystem/models/animal/__init__.py
new file mode 100644
index 000000000..da46ec962
--- /dev/null
+++ b/virtual_ecosystem/models/animal/__init__.py
@@ -0,0 +1,30 @@
+"""The :mod:`~virtual_ecosystem.models.animal` module is one of the component models
+of the Virtual Ecosystem. It is comprised of a number of submodules.
+
+Each of the animal sub-modules has its own API reference page:
+
+* The :mod:`~virtual_ecosystem.models.animal.animal_model` submodule instantiates the
+ AnimalModel class which consolidates the functionality of the animal module
+ into a single class, which the high level functions of the Virtual Ecosystem
+ can then make use of.
+* The :mod:`~virtual_ecosystem.models.animal.animal_communities` provides a class for
+ containing and managing all of the animal cohorts within a grid square.
+* The :mod:`~virtual_ecosystem.models.animal.animal_cohorts` provides a class for the
+ individual animal cohorts, their attributes, and behaviors.
+* The :mod:`~virtual_ecosystem.models.animal.functional_group` provides a class for
+ the animal functional groups that define the type of animal in an animal cohort.
+* The :mod:`~virtual_ecosystem.models.animal.animal_traits` provides classes for
+ the traits that feed into the functional group class definitions.
+* The :mod:`~virtual_ecosystem.models.animal.scaling_functions` provides a set of
+ allometric scaling functions that define the biological rates used in the animal
+ module.
+* The :mod:`~virtual_ecosystem.models.animal.constants` provides a set of dataclasses
+ containing the constants required by the broader animal model.
+* The :mod:`~virtual_ecosystem.models.animal.decay` provides a model for
+ both surface carcasses created by mortality and animal excrement.
+* The :mod:`~virtual_ecosystem.models.animal.plant_resources` provides the
+ :class:`~virtual_ecosystem.models.animal.plant_resources.PlantResources` class,
+ which provides an API for exposing plant model data via the animal model protocols.
+""" # noqa: D205
+
+from virtual_ecosystem.models.animal.animal_model import AnimalModel # noqa: F401
diff --git a/virtual_ecosystem/models/animal/animal_cohorts.py b/virtual_ecosystem/models/animal/animal_cohorts.py
new file mode 100644
index 000000000..f4ebef27c
--- /dev/null
+++ b/virtual_ecosystem/models/animal/animal_cohorts.py
@@ -0,0 +1,837 @@
+"""The ''animal'' module provides animal module functionality.
+
+Notes:
+- assume each grid = 1 km2
+- assume each tick = 1 day (28800s)
+- damuth ~ 4.23*mass**(-3/4) indiv / km2
+"""
+
+from __future__ import annotations
+
+from collections.abc import Sequence
+from math import ceil, exp, sqrt
+
+from numpy import timedelta64
+
+import virtual_ecosystem.models.animal.scaling_functions as sf
+from virtual_ecosystem.core.logger import LOGGER
+from virtual_ecosystem.models.animal.animal_traits import DietType
+from virtual_ecosystem.models.animal.constants import AnimalConsts
+from virtual_ecosystem.models.animal.decay import CarcassPool
+from virtual_ecosystem.models.animal.functional_group import FunctionalGroup
+from virtual_ecosystem.models.animal.protocols import Consumer, DecayPool, Resource
+
+
+class AnimalCohort:
+ """This is a class of animal cohorts."""
+
+ def __init__(
+ self,
+ functional_group: FunctionalGroup,
+ mass: float,
+ age: float,
+ individuals: int,
+ constants: AnimalConsts = AnimalConsts(),
+ ) -> None:
+ if age < 0:
+ raise ValueError("Age must be a positive number.")
+ """Check if age is a positive number. """
+
+ if mass < 0:
+ raise ValueError("Mass must be a positive number.")
+ """Check if mass is a positive number."""
+
+ """The constructor for the AnimalCohort class."""
+ self.functional_group = functional_group
+ """The functional group of the animal cohort which holds constants."""
+ self.name = functional_group.name
+ """The functional type name of the animal cohort."""
+ self.mass_current = mass
+ """The current average body mass of an individual [kg]."""
+ self.age = age
+ """The age of the animal cohort [days]."""
+ self.individuals = individuals
+ """The number of individuals in this cohort."""
+ self.constants = constants
+ """Animal constants."""
+ self.damuth_density: int = sf.damuths_law(
+ self.functional_group.adult_mass, self.functional_group.damuths_law_terms
+ )
+ """The number of individuals in an average cohort of this type."""
+ self.is_alive: bool = True
+ """Whether the cohort is alive [True] or dead [False]."""
+ self.is_mature: bool = False
+ """Whether the cohort has reached adult body-mass."""
+ self.time_to_maturity: float = 0.0
+ """The amount of time [days] between birth and adult body-mass."""
+ self.time_since_maturity: float = 0.0
+ """The amount of time [days] since reaching adult body-mass."""
+ self.reproductive_mass: float = 0.0
+ """The pool of biomass from which the material of reproduction is drawn."""
+ self.prey_groups = sf.prey_group_selection(
+ self.functional_group.diet,
+ self.functional_group.adult_mass,
+ self.functional_group.prey_scaling,
+ )
+ """The identification of useable food resources."""
+ # TODO - In future this should be parameterised using a constants dataclass, but
+ # this hasn't yet been implemented for the animal model
+ self.decay_fraction_excrement: float = self.constants.decay_fraction_excrement
+ """The fraction of excrement which decays before it gets consumed."""
+ self.decay_fraction_carcasses: float = self.constants.decay_fraction_carcasses
+ """The fraction of carcass biomass which decays before it gets consumed."""
+
+ def metabolize(self, temperature: float, dt: timedelta64) -> float:
+ """The function to reduce body mass through metabolism.
+
+ This method currently employs a toy 50/50 split of basal and field metabolism
+ through the metabolic_rate scaling function. Ecothermic metabolism is a function
+ of environmental temperature. Endotherms are unaffected by temperature change.
+ This method will later drive the processing of carbon and nitrogen metabolic
+ products.
+
+ TODO: Update with stoichiometry
+
+ Args:
+ temperature: Current air temperature (K)
+ dt: Number of days over which the metabolic costs should be calculated.
+
+ Returns:
+ The mass of metabolic waste produced.
+
+ """
+
+ if dt < timedelta64(0, "D"):
+ raise ValueError("dt cannot be negative.")
+
+ if self.mass_current < 0:
+ raise ValueError("mass_current cannot be negative.")
+
+ # kg/day metabolic rate * number of days
+ potential_mass_metabolized = sf.metabolic_rate(
+ self.mass_current,
+ temperature,
+ self.functional_group.metabolic_rate_terms,
+ self.functional_group.metabolic_type,
+ ) * float(dt / timedelta64(1, "D"))
+
+ actual_mass_metabolized = min(self.mass_current, potential_mass_metabolized)
+
+ self.mass_current -= actual_mass_metabolized
+
+ # returns total metabolic waste from cohort to animal_communities for tracking
+ # in data object
+ return actual_mass_metabolized * self.individuals
+
+ def excrete(self, excreta_mass: float, excrement_pool: DecayPool) -> None:
+ """Transfers nitrogenous metabolic wastes to the excrement pool.
+
+ This method will not be fully implemented until the stoichiometric rework. All
+ current metabolic wastes are carbonaceous and so all this does is provide a link
+ joining metabolism to a soil pool for later use.
+
+ TODO: Update with stoichiometry
+
+ Args:
+ excreta_mass: The total mass of carbonaceous wastes excreted by the cohort.
+ excrement_pool: The pool of wastes to which the excreted nitrogenous wastes
+ flow.
+
+ """
+ excrement_pool.decomposed_energy += (
+ excreta_mass * self.constants.nitrogen_excreta_proportion
+ )
+
+ def respire(self, excreta_mass: float) -> float:
+ """Transfers carbonaceous metabolic wastes to the atmosphere.
+
+ This method will not be fully implemented until the stoichiometric rework. All
+ current metabolic wastes are carbonaceous and so all this does is return the
+ excreta mass for updating data["total_animal_respiration"] in metabolize
+ community.
+
+ TODO: Update with stoichiometry
+
+ Args:
+ excreta_mass: The total mass of carbonaceous wastes excreted by the cohort.
+
+ Return: The total mass of carbonaceous wastes excreted by the cohort.
+
+ """
+
+ return excreta_mass * self.constants.carbon_excreta_proportion
+
+ def defecate(
+ self,
+ excrement_pool: DecayPool,
+ mass_consumed: float,
+ ) -> None:
+ """Transfer waste mass from an animal cohort to the excrement pool.
+
+ Currently, this function is in an inbetween state where mass is removed from
+ the animal cohort but it is recieved by the litter pool as energy. This will be
+ fixed once the litter pools are updated for mass.
+
+ TODO: Rework after update litter pools for mass
+ TODO: update for current conversion efficiency
+ TODO: Update with stoichiometry
+
+ Args:
+ excrement_pool: The local ExcrementSoil pool in which waste is deposited.
+ mass_consumed: The amount of mass flowing through cohort digestion.
+ """
+ # Find total waste mass, the total amount of waste is then found by the
+ # average cohort member * number individuals.
+ waste_energy = mass_consumed * self.functional_group.conversion_efficiency
+
+ # This total waste is then split between decay and scavengeable excrement
+ excrement_pool.scavengeable_energy += (
+ (1 - self.decay_fraction_excrement) * waste_energy * self.individuals
+ )
+ excrement_pool.decomposed_energy += (
+ self.decay_fraction_excrement * waste_energy * self.individuals
+ )
+
+ def increase_age(self, dt: timedelta64) -> None:
+ """The function to modify cohort age as time passes and flag maturity.
+
+ Args:
+ dt: The amount of time that should be added to cohort age.
+
+ """
+
+ dt_float = float(dt / timedelta64(1, "D"))
+
+ self.age += dt_float
+
+ if self.is_mature is True:
+ self.time_since_maturity += dt_float
+ elif (
+ self.is_mature is False
+ and self.mass_current >= self.functional_group.adult_mass
+ ):
+ self.is_mature = True
+ self.time_to_maturity = self.age
+
+ def die_individual(self, number_dead: int, carcass_pool: CarcassPool) -> None:
+ """The function to reduce the number of individuals in the cohort through death.
+
+ Currently, all cohorts are crafted as single km2 grid cohorts. This means that
+ very large animal will have one or fewer cohort members per grid. As changes
+ are made to capture large body size and multi-grid occupancy, this will be
+ updated.
+
+ Currently, this function is in an inbetween state where mass is removed from
+ the animal cohort but it is recieved by the litter pool as energy. This will be
+ fixed once the litter pools are updated for mass.
+
+ TODO: Rework after update litter pools for mass
+
+ Args:
+ number_dead: The number of individuals by which to decrease the population
+ count.
+ carcass_pool: The resident pool of animal carcasses to which the dead
+ individuals are delivered.
+
+ """
+ self.individuals -= number_dead
+
+ # Find total mass contained in the carcasses
+ carcass_mass = number_dead * self.mass_current
+
+ # Split this mass between carcass decay, and scavengeable carcasses
+ carcass_pool.scavengeable_energy += (
+ 1 - self.decay_fraction_carcasses
+ ) * carcass_mass
+ carcass_pool.decomposed_energy += self.decay_fraction_carcasses * carcass_mass
+
+ def update_carcass_pool(self, carcass_mass: float, carcass_pool: DecayPool) -> None:
+ """Updates the carcass pool based on consumed mass and predator's efficiency.
+
+ Args:
+ carcass_mass: The total mass consumed from the prey cohort.
+ carcass_pool: The pool to which remains of eaten individuals are delivered.
+ """
+
+ # Update the carcass pool with the remainder
+ carcass_pool.scavengeable_energy += (
+ 1 - self.decay_fraction_carcasses
+ ) * carcass_mass
+ carcass_pool.decomposed_energy += self.decay_fraction_carcasses * carcass_mass
+
+ def get_eaten(
+ self,
+ potential_consumed_mass: float,
+ predator: Consumer,
+ carcass_pool: DecayPool,
+ ) -> float:
+ """Removes individuals according to mass demands of a predation event.
+
+ It finds the smallest whole number of prey required to satisfy the predators
+ mass demands and caps at then caps it at the available population.
+
+ Args:
+ potential_consumed_mass: The mass intended to be consumed by the predator.
+ predator: The predator consuming the cohort.
+ carcass_pool: The pool to which remains of eaten individuals are delivered.
+
+ Returns:
+ The actual mass consumed by the predator, closely matching consumed_mass.
+ """
+
+ # Mass of an average individual in the cohort
+ individual_mass = self.mass_current
+
+ max_individuals_killed = ceil(potential_consumed_mass / individual_mass)
+ actual_individuals_killed = min(max_individuals_killed, self.individuals)
+
+ # Calculate the mass represented by the individuals actually killed
+ actual_mass_killed = actual_individuals_killed * individual_mass
+
+ # Calculate the actual amount of mass consumed by the predator
+ actual_mass_consumed = min(actual_mass_killed, potential_consumed_mass)
+
+ # Calculate the amount of mass that goes into carcass pool
+ carcass_mass = (actual_mass_killed - actual_mass_consumed) + (
+ actual_mass_consumed * (1 - predator.functional_group.mechanical_efficiency)
+ )
+
+ # Update the number of individuals in the prey cohort
+ self.individuals -= actual_individuals_killed
+
+ # Update the carcass pool with carcass mass
+ self.update_carcass_pool(carcass_mass, carcass_pool)
+
+ return actual_mass_consumed
+
+ def calculate_alpha(self) -> float:
+ """Calculate search efficiency.
+
+ This utilizes the alpha_i_k scaling function to determine the effective rate at
+ which an individual herbivore searches its environment, factoring in the
+ herbivore's current mass.
+
+ TODO: update name
+
+ Returns:
+ A float representing the search efficiency rate in [ha/(day*g)].
+ """
+
+ return sf.alpha_i_k(self.constants.alpha_0_herb, self.mass_current)
+
+ def calculate_potential_consumed_biomass(
+ self, target_plant: Resource, alpha: float
+ ) -> float:
+ """Calculate potential consumed biomass for the target plant.
+
+ This method computes the potential consumed biomass based on the search
+ efficiency (alpha),the fraction of the total plant stock available to the cohort
+ (phi), and the biomass of the target plant.
+
+ TODO: give A_cell a grid size reference
+
+ Args:
+ target_plant: The plant resource being targeted by the herbivore cohort.
+ alpha: The search efficiency rate of the herbivore cohort.
+
+ Returns:
+ A float representing the potential consumed biomass of the target plant by
+ the cohort [g/day].
+ """
+
+ phi = self.functional_group.constants.phi_herb_t
+ A_cell = 1.0 # temporary
+ return sf.k_i_k(alpha, phi, target_plant.mass_current, A_cell)
+
+ def calculate_total_handling_time_for_herbivory(
+ self, plant_list: Sequence[Resource], alpha: float
+ ) -> float:
+ """Calculate total handling time across all plant resources.
+
+ This aggregates the handling times for consuming each plant resource in the
+ list, incorporating the search efficiency and other scaling factors to compute
+ the total handling time required by the cohort.
+
+ TODO: give A_cell a grid size reference.
+
+ Args:
+ plant_list: A sequence of plant resources available for consumption by the
+ cohort.
+ alpha: The search efficiency rate of the herbivore cohort.
+
+ Returns:
+ A float representing the total handling time in days required by the cohort
+ for all available plant resources.
+ """
+
+ phi = self.functional_group.constants.phi_herb_t
+ A_cell = 1.0 # temporary
+ return sum(
+ sf.k_i_k(alpha, phi, plant.mass_current, A_cell)
+ + sf.H_i_k(
+ self.constants.h_herb_0,
+ self.constants.M_herb_ref,
+ self.mass_current,
+ self.constants.b_herb,
+ )
+ for plant in plant_list
+ )
+
+ def F_i_k(self, plant_list: Sequence[Resource], target_plant: Resource) -> float:
+ """Method to determine instantaneous herbivory rate on plant k.
+
+ This method integrates the calculated search efficiency, potential consumed
+ biomass of the target plant, and the total handling time for all available
+ plant resources to determine the rate at which the target plant is consumed by
+ the cohort.
+
+ TODO: update name
+
+ Args:
+ plant_list: A sequence of plant resources available for consumption by the
+ cohort.
+ target_plant: The specific plant resource being targeted by the herbivore
+ cohort for consumption.
+
+ Returns:
+ The instantaneous consumption rate [g/day] of the target plant resource by
+ the herbivore cohort.
+ """
+ alpha = self.calculate_alpha()
+ k = self.calculate_potential_consumed_biomass(target_plant, alpha)
+ total_handling_t = self.calculate_total_handling_time_for_herbivory(
+ plant_list, alpha
+ )
+ B_k = target_plant.mass_current # current plant biomass
+ N = self.individuals # herb cohort size
+ return N * (k / (1 + total_handling_t)) * (1 / B_k)
+
+ def calculate_theta_opt_i(self) -> float:
+ """Calculate the optimal predation param based on predator-prey mass ratio.
+
+ TODO: update name
+
+ Returns:
+ Float value of the optimal predation parameter for use in calculating the
+ probability of a predation event being successful.
+
+ """
+ return sf.theta_opt_i(
+ self.constants.theta_opt_min_f,
+ self.constants.theta_opt_f,
+ self.constants.sigma_opt_f,
+ )
+
+ def calculate_predation_success_probability(self, M_target: float) -> float:
+ """Calculate the probability of a successful predation event.
+
+ Args:
+ M_target: the body mass of the animal cohort being targeted for predation.
+
+ Returns:
+ A float value of the probability that a predation event is successful.
+
+ """
+ M_i = self.mass_current
+ theta_opt_i = self.calculate_theta_opt_i()
+ return sf.w_bar_i_j(
+ M_i,
+ M_target,
+ theta_opt_i,
+ self.constants.sigma_opt_pred_prey,
+ )
+
+ def calculate_predation_search_rate(self, w_bar: float) -> float:
+ """Calculate the search rate of the predator.
+
+ Args:
+ w_bar: Probability of successfully capturing prey.
+
+ Returns:
+ A float value of the search rate in ha/day
+
+ """
+ return sf.alpha_i_j(self.constants.alpha_0_pred, self.mass_current, w_bar)
+
+ def calculate_potential_prey_consumed(
+ self, alpha: float, theta_i_j: float
+ ) -> float:
+ """Calculate the potential number of prey consumed.
+
+ TODO: give A_cell a grid size reference
+
+ Args:
+ alpha: the predation search rate
+ theta_i_j: The cumulative density of organisms with a mass lying within the
+ same predator specific mass bin.
+
+ Returns:
+ The potential number of prey items consumed.
+
+ """
+ A_cell = 1.0 # temporary
+ return sf.k_i_j(alpha, self.individuals, A_cell, theta_i_j)
+
+ def calculate_total_handling_time_for_predation(self) -> float:
+ """Calculate the total handling time for preying on available animal cohorts.
+
+ Returns:
+ A float value of handling time in days.
+
+ """
+ return sf.H_i_j(
+ self.constants.h_pred_0,
+ self.constants.M_pred_ref,
+ self.mass_current,
+ self.constants.b_pred,
+ )
+
+ def F_i_j_individual(
+ self, animal_list: Sequence[AnimalCohort], target_cohort: AnimalCohort
+ ) -> float:
+ """Method to determine instantaneous predation rate on cohort j.
+
+ Args:
+ animal_list: A sequence of animal cohorts that can be consumed by the
+ predator.
+ target_cohort: The prey cohort from which mass will be consumed.
+
+ Returns:
+ Float fraction of target cohort consumed per day.
+
+
+ """
+ w_bar = self.calculate_predation_success_probability(target_cohort.mass_current)
+ alpha = self.calculate_predation_search_rate(w_bar)
+ theta_i_j = self.theta_i_j(animal_list) # Assumes implementation of theta_i_j
+ k_target = self.calculate_potential_prey_consumed(alpha, theta_i_j)
+ total_handling_t = self.calculate_total_handling_time_for_predation()
+ N_i = self.individuals
+ N_target = target_cohort.individuals
+
+ return N_i * (k_target / (1 + total_handling_t)) * (1 / N_target)
+
+ def calculate_consumed_mass_predation(
+ self, animal_list: Sequence[AnimalCohort], target_cohort: AnimalCohort
+ ) -> float:
+ """Calculates the mass to be consumed from a prey cohort by the predator.
+
+ This method utilizes the F_i_j_individual method to determine the rate at which
+ the target cohort is consumed, and then calculates the actual mass to be
+ consumed based on this rate and other model parameters.
+
+ TODO: Replace delta_t with time step reference
+
+ Args:
+ animal_list: A sequence of animal cohorts that can be consumed by the
+ predator.
+ target_cohort: The prey cohort from which mass will be consumed.
+
+ Returns:
+ The mass to be consumed from the target cohort by the predator (in kg).
+ """
+ F = self.F_i_j_individual(animal_list, target_cohort)
+ delta_t = 30.0 # days
+
+ # Calculate the consumed mass based on Mad. formula for delta_mass_predation
+ consumed_mass = (
+ target_cohort.mass_current
+ * target_cohort.individuals
+ * (
+ 1
+ - exp(-(F * delta_t * self.constants.tau_f * self.constants.sigma_f_t))
+ )
+ )
+
+ return consumed_mass
+
+ def delta_mass_predation(
+ self,
+ animal_list: Sequence[AnimalCohort],
+ excrement_pool: DecayPool,
+ carcass_pool: CarcassPool,
+ ) -> float:
+ """This method handles mass assimilation from predation.
+
+ This is Madingley's delta_assimilation_mass_predation
+
+ Args:
+ animal_list: A sequence of animal cohorts that can be consumed by the
+ predator.
+ excrement_pool: A pool representing the excrement in the grid cell.
+ carcass_pool: A pool representing the animal carcasses in the grid cell.
+
+ Returns:
+ The change in mass experienced by the predator.
+ """
+
+ total_consumed_mass = 0.0 # Initialize the total consumed mass
+
+ for cohort in animal_list:
+ # Calculate the mass to be consumed from this cohort
+ consumed_mass = self.calculate_consumed_mass_predation(animal_list, cohort)
+ # Call get_eaten on the prey cohort to update its mass and individuals
+ actual_consumed_mass = cohort.get_eaten(consumed_mass, self, carcass_pool)
+ # Update total mass gained by the predator
+ total_consumed_mass += actual_consumed_mass
+
+ # Process waste generated from predation, separate from herbivory b/c diff waste
+ self.defecate(excrement_pool, total_consumed_mass)
+ return total_consumed_mass
+
+ def calculate_consumed_mass_herbivory(
+ self, plant_list: Sequence[Resource], target_plant: Resource
+ ) -> float:
+ """Calculates the mass to be consumed from a plant resource by the herbivore.
+
+ This method utilizes the F_i_k method to determine the rate at which the target
+ plant is consumed, and then calculates the actual mass to be consumed based on
+ this rate and other model parameters.
+
+ TODO: Replace delta_t with actual time step reference
+
+ Args:
+ plant_list: A sequence of plant resources that can be consumed by the
+ herbivore.
+ target_plant: The plant resource from which mass will be consumed.
+
+ Returns:
+ The mass to be consumed from the target plant by the herbivore (in kg).
+ """
+ F = self.F_i_k(plant_list, target_plant) # Adjusting this call as necessary
+ delta_t = 30.0 # days
+
+ consumed_mass = target_plant.mass_current * (
+ 1 - exp(-(F * delta_t * self.constants.tau_f * self.constants.sigma_f_t))
+ )
+ return consumed_mass
+
+ def delta_mass_herbivory(
+ self, plant_list: Sequence[Resource], excrement_pool: DecayPool
+ ) -> float:
+ """This method handles mass assimilation from herbivory.
+
+ TODO: update name
+
+ Args:
+ plant_list: A sequence of plant resources available for herbivory.
+ excrement_pool: A pool representing the excrement in the grid cell.
+
+ Returns:
+ A float of the total plant mass consumed by the animal cohort in g.
+
+ """
+ total_consumed_mass = 0.0 # Initialize the total consumed mass
+
+ for plant in plant_list:
+ # Calculate the mass to be consumed from this plant
+ consumed_mass = self.calculate_consumed_mass_herbivory(plant_list, plant)
+ # Update the plant resource's state based on consumed mass
+ actual_consumed_mass = plant.get_eaten(consumed_mass, self, excrement_pool)
+ # Update total mass gained by the herbivore
+ total_consumed_mass += actual_consumed_mass
+
+ return total_consumed_mass
+
+ def forage_cohort(
+ self,
+ plant_list: Sequence[Resource],
+ animal_list: Sequence[AnimalCohort],
+ excrement_pool: DecayPool,
+ carcass_pool: CarcassPool,
+ ) -> None:
+ """This function handles selection of resources from a list for consumption.
+
+ Args:
+ plant_list: A sequence of plant resources available for herbivory.
+ animal_list: A sequence of animal cohorts available for predation.
+ excrement_pool: A pool representing the excrement in the grid cell.
+ carcass_pool: A pool representing the carcasses in the grid cell.
+
+ Return:
+ A float value of the net change in consumer mass due to foraging.
+ """
+ if self.individuals == 0:
+ LOGGER.warning("No individuals in cohort to forage.")
+ return
+
+ # Herbivore diet
+ if self.functional_group.diet == DietType.HERBIVORE and plant_list:
+ consumed_mass = self.delta_mass_herbivory(
+ plant_list, excrement_pool
+ ) # Directly modifies the plant mass
+ self.eat(consumed_mass) # Accumulate net mass gain from each plant
+
+ # Carnivore diet
+ elif self.functional_group.diet == DietType.CARNIVORE and animal_list:
+ # Calculate the mass gained from predation
+ consumed_mass = self.delta_mass_predation(
+ animal_list, excrement_pool, carcass_pool
+ )
+ # Update the predator's mass with the total gained mass
+ self.eat(consumed_mass)
+
+ def theta_i_j(self, animal_list: Sequence[AnimalCohort]) -> float:
+ """Cumulative density method for delta_mass_predation.
+
+ The cumulative density of organisms with a mass lying within the same predator
+ specific mass bin as Mi.
+
+ Madingley
+
+ TODO: current format makes no sense, dig up the details in the supp
+ TODO: update A_cell with real reference to grid zie
+ TODO: update name
+
+ Args:
+ animal_list: A sequence of animal cohorts that can be consumed by the
+ predator.
+
+ Returns:
+ The float value of theta.
+ """
+ A_cell = 1.0 # temporary
+
+ return sum(
+ cohort.individuals / A_cell
+ for cohort in animal_list
+ if self.mass_current == cohort.mass_current
+ )
+
+ def eat(self, mass_consumed: float) -> None:
+ """Handles the mass gain from consuming food.
+
+ This method updates the consumer's mass based on the amount of food consumed.
+ It assumes the `mass_consumed` has already been calculated and processed
+ through `get_eaten`.
+
+ TODO: non-reproductive functional groups should not store any reproductive mass
+
+ Args:
+ mass_consumed: The mass consumed by this consumer, calculated externally.
+
+ Returns:
+ The amount of consumed mass, adjusted for efficiency and used for waste
+ output.
+ """
+ if self.individuals == 0:
+ return
+
+ # Adjust mass gain based on the consumer's current mass and reproductive
+ # threshold
+ if self.is_below_mass_threshold(
+ self.constants.flow_to_reproductive_mass_threshold
+ ):
+ self.mass_current += mass_consumed # Gains to reproductive or body mass
+ else:
+ self.reproductive_mass += mass_consumed
+
+ def is_below_mass_threshold(self, mass_threshold: float) -> bool:
+ """Check if cohort's total mass is below a certain threshold.
+
+ Currently used for thesholding: birth, dispersal, trophic flow to reproductive
+ mass.
+
+ Args:
+ mass_threshold: a float value holding a threshold ratio of current total
+ mass to standard adult mass.
+
+ Return:
+ A bool of whether the current mass state is above the migration threshold.
+ """
+ return (
+ self.mass_current + self.reproductive_mass
+ ) / self.functional_group.adult_mass < mass_threshold
+
+ def migrate_juvenile_probability(self) -> float:
+ """The probability that a juvenile cohort will migrate to a new grid cell.
+
+ TODO: This does not hold for diagonal moves or non-square grids.
+ TODO: update A_cell to grid size reference
+
+ Following Madingley's assumption that the probability of juvenile dispersal is
+ equal to the proportion of the cohort individuals that would arrive in the
+ neighboring cell after one full timestep's movement.
+
+ Assuming cohort individuals are homogenously distributed within a grid cell and
+ that the move is non-diagonal, the probability is then equal to the ratio of
+ dispersal speed to the side-length of a grid cell.
+
+ A homogenously distributed cohort with a partial presence in a grid cell will
+ have a proportion of its individuals in the new grid cell equal to the
+ proportion the new grid cell that it occupies (A_new / A_cell). This proportion
+ will be equal to the cohorts velocity (V) multiplied by the elapsed time (t)
+ multiplied by the length of one side of a grid cell (L) (V*t*L) (t is assumed
+ to be 1 here). The area of the square grid cell is the square of the length of
+ one side. The proportion of individuals in the new cell is then:
+ A_new / A_cell = (V * T * L) / (L * L) = ((L/T) * T * L) / (L * L ) =
+ dimensionless
+ [m2 / m2 = (m/d * d * m) / (m * m) = m / m = dimensionless]
+
+ Returns:
+ The probability of diffusive natal dispersal to a neighboring grid cell.
+
+ """
+
+ A_cell = 1.0 # temporary
+ grid_side = sqrt(A_cell)
+ velocity = sf.juvenile_dispersal_speed(
+ self.mass_current,
+ self.constants.V_disp,
+ self.constants.M_disp_ref,
+ self.constants.o_disp,
+ )
+
+ # not a true probability as can be > 1, reduced to 1.0 in return statement
+ probability_of_dispersal = velocity / grid_side
+
+ return min(1.0, probability_of_dispersal)
+
+ def inflict_non_predation_mortality(
+ self, dt: float, carcass_pool: CarcassPool
+ ) -> None:
+ """Inflict combined background, senescence, and starvation mortalities.
+
+ TODO: Review logic of mass_max = adult_mass
+ TODO: Review the use of ceil in number_dead, it fails for large animals.
+
+ Args:
+ dt: The time passed in the timestep (days).
+ carcass_pool: The local carcass pool to which dead individuals go.
+
+ """
+
+ pop_size = self.individuals
+ mass_current = self.mass_current
+
+ t_to_maturity = self.time_to_maturity
+ t_since_maturity = self.time_since_maturity
+ mass_max = self.functional_group.adult_mass # this might not be only solution
+
+ u_bg = sf.background_mortality(
+ self.constants.u_bg
+ ) # constant background mortality
+
+ u_se = 0.0
+ if self.is_mature:
+ # senescence mortality is only experienced by mature adults.
+ u_se = sf.senescence_mortality(
+ self.constants.lambda_se, t_to_maturity, t_since_maturity
+ ) # senesence mortality
+ elif self.is_mature is False:
+ u_se = 0.0
+
+ u_st = sf.starvation_mortality(
+ self.constants.lambda_max,
+ self.constants.J_st,
+ self.constants.zeta_st,
+ mass_current,
+ mass_max,
+ ) # starvation mortality
+ u_t = u_bg + u_se + u_st
+
+ # Calculate the total number of dead individuals
+ number_dead = ceil(pop_size * (1 - exp(-u_t * dt)))
+
+ # Remove the dead individuals from the cohort
+ self.die_individual(number_dead, carcass_pool)
diff --git a/virtual_ecosystem/models/animal/animal_communities.py b/virtual_ecosystem/models/animal/animal_communities.py
new file mode 100644
index 000000000..089f32054
--- /dev/null
+++ b/virtual_ecosystem/models/animal/animal_communities.py
@@ -0,0 +1,429 @@
+"""The ''animal'' module provides animal module functionality.
+
+Notes:
+- assume each grid = 1 km2
+- assume each tick = 1 day (28800s)
+- damuth ~ 4.23*mass**(-3/4) indiv / km2
+"""
+
+from __future__ import annotations
+
+import random
+from collections.abc import Callable, Iterable
+from itertools import chain
+from math import ceil
+
+from numpy import timedelta64
+
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.core.logger import LOGGER
+from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+from virtual_ecosystem.models.animal.animal_traits import DevelopmentType
+from virtual_ecosystem.models.animal.constants import AnimalConsts
+from virtual_ecosystem.models.animal.decay import CarcassPool, ExcrementPool
+from virtual_ecosystem.models.animal.functional_group import (
+ FunctionalGroup,
+ get_functional_group_by_name,
+)
+from virtual_ecosystem.models.animal.plant_resources import PlantResources
+from virtual_ecosystem.models.animal.scaling_functions import damuths_law
+
+
+class AnimalCommunity:
+ """This is a class for the animal community of a grid cell.
+
+ This class manages the animal cohorts present in a grid cell and provides methods
+ that need to loop over all cohorts, move cohorts to new grids, or manage an
+ interaction between two cohorts.
+
+ Args:
+ functional_groups: A list of FunctionalGroup objects
+ data: The core data object
+ community_key: The integer key of the cell id for this community
+ neighbouring_keys: A list of cell id keys for neighbouring communities
+ get_destination: A function to return a destination AnimalCommunity for
+ migration.
+ """
+
+ def __init__(
+ self,
+ functional_groups: list[FunctionalGroup],
+ data: Data,
+ community_key: int,
+ neighbouring_keys: list[int],
+ get_destination: Callable[[int], AnimalCommunity],
+ constants: AnimalConsts = AnimalConsts(),
+ ) -> None:
+ # The constructor of the AnimalCommunity class.
+ self.data = data
+ """A reference to the core data object."""
+ self.functional_groups = tuple(functional_groups)
+ """A list of all FunctionalGroup types in the model."""
+ self.community_key = community_key
+ """Integer designation of the community in the model grid."""
+ self.neighbouring_keys = neighbouring_keys
+ """List of integer keys of neighbouring communities."""
+ self.get_destination = get_destination
+ """Callable get_destination from AnimalModel."""
+ self.constants = constants
+ """Animal constants."""
+
+ self.animal_cohorts: dict[str, list[AnimalCohort]] = {
+ k.name: [] for k in self.functional_groups
+ }
+ """A dictionary of lists of animal cohort keyed by functional group."""
+ self.carcass_pool: CarcassPool = CarcassPool(10000.0, 0.0)
+ """A pool for animal carcasses within the community."""
+ self.excrement_pool: ExcrementPool = ExcrementPool(10000.0, 0.0)
+ """A pool for excrement within the community."""
+
+ @property
+ def all_animal_cohorts(self) -> Iterable[AnimalCohort]:
+ """Get an iterable of all animal cohorts in the community.
+
+ This property provides access to all the animal cohorts contained
+ within this community class.
+
+ Returns:
+ Iterable[AnimalCohort]: An iterable of AnimalCohort objects.
+ """
+ return chain.from_iterable(self.animal_cohorts.values())
+
+ def populate_community(self) -> None:
+ """This function creates an instance of each functional group.
+
+ Currently, this is the simplest implementation of populating the animal model.
+ In each AnimalCommunity one AnimalCohort of each FunctionalGroup type is
+ generated. So the more functional groups that are made, the denser the animal
+ community will be. This function will need to be reworked dramatically later on.
+
+ Currently, the number of individuals in a cohort is handled using Damuth's Law,
+ which only holds for mammals.
+
+ TODO: Move populate_community to following Madingley instead of damuth
+
+ """
+ for functional_group in self.functional_groups:
+ individuals = damuths_law(
+ functional_group.adult_mass, functional_group.damuths_law_terms
+ )
+
+ cohort = AnimalCohort(
+ functional_group,
+ functional_group.adult_mass,
+ 0.0,
+ individuals,
+ self.constants,
+ )
+ self.animal_cohorts[functional_group.name].append(cohort)
+
+ def migrate(self, migrant: AnimalCohort, destination: AnimalCommunity) -> None:
+ """Function to move an AnimalCohort between AnimalCommunity objects.
+
+ This function should take a cohort and a destination community and then pop the
+ cohort from this community to the destination.
+
+ TODO: travel distance should be a function of body-size or locomotion once
+ multi-grid occupancy is integrated.
+
+ Args:
+ migrant: The AnimalCohort moving between AnimalCommunities.
+ destination: The AnimalCommunity the cohort is moving to.
+
+ """
+
+ self.animal_cohorts[migrant.name].remove(migrant)
+ destination.animal_cohorts[migrant.name].append(migrant)
+
+ def migrate_community(self) -> None:
+ """This handles migrating all cohorts in a community.
+
+ This migration method initiates migration for two reasons:
+ 1) The cohort is starving and needs to move for a chance at resource access
+ 2) An initial migration event immediately after birth.
+
+ """
+ for cohort in self.all_animal_cohorts:
+ migrate = cohort.is_below_mass_threshold(
+ self.constants.dispersal_mass_threshold
+ ) or (
+ cohort.age == 0.0
+ and random.random() <= cohort.migrate_juvenile_probability()
+ )
+
+ if not migrate:
+ return
+
+ destination_key = random.choice(self.neighbouring_keys)
+ destination = self.get_destination(destination_key)
+ self.migrate(cohort, destination)
+
+ def remove_dead_cohort(self, cohort: AnimalCohort) -> None:
+ """Remove a dead cohort from a community.
+
+ Args:
+ cohort: The AnimalCohort instance that has lost all individuals.
+
+ """
+
+ if not cohort.is_alive:
+ self.animal_cohorts[cohort.name].remove(cohort)
+ elif cohort.is_alive:
+ LOGGER.exception("An animal cohort which is alive cannot be removed.")
+
+ def remove_dead_cohort_community(self) -> None:
+ """This handles remove_dead_cohort for all cohorts in a community."""
+ for cohort in chain.from_iterable(self.animal_cohorts.values()):
+ if cohort.individuals <= 0:
+ cohort.is_alive = False
+ self.remove_dead_cohort(cohort)
+
+ def birth(self, parent_cohort: AnimalCohort) -> None:
+ """Produce a new AnimalCohort through reproduction.
+
+ A cohort can only reproduce if it has an excess of reproductive mass above a
+ certain threshold. The offspring will be an identical cohort of adults
+ with age 0 and mass=birth_mass.
+
+ The science here follows Madingley.
+
+ TODO: Check whether Madingley discards excess reproductive mass.
+ TODO: Rework birth mass for indirect developers.
+
+ Args:
+ parent_cohort: The AnimalCohort instance which is producing a new cohort.
+ """
+ # semelparous organisms use a portion of their non-reproductive mass to make
+ # offspring and then they die
+ non_reproductive_mass_loss = 0.0
+ if parent_cohort.functional_group.reproductive_type == "semelparous":
+ non_reproductive_mass_loss = (
+ parent_cohort.mass_current
+ * parent_cohort.constants.semelparity_mass_loss
+ )
+ parent_cohort.mass_current -= non_reproductive_mass_loss
+ # kill the semelparous parent cohort
+ parent_cohort.is_alive = False
+
+ number_offspring = (
+ int(
+ (parent_cohort.reproductive_mass + non_reproductive_mass_loss)
+ / parent_cohort.functional_group.birth_mass
+ )
+ * parent_cohort.individuals
+ )
+
+ # reduce reproductive mass by amount used to generate offspring
+ parent_cohort.reproductive_mass = 0.0
+
+ offspring_cohort = AnimalCohort(
+ get_functional_group_by_name(
+ self.functional_groups,
+ parent_cohort.functional_group.offspring_functional_group,
+ ),
+ parent_cohort.functional_group.birth_mass,
+ 0.0,
+ number_offspring,
+ self.constants,
+ )
+
+ # add a new cohort of the parental type to the community
+ self.animal_cohorts[parent_cohort.name].append(offspring_cohort)
+
+ if parent_cohort.functional_group.reproductive_type == "semelparous":
+ self.remove_dead_cohort(parent_cohort)
+
+ def birth_community(self) -> None:
+ """This handles birth for all cohorts in a community."""
+
+ # reproduction occurs for cohorts with sufficient reproductive mass
+ for cohort in self.all_animal_cohorts:
+ if (
+ not cohort.is_below_mass_threshold(self.constants.birth_mass_threshold)
+ and cohort.functional_group.reproductive_type != "nonreproductive"
+ ):
+ self.birth(cohort)
+
+ def forage_community(self) -> None:
+ """This function organizes the foraging of animal cohorts.
+
+ It loops over every animal cohort in the community and calls the
+ forage_cohort function with a list of suitable trophic resources. This action
+ initiates foraging for those resources, with mass transfer details handled
+ internally by forage_cohort and its helper functions. Future expansions may
+ include functions for handling scavenging and soil consumption behaviors.
+
+ Cohorts with no remaining individuals post-foraging are marked for death.
+ """
+ # Generate the plant resources for foraging.
+ plant_community: PlantResources = PlantResources(
+ data=self.data,
+ cell_id=self.community_key,
+ constants=self.constants,
+ )
+
+ plant_list = [plant_community]
+
+ for consumer_cohort in self.all_animal_cohorts:
+ # Prepare the prey list for the consumer cohort
+ prey_list = self.collect_prey(consumer_cohort)
+
+ # Initiate foraging for the consumer cohort with the prepared resources
+ consumer_cohort.forage_cohort(
+ plant_list=plant_list,
+ animal_list=prey_list,
+ excrement_pool=self.excrement_pool,
+ carcass_pool=self.carcass_pool,
+ )
+
+ # Check if the cohort has been depleted to zero individuals post-foraging
+ if consumer_cohort.individuals == 0:
+ self.remove_dead_cohort(consumer_cohort)
+
+ def collect_prey(self, consumer_cohort: AnimalCohort) -> list[AnimalCohort]:
+ """Collect suitable prey for a given consumer cohort.
+
+ This is a helper function for forage_community to isolate the prey selection
+ functionality.
+
+ Args:
+ consumer_cohort: The AnimalCohort for which a prey list is being collected
+
+ Returns:
+ A list of AnimalCohorts that can be preyed upon.
+
+ """
+ prey: list = []
+ for (
+ prey_functional_group,
+ potential_prey_cohorts,
+ ) in self.animal_cohorts.items():
+ # Skip if this functional group is not a prey of current predator
+ if prey_functional_group not in consumer_cohort.prey_groups:
+ continue
+
+ # Get the size range of the prey this predator eats
+ min_size, max_size = consumer_cohort.prey_groups[prey_functional_group]
+
+ # Filter the potential prey cohorts based on their size
+ for cohort in potential_prey_cohorts:
+ if (
+ min_size <= cohort.mass_current <= max_size
+ and cohort.individuals != 0
+ and cohort is not consumer_cohort
+ ):
+ prey.append(cohort)
+
+ return prey
+
+ def metabolize_community(self, temperature: float, dt: timedelta64) -> None:
+ """This handles metabolize for all cohorts in a community.
+
+ This method generates a total amount of metabolic waste per cohort and passes
+ that waste to handler methods for distinguishing between nitrogenous and
+ carbonaceous wastes as they need depositing in different pools. This will not
+ be fully implemented until the stoichiometric rework.
+
+ Respiration wastes are totaled because they are CO2 and not tracked spatially.
+ Excretion wastes are handled cohort by cohort because they will need to be
+ spatially explicit with multi-grid occupancy.
+
+ TODO: Rework with stoichiometry
+
+ Args:
+ temperature: Current air temperature (K).
+ dt: Number of days over which the metabolic costs should be calculated.
+
+ """
+ total_carbonaceous_waste = 0.0
+
+ for cohort in self.all_animal_cohorts:
+ metabolic_waste_mass = cohort.metabolize(temperature, dt)
+ total_carbonaceous_waste += cohort.respire(metabolic_waste_mass)
+ cohort.excrete(
+ metabolic_waste_mass,
+ self.excrement_pool,
+ )
+
+ # Update the total_animal_respiration for this community using community_key.
+
+ self.data["total_animal_respiration"].loc[{"cell_id": self.community_key}] += (
+ total_carbonaceous_waste
+ )
+
+ def increase_age_community(self, dt: timedelta64) -> None:
+ """This handles age for all cohorts in a community.
+
+ Args:
+ dt: Number of days over which the metabolic costs should be calculated.
+
+ """
+ for cohort in self.all_animal_cohorts:
+ cohort.increase_age(dt)
+
+ def inflict_non_predation_mortality_community(self, dt: timedelta64) -> None:
+ """This handles natural mortality for all cohorts in a community.
+
+ This includes background mortality, starvation, and, for mature cohorts,
+ senescence.
+
+ Args:
+ dt: Number of days over which the metabolic costs should be calculated.
+
+ """
+ number_of_days = float(dt / timedelta64(1, "D"))
+ for cohort in self.all_animal_cohorts:
+ cohort.inflict_non_predation_mortality(number_of_days, self.carcass_pool)
+ if cohort.individuals <= 0:
+ cohort.is_alive = False
+ self.remove_dead_cohort(cohort)
+
+ def metamorphose(self, larval_cohort: AnimalCohort) -> None:
+ """This transforms a larval status cohort into an adult status cohort.
+
+ This method takes an indirect developing cohort in its larval form,
+ inflicts a mortality rate, and creates an adult cohort of the correct type.
+
+ TODO: Build in a relationship between larval_cohort mass and adult cohort mass.
+ TODO: Is adult_mass the correct mass threshold?
+ TODO: If the time step drops below a month, this needs an intermediary stage.
+
+ Args:
+ larval_cohort: The cohort in its larval stage to be transformed.
+ """
+
+ # inflict a mortality
+ number_dead = ceil(
+ larval_cohort.individuals * larval_cohort.constants.metamorph_mortality
+ )
+ larval_cohort.die_individual(number_dead, self.carcass_pool)
+ # collect the adult functional group
+ adult_functional_group = get_functional_group_by_name(
+ self.functional_groups,
+ larval_cohort.functional_group.offspring_functional_group,
+ )
+ # create the adult cohort
+ adult_cohort = AnimalCohort(
+ adult_functional_group,
+ adult_functional_group.birth_mass,
+ 0.0,
+ larval_cohort.individuals,
+ self.constants,
+ )
+
+ # add a new cohort of the parental type to the community
+ self.animal_cohorts[adult_cohort.name].append(adult_cohort)
+
+ # remove the larval cohort
+ larval_cohort.is_alive = False
+ self.remove_dead_cohort(larval_cohort)
+
+ def metamorphose_community(self) -> None:
+ """Handle metamorphosis for all applicable cohorts in the community."""
+
+ for cohort in self.all_animal_cohorts:
+ if (
+ cohort.functional_group.development_type == DevelopmentType.INDIRECT
+ and (cohort.mass_current >= cohort.functional_group.adult_mass)
+ ):
+ self.metamorphose(cohort)
diff --git a/virtual_ecosystem/models/animals/animal_model.py b/virtual_ecosystem/models/animal/animal_model.py
similarity index 62%
rename from virtual_ecosystem/models/animals/animal_model.py
rename to virtual_ecosystem/models/animal/animal_model.py
index 7b6d2b9d4..086848bd0 100644
--- a/virtual_ecosystem/models/animals/animal_model.py
+++ b/virtual_ecosystem/models/animal/animal_model.py
@@ -1,12 +1,12 @@
-"""The :mod:`~virtual_ecosystem.models.animals.animal_model` module creates a
-:class:`~virtual_ecosystem.models.animals.animal_model.AnimalModel` class as a
+"""The :mod:`~virtual_ecosystem.models.animal.animal_model` module creates a
+:class:`~virtual_ecosystem.models.animal.animal_model.AnimalModel` class as a
child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` class.
At present a lot of the abstract methods of the parent class (e.g.
:func:`~virtual_ecosystem.core.base_model.BaseModel.setup` and
:func:`~virtual_ecosystem.core.base_model.BaseModel.spinup`) are overwritten using
placeholder functions that don't do anything. This will change as the
Virtual Ecosystem model develops. The factory method
-:func:`~virtual_ecosystem.models.animals.animal_model.AnimalModel.from_config`
+:func:`~virtual_ecosystem.models.animal.animal_model.AnimalModel.from_config`
exists in a more complete state, and unpacks a small number of parameters
from our currently pretty minimal configuration dictionary. These parameters are
then used to generate a class instance. If errors crop up here when converting the
@@ -14,14 +14,14 @@
(e.g. :class:`~numpy.timedelta64`) they are caught and then logged, and at the end
of the unpacking an error is thrown. This error should be caught and handled
by downstream functions so that all model configuration failures can be reported as one.
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
from math import sqrt
from typing import Any
-from numpy import array, timedelta64
+from numpy import array, timedelta64, zeros
from xarray import DataArray
from virtual_ecosystem.core.base_model import BaseModel
@@ -30,19 +30,24 @@
from virtual_ecosystem.core.core_components import CoreComponents
from virtual_ecosystem.core.data import Data
from virtual_ecosystem.core.logger import LOGGER
-from virtual_ecosystem.models.animals.animal_communities import AnimalCommunity
-from virtual_ecosystem.models.animals.constants import AnimalConsts
-from virtual_ecosystem.models.animals.functional_group import FunctionalGroup
+from virtual_ecosystem.models.animal.animal_cohorts import AnimalCohort
+from virtual_ecosystem.models.animal.animal_communities import AnimalCommunity
+from virtual_ecosystem.models.animal.constants import AnimalConsts
+from virtual_ecosystem.models.animal.functional_group import FunctionalGroup
class AnimalModel(
BaseModel,
- model_name="animals",
+ model_name="animal",
model_update_bounds=("1 day", "1 month"),
- required_init_vars=(),
+ vars_required_for_init=(),
+ vars_populated_by_init=("total_animal_respiration", "population_densities"),
+ vars_required_for_update=(),
+ vars_populated_by_first_update=("decomposed_excrement", "decomposed_carcasses"),
vars_updated=(
"decomposed_excrement",
"decomposed_carcasses",
+ "total_animal_respiration",
),
):
"""A class describing the animal model.
@@ -75,6 +80,8 @@ def __init__(
self._setup_grid_neighbors()
"""Determine grid square adjacency."""
+ self.functional_groups = functional_groups
+ """List of functional groups in the model."""
self.communities: dict[int, AnimalCommunity] = {}
"""Set empty dict for populating with communities."""
self.model_constants = model_constants
@@ -82,6 +89,8 @@ def __init__(
self._initialize_communities(functional_groups)
"""Create the dictionary of animal communities and populate each community with
animal cohorts."""
+ self.setup()
+ """Initialize the data variables used by the animal model."""
def _setup_grid_neighbors(self) -> None:
"""Set up grid neighbors for the model.
@@ -150,18 +159,19 @@ def from_config(
"""
# Load in the relevant constants
- model_constants = load_constants(config, "animals", "AnimalConsts")
+ model_constants = load_constants(config, "animal", "AnimalConsts")
# Load functional groups
functional_groups = [
FunctionalGroup(**k, constants=model_constants)
- for k in config["animals"]["functional_groups"]
+ for k in config["animal"]["functional_groups"]
]
LOGGER.info(
"Information required to initialise the animal model successfully "
"extracted."
)
+
return cls(
data=data,
core_components=core_components,
@@ -170,7 +180,52 @@ def from_config(
)
def setup(self) -> None:
- """Function to set up the animal model."""
+ """Method to setup the animal model specific data variables.
+
+ TODO: rename this as something else because you've used it crazy
+
+ """
+
+ # animal respiration data variable
+ # the array should have one value for each animal community
+ n_communities = len(self.data.grid.cell_id)
+
+ # Initialize total_animal_respiration as a DataArray with a single dimension:
+ # cell_id
+ total_animal_respiration = DataArray(
+ zeros(
+ n_communities
+ ), # Filled with zeros to start with no carbon production.
+ dims=["cell_id"],
+ coords={"cell_id": self.data.grid.cell_id},
+ name="total_animal_respiration",
+ )
+
+ # Add total_animal_respiration to the Data object.
+ self.data["total_animal_respiration"] = total_animal_respiration
+
+ # Population density data variable
+ functional_group_names = [fg.name for fg in self.functional_groups]
+
+ # Assuming self.communities is a dict with community_id as keys
+ community_ids = list(self.communities.keys())
+
+ # Create a multi-dimensional array for population densities
+ population_densities = DataArray(
+ zeros((len(community_ids), len(functional_group_names)), dtype=float),
+ dims=["community_id", "functional_group_id"],
+ coords={
+ "community_id": community_ids,
+ "functional_group_id": functional_group_names,
+ },
+ name="population_densities",
+ )
+
+ # Add to Data object
+ self.data["population_densities"] = population_densities
+
+ # initialize values
+ self.update_population_densities()
def spinup(self) -> None:
"""Placeholder function to spin up the animal model."""
@@ -178,24 +233,30 @@ def spinup(self) -> None:
def update(self, time_index: int, **kwargs: Any) -> None:
"""Function to step the animal model through time.
- Currently this is a toy implementation.
+ This method sets the order of operations for the animal module. In nature, these
+ events would be simultaneous. The ordering within the method is less a question
+ of the science and more a question of computational logic and stability.
+
+
Args:
time_index: The index representing the current time step in the data object.
+ **kwargs: Further arguments to the update method.
"""
for community in self.communities.values():
community.forage_community()
community.migrate_community()
community.birth_community()
+ community.metamorphose_community()
community.metabolize_community(
float(self.data["air_temperature"][0][community.community_key].values),
self.update_interval_timedelta,
)
- community.inflict_natural_mortality_community(
+ community.inflict_non_predation_mortality_community(
self.update_interval_timedelta
)
- community.die_cohort_community()
+ community.remove_dead_cohort_community()
community.increase_age_community(self.update_interval_timedelta)
# Now that communities have been updated information required to update the
@@ -205,6 +266,9 @@ def update(self, time_index: int, **kwargs: Any) -> None:
# Update the litter pools
self.data.add_from_dict(additions_to_litter)
+ # Update population densities
+ self.update_population_densities()
+
def cleanup(self) -> None:
"""Placeholder function for animal model cleanup."""
@@ -239,3 +303,41 @@ def calculate_litter_additions(self) -> dict[str, DataArray]:
dims="cell_id",
),
}
+
+ def update_population_densities(self) -> None:
+ """Updates the densities for each functional group in each community."""
+
+ for community_id, community in self.communities.items():
+ for fg_name, cohorts in community.animal_cohorts.items():
+ # Initialize the population density of the functional group
+ fg_density = 0.0
+ for cohort in cohorts:
+ # Calculate the population density for the cohort
+ fg_density += self.calculate_density_for_cohort(cohort)
+
+ # Update the corresponding entry in the data variable
+ # This update should happen once per functional group after summing
+ # all cohort densities
+ self.data["population_densities"].loc[
+ {"community_id": community_id, "functional_group_id": fg_name}
+ ] = fg_density
+
+ def calculate_density_for_cohort(self, cohort: AnimalCohort) -> float:
+ """Calculate the population density for a cohort within a specific community.
+
+ TODO: This will need to be modified for multi-grid occupancy.
+
+ Args:
+ cohort: The AnimalCohort object for which to calculate the density.
+ community_id: The identifier for the community where the cohort resides.
+
+ Returns:
+ The population density of the cohort within the community (individuals/m2).
+ """
+ # Retrieve the area of the community where the cohort resides
+ community_area = self.data.grid.cell_area
+
+ # Calculate the population density
+ population_density = cohort.individuals / community_area
+
+ return population_density
diff --git a/virtual_ecosystem/models/animal/animal_traits.py b/virtual_ecosystem/models/animal/animal_traits.py
new file mode 100644
index 000000000..c58caa678
--- /dev/null
+++ b/virtual_ecosystem/models/animal/animal_traits.py
@@ -0,0 +1,57 @@
+"""The `models.animal.animal_traits` module contains classes that organizes
+animal traits into enumerations for use by the Functional Group class in the
+:mod:`~virtual_ecosystem.models.animal.functional_group` module.
+""" # noqa: D205
+
+from enum import Enum
+
+
+class MetabolicType(Enum):
+ """Enumeration for metabolic types."""
+
+ ENDOTHERMIC = "endothermic"
+ ECTOTHERMIC = "ectothermic"
+
+
+class DietType(Enum):
+ """Enumeration for diet types."""
+
+ HERBIVORE = "herbivore"
+ CARNIVORE = "carnivore"
+
+
+class TaxaType(Enum):
+ """Enumeration for taxa types."""
+
+ MAMMAL = "mammal"
+ BIRD = "bird"
+ INSECT = "insect"
+
+
+class ReproductiveType(Enum):
+ """Enumeration for reproductive types."""
+
+ SEMELPAROUS = "semelparous"
+ ITEROPAROUS = "iteroparous"
+ NONREPRODUCTIVE = "nonreproductive"
+
+
+class DevelopmentType(Enum):
+ """Enumeration for development types."""
+
+ DIRECT = "direct"
+ INDIRECT = "indirect"
+
+
+class DevelopmentStatus(Enum):
+ """Enumeration for development status."""
+
+ LARVAL = "larval"
+ ADULT = "adult"
+
+
+class ExcretionType(Enum):
+ """Enumeration for excretion type."""
+
+ UREOTELIC = "ureotelic"
+ URICOTELIC = "uricotelic"
diff --git a/virtual_ecosystem/models/animal/constants.py b/virtual_ecosystem/models/animal/constants.py
new file mode 100644
index 000000000..4e5c3e5c4
--- /dev/null
+++ b/virtual_ecosystem/models/animal/constants.py
@@ -0,0 +1,242 @@
+"""The `models.animal.constants` module contains a set of dataclasses containing
+constants" (fitting relationships taken from the literature) required by the broader
+:mod:`~virtual_ecosystem.models.animal` module
+
+""" # noqa: D205, D415
+
+from dataclasses import dataclass, field
+
+from virtual_ecosystem.core.constants_class import ConstantsDataclass
+from virtual_ecosystem.models.animal.animal_traits import (
+ DietType,
+ MetabolicType,
+ TaxaType,
+)
+
+
+@dataclass(frozen=True)
+class AnimalConsts(ConstantsDataclass):
+ """Dataclass to store all constants related to metabolic rates.
+
+ TODO: Remove unused constants.
+
+ """
+
+ metabolic_rate_terms: dict[MetabolicType, dict[str, tuple[float, float]]] = field(
+ default_factory=lambda: {
+ # Parameters from Madingley, mass-based metabolic rates
+ MetabolicType.ENDOTHERMIC: {
+ "basal": (4.19e10, 0.69),
+ "field": (9.08e11, 0.7),
+ },
+ MetabolicType.ECTOTHERMIC: {
+ "basal": (4.19e10, 0.69),
+ "field": (1.49e11, 0.88),
+ },
+ }
+ )
+
+ damuths_law_terms: dict[TaxaType, dict[DietType, tuple[float, float]]] = field(
+ default_factory=lambda: {
+ TaxaType.MAMMAL: {
+ DietType.HERBIVORE: (-0.75, 4.23),
+ DietType.CARNIVORE: (-0.75, 1.00),
+ },
+ TaxaType.BIRD: {
+ DietType.HERBIVORE: (-0.75, 5.00),
+ DietType.CARNIVORE: (-0.75, 2.00),
+ },
+ TaxaType.INSECT: {
+ DietType.HERBIVORE: (-0.75, 5.00),
+ DietType.CARNIVORE: (-0.75, 2.00),
+ },
+ }
+ )
+
+ energy_density: dict[str, float] = field(
+ default_factory=lambda: {
+ "meat": 7000.0, # Energy of mammal meat [J/g]
+ "plant": 18200000.0, # Energy of plant food [J/g]
+ }
+ )
+
+ conversion_efficiency: dict[DietType, float] = field(
+ default_factory=lambda: {
+ DietType.HERBIVORE: 0.1, # Toy value
+ DietType.CARNIVORE: 0.25, # Toy value
+ }
+ )
+
+ mechanical_efficiency: dict[DietType, float] = field(
+ default_factory=lambda: {
+ DietType.HERBIVORE: 0.9, # Toy value
+ DietType.CARNIVORE: 0.8, # Toy value
+ }
+ )
+
+ prey_mass_scaling_terms: dict[
+ MetabolicType, dict[TaxaType, tuple[float, float]]
+ ] = field(
+ default_factory=lambda: {
+ MetabolicType.ENDOTHERMIC: {
+ TaxaType.MAMMAL: (1.0, 1.0), # Toy values
+ TaxaType.BIRD: (1.0, 1.0), # Toy values
+ },
+ MetabolicType.ECTOTHERMIC: {TaxaType.INSECT: (1.0, 1.0)}, # Toy values
+ }
+ )
+
+ birth_mass_threshold: float = 1.5 # Threshold for reproduction
+ flow_to_reproductive_mass_threshold: float = (
+ 1.0 # Threshold of trophic flow to reproductive mass
+ )
+ dispersal_mass_threshold: float = 0.8 # Threshold for dispersal
+ energy_percentile_threshold: float = 0.5 # Threshold for initiating migration
+ decay_fraction_excrement: float = 0.5 # Decay fraction for excrement
+ decay_fraction_carcasses: float = 0.2 # Decay fraction for carcasses
+
+ # Madingley Foraging Parameters
+
+ tau_f = 0.5 # tau_f
+ """Proportion of time for which functional group is active."""
+ sigma_f_t = 0.5 # sigma_f(t) - TODO: find real value
+ """Proportion of the time step in which it's suitable to be active for functional
+ group f."""
+
+ # Trophic paramters
+
+ alpha_0_herb = 1.0e-11 # alpha_herb_0 [Madingley] ha/(day*g)
+ """Effective rate per unit mass at which a herbivore searches its environment."""
+ alpha_0_pred = 1.0e-6 # alpha_pred_0 [Madingley] ha/(day*g)
+ """Effective rate per unit mass at which a predator searches its environment."""
+
+ phi_herb_t = 0.1 # phi_herb_t
+ """Fraction of the resource stock that is available to any one herbivore cohort."""
+
+ b_herb = 0.7 # ( ),b_herb)
+ """Herbivore exponent of the power-law function relating the handling time of
+ autotroph matter to herbivore mass."""
+
+ b_pred = 0.05 # Toy Values
+ """Carnivore exponent of the power-law relationship between the handling time of
+ prey and the ratio of prey to predator body mass."""
+
+ M_herb_ref = 1.0 # M_herb_ref [Madingley] g
+ """Reference mass for herbivore handling time."""
+ M_herb_0 = 0.7 # M_herb_0 [Madingley] (days)
+ """Time that it would take a herbivore of body mass equal to the reference mass,
+ to handle one gram of autotroph biomass."""
+ h_herb_0 = 0.7 # h_pred_0 [Madingley]
+ """Time that it would take a herbivore of body mass equal to the reference mass,
+ to handle one gram of autotroph biomass"""
+
+ M_pred_ref = 1.0 # toy value TODO: find real value
+ """The reference value for predator mass."""
+ sigma_opt_pred_prey = 0.7 # sigma_opt_pred-prey [Madingley]
+ """Standard deviation of the normal distribution describing realized attack rates
+ around the optimal predator-prey body mass ratio."""
+ theta_opt_min_f = 0.01 # theta_opt_min_f [Madingley]
+ """The minimum optimal prey-predator body mass ratio."""
+ theta_opt_f = 0.1 # theta_opt_f [Madingley]
+ """The mean optimal prey-predator body mass ratio, from which actual cohort optima
+ are drawn."""
+ sigma_opt_f = 0.02 # sigma_opt_f [Madingley]
+ """The standard deviation of optimal predator-prey mass ratios among cohorts."""
+ N_sigma_opt_pred_prey = 3.0 # N_sigma_opt_pred-prey [Madingley]
+ """The standard deviations of the realized attack rates around the optimal
+ predator-prey body mass ratio for which to calculate predator specific cumulative
+ prey densities."""
+ h_pred_0 = 0.5 # h_pred_0 [Madingley]
+ """Time that it would take a predator of body mass equal to the reference mass,
+ to handle a prey individual of body mass equal to one gram."""
+
+ # Activity parameters
+ m_tol = 1.6 # m_tol_terrestrial [Madingley]
+ """Slope of the relationship between monthly temperature variability and the upper
+ critical temperature limit relative to annual mean temperature, for terrestrial
+ ectothermic functional groups."""
+
+ c_tol = 6.61 # c_tol_terrestrial [Madingley] (degrees C)
+ """Intercept of the relationship between monthly temperature variability and the
+ upper critical temperature limit relative to annual mean temperature, for
+ terrestrial ectothermic functional groups."""
+
+ m_tsm = 1.53 # m_tsm [Madingley]
+ """Slope of the relationship between monthly temperature variability and the optimal
+ temperature relative to annual mean temperature, for terrestrial ectothermic
+ functional groups."""
+
+ c_tsm = 1.51 # c_tsm [Madingley] (degrees C)
+ """Intercept of the relationship between monthly temperature variability and the
+ optimal temperature relative to annual mean temperature, for terrestrial
+ ectothermic functional groups."""
+
+ # Madingley dispersal parameters
+
+ M_disp_ref = 1.0 # M_disp_ref [Madingley] [g]
+ """The reference mass for calculating diffusive juvenile dispersal in grams."""
+
+ V_disp = 0.0278 # V_disp [Madingley] [km/month]
+ """Diffusive dispersal speed on an individual of body-mass equal to M_disp_ref
+ in km/month."""
+
+ o_disp = 0.48 # o_disp [Madingley] [unitless]
+ """Power law exponent for the scaling relationship between body-mass and dispersal
+ distance as mediated by a reference mass, M_disp_ref."""
+
+ beta_responsive_bodymass = 0.8 # Beta_responsive_bodymass [unitless]
+ """Ratio of current body-mass to adult body-mass at which starvation-response
+ dispersal is attempted."""
+
+ # Madingley reproductive parameters
+ semelparity_mass_loss = 0.5 # chi [Madingley] [unitless]
+ """The proportion of non-reproductive mass lost in semelparous reproduction."""
+
+ # Madingley mortality parameters
+ u_bg = 10.0**-3.0 # u_bg [Madingley] [day^-1]
+ """The constant background mortality faced by all animal."""
+
+ lambda_se = 3.0 * 10.0**-3.0 # lambda_se [Madingley] [day^-1]
+ """The instantaneous rate of senescence mortality at the point of maturity."""
+
+ lambda_max = 1.0 # lambda_max [Madingley] [day^-1]
+ """The maximum possible instantaneous fractional starvation mortality rate."""
+
+ J_st = 0.6 # J_st [Madingley] [unitless]
+ """Determines the inflection point of the logistic function describing ratio of the
+ realised mortality rate to the maximum rate."""
+
+ zeta_st = 0.05 # zeta_st [Madingley] [unitless]
+ """The scaling of the logistic function describing the ratio of the realised
+ mortality rate to the maximum rate."""
+
+ metamorph_mortality = 0.1 # toy [unitless]
+ """The mortality proportion inflicted on a larval cohort undergoing
+ metamorphosis. """
+
+ carbon_excreta_proportion = 1.0 # toy [unitless]
+ """The proportion of metabolic wastes that are carbonaceous. This is a temporary
+ fix to facilitate building the machinery and will be updated with stoichiometry."""
+
+ nitrogen_excreta_proportion = 0.0 # toy [unitless]
+ """The proportion of metabolic wastes that are nitrogenous. This is a temporary
+ fix to facilitate building the machinery and will be updated with stoichiometry."""
+
+
+DECAY_FRACTION_EXCREMENT: float = 0.5
+"""Fraction of excrement that is assumed to decay rather than be consumed [unitless].
+
+TODO - The number given here is very much made up. In future, we either need to find a
+way of estimating this from data, or come up with a smarter way of handling this
+process.
+"""
+
+DECAY_FRACTION_CARCASSES: float = 0.2
+"""Fraction of carcass biomass that is assumed to decay rather than be consumed.
+
+[unitless]. TODO - The number given here is very much made up, see
+:attr:`DECAY_FRACTION_EXCREMENT` for details of how this should be changed in future.
+"""
+BOLTZMANN_CONSTANT: float = 8.617333262145e-5 # Boltzmann constant [eV/K]
+
+TEMPERATURE: float = 37.0 # Toy temperature for setting up metabolism [C].
diff --git a/virtual_ecosystem/models/animals/decay.py b/virtual_ecosystem/models/animal/decay.py
similarity index 95%
rename from virtual_ecosystem/models/animals/decay.py
rename to virtual_ecosystem/models/animal/decay.py
index eed7077bb..d5b0f6c74 100644
--- a/virtual_ecosystem/models/animals/decay.py
+++ b/virtual_ecosystem/models/animal/decay.py
@@ -1,7 +1,7 @@
-"""The :mod:`~virtual_ecosystem.models.animals.decay` module contains
+"""The :mod:`~virtual_ecosystem.models.animal.decay` module contains
pools which are still potentially forageable by animals but are in the process of
microbial decomposition. And the moment this consists of animal carcasses and excrement.
-""" # noqa: #D205, D415
+""" # noqa: D205
from dataclasses import dataclass
diff --git a/virtual_ecosystem/models/animals/functional_group.py b/virtual_ecosystem/models/animal/functional_group.py
similarity index 59%
rename from virtual_ecosystem/models/animals/functional_group.py
rename to virtual_ecosystem/models/animal/functional_group.py
index b7109a000..f81765fef 100644
--- a/virtual_ecosystem/models/animals/functional_group.py
+++ b/virtual_ecosystem/models/animal/functional_group.py
@@ -1,16 +1,22 @@
-"""The `models.animals.functional_group` module contains a class that organizes
+"""The `models.animal.functional_group` module contains a class that organizes
constants and rate equations used by AnimalCohorts in the
-:mod:`~virtual_ecosystem.models.animals` module.
-""" # noqa: D205, D415
+:mod:`~virtual_ecosystem.models.animal` module.
+""" # noqa: D205
+
+from collections.abc import Iterable
import pandas as pd
-from virtual_ecosystem.models.animals.animal_traits import (
+from virtual_ecosystem.models.animal.animal_traits import (
+ DevelopmentStatus,
+ DevelopmentType,
DietType,
+ ExcretionType,
MetabolicType,
+ ReproductiveType,
TaxaType,
)
-from virtual_ecosystem.models.animals.constants import AnimalConsts
+from virtual_ecosystem.models.animal.constants import AnimalConsts
class FunctionalGroup:
@@ -32,11 +38,20 @@ def __init__(
taxa: str,
diet: str,
metabolic_type: str,
+ reproductive_type: str,
+ development_type: str,
+ development_status: str,
+ offspring_functional_group: str,
+ excretion_type: str,
birth_mass: float,
adult_mass: float,
constants: AnimalConsts = AnimalConsts(),
) -> None:
- """The constructor for the FunctionalGroup class."""
+ """The constructor for the FunctionalGroup class.
+
+ TODO: Remove unused attributes.
+
+ """
self.name = name
"""The name of the functional group."""
@@ -45,7 +60,18 @@ def __init__(
self.diet = DietType(diet)
"""The diet of the functional group."""
self.metabolic_type = MetabolicType(metabolic_type)
- """The metabolic type of the functional group"""
+ """The metabolic type of the functional group."""
+ self.reproductive_type = ReproductiveType(reproductive_type)
+ """The reproductive type of the functional group."""
+ self.development_type = DevelopmentType(development_type)
+ """The development type of the functional group."""
+ self.development_status = DevelopmentStatus(development_status)
+ """The development status of the functional group."""
+ self.offspring_functional_group = offspring_functional_group
+ """The offspring type produced by this functional group in reproduction or
+ metamorphosis."""
+ self.excretion_type = ExcretionType(excretion_type)
+ """The excretion type of the functional group."""
self.birth_mass = birth_mass
"""The mass of the functional group at birth."""
self.adult_mass = adult_mass
@@ -58,12 +84,6 @@ def __init__(
"""The coefficient and exponent of metabolic rate."""
self.damuths_law_terms = self.constants.damuths_law_terms[self.taxa][self.diet]
"""The coefficient and exponent of damuth's law for population density."""
- self.muscle_mass_terms = self.constants.muscle_mass_terms[self.taxa]
- """The coefficient and exponent of muscle mass allometry."""
- self.fat_mass_terms = self.constants.fat_mass_terms[self.taxa]
- """The coefficient and exponent of fat mass allometry."""
- self.intake_rate_terms = self.constants.intake_rate_terms[self.taxa]
- """The coefficient and exponent of intake allometry."""
self.conversion_efficiency = self.constants.conversion_efficiency[self.diet]
"""The conversion efficiency of the functional group based on diet."""
self.mechanical_efficiency = self.constants.mechanical_efficiency[self.diet]
@@ -72,8 +92,6 @@ def __init__(
self.taxa
]
"""The predator-prey mass ratio scaling relationship."""
- self.longevity_scaling = self.constants.longevity_scaling_terms[self.taxa]
- """The coefficient and exponent for lifespan allometry."""
def import_functional_groups(
@@ -81,18 +99,17 @@ def import_functional_groups(
) -> list[FunctionalGroup]:
"""The function to import pre-defined functional groups.
- This function is a first-pass of how we might import pre-defined functional groups.
- The current expected csv structure is:
- - ["name", "taxa", "diet", "metabolic_type", "birth_mass", "adult_mass"]
+ This function is a first-pass of how we might import pre-defined functional groups,
the specific options of which can be found in functional_group.py.
This allows a user to set out a basic outline of functional groups that accept our
definitions of parameters and scaling relationships based on those traits.
- We will need a structure for users changing those underlying definitions but that
- can be constructed later.
+ TODO: A structure for user-selection of which traits to employ.
Args:
- csv_file: The location of the csv file holding the functional group definitions.
+ fg_csv_file: The location of the csv file holding the functional group
+ definitions.
+ constants: An object providing animal model constants.
Returns:
A list of the FunctionalGroup instances created by the import.
@@ -114,6 +131,11 @@ def import_functional_groups(
row.taxa,
row.diet,
row.metabolic_type,
+ row.reproductive_type,
+ row.development_type,
+ row.development_status,
+ row.offspring_functional_group,
+ row.excretion_type,
row.birth_mass,
row.adult_mass,
constants=constants,
@@ -122,3 +144,24 @@ def import_functional_groups(
]
return functional_group_list
+
+
+def get_functional_group_by_name(
+ functional_groups: Iterable[FunctionalGroup], name: str
+) -> FunctionalGroup:
+ """Retrieve a FunctionalGroup by its name from a tuple of FunctionalGroup instances.
+
+ Args:
+ functional_groups: Tuple of FunctionalGroup instances.
+ name: The name of the FunctionalGroup to retrieve.
+
+ Returns:
+ The FunctionalGroup instance with the matching name.
+
+ Raises:
+ ValueError: If no FunctionalGroup with the given name is found.
+ """
+ for fg in functional_groups:
+ if fg.name == name:
+ return fg
+ raise ValueError(f"No FunctionalGroup with name '{name}' found.")
diff --git a/virtual_ecosystem/models/animals/module_schema.json b/virtual_ecosystem/models/animal/module_schema.json
similarity index 71%
rename from virtual_ecosystem/models/animals/module_schema.json
rename to virtual_ecosystem/models/animal/module_schema.json
index a77d5415a..9d51df05b 100644
--- a/virtual_ecosystem/models/animals/module_schema.json
+++ b/virtual_ecosystem/models/animal/module_schema.json
@@ -1,7 +1,7 @@
{
"type": "object",
"properties": {
- "animals": {
+ "animal": {
"description": "Configuration settings for the animal module.",
"type": "object",
"properties": {
@@ -23,6 +23,21 @@
"metabolic_type": {
"type": "string"
},
+ "reproductive_type": {
+ "type": "string"
+ },
+ "development_type": {
+ "type": "string"
+ },
+ "development_status": {
+ "type": "string"
+ },
+ "offspring_functional_group": {
+ "type": "string"
+ },
+ "excretion_type": {
+ "type": "string"
+ },
"birth_mass": {
"type": "number"
},
@@ -35,6 +50,11 @@
"taxa",
"diet",
"metabolic_type",
+ "reproductive_type",
+ "development_type",
+ "development_status",
+ "offspring_functional_group",
+ "excretion_type",
"birth_mass",
"adult_mass"
]
@@ -68,6 +88,6 @@
}
},
"required": [
- "animals"
+ "animal"
]
}
\ No newline at end of file
diff --git a/virtual_ecosystem/models/animals/plant_resources.py b/virtual_ecosystem/models/animal/plant_resources.py
similarity index 56%
rename from virtual_ecosystem/models/animals/plant_resources.py
rename to virtual_ecosystem/models/animal/plant_resources.py
index c69c8ca76..9d03b2d2b 100644
--- a/virtual_ecosystem/models/animals/plant_resources.py
+++ b/virtual_ecosystem/models/animal/plant_resources.py
@@ -1,19 +1,19 @@
"""The ''plant_resources'' classes provides toy plant module functionality that are
required for setting up and testing the early stages of the animal module.
-""" # noqa: #D205, D415
+""" # noqa: D205
from __future__ import annotations
from virtual_ecosystem.core.data import Data
-from virtual_ecosystem.models.animals.constants import AnimalConsts
-from virtual_ecosystem.models.animals.protocols import Consumer, DecayPool
+from virtual_ecosystem.models.animal.constants import AnimalConsts
+from virtual_ecosystem.models.animal.protocols import Consumer, DecayPool
class PlantResources:
"""A class implementing the Resource protocol for plant data.
This class acts as the interface between plant model data stored in the core data
- object using the :class:`~virtual_ecosystem.models.animals.protocols.Resource`
+ object using the :class:`~virtual_ecosystem.models.animal.protocols.Resource`
protocol.
At present, it only exposes a single resource - the total leaf mass of the entire
@@ -48,42 +48,46 @@ def __init__(self, data: Data, cell_id: int, constants: AnimalConsts) -> None:
self.is_alive: bool = True
"""Whether the cohort is alive [True] or dead [False]."""
- def get_eaten(self, herbivore: Consumer, excrement_pool: DecayPool) -> float:
- """This function removes energy from a PlantResources and through herbivory.
+ def get_eaten(
+ self, consumed_mass: float, herbivore: Consumer, excrement_pool: DecayPool
+ ) -> float:
+ """This function handles herbivory on PlantResources.
+
+ TODO: plant waste should flow to a litter pool of some kind
Args:
- herbivore: The AnimalCohort preying on the PlantResources
- excrement_pool: The resident pool of detritus to which the remains of excess
- plant material is lost.
+ consumed_mass: The mass intended to be consumed by the herbivore.
+ herbivore: The Consumer (AnimalCohort) consuming the PlantResources.
+ excrement_pool: The pool to which remains of uneaten plant material is added
Returns:
- A float of the energy value of the consumed plants after mechanical and
- digestive efficiencies are accounted for.
-
+ The actual mass consumed by the herbivore, adjusted for efficiencies.
"""
+ # Check if the requested consumed mass is more than the available mass
+ actual_consumed_mass = min(self.mass_current, consumed_mass)
- # Minimum of the energy available and amount that can be consumed in an 8 hour
- # foraging window .
- mass_consumed = min(
- self.mass_current,
- herbivore.intake_rate * herbivore.individuals,
- )
+ # Update the plant mass to reflect the mass consumed
+ self.mass_current -= actual_consumed_mass
- # TODO - this needs to feedback herbivory to into the data object and hence back
- # into the plant model, but for now, the energy is consumed and not lost from
- # plants.
- self.mass_current -= mass_consumed
+ # Calculate the energy value of the consumed plants after mechanical efficiency
+ effective_mass_for_herbivore = (
+ actual_consumed_mass * herbivore.functional_group.mechanical_efficiency
+ )
- # TODO - All plant matter that animals fail to eat currently goes into the
- # excrement pool. This isn't ideal, but will do for now. This herbivore
- # contribution to litter fall should be handled by the plant model in future.
- excrement_pool.decomposed_energy += mass_consumed * (
+ # Excess mass goes to the excrement pool, considering only the part not
+ # converted by mechanical efficiency
+ excess_mass = actual_consumed_mass * (
1 - herbivore.functional_group.mechanical_efficiency
)
+ excrement_pool.decomposed_energy += (
+ excess_mass * self.constants.energy_density["plant"]
+ )
- # Return the net mass gain of herbivory
- return (
- mass_consumed
+ # Return the net mass gain of herbivory, considering both mechanical and
+ # digestive efficiencies
+ net_mass_gain = (
+ effective_mass_for_herbivore
* herbivore.functional_group.conversion_efficiency
- * herbivore.functional_group.mechanical_efficiency
)
+
+ return net_mass_gain
diff --git a/virtual_ecosystem/models/animals/protocols.py b/virtual_ecosystem/models/animal/protocols.py
similarity index 69%
rename from virtual_ecosystem/models/animals/protocols.py
rename to virtual_ecosystem/models/animal/protocols.py
index bb46a10d5..deaca524f 100644
--- a/virtual_ecosystem/models/animals/protocols.py
+++ b/virtual_ecosystem/models/animal/protocols.py
@@ -1,17 +1,16 @@
-"""The `models.animals.protocols` module contains a class provides eatability definition
+"""The `models.animal.protocols` module contains a class provides eatability definition
used by AnimalCohorts, PlantResources, and Carcasses in the
-:mod:`~virtual_ecosystem.models.animals` module.
-""" # noqa: D205, D415
+:mod:`~virtual_ecosystem.models.animal` module.
+""" # noqa: D205
from typing import Protocol
-from virtual_ecosystem.models.animals.functional_group import FunctionalGroup
+from virtual_ecosystem.models.animal.functional_group import FunctionalGroup
class Consumer(Protocol):
"""This is the protocol for defining consumers (currently just AnimalCohort)."""
- intake_rate: float
functional_group: FunctionalGroup
individuals: int
@@ -35,6 +34,8 @@ class Resource(Protocol):
mass_current: float
- def get_eaten(self, consumer: Consumer, pool: DecayPool) -> float:
+ def get_eaten(
+ self, consumed_mass: float, consumer: Consumer, pool: DecayPool
+ ) -> float:
"""The get_eaten method defines a resource."""
...
diff --git a/virtual_ecosystem/models/animal/scaling_functions.py b/virtual_ecosystem/models/animal/scaling_functions.py
new file mode 100644
index 000000000..f299eb993
--- /dev/null
+++ b/virtual_ecosystem/models/animal/scaling_functions.py
@@ -0,0 +1,441 @@
+"""The `models.animal.scaling_functions` module contains a set of functions containing
+scaling equations" (relationships between body-mass and a trait) required by the broader
+:mod:`~virtual_ecosystem.models.animal` module
+
+To Do:
+- streamline units of scaling functions [kg]->[kg] etc
+
+""" # noqa: D205, D415
+
+from math import ceil, exp, log
+
+import numpy as np
+
+from virtual_ecosystem.models.animal.animal_traits import DietType, MetabolicType
+from virtual_ecosystem.models.animal.constants import BOLTZMANN_CONSTANT
+
+
+def damuths_law(mass: float, terms: tuple) -> int:
+ """The function set initial population densities .
+
+ Currently, this function just employs Damuth's Law (Damuth 1987) for
+ terrestrial herbivorous mammals. Later, it will be expanded to other types. The
+ current form takes the ceiling of the population density to ensure there is a
+ minimum of 1 individual and integer values. This will be corrected once the
+ multi-grid occupation system for large animal is implemented.
+
+ Args:
+ mass: The body-mass [kg] of an AnimalCohort.
+ terms: The tuple of population density terms used, default to Damuth.
+
+ Returns:
+ The population density of that AnimalCohort [individuals/km2].
+
+ """
+
+ return ceil(terms[1] * mass ** terms[0])
+
+
+def metabolic_rate(
+ mass: float,
+ temperature: float,
+ terms: dict,
+ metabolic_type: MetabolicType,
+) -> float:
+ """Calculates metabolic rate in grams of body mass per day.
+
+ This follows the Madingley implementation, assuming a power-law relationship with
+ mass and an exponential relationship with temperature.
+
+ TODO: Implement activity windows to properly paramterize sigma.
+ TODO: Move constants to constants file.
+
+ Args:
+ mass: The body-mass [kg] of an AnimalCohort.
+ temperature: The temperature [Celsius] of the environment.
+ terms: The tuple of metabolic rate terms used.
+ metabolic_type: The metabolic type of the animal [ENDOTHERMIC or ECTOTHERMIC].
+
+ Returns:
+ The metabolic rate of an individual of the given cohort in [g/d].
+ """
+
+ Es = 3.7 * 10 ** (-2) # energy to mass conversion constant (g/kJ)
+ sig = 0.5 # proportion of time-step with temp in active range (toy)
+ Ea = 0.69 # aggregate activation energy of metabolic reactions
+ kB = BOLTZMANN_CONSTANT
+ mass_g = mass * 1000 # convert mass to grams
+
+ if metabolic_type == MetabolicType.ENDOTHERMIC:
+ Ib, bf = terms["basal"] # field metabolic constant and exponent
+ If, bb = terms["field"] # basal metabolic constant and exponent
+ Tk = 310.0 # body temperature of the individual (K)
+ return (
+ Es
+ * (
+ (sig * If * exp(-(Ea / (kB * Tk)))) * mass_g**bf
+ + ((1 - sig) * Ib * exp(-(Ea / (kB * Tk)))) * mass_g**bb
+ )
+ / 1000 # convert back to kg
+ )
+ elif metabolic_type == MetabolicType.ECTOTHERMIC:
+ Ib, bf = terms["basal"] # field metabolic constant and exponent
+ If, bb = terms["field"] # basal metabolic constant and exponent
+ Tk = temperature + 274.15 # body temperature of the individual (K)
+ return (
+ Es
+ * (
+ (sig * If * exp(-(Ea / (kB * Tk)))) * mass_g**bf
+ + ((1 - sig) * Ib * exp(-(Ea / (kB * Tk)))) * mass_g**bb
+ )
+ / 1000 # convert back to kg
+ )
+ else:
+ raise ValueError("Invalid metabolic type: {metabolic_type}")
+
+
+def prey_group_selection(
+ diet_type: DietType, mass: float, terms: tuple
+) -> dict[str, tuple[float, float]]:
+ """The function to set the type selection and mass scaling of predators.
+
+ Currently, this function is in a toy form. It exists so the forage_community
+ structure can be built properly. In the parameterization stage of development this
+ will be expanded into something realistic. I suspect some/much of the content will
+ be shifted into functional_group definitions.
+
+ TODO: Implement real pred-prey mass ratio.
+ TODO: Remove if unused.
+
+ Args:
+ diet_type: A value from the DietType enumeration.
+ mass: The body-mass [kg] of an AnimalCohort
+ terms: The tuple of predator-prey scaling terms used.
+
+ Returns:
+ The dictionary of functional group names and mass ranges that the predator
+ can prey upon.
+
+ """
+
+ if diet_type == DietType.HERBIVORE:
+ return {"plants": (0.0, 0.0)}
+ elif diet_type == DietType.CARNIVORE:
+ return {
+ "herbivorous_mammal": (0.1, 1000.0),
+ "carnivorous_mammal": (0.1, 1000.0),
+ "herbivorous_bird": (0.1, 1000.0),
+ "carnivorous_bird": (0.1, 1000.0),
+ "herbivorous_insect": (0.1, 1000.0),
+ "carnivorous_insect": (0.1, 1000.0),
+ }
+ else:
+ raise ValueError("Invalid diet type: {diet_type}")
+
+
+def background_mortality(u_bg: float) -> float:
+ """Constant background rate of wastebasket mortality.
+
+ This function does nothing but return a constant at the moment.
+ I am leaving it in so there is a clear way to alter the assumptions about
+ background mortality as we move into testing and validation.
+
+ Madingley
+
+ Args:
+ u_bg: The constant of background mortality [day^-1].
+
+ Returns:
+ The background rate of mortality faced by a cohort [day^-1].
+
+ """
+
+ return u_bg
+
+
+def senescence_mortality(
+ lambda_se: float, t_to_maturity: float, t_since_maturity: float
+) -> float:
+ """Age-based mortality.
+
+ Madingley describes the equation as exp(time_to_maturity/time_since_maturity) but I
+ suspect this is an error and that it should be inverted. If, for example, it took
+ 1000 days to reach maturity and the cohort had been mature for 1 day, then the
+ instantaneous rate of senescence mortality would be lambda_se * exp(1000/1). This
+ would also mean that the rate of senescence would decrease over time. Therefore, I
+ have inverted the relationship below.
+
+ TODO: Check Madingley code for function implementation
+
+ Args:
+ lambda_se: The instantaneous rate of senescence mortality at point of maturity
+ [day^-1].
+ t_to_maturity: The time it took the cohort to reach maturity [days].
+ t_since_maturity: The time elapsed since the cohort reached maturity [days].
+
+ Returns:
+ The rate of senescence mortality faced by an animal cohort [day^-1].
+
+ """
+
+ t_pm = t_to_maturity # time it took to reach maturity
+ t_bm = t_since_maturity # time since maturity
+
+ u_se = lambda_se * exp(t_bm / t_pm)
+
+ return u_se
+
+
+def starvation_mortality(
+ lambda_max: float, J_st: float, zeta_st: float, mass_current: float, mass_max: float
+) -> float:
+ """Mortality from body-mass loss.
+
+ There is a error in the madingley paper that does not follow their source code. The
+ paper uses exp(k) instead of exp(-k).
+
+ Args:
+ lambda_max: The maximum possible instantaneous fractional starvation mortality
+ rate. [day^-1]
+ J_st: Determines the inflection point of the logistic function describing ratio
+ of the realised mortality rate to the maximum rate. [unitless]
+ zeta_st:The scaling of the logistic function describing the ratio of the
+ realised mortality rate to the maximum rate. [unitless]
+ mass_current: The current mass of the animal cohort [kg].
+ mass_max: The maximum body mass ever achieved by individuals of this type [kg].
+
+ Returns:
+ The rate of mortality from starvation based on current body-mass. [day^-1]
+
+ """
+
+ M_i_t = mass_current
+ M_i_max = mass_max
+ k = -(M_i_t - J_st * M_i_max) / (zeta_st * M_i_max) # extra step to follow source
+ u_st = lambda_max / (1 + exp(-k))
+
+ return u_st
+
+
+def alpha_i_k(alpha_0_herb: float, mass: float) -> float:
+ """Effective rate at which an individual herbivore searches its environment.
+
+ This is linear scaling of herbivore search times with current body mass.
+
+ TODO: Update name
+
+ Madingley
+
+ Args:
+ alpha_0_herb: Effective rate per unit body mass at which a herbivore searches
+ its environment.
+ mass: The current body mass of the foraging herbivore.
+
+ Returns:
+ A float of the effective search rate in [ha/day]
+
+ """
+
+ return alpha_0_herb * mass
+
+
+def k_i_k(alpha_i_k: float, phi_herb_t: float, B_k_t: float, A_cell: float) -> float:
+ """The potential biomass (g) of plant k eaten by cohort i, per day.
+
+ TODO: update name
+
+ Madingley
+
+ Args:
+ alpha_i_k: Effective rate at which an individual herbivore searches its
+ environment.
+ phi_herb_t: Fraction of the total plant stock that is available to any one
+ herbivore cohort
+ B_k_t: Plant resource bool biomass.
+ A_cell: The area of one cell [standard = 1 ha]
+
+ Returns:
+ A float of The potential biomass (g) of plant k eating by cohort i, per day
+ [g/day]
+
+ """
+
+ return alpha_i_k * ((phi_herb_t * B_k_t) / A_cell) ** 2
+
+
+def H_i_k(h_herb_0: float, M_ref: float, M_i_t: float, b_herb: float) -> float:
+ """Handling time of plant resource k by cohort i.
+
+ Time (days) for an individual of cohort i to handle 1 gram of plant resource.
+
+ TODO: update name
+
+ Madingley
+
+ Args:
+ h_herb_0: Time in days that it would take a herbivore of mass = M_ref to handle
+ 1g of autotroph mass.
+ M_ref: Reference body mass.
+ M_i_t: Current herbivore mass
+ b_herb: Exponent of the power-law function relating the handling time of
+ autotroph matter to herbivore mass
+
+ Returns:
+ A float of the handling time (days).
+
+ """
+
+ return h_herb_0 * (M_ref / M_i_t) ** b_herb
+
+
+def theta_opt_i(
+ theta_opt_min_f: float, theta_opt_f: float, sigma_opt_f: float
+) -> float:
+ """Optimum predator-prey mass ratio.
+
+ TODO: update name
+
+ Madingley
+
+ Args:
+ theta_opt_min_f: The minimum optimal prey-predator body mass ratio.
+ theta_opt_f: The mean optimal prey-predator body mass ratio, from which actual
+ cohort optima are drawn.
+ sigma_opt_f: The standard deviation of optimal predator-prey mass ratios among
+ cohorts.
+
+ Returns:
+ A float measure of the optimum ratio.
+
+ """
+
+ return max(theta_opt_min_f, np.random.normal(theta_opt_f, sigma_opt_f))
+
+
+def w_bar_i_j(
+ mass_predator: float,
+ mass_prey: float,
+ theta_opt_i: float,
+ sigma_opt_pred_prey: float,
+) -> float:
+ """The probability of successfully capturing a prey item.
+
+ TODO: update name
+
+ Madingley
+
+ Args:
+ mass_predator: Current mass of the predator..
+ mass_prey: Current mass of the prey.
+ theta_opt_i: The optimum predator-prey mass ratio.
+ sigma_opt_pred_prey: The standard deviation of the mass ration.
+
+ Returns:
+ A float probability [0.0-1.0] that a predation encounter is successful.
+
+ """
+
+ return exp(
+ -(
+ ((log(mass_prey / mass_predator) - log(theta_opt_i)) / sigma_opt_pred_prey)
+ ** 2
+ )
+ )
+
+
+def alpha_i_j(alpha_0_pred: float, mass: float, w_bar_i_j: float) -> float:
+ """Rate at which an individual predator searches its environment and kills prey.
+
+ This is linear scaling of herbivore search times with current body mass.
+
+ TODO: update name
+
+ Madingley
+
+
+ Args:
+ alpha_0_pred: Constant describing effective rate per unit body mass at which any
+ predator searches its environment in ha/(day*g).
+ mass: The current body mass of the foraging herbivore.
+ w_bar_i_j: The probability of successfully capturing a prey item.
+
+ Returns:
+ A float of the effective search rate in [ha/day]
+
+ """
+
+ return alpha_0_pred * mass * w_bar_i_j
+
+
+def k_i_j(alpha_i_j: float, N_i_t: float, A_cell: float, theta_i_j: float) -> float:
+ """Potential number of prey items eaten off j by i.
+
+ TODO: Finish docstring
+ TODO: double check output needs to be float, might be int
+ TODO: update name
+
+ Madingley
+
+ Args:
+ alpha_i_j: Rate at which an individual predator searches its environment and
+ kills prey.
+ N_i_t: Number of consumer individuals.
+ A_cell: The area of a grid cell.
+ theta_i_j: The cumulative density of organisms with a mass lying within the
+ same predator specific mass bin.
+
+ Returns:
+ Potential number of prey items eaten off j by i [integer number of individuals]
+
+
+ """
+
+ return alpha_i_j * (N_i_t / A_cell) * theta_i_j
+
+
+def H_i_j(h_pred_0: float, M_ref: float, M_i_t: float, b_pred: float) -> float:
+ """Handling time of prey cohort j by cohort i.
+
+ Time (days) for an individual of cohort i to handle 1 individual of cohort j.
+
+ TODO: update name
+
+ Madingley
+
+ Args:
+ h_pred_0: Time that it would take a predator of body mass equal to the reference
+ mass, to handle a prey individual of body mass equal to one gram.
+ M_ref: Reference body mass.
+ M_i_t: Current predator mass.
+ b_pred: Exponent of the power-law function relating the handling time of
+ prey to predator mass.
+
+ Returns:
+ A float of the handling time (days).
+
+ """
+
+ return h_pred_0 * ((M_ref / M_i_t) ** b_pred) * M_i_t
+
+
+def juvenile_dispersal_speed(
+ current_mass: float, V_disp: float, M_disp_ref: float, o_disp: float
+) -> float:
+ """Dispersal speed of cohorts during diffusive natal dispersal event [km/month].
+
+ Madingley
+
+ Args:
+ current_mass: The mass of an individual of the cohort during the current time
+ step [kg].
+ V_disp: Diffusive dispersal speed on an individual with reference body-mass.
+ M_disp_ref: A reference body-mass.
+ o_disp: The power-law exponent for the mass-dispersal speed scaling
+ relationship.
+
+ Returns:
+ The dispersal speed of a juvenile cohort in km/month.
+
+ """
+
+ return V_disp * (current_mass / M_disp_ref) ** o_disp
diff --git a/virtual_ecosystem/models/animals/__init__.py b/virtual_ecosystem/models/animals/__init__.py
deleted file mode 100644
index c9aceb727..000000000
--- a/virtual_ecosystem/models/animals/__init__.py
+++ /dev/null
@@ -1,30 +0,0 @@
-"""The :mod:`~virtual_ecosystem.models.animals` module is one of the component models
-of the Virtual Ecosystem. It is comprised of a number of submodules.
-
-Each of the animal sub-modules has its own API reference page:
-
-* The :mod:`~virtual_ecosystem.models.animals.animal_model` submodule instantiates the
- AnimalModel class which consolidates the functionality of the animal module
- into a single class, which the high level functions of the Virtual Ecosystem
- can then make use of.
-* The :mod:`~virtual_ecosystem.models.animals.animal_communities` provides a class for
- containing and managing all of the animal cohorts within a grid square.
-* The :mod:`~virtual_ecosystem.models.animals.animal_cohorts` provides a class for the
- individual animal cohorts, their attributes, and behaviors.
-* The :mod:`~virtual_ecosystem.models.animals.functional_group` provides a class for
- the animal functional groups that define the type of animal in an animal cohort.
-* The :mod:`~virtual_ecosystem.models.animals.animal_traits` provides classes for
- the traits that feed into the functional group class definitions.
-* The :mod:`~virtual_ecosystem.models.animals.scaling_functions` provides a set of
- allometric scaling functions that define the biological rates used in the animal
- module.
-* The :mod:`~virtual_ecosystem.models.animals.constants` provides a set of dataclasses
- containing the constants required by the broader animal model.
-* The :mod:`~virtual_ecosystem.models.animals.decay` provides a model for
- both surface carcasses created by mortality and animal excrement.
-* The :mod:`~virtual_ecosystem.models.animals.plant_resources` provides the
- :class:`~virtual_ecosystem.models.animals.plant_resources.PlantResources` class,
- which provides an API for exposing plant model data via the animal model protocols.
-""" # noqa: D205, D415
-
-from virtual_ecosystem.models.animals.animal_model import AnimalModel # noqa: F401
diff --git a/virtual_ecosystem/models/animals/animal_cohorts.py b/virtual_ecosystem/models/animals/animal_cohorts.py
deleted file mode 100644
index ca297f10a..000000000
--- a/virtual_ecosystem/models/animals/animal_cohorts.py
+++ /dev/null
@@ -1,381 +0,0 @@
-"""The ''animals'' module provides animal module functionality.
-
-Notes:
-- assume each grid = 1 km2
-- assume each tick = 1 day (28800s)
-- damuth ~ 4.23*mass**(-3/4) indiv / km2
-""" # noqa: #D205, D415
-
-from __future__ import annotations
-
-from collections.abc import Sequence
-from math import ceil
-from random import choice
-
-from numpy import random, timedelta64
-
-from virtual_ecosystem.core.logger import LOGGER
-from virtual_ecosystem.models.animals.animal_traits import DietType
-from virtual_ecosystem.models.animals.constants import AnimalConsts
-from virtual_ecosystem.models.animals.decay import CarcassPool
-from virtual_ecosystem.models.animals.functional_group import FunctionalGroup
-from virtual_ecosystem.models.animals.protocols import Consumer, DecayPool, Resource
-from virtual_ecosystem.models.animals.scaling_functions import (
- damuths_law,
- intake_rate_scaling,
- metabolic_rate,
- natural_mortality_scaling,
- prey_group_selection,
-)
-
-
-class AnimalCohort:
- """This is a class of animal cohorts."""
-
- def __init__(
- self,
- functional_group: FunctionalGroup,
- mass: float,
- age: float,
- individuals: int,
- constants: AnimalConsts = AnimalConsts(),
- ) -> None:
- if age < 0:
- raise ValueError("Age must be a positive number.")
- """Check if age is a positive number. """
-
- if mass < 0:
- raise ValueError("Mass must be a positive number.")
- """Check if mass is a positive number."""
-
- """The constructor for the AnimalCohort class."""
- self.functional_group = functional_group
- """The functional group of the animal cohort which holds constants."""
- self.name = functional_group.name
- """The functional type name of the animal cohort."""
- """The average mass of an individual in the animal cohort [kg]."""
- self.mass_current = mass
- """The current average body mass of an individual [kg]."""
- self.age = age
- """The age of the animal cohort [days]."""
- self.individuals = individuals
- """The number of individuals in this cohort."""
- self.constants = constants
- """Animal constants."""
- self.damuth_density: int = damuths_law(
- self.functional_group.adult_mass, self.functional_group.damuths_law_terms
- )
- """The number of individuals in an average cohort of this type."""
- self.is_alive: bool = True
- """Whether the cohort is alive [True] or dead [False]."""
- self.reproductive_mass: float = 0.0
- """The pool of biomass from which the material of reproduction is drawn."""
-
- self.intake_rate: float = intake_rate_scaling(
- self.functional_group.adult_mass, self.functional_group.intake_rate_terms
- )
- """The individual rate of plant mass consumption over an 8hr foraging day
- [kg/day]."""
- self.prey_groups = prey_group_selection(
- self.functional_group.diet,
- self.functional_group.adult_mass,
- self.functional_group.prey_scaling,
- )
- """The identification of useable food resources."""
-
- self.adult_natural_mortality_prob = natural_mortality_scaling(
- self.functional_group.adult_mass, self.functional_group.longevity_scaling
- )
- # TODO: Distinguish between background, senesence, and starvation mortalities.
- """The per-day probability of an individual dying to natural causes."""
-
- # TODO - In future this should be parameterised using a constants dataclass, but
- # this hasn't yet been implemented for the animal model
- self.decay_fraction_excrement: float = self.constants.decay_fraction_excrement
- """The fraction of excrement which decays before it gets consumed."""
- self.decay_fraction_carcasses: float = self.constants.decay_fraction_carcasses
- """The fraction of carcass biomass which decays before it gets consumed."""
-
- def metabolize(self, temperature: float, dt: timedelta64) -> None:
- """The function to reduce mass_current through basal metabolism.
-
- TODO: Implement distinction between field and basal rates.
- TODO: Implement proportion of day active.
- TODO: clean up units
-
- Args:
- temperature: Current air temperature (K)
- dt: Number of days over which the metabolic costs should be calculated.
-
- """
-
- if dt < timedelta64(0, "D"):
- raise ValueError("dt cannot be negative.")
-
- if self.mass_current < 0:
- raise ValueError("mass_current cannot be negative.")
-
- # kg/day metabolic rate * number of days
- mass_metabolized = metabolic_rate(
- self.mass_current,
- temperature,
- self.functional_group.metabolic_rate_terms,
- self.functional_group.metabolic_type,
- ) * float(dt / timedelta64(1, "D"))
-
- self.mass_current -= min(self.mass_current, mass_metabolized)
-
- def excrete(
- self,
- excrement_pool: DecayPool,
- mass_consumed: float,
- ) -> None:
- """Transfer waste mass from an animal cohort to the excrement pool.
-
- Currently, this function is in an inbetween state where mass is removed from
- the animal cohort but it is recieved by the litter pool as energy. This will be
- fixed once the litter pools are updated for mass.
-
- TODO: Rework after update litter pools for mass
-
- Args:
- excrement_pool: The local ExcrementSoil pool in which waste is deposited.
- mass_consumed: The amount of mass flowing through cohort digestion.
- """
- # Find total waste mass, the total amount of waste is then found by the
- # average cohort member * number individuals.
- waste_energy = mass_consumed * self.functional_group.conversion_efficiency
-
- # This total waste is then split between decay and scavengeable excrement
- excrement_pool.scavengeable_energy += (
- (1 - self.decay_fraction_excrement) * waste_energy * self.individuals
- )
- excrement_pool.decomposed_energy += (
- self.decay_fraction_excrement * waste_energy * self.individuals
- )
-
- def increase_age(self, dt: timedelta64) -> None:
- """The function to modify cohort age as time passes.
-
- Args:
- dt: The amount of time that should be added to cohort age.
-
- """
- self.age += float(dt / timedelta64(1, "D"))
-
- def die_individual(self, number_dead: int, carcass_pool: CarcassPool) -> None:
- """The function to reduce the number of individuals in the cohort through death.
-
- Currently, all cohorts are crafted as single km2 grid cohorts. This means that
- very large animals will have one or fewer cohort members per grid. As changes
- are made to capture large body size and multi-grid occupancy, this will be
- updated.
-
- Currently, this function is in an inbetween state where mass is removed from
- the animal cohort but it is recieved by the litter pool as energy. This will be
- fixed once the litter pools are updated for mass.
-
- TODO: Rework after update litter pools for mass
-
- Args:
- number_dead: The number of individuals by which to decrease the population
- count.
- carcass_pool: The resident pool of animal carcasses to which the dead
- individuals are delivered.
-
- """
- self.individuals -= number_dead
-
- # Find total mass contained in the carcasses
- carcass_mass = number_dead * self.mass_current
-
- # Split this mass between carcass decay, and scavengeable carcasses
- carcass_pool.scavengeable_energy += (
- 1 - self.decay_fraction_carcasses
- ) * carcass_mass
- carcass_pool.decomposed_energy += self.decay_fraction_carcasses * carcass_mass
-
- def get_eaten(self, predator: Consumer, carcass_pool: DecayPool) -> float:
- """This function handles AnimalCohorts being subject to predation.
-
- Note: AnimalCohort mass_current is mean per individual mass within the
- cohort. Mass is not lost from mass_current from a predation event but the
- number of individuals in the cohort is reduced.
-
- Currently, this function is in an inbetween state where mass is removed from
- the animal cohort but it is recieved by the litter pool as energy. This will be
- fixed once the litter pools are updated for mass.
-
- TODO: Rework after update litter pools for mass
-
- Args:
- predator: The AnimalCohort preying on the eaten cohort.
- carcass_pool: The resident pool of animal carcasses to which the remains of
- dead individuals are delivered.
-
- Returns:
- A float of the mass value of the lost individuals after digestive
- efficiencies are accounted for.
-
- """
- # Calculate the number of individuals that can be eaten based on intake rate
- # Here we assume predators can consume prey mass equivalent to daily intake
- number_eaten = min(
- ceil((predator.intake_rate * predator.individuals) / self.mass_current),
- self.individuals,
- )
-
- # Calculate the mass gain from eating prey
- # Here we assume all eaten mass is converted to consumer mass
- prey_mass = min(
- (
- number_eaten
- * self.mass_current
- * self.functional_group.mechanical_efficiency
- ),
- self.mass_current,
- )
-
- # Reduce the number of individuals in the prey cohort
- self.individuals -= number_eaten
- # Calculate excess from deficits of efficiency, which flows to the carcass pool
- carcass_mass = prey_mass * (1 - self.functional_group.mechanical_efficiency)
-
- # Split this mass between carcass decay, and scavengeable carcasses
- carcass_pool.scavengeable_energy += (
- 1 - self.decay_fraction_carcasses
- ) * carcass_mass
- carcass_pool.decomposed_energy += self.decay_fraction_carcasses * carcass_mass
-
- # return the net mass gain of predation
- return prey_mass * predator.functional_group.conversion_efficiency
-
- def forage_cohort(
- self,
- plant_list: Sequence[Resource],
- animal_list: Sequence[Resource],
- carcass_pool: DecayPool,
- excrement_pool: DecayPool,
- ) -> Resource | None: # Note the optional here, temporary
- """This function handles selection of resources from a list of options.
-
- Currently, this function is passed a list of plant or animal resources from
- AnimalCommunity.forage_community and performs a simple random uniform selection.
- After this, excrete is called to pass excess waste to the excrement pool.
- Later this function will involve more complex weightings of prey options.
-
- TODO: Fix the occasional division by zero bug in eat and then remove Optional
-
- Args:
- plant_list: A list of plant cohorts available for herbivory.
- animal_list: A list of animal cohorts available for predation.
- carcass_pool: A CarcassPool object representing available carcasses.
- excrement_pool: A pool representing the excrement in the grid cell
-
- """
-
- if self.individuals == 0:
- LOGGER.warning("No individuals in cohort to forage.")
- return None # Early return with no food choice
-
- mass_consumed = 0.0 # Initialize to 0.0
-
- try:
- if self.functional_group.diet == DietType.HERBIVORE and plant_list:
- food_choice = choice(plant_list)
- mass_consumed = self.eat(food_choice, excrement_pool)
- elif self.functional_group.diet == DietType.CARNIVORE and animal_list:
- food_choice = choice(animal_list)
- mass_consumed = self.eat(food_choice, carcass_pool)
- else:
- LOGGER.info("No food available.")
- food_choice = None # No food available
-
- except ValueError as e:
- raise e
-
- # excrete excess digestive wastes
- self.excrete(excrement_pool, mass_consumed)
-
- return food_choice
-
- def eat(self, food: Resource, pool: DecayPool) -> float:
- """This function handles the mass transfer of a trophic interaction.
-
- Currently, all this does is call the food's get_eaten method and pass the
- returned mass value to the consumer.
-
- Args:
- food: An object of a Resource class (currently: AnimalCohort, Plant
- Community)
- pool: An object of a DecayPool class, which could represent depositional
- pools like soil or carcass pools.
-
- Returns:
- The amount of consumed mass so it can be used to determine waste output.
-
- """
- # Check if self.individuals is greater than zero
- if self.individuals == 0:
- return 0.0
-
- if self is food:
- raise ValueError("The food and the consumer are the same object.")
-
- # get the per-individual energetic gain from the bulk value
- mass_consumed = food.get_eaten(self, pool) / self.individuals
-
- if self.is_below_mass_threshold(
- self.constants.flow_to_reproductive_mass_threshold
- ):
- # if current mass equals or exceeds standard adult mass, gains to repro mass
- self.mass_current += mass_consumed
- else:
- # otherwise, gains flow to non-reproductive body mass.
- self.reproductive_mass += mass_consumed
- return mass_consumed # for passing to excrete
-
- def is_below_mass_threshold(self, mass_threshold: float) -> bool:
- """Check if cohort's total mass is below a certain threshold.
-
- Currently used for thesholding: birth, dispersal, trophic flow to reproductive
- mass.
-
- Args:
- mass_threshold: a float value holding a threshold ratio of current total
- mass to standard adult mass.
-
- Return:
- A bool of whether the current mass state is above the migration threshold.
- """
- return (
- self.mass_current + self.reproductive_mass
- ) / self.functional_group.adult_mass < mass_threshold
-
- def inflict_natural_mortality(
- self, carcass_pool: CarcassPool, number_days: float
- ) -> None:
- """The function to cause natural mortality in a cohort.
-
- TODO Find a more efficient structure so we aren't recalculating the
- time_step_mortality. Probably pass through the initialized timestep size to the
- scaling function
-
- Args:
- carcass_pool: The grid-local carcass pool to which the dead matter is
- transferred.
- number_days: Number of days over which the metabolic costs should be
- calculated.
-
- """
-
- # Calculate the mortality probability for the entire time step
- time_step_mortality_prob = (
- 1 - (1 - self.adult_natural_mortality_prob) ** number_days
- )
- # Draw the number of deaths from a binomial distribution
- number_of_deaths = random.binomial(
- n=self.individuals, p=time_step_mortality_prob
- )
-
- self.die_individual(number_of_deaths, carcass_pool)
diff --git a/virtual_ecosystem/models/animals/animal_communities.py b/virtual_ecosystem/models/animals/animal_communities.py
deleted file mode 100644
index d7281f2e2..000000000
--- a/virtual_ecosystem/models/animals/animal_communities.py
+++ /dev/null
@@ -1,305 +0,0 @@
-"""The ''animals'' module provides animal module functionality.
-
-Notes:
-- assume each grid = 1 km2
-- assume each tick = 1 day (28800s)
-- damuth ~ 4.23*mass**(-3/4) indiv / km2
-""" # noqa: #D205, D415
-
-from __future__ import annotations
-
-from collections.abc import Callable, Iterable
-from itertools import chain
-from random import choice
-
-from numpy import timedelta64
-
-from virtual_ecosystem.core.data import Data
-from virtual_ecosystem.core.logger import LOGGER
-from virtual_ecosystem.models.animals.animal_cohorts import AnimalCohort
-from virtual_ecosystem.models.animals.constants import AnimalConsts
-from virtual_ecosystem.models.animals.decay import CarcassPool, ExcrementPool
-from virtual_ecosystem.models.animals.functional_group import FunctionalGroup
-from virtual_ecosystem.models.animals.plant_resources import PlantResources
-from virtual_ecosystem.models.animals.scaling_functions import damuths_law
-
-
-class AnimalCommunity:
- """This is a class for the animal community of a grid cell.
-
- Args:
- functional_groups: A list of FunctionalGroup objects
- data: The core data object
- community_key: The integer key of the cell id for this community
- neighbouring_keys: A list of cell id keys for neighbouring communities
- get_destination: A function to return a destination AnimalCommunity for
- migration.
- """
-
- def __init__(
- self,
- functional_groups: list[FunctionalGroup],
- data: Data,
- community_key: int,
- neighbouring_keys: list[int],
- get_destination: Callable[[int], AnimalCommunity],
- constants: AnimalConsts = AnimalConsts(),
- ) -> None:
- # The constructor of the AnimalCommunity class.
- self.data = data
- """A reference to the core data object."""
- self.functional_groups = tuple(functional_groups)
- """A list of all FunctionalGroup types in the model."""
- self.community_key = community_key
- """Integer designation of the community in the model grid."""
- self.neighbouring_keys = neighbouring_keys
- """List of integer keys of neighbouring communities."""
- self.get_destination = get_destination
- """Callable get_destination from AnimalModel."""
- self.constants = constants
- """Animal constants."""
-
- self.animal_cohorts: dict[str, list[AnimalCohort]] = {
- k.name: [] for k in self.functional_groups
- }
- """A dictionary of lists of animal cohort keyed by functional group."""
- self.carcass_pool: CarcassPool = CarcassPool(10000.0, 0.0)
- """A pool for animal carcasses within the community."""
- self.excrement_pool: ExcrementPool = ExcrementPool(10000.0, 0.0)
- """A pool for excrement within the community."""
-
- @property
- def all_animal_cohorts(self) -> Iterable[AnimalCohort]:
- """Get an iterable of all animal cohorts in the community.
-
- This property provides access to all the animal cohorts contained
- within this community class.
-
- Returns:
- Iterable[AnimalCohort]: An iterable of AnimalCohort objects.
- """
- return chain.from_iterable(self.animal_cohorts.values())
-
- def populate_community(self) -> None:
- """This function creates an instance of each functional group.
-
- Currently, this is the simplest implementation of populating the animal model.
- In each AnimalCommunity one AnimalCohort of each FunctionalGroup type is
- generated. So the more functional groups that are made, the denser the animal
- community will be. This function will need to be reworked dramatically later on.
-
- """
- for functional_group in self.functional_groups:
- individuals = damuths_law(
- functional_group.adult_mass, functional_group.damuths_law_terms
- )
-
- cohort = AnimalCohort(
- functional_group,
- functional_group.adult_mass,
- 0.0,
- individuals,
- self.constants,
- )
- self.animal_cohorts[functional_group.name].append(cohort)
-
- def migrate(self, migrant: AnimalCohort, destination: AnimalCommunity) -> None:
- """Function to move an AnimalCohort between AnimalCommunity objects.
-
- This function should take a cohort and a destination community and then pop the
- cohort from this community to the destination.
-
- TODO: Implement juvenile dispersal.
- TODO: Implement low-density trigger.
-
- Args:
- migrant: The AnimalCohort moving between AnimalCommunities.
- destination: The AnimalCommunity the cohort is moving to.
-
- """
-
- self.animal_cohorts[migrant.name].remove(migrant)
- destination.animal_cohorts[migrant.name].append(migrant)
-
- def migrate_community(self) -> None:
- """This handles migrating all cohorts in a community."""
- for cohort in self.all_animal_cohorts:
- if cohort.is_below_mass_threshold(self.constants.dispersal_mass_threshold):
- # Random walk destination from the neighbouring keys
- destination_key = choice(self.neighbouring_keys)
- destination = self.get_destination(destination_key)
- self.migrate(cohort, destination)
-
- def die_cohort(self, cohort: AnimalCohort) -> None:
- """The function to change the cohort status from alive to dead.
-
- Args:
- cohort: The AnimalCohort instance that has lost all individuals.
-
- """
-
- if cohort.is_alive:
- cohort.is_alive = False
- # LOGGER.debug("An animal cohort has died")
- self.animal_cohorts[cohort.name].remove(cohort)
- elif not cohort.is_alive:
- LOGGER.exception("An animal cohort which is dead cannot die.")
-
- def die_cohort_community(self) -> None:
- """This handles die_cohort for all cohorts in a community."""
- for cohort in chain.from_iterable(self.animal_cohorts.values()):
- self.die_cohort(cohort)
-
- def birth(self, parent_cohort: AnimalCohort) -> None:
- """Produce a new AnimalCohort through reproduction.
-
- A cohort can only reproduce if it has an excess of reproductive mass above a
- certain threshold. The offspring will be an identical cohort of adults
- with age 0 and mass=birth_mass.
-
- TODO: Implement juvenile dispersal.
- TODO: Check whether madingley discards excess reproductive mass
-
- Args:
- parent_cohort: The AnimalCohort instance which is producing a new
- AnimalCohort.
-
- """
- number_offspring = int(
- (parent_cohort.reproductive_mass * parent_cohort.individuals)
- / parent_cohort.functional_group.birth_mass
- )
-
- # reduce reproductive mass by amount used to generate offspring
- parent_cohort.reproductive_mass = 0.0
-
- # add a new cohort of the parental type to the community
- self.animal_cohorts[parent_cohort.name].append(
- AnimalCohort(
- parent_cohort.functional_group,
- parent_cohort.functional_group.birth_mass,
- 0.0,
- number_offspring,
- self.constants,
- )
- )
-
- def birth_community(self) -> None:
- """This handles birth for all cohorts in a community."""
-
- # reproduction occurs for cohorts with sufficient reproductive mass
- for cohort in self.all_animal_cohorts:
- if not cohort.is_below_mass_threshold(self.constants.birth_mass_threshold):
- self.birth(cohort)
-
- def forage_community(self) -> None:
- """This function needs to organize the foraging of animal cohorts.
-
- It should loop over every animal cohort in the community and call the
- collect_prey and forage_cohort functions. This will create a list of suitable
- trophic resources and then action foraging on those resources. Details of
- mass transfer are handled inside forage_cohort and its helper functions.
- This will sooner be expanded to include functions for handling scavenging
- and soil consumption behaviors specifically.
-
- TODO Remove excess die_cohort related checks
-
- """
- # Generate the plant resources for foraging.
- plant_community: PlantResources = PlantResources(
- data=self.data,
- cell_id=self.community_key,
- constants=self.constants,
- )
-
- plant_list = [plant_community]
-
- for consumer_cohort in self.all_animal_cohorts:
- if (
- consumer_cohort.individuals == 0
- ): # temporary while finalizing die_cohort placements
- continue
-
- prey_list = self.collect_prey(consumer_cohort)
- food_choice = consumer_cohort.forage_cohort(
- plant_list=plant_list,
- animal_list=prey_list,
- carcass_pool=self.carcass_pool,
- excrement_pool=self.excrement_pool,
- )
- if isinstance(food_choice, AnimalCohort) and food_choice.individuals == 0:
- self.die_cohort(food_choice)
-
- def collect_prey(self, consumer_cohort: AnimalCohort) -> list[AnimalCohort]:
- """Collect suitable prey for a given consumer cohort.
-
- This is a helper function for forage_community to isolate the prey selection
- functionality. It was already getting confusing and it will get much more so
- as the Animal Module develops.
-
- Args:
- consumer_cohort: The AnimalCohort for which a prey list is being collected
-
- Returns:
- A list of AnimalCohorts that can be preyed upon.
-
- """
- prey: list = []
- for (
- prey_functional_group,
- potential_prey_cohorts,
- ) in self.animal_cohorts.items():
- # Skip if this functional group is not a prey of current predator
- if prey_functional_group not in consumer_cohort.prey_groups:
- continue
-
- # Get the size range of the prey this predator eats
- min_size, max_size = consumer_cohort.prey_groups[prey_functional_group]
-
- # Filter the potential prey cohorts based on their size
- for cohort in potential_prey_cohorts:
- if (
- min_size <= cohort.mass_current <= max_size
- and cohort.individuals != 0
- and cohort is not consumer_cohort
- ):
- prey.append(cohort)
-
- return prey
-
- def metabolize_community(self, temperature: float, dt: timedelta64) -> None:
- """This handles metabolize for all cohorts in a community.
-
- Args:
- temperature: Current air temperature (K).
- dt: Number of days over which the metabolic costs should be calculated.
-
- """
- for cohort in self.all_animal_cohorts:
- cohort.metabolize(temperature, dt)
-
- def increase_age_community(self, dt: timedelta64) -> None:
- """This handles age for all cohorts in a community.
-
- Args:
- dt: Number of days over which the metabolic costs should be calculated.
-
- """
- for cohort in self.all_animal_cohorts:
- cohort.increase_age(dt)
-
- def inflict_natural_mortality_community(self, dt: timedelta64) -> None:
- """This handles natural mortality for all cohorts in a community.
-
- TODO Replace the number_of_days format with a passthrough of the initialized
- dt straight to the scaling function that sets the cohort rates.
-
- Args:
- dt: Number of days over which the metabolic costs should be calculated.
-
- """
- number_of_days = float(dt / timedelta64(1, "D"))
- for cohort in self.all_animal_cohorts:
- cohort.inflict_natural_mortality(self.carcass_pool, number_of_days)
- if cohort.individuals <= 0:
- self.die_cohort(cohort)
diff --git a/virtual_ecosystem/models/animals/animal_traits.py b/virtual_ecosystem/models/animals/animal_traits.py
deleted file mode 100644
index df812c7f4..000000000
--- a/virtual_ecosystem/models/animals/animal_traits.py
+++ /dev/null
@@ -1,28 +0,0 @@
-"""The `models.animals.animal_traits` module contains classes that organizes
-animal traits into enumerations for use by the Functional Group class in the
-:mod:`~virtual_ecosystem.models.animals.functional_group` module.
-""" # noqa: D205, D415
-
-from enum import Enum
-
-
-class MetabolicType(Enum):
- """Enumeration for metabolic types."""
-
- ENDOTHERMIC = "endothermic"
- ECTOTHERMIC = "ectothermic"
-
-
-class DietType(Enum):
- """Enumeration for diet types."""
-
- HERBIVORE = "herbivore"
- CARNIVORE = "carnivore"
-
-
-class TaxaType(Enum):
- """Enumeration for taxa types."""
-
- MAMMAL = "mammal"
- BIRD = "bird"
- INSECT = "insect"
diff --git a/virtual_ecosystem/models/animals/constants.py b/virtual_ecosystem/models/animals/constants.py
deleted file mode 100644
index 457409dde..000000000
--- a/virtual_ecosystem/models/animals/constants.py
+++ /dev/null
@@ -1,274 +0,0 @@
-"""The `models.animals.constants` module contains a set of dataclasses containing
-constants" (fitting relationships taken from the literature) required by the broader
-:mod:`~virtual_ecosystem.models.animals` module
-
-The near-future intention is to rework the relationship between these constants and the
-AnimalCohort objects in which they are used such that there is a FunctionalType class
-in-between them. This class will hold the specific scaling, rate, and conversion
-parameters required for determining the function of a specific AnimalCohort and will
-avoid frequent searches through this constants file for values.
-""" # noqa: D205, D415
-
-from dataclasses import dataclass, field
-
-from virtual_ecosystem.core.constants_class import ConstantsDataclass
-from virtual_ecosystem.models.animals.animal_traits import (
- DietType,
- MetabolicType,
- TaxaType,
-)
-
-
-@dataclass(frozen=True)
-class AnimalConsts(ConstantsDataclass):
- """Dataclass to store all constants related to metabolic rates.
-
- TODO: The entire constants fille will be reworked in this style after the energy to
- mass conversion.
-
- """
-
- metabolic_rate_terms: dict[MetabolicType, dict[str, tuple[float, float]]] = field(
- default_factory=lambda: {
- # Parameters from Madingley, mass-based metabolic rates
- MetabolicType.ENDOTHERMIC: {
- "basal": (4.19e10, 0.69),
- "field": (9.08e11, 0.7),
- },
- MetabolicType.ECTOTHERMIC: {
- "basal": (4.19e10, 0.69),
- "field": (1.49e11, 0.88),
- },
- }
- )
-
- damuths_law_terms: dict[TaxaType, dict[DietType, tuple[float, float]]] = field(
- default_factory=lambda: {
- TaxaType.MAMMAL: {
- DietType.HERBIVORE: (-0.75, 4.23),
- DietType.CARNIVORE: (-0.75, 1.00),
- },
- TaxaType.BIRD: {
- DietType.HERBIVORE: (-0.75, 5.00),
- DietType.CARNIVORE: (-0.75, 2.00),
- },
- TaxaType.INSECT: {
- DietType.HERBIVORE: (-0.75, 5.00),
- DietType.CARNIVORE: (-0.75, 2.00),
- },
- }
- )
-
- fat_mass_terms: dict[TaxaType, tuple[float, float]] = field(
- default_factory=lambda: {
- TaxaType.MAMMAL: (1.19, 0.02), # Scaling of mammalian herbivore fat mass
- TaxaType.BIRD: (1.19, 0.05), # Toy Values
- TaxaType.INSECT: (1.19, 0.05), # Toy Values
- }
- )
-
- muscle_mass_terms: dict[TaxaType, tuple[float, float]] = field(
- default_factory=lambda: {
- TaxaType.MAMMAL: (1.0, 0.38), # Scaling of mammalian herbivore muscle mass
- TaxaType.BIRD: (1.0, 0.40), # Toy Values
- TaxaType.INSECT: (1.0, 0.40), # Toy Values
- }
- )
-
- intake_rate_terms: dict[TaxaType, tuple[float, float]] = field(
- default_factory=lambda: {
- TaxaType.MAMMAL: (0.71, 0.63), # Mammalian maximum intake rate
- TaxaType.BIRD: (0.7, 0.50), # Toy Values
- TaxaType.INSECT: (0.7, 0.50), # Toy Values
- }
- )
-
- energy_density: dict[str, float] = field(
- default_factory=lambda: {
- "meat": 7000.0, # Energy of mammal meat [J/g]
- "plant": 18200000.0, # Energy of plant food [J/g]
- }
- )
-
- conversion_efficiency: dict[DietType, float] = field(
- default_factory=lambda: {
- DietType.HERBIVORE: 0.1, # Toy value
- DietType.CARNIVORE: 0.25, # Toy value
- }
- )
-
- mechanical_efficiency: dict[DietType, float] = field(
- default_factory=lambda: {
- DietType.HERBIVORE: 0.9, # Toy value
- DietType.CARNIVORE: 0.8, # Toy value
- }
- )
-
- prey_mass_scaling_terms: dict[
- MetabolicType, dict[TaxaType, tuple[float, float]]
- ] = field(
- default_factory=lambda: {
- MetabolicType.ENDOTHERMIC: {
- TaxaType.MAMMAL: (1.0, 1.0), # Toy values
- TaxaType.BIRD: (1.0, 1.0), # Toy values
- },
- MetabolicType.ECTOTHERMIC: {TaxaType.INSECT: (1.0, 1.0)}, # Toy values
- }
- )
-
- longevity_scaling_terms: dict[TaxaType, tuple[float, float]] = field(
- default_factory=lambda: {
- TaxaType.MAMMAL: (0.25, 0.02), # Toy values
- TaxaType.BIRD: (0.25, 0.05), # Toy values
- TaxaType.INSECT: (0.25, 0.05), # Toy values
- }
- )
-
- birth_mass_threshold: float = 1.5 # Threshold for reproduction
- flow_to_reproductive_mass_threshold: float = (
- 1.0 # Threshold of trophic flow to reproductive mass
- )
- dispersal_mass_threshold: float = 0.75 # Threshold for dispersal
- energy_percentile_threshold: float = 0.5 # Threshold for initiating migration
- decay_fraction_excrement: float = 0.5 # Decay fraction for excrement
- decay_fraction_carcasses: float = 0.2 # Decay fraction for carcasses
-
-
-"""
-METABOLIC_RATE_TERMS: dict[MetabolicType, dict[str, tuple[float, float]]] = {
- # Parameters from Madingley, mass based metabolic rates
- MetabolicType.ENDOTHERMIC: {
- "basal": (4.19e10, 0.69),
- "field": (9.08e11, 0.7),
- },
- MetabolicType.ECTOTHERMIC: {
- "basal": (4.19e10, 0.69),
- "field": (1.49e11, 0.88),
- },
-}
-
-DAMUTHS_LAW_TERMS: dict[TaxaType, dict[DietType, tuple[float, float]]] = {
- TaxaType.MAMMAL: {
- DietType.HERBIVORE: (-0.75, 4.23),
- # Mammalian herbivore population density, observed allometry (Damuth 1987).
- # [assumes kg mass]
- DietType.CARNIVORE: (-0.75, 1.00),
- # Toy values.
- },
- TaxaType.BIRD: {
- DietType.HERBIVORE: (-0.75, 5.00),
- # Toy values.
- DietType.CARNIVORE: (-0.75, 2.00),
- # Toy values.
- },
- TaxaType.INSECT: {
- DietType.HERBIVORE: (-0.75, 5.00),
- # Toy values.
- DietType.CARNIVORE: (-0.75, 2.00),
- # Toy values.
- },
-}
-
-FAT_MASS_TERMS: dict[TaxaType, tuple[float, float]] = {
- TaxaType.MAMMAL: (1.19, 0.02),
- # Scaling of mammalian herbivore fat mass (citation from Rallings). [assumes g mass]
- TaxaType.BIRD: (1.19, 0.05),
- # Toy Values
- TaxaType.INSECT: (1.19, 0.05),
- # Toy Values
-}
-
-MUSCLE_MASS_TERMS: dict[TaxaType, tuple[float, float]] = {
- TaxaType.MAMMAL: (1.0, 0.38),
- # Scaling of mammalian herbivore muscle mass (citation from Rallings).
- # [assumes g mass]
- TaxaType.BIRD: (1.0, 0.40),
- # Toy Values
- TaxaType.INSECT: (1.0, 0.40),
- # Toy Values
-}
-
-INTAKE_RATE_TERMS: dict[TaxaType, tuple[float, float]] = {
- TaxaType.MAMMAL: (0.71, 0.63),
- # Mammalian maximum intake rate (g/min) from (Shipley 1994). [assumes kg mass]
- TaxaType.BIRD: (0.7, 0.50),
- # Toy Values
- TaxaType.INSECT: (0.7, 0.50),
- # Toy Values
-}
-
-
-ENERGY_DENSITY: dict[str, float] = {
- "meat": 7000.0,
- # The energy of a unit mass of mammal meat (check citation from Rallings). [J/g]
- "plant": 18200000.0
- # Temporary realistic plant food value: Alfalfa ¬ 18,200,000 J/kg DM.
-}
-
-CONVERSION_EFFICIENCY: dict[DietType, float] = {
- DietType.HERBIVORE: 0.1,
- # Toy value [unitless].
- DietType.CARNIVORE: 0.25,
- # Toy value [unitless].
-}
-
-MECHANICAL_EFFICIENCY: dict[DietType, float] = {
- DietType.HERBIVORE: 0.9,
- # Toy value [unitless].
- DietType.CARNIVORE: 0.8,
- # Toy Value [unitless]
-}
-
-PREY_MASS_SCALING_TERMS: dict[MetabolicType, dict[TaxaType, tuple[float, float]]] = {
- MetabolicType.ENDOTHERMIC: {
- TaxaType.MAMMAL: (1.0, 1.0),
- # Toy values.
- TaxaType.BIRD: (1.0, 1.0),
- # Toy values.
- },
- MetabolicType.ECTOTHERMIC: {
- TaxaType.INSECT: (1.0, 1.0)
- # Toy values.
- },
-}
-
-LONGEVITY_SCALING_TERMS: dict[TaxaType, tuple[float, float]] = {
- TaxaType.MAMMAL: (0.25, 0.02),
- # Toy values
- TaxaType.BIRD: (0.25, 0.05),
- # Toy Values
- TaxaType.INSECT: (0.25, 0.05),
- # Toy Values
-}
-
-BOLTZMANN_CONSTANT: float = 8.617333262145e-5 # Boltzmann constant [eV/K]
-
-TEMPERATURE: float = 37.0 # Toy temperature for setting up metabolism [C].
-
-BIRTH_MASS_THRESHOLD: float = 1.5 # Toy value for thresholding reproduction.
-
-FLOW_TO_REPRODUCTIVE_MASS_THRESHOLD: float = (
- 1.0 # Toy value for threshold of trophic flow to reproductive mass.
-)
-
-DISPERSAL_MASS_THRESHOLD: float = 0.75 # Toy value for thesholding dispersal.
-
-ENERGY_PERCENTILE_THRESHOLD: float = 0.5 # Toy value for initiating migration
-"""
-DECAY_FRACTION_EXCREMENT: float = 0.5
-"""Fraction of excrement that is assumed to decay rather than be consumed [unitless].
-
-TODO - The number given here is very much made up. In future, we either need to find a
-way of estimating this from data, or come up with a smarter way of handling this
-process.
-"""
-
-DECAY_FRACTION_CARCASSES: float = 0.2
-"""Fraction of carcass biomass that is assumed to decay rather than be consumed.
-
-[unitless]. TODO - The number given here is very much made up, see
-:attr:`DECAY_FRACTION_EXCREMENT` for details of how this should be changed in future.
-"""
-BOLTZMANN_CONSTANT: float = 8.617333262145e-5 # Boltzmann constant [eV/K]
-
-TEMPERATURE: float = 37.0 # Toy temperature for setting up metabolism [C].
diff --git a/virtual_ecosystem/models/animals/scaling_functions.py b/virtual_ecosystem/models/animals/scaling_functions.py
deleted file mode 100644
index 02a40b8a4..000000000
--- a/virtual_ecosystem/models/animals/scaling_functions.py
+++ /dev/null
@@ -1,266 +0,0 @@
-"""The `models.animals.scaling_functions` module contains a set of functions containing
-scaling equations" (relationships between body-mass and a trait) required by the broader
-:mod:`~virtual_ecosystem.models.animals` module
-
-To Do:
-- streamline units of scaling functions [kg]->[kg] etc
-
-""" # noqa: D205, D415
-
-from math import ceil, exp, log
-
-from virtual_ecosystem.models.animals.animal_traits import DietType, MetabolicType
-from virtual_ecosystem.models.animals.constants import BOLTZMANN_CONSTANT
-
-
-def damuths_law(mass: float, terms: tuple) -> int:
- """The function set initial population densities .
-
- Currently, this function just employs Damuth's Law (Damuth 1987) for
- terrestrial herbivorous mammals. Later, it will be expanded to other types. The
- current form takes the ceiling of the population density to ensure there is a
- minimum of 1 individual and integer values. This will be corrected once the
- multi-grid occupation system for large animals is implemented.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- terms: The tuple of population density terms used, default to Damuth.
-
- Returns:
- The population density of that AnimalCohort [individuals/km2].
-
- """
-
- return ceil(terms[1] * mass ** terms[0])
-
-
-def metabolic_rate_energy(
- mass: float, temperature: float, terms: tuple, metabolic_type: MetabolicType
-) -> float:
- """Calculates the metabolic rate of animal cohorts.
-
- TODO: No longer in use. Remove this method after constants rework.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- temperature: The temperature [Celsius] of the environment.
- terms: The tuple of metabolic rate terms used.
- metabolic_type: The metabolic type of the animal [ENDOTHERMIC or ECTOTHERMIC].
-
- Returns:
- The metabolic rate of an individual of the given cohort in [J/s].
-
- """
- mass_g = mass * 1000 # Convert mass to grams
- temperature_k = temperature + 273.15 # Convert temperature to Kelvin
-
- if metabolic_type == MetabolicType.ENDOTHERMIC:
- return terms[1] * mass_g ** terms[0]
- elif metabolic_type == MetabolicType.ECTOTHERMIC:
- b0, exponent = terms
- return b0 * mass_g**exponent * exp(-0.65 / (BOLTZMANN_CONSTANT * temperature_k))
- else:
- raise ValueError("Invalid metabolic type: {metabolic_type}")
-
-
-def metabolic_rate(
- mass: float,
- temperature: float,
- terms: dict,
- metabolic_type: MetabolicType,
-) -> float:
- """Calculates metabolic rate in grams of body mass per day.
-
- This follows the Madingley implementation, assuming a power-law relationship with
- mass and an exponential relationship with temperature.
-
- TODO: Implement activity windows to properly paramterize sigma.
- TODO: Move constants to constants file after constants rework.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- temperature: The temperature [Celsius] of the environment.
- terms: The tuple of metabolic rate terms used.
- metabolic_type: The metabolic type of the animal [ENDOTHERMIC or ECTOTHERMIC].
-
- Returns:
- The metabolic rate of an individual of the given cohort in [g/d].
- """
-
- Es = 3.7 * 10 ** (-2) # energy to mass conversion constant (g/kJ)
- sig = 0.5 # proportion of time-step with temp in active range (toy)
- Ea = 0.69 # aggregate activation energy of metabolic reactions
- kB = BOLTZMANN_CONSTANT
- mass_g = mass * 1000 # convert mass to grams
-
- if metabolic_type == MetabolicType.ENDOTHERMIC:
- Ib, bf = terms["basal"] # field metabolic constant and exponent
- If, bb = terms["field"] # basal metabolic constant and exponent
- Tk = 310.0 # body temperature of the individual (K)
- return (
- Es
- * (
- (sig * If * exp(-(Ea / (kB * Tk)))) * mass_g**bf
- + ((1 - sig) * Ib * exp(-(Ea / (kB * Tk)))) * mass_g**bb
- )
- / 1000 # convert back to kg
- )
- elif metabolic_type == MetabolicType.ECTOTHERMIC:
- Ib, bf = terms["basal"] # field metabolic constant and exponent
- If, bb = terms["field"] # basal metabolic constant and exponent
- Tk = temperature + 274.15 # body temperature of the individual (K)
- return (
- Es
- * (
- (sig * If * exp(-(Ea / (kB * Tk)))) * mass_g**bf
- + ((1 - sig) * Ib * exp(-(Ea / (kB * Tk)))) * mass_g**bb
- )
- / 1000 # convert back to kg
- )
- else:
- raise ValueError("Invalid metabolic type: {metabolic_type}")
-
-
-def muscle_mass_scaling(mass: float, terms: tuple) -> float:
- """The function to set the amount of muscle mass on individual in an AnimalCohort.
-
- Currently, this scaling relationship is only accurate for terrestrial mammals.
- This will later be updated for additional functional types.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- terms: The tuple of muscle scaling terms used.
-
- Returns:
- The mass [g] of muscle on an individual of the animal cohort.
-
- """
-
- return terms[1] * (mass * 1000) ** terms[0]
-
-
-def fat_mass_scaling(mass: float, terms: tuple) -> float:
- """The function to set the amount of fat mass on individual in an AnimalCohort.
-
- Currently, this scaling relationship is only accurate for terrestrial mammals.
- This will later be updated for additional functional types.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- terms: The tuple of fat scaling terms used.
-
- Returns:
- The mass [g] of fat on an individual of the animal cohort.
-
- """
-
- return terms[1] * (mass * 1000) ** terms[0]
-
-
-def energetic_reserve_scaling(
- mass: float, muscle_terms: tuple, fat_terms: tuple
-) -> float:
- """The function to set the energetic reserve of an individual in an AnimalCohort.
-
- Currently, this scaling relationship is only accurate for terrestrial mammals.
- This will later be updated for additional functional types.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- muscle_terms: The tuple of muscle scaling terms used.
- fat_terms: The tuple of fat scaling terms used.
-
- Returns:
- The energetic reserve [J] of an individual of the animal cohort.
-
- """
- return (
- muscle_mass_scaling(mass, muscle_terms) + fat_mass_scaling(mass, fat_terms)
- ) * 7000.0 # j/g
-
-
-def intake_rate_scaling(mass: float, terms: tuple) -> float:
- """The function to set the intake rate of an individual in an AnimalCohort.
-
- Currently, this scaling relationship is only accurate for terrestrial
- herbivorous mammals interacting with plant foods. This will later be updated
- for additional functional types and interactions.
-
- The function form converts the original g/min rate into a kg/day rate, where a
- day is an 8hr foraging window.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
- terms: The tuple of intake rate terms used.
-
- Returns:
- The intake rate [kg/day] of an individual of the animal cohort.
-
- """
-
- return terms[1] * mass ** terms[0] * 480 * (1 / 1000)
-
-
-def prey_group_selection(
- diet_type: DietType, mass: float, terms: tuple
-) -> dict[str, tuple[float, float]]:
- """The function to set the type selection and mass scaling of predators.
-
- Currently, this function is in a toy form. It exists so the forage_community
- structure can be built properly. In the parameterization stage of development this
- will be expanded into something realistic. I suspect some/much of the content will
- be shifted into functional_group definitions.
-
- TODO: Implement real pred-prey mass ratio.
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort
- terms: The tuple of predator-prey scaling terms used.
-
- Returns:
- The dictionary of functional group names and mass ranges that the predator
- can prey upon.
-
- """
-
- if diet_type == DietType.HERBIVORE:
- return {"plants": (0.0, 0.0)}
- elif diet_type == DietType.CARNIVORE:
- return {
- "herbivorous_mammal": (0.1, 1000.0),
- "carnivorous_mammal": (0.1, 1000.0),
- "herbivorous_bird": (0.1, 1000.0),
- "carnivorous_bird": (0.1, 1000.0),
- "herbivorous_insect": (0.1, 1000.0),
- "carnivorous_insect": (0.1, 1000.0),
- }
- else:
- raise ValueError("Invalid diet type: {diet_type}")
-
-
-def natural_mortality_scaling(mass: float, terms: tuple) -> float:
- """The function to determine the natural mortality rate of animal cohorts.
-
- Relationship from: Dureuil & Froese 2021
-
- M = - ln(P) / tmax (annual, year^-1, instantaneous rate)
- tmax = mean maximum age
- P = 0.015 # proportion surviving to tmax
-
- Transform yearly rate to daily rate
- transform daily rate to daily probability
- prob = 1 - e^-M
-
- Args:
- mass: The body-mass [kg] of an AnimalCohort.
-
- Returns:
- The allometric natural mortality rate as a daily probability of death.
-
- """
- tmax = terms[1] * mass ** terms[0]
- annual_mortality_rate = -log(0.015) / tmax
- daily_mortality_rate = annual_mortality_rate / 365.0
- daily_mortality_prob = 1 - exp(-daily_mortality_rate)
-
- return daily_mortality_prob
diff --git a/virtual_ecosystem/models/hydrology/__init__.py b/virtual_ecosystem/models/hydrology/__init__.py
index dda962015..3d8c2fb77 100644
--- a/virtual_ecosystem/models/hydrology/__init__.py
+++ b/virtual_ecosystem/models/hydrology/__init__.py
@@ -21,8 +21,13 @@
matric potential, groundwater storage, and subsurface horizontal flow.
* The :mod:`~virtual_ecosystem.models.hydrology.constants` submodule contains
- parameters and constants for the hydrology model. This is a temporary solution.
-""" # noqa: D205, D415
+ parameters and constants for the hydrology model.
+
+* The :mod:`~virtual_ecosystem.models.hydrology.hydrology_tools` submodule
+ contains a set of functions that support the data preprocessing for the model update,
+ for example by preselecting relevant layers, distributing monthly rainfall over 30
+ days, and so on.
+""" # noqa: D205
from virtual_ecosystem.models.hydrology.hydrology_model import ( # noqa: F401
HydrologyModel,
diff --git a/virtual_ecosystem/models/hydrology/above_ground.py b/virtual_ecosystem/models/hydrology/above_ground.py
index e764f7258..e3f63fb91 100644
--- a/virtual_ecosystem/models/hydrology/above_ground.py
+++ b/virtual_ecosystem/models/hydrology/above_ground.py
@@ -2,7 +2,11 @@
processes for the Virtual Ecosystem. At the moment, this includes rain water
interception by the canopy, soil evaporation, and functions related to surface
runoff, bypass flow, and river discharge.
-""" # noqa: D205, D415
+
+TODO change temperatures to Kelvin
+
+TODO add canopy evaporation
+""" # noqa: D205
from math import sqrt
@@ -21,14 +25,14 @@ def calculate_soil_evaporation(
soil_moisture_residual: float | NDArray[np.float32],
soil_moisture_capacity: float | NDArray[np.float32],
leaf_area_index: NDArray[np.float32],
- wind_speed: float | NDArray[np.float32],
+ wind_speed_surface: NDArray[np.float32],
celsius_to_kelvin: float,
density_air: float | NDArray[np.float32],
latent_heat_vapourisation: float | NDArray[np.float32],
gas_constant_water_vapour: float,
- heat_transfer_coefficient: float,
+ soil_surface_heat_transfer_coefficient: float,
extinction_coefficient_global_radiation: float,
-) -> NDArray[np.float32]:
+) -> dict[str, NDArray[np.float32]]:
r"""Calculate soil evaporation based on classical bulk aerodynamic formulation.
This function uses the so-called 'alpha' method to estimate the evaporative flux
@@ -54,25 +58,28 @@ def calculate_soil_evaporation(
:math:`LAI` is the total leaf area index.
Args:
- temperature: air temperature at reference height, [C]
- relative_humidity: relative humidity at reference height, []
- atmospheric_pressure: atmospheric pressure at reference height, [kPa]
+ temperature: Air temperature at reference height, [C]
+ relative_humidity: Relative humidity at reference height, []
+ atmospheric_pressure: Atmospheric pressure at reference height, [kPa]
soil_moisture: Volumetric relative water content, [unitless]
- soil_moisture_residual: residual soil moisture, [unitless]
- soil_moisture_capacity: soil moisture capacity, [unitless]
- wind_speed: wind speed at reference height, [m s-1]
- celsius_to_kelvin: factor to convert teperature from Celsius to Kelvin
- density_air: density if air, [kg m-3]
- latent_heat_vapourisation: latent heat of vapourisation, [J kg-1]
- gas_constant_water_vapour: gas constant for water vapour, [J kg-1 K-1]
- heat_transfer_coefficient: heat transfer coefficient of air
+ soil_moisture_residual: Residual soil moisture, [unitless]
+ soil_moisture_capacity: Soil moisture capacity, [unitless]
+ wind_speed_surface: Wind speed in the bottom air layer, [m s-1]
+ celsius_to_kelvin: Factor to convert temperature from Celsius to Kelvin
+ density_air: Density if air, [kg m-3]
+ latent_heat_vapourisation: Latent heat of vapourisation, [MJ kg-1]
+ leaf_area_index: Leaf area index [m m-1]
+ gas_constant_water_vapour: Gas constant for water vapour, [J kg-1 K-1]
+ soil_surface_heat_transfer_coefficient: Heat transfer coefficient between soil
+ and air, [W m-2 K-1]
extinction_coefficient_global_radiation: Extinction coefficient for global
radiation, [unitless]
Returns:
- soil evaporation, [mm]
+ soil evaporation, [mm] and aerodynamic resistance near the surface [kg m-2 s-3]
"""
+ output = {}
# Convert temperature to Kelvin
temperature_k = temperature + celsius_to_kelvin
@@ -98,16 +105,20 @@ def calculate_soil_evaporation(
specific_humidity_air = (relative_humidity * saturated_specific_humidity) / 100
- aerodynamic_resistance = heat_transfer_coefficient / wind_speed**2
+ aerodynamic_resistance = (
+ 1 / wind_speed_surface**2
+ ) * soil_surface_heat_transfer_coefficient
+ output["aerodynamic_resistance_surface"] = aerodynamic_resistance
evaporative_flux = (density_air / aerodynamic_resistance) * ( # W/m2
alpha * saturation_vapour_pressure - specific_humidity_air
)
- # Return surface evaporation, [mm]
- return (evaporative_flux / latent_heat_vapourisation).squeeze() * np.exp(
- -extinction_coefficient_global_radiation * leaf_area_index
- )
+ output["soil_evaporation"] = ( # Return surface evaporation, [mm]
+ evaporative_flux / latent_heat_vapourisation
+ ).squeeze() * np.exp(-extinction_coefficient_global_radiation * leaf_area_index)
+
+ return output
def find_lowest_neighbour(
@@ -120,8 +131,8 @@ def find_lowest_neighbour(
can be used to determine in which direction surface runoff flows.
Args:
- neighbours: list of neighbour IDs
- elevation: elevation, [m]
+ neighbours: List of neighbour IDs
+ elevation: Elevation, [m]
Returns:
list of lowest neighbour IDs
@@ -141,7 +152,7 @@ def find_upstream_cells(lowest_neighbour: list[int]) -> list[list[int]]:
be used to calculate the water flow that goes though a grid cell.
Args:
- lowest_neighbour: list of lowest neighbour cell_ids
+ lowest_neighbour: List of lowest neighbour cell IDs
Returns:
lists of all upstream IDs for each grid cell
@@ -168,16 +179,17 @@ def accumulate_horizontal_flow(
The function currently raises a `ValueError` if accumulated flow is negative.
Args:
- drainage_map: dict of all upstream IDs for each grid cell
- current_flow: (sub-)surface flow of the current time step, [mm]
- previous_accumulated_flow: accumulated flow from previous time step, [mm]
+ drainage_map: Dict of all upstream IDs for each grid cell
+ current_flow: (Sub-)surface flow of the current time step, [mm]
+ previous_accumulated_flow: Accumulated flow from previous time step, [mm]
Returns:
accumulated (sub-)surface flow, [mm]
"""
+ current_flow_true = np.nan_to_num(current_flow, nan=0.0)
for cell_id, upstream_ids in enumerate(drainage_map.values()):
- previous_accumulated_flow[cell_id] += np.sum(current_flow[upstream_ids])
+ previous_accumulated_flow[cell_id] += np.sum(current_flow_true[upstream_ids])
if (previous_accumulated_flow < 0.0).any():
to_raise = ValueError("The accumulated flow should not be negative!")
@@ -191,12 +203,12 @@ def calculate_drainage_map(grid: Grid, elevation: np.ndarray) -> dict[int, list[
"""Calculate drainage map based on digital elevation model.
This function finds the lowest neighbour for each grid cell, identifies all upstream
- IDs and creates a dictionary that provides all upstream cell IDs for each grid
+ cell IDs and creates a dictionary that provides all upstream cell IDs for each grid
cell. This function currently supports only square grids.
Args:
- grid: grid object
- elevation: elevation, [m]
+ grid: Grid object
+ elevation: Elevation, [m]
Returns:
dictionary of cell IDs and their upstream neighbours
@@ -219,9 +231,7 @@ def calculate_drainage_map(grid: Grid, elevation: np.ndarray) -> dict[int, list[
def calculate_interception(
leaf_area_index: NDArray[np.float32],
precipitation: NDArray[np.float32],
- intercept_param_1: float,
- intercept_param_2: float,
- intercept_param_3: float,
+ intercept_parameters: tuple[float, float, float],
veg_density_param: float,
) -> NDArray[np.float32]:
r"""Estimate canopy interception.
@@ -256,14 +266,10 @@ def calculate_interception(
:math:`k=0.046 * LAI`
Args:
- leaf_area_index: leaf area index summed over all canopy layers, [m2 m-2]
- precipitation: precipitation, [mm]
- intercept_parameter_1: Parameter in equation that estimates maximum canopy
- interception capacity
- intercept_parameter_2: Parameter in equation that estimates maximum canopy
- interception capacity
- intercept_parameter_3: Parameter in equation that estimates maximum canopy
- interception capacity
+ leaf_area_index: Leaf area index summed over all canopy layers, [m2 m-2]
+ precipitation: Precipitation, [mm]
+ intercept_parameters: Parameters for equation estimating maximum canopy
+ interception capacity.
veg_density_param: Parameter used to estimate vegetation density for maximum
canopy interception capacity estimate
@@ -272,9 +278,9 @@ def calculate_interception(
"""
capacity = (
- intercept_param_1
- + intercept_param_2 * leaf_area_index
- - intercept_param_3 * leaf_area_index**2
+ intercept_parameters[0]
+ + intercept_parameters[1] * leaf_area_index
+ - intercept_parameters[2] * leaf_area_index**2
)
max_capacity = np.where(leaf_area_index > 0.1, capacity, 0)
@@ -301,7 +307,7 @@ def distribute_monthly_rainfall(
Args:
total_monthly_rainfall: Total monthly rainfall, [mm]
num_days: Number of days to distribute the rainfall over
- seed: seed for random number generator, optional
+ seed: Seed for random number generator, optional
Returns:
An array containing the daily rainfall amounts, [mm]
@@ -349,10 +355,10 @@ def calculate_bypass_flow(
important as the soil gets wetter.
Args:
- top_soil_moisture: soil moisture of top soil layer, [mm]
- sat_top_soil_moisture: soil moisture of top soil layer at saturation, [mm]
- available_water: amount of water available for infiltration, [mm]
- infiltration_shape_parameter: shape parameter for infiltration
+ top_soil_moisture: Soil moisture of top soil layer, [mm]
+ sat_top_soil_moisture: Soil moisture of top soil layer at saturation, [mm]
+ available_water: Amount of water available for infiltration, [mm]
+ infiltration_shape_parameter: Shape parameter for infiltration
Returns:
preferential bypass flow, [mm]
@@ -371,17 +377,17 @@ def convert_mm_flow_to_m3_per_second(
seconds_to_day: float,
meters_to_millimeters: float,
) -> NDArray[np.float32]:
- """Convert river discharge from millimeters to m3/s.
+ """Convert river discharge from millimeters to m3 s-1.
Args:
- river_discharge_mm: total river discharge, [mm]
- area: area of each grid cell, [m2]
- days: number of days
- seconds_to_day: second to day conversion factor
- meters_to_millimeters: factor to convert between millimeters and meters
+ river_discharge_mm: Total river discharge, [mm]
+ area: Area of each grid cell, [m2]
+ days: Number of days
+ seconds_to_day: Second to day conversion factor
+ meters_to_millimeters: Factor to convert between millimeters and meters
Returns:
- river discharge rate for each grid cell in m3/s
+ river discharge rate for each grid cell, [m3 s-1]
"""
return river_discharge_mm / meters_to_millimeters / days / seconds_to_day * area
@@ -401,9 +407,9 @@ def calculate_surface_runoff(
added to the current soil moisture level and runoff is set to zero.
Args:
- precipitation_surface: precipitation that reaches surface, [mm]
- top_soil_moisture: water content of top soil layer, [mm]
- top_soil_moisture_capacity: soil mositure capacity of top soil layer, [mm]
+ precipitation_surface: Precipitation that reaches surface, [mm]
+ top_soil_moisture: Water content of top soil layer, [mm]
+ top_soil_moisture_capacity: Soil mositure capacity of top soil layer, [mm]
"""
# Calculate how much water can be added to soil before capacity is reached, [mm]
diff --git a/virtual_ecosystem/models/hydrology/below_ground.py b/virtual_ecosystem/models/hydrology/below_ground.py
index 3c7c54f35..7f90aff3a 100644
--- a/virtual_ecosystem/models/hydrology/below_ground.py
+++ b/virtual_ecosystem/models/hydrology/below_ground.py
@@ -1,7 +1,7 @@
"""The ``models.hydrology.below_ground`` module simulates the below-ground hydrological
processes for the Virtual Ecosystem. This includes vertical flow, soil moisture and
matric potential, groundwater storage, and subsurface horizontal flow.
-""" # noqa: D205, D415
+""" # noqa: D205
import numpy as np
from numpy.typing import NDArray
@@ -51,16 +51,16 @@ def calculate_vertical_flow(
Args:
soil_moisture: Volumetric relative water content in top soil, [unitless]
soil_layer_thickness: Thickness of all soil_layers, [mm]
- soil_moisture_capacity: soil moisture capacity, [unitless]
- soil_moisture_residual: residual soil moisture, [unitless]
- hydraulic_conductivity: hydraulic conductivity of soil, [m/s]
- hydraulic_gradient: hydraulic gradient (change in hydraulic head) along the flow
+ soil_moisture_capacity: Soil moisture capacity, [unitless]
+ soil_moisture_residual: Residual soil moisture, [unitless]
+ hydraulic_conductivity: Hydraulic conductivity of soil, [m/s]
+ hydraulic_gradient: Hydraulic gradient (change in hydraulic head) along the flow
path, positive values indicate downward flow, [m/m]
- nonlinearily_parameter: dimensionless parameter in van Genuchten model that
+ nonlinearily_parameter: Dimensionless parameter in van Genuchten model that
describes the degree of nonlinearity of the relationship between the
volumetric water content and the soil matric potential.
- groundwater_capacity: storage capacity of groundwater, [mm]
- seconds_to_day: factor to convert between second and day
+ groundwater_capacity: Storage capacity of groundwater, [mm]
+ seconds_to_day: Factor to convert between second and day
Returns:
volumetric flow rate of water, [mm d-1]
@@ -120,28 +120,33 @@ def update_soil_moisture(
removed from the second soil layer.
Args:
- soil_moisture: soil moisture after infiltration and surface evaporation, [mm]
- vertical_flow: vertical flow between all layers, [mm]
- evapotranspiration: canopy evaporation, [mm]
- soil_moisture_capacity: soil moisture capacity for each layer, [mm]
- soil_moisture_residual: residual soil moisture for each layer, [mm]
+ soil_moisture: Soil moisture after infiltration and surface evaporation, [mm]
+ vertical_flow: Vertical flow between all layers, [mm]
+ evapotranspiration: Canopy evaporation, [mm]
+ soil_moisture_capacity: Soil moisture capacity for each layer, [mm]
+ soil_moisture_residual: Residual soil moisture for each layer, [mm]
Returns:
updated soil moisture profile, relative volumetric water content, dimensionless
"""
# TODO this is currently not conserving water
+ # Remove vertical flow from topsoil moisture and ensure it is within capacity
top_soil_moisture = np.clip(
soil_moisture[0] - vertical_flow[0],
soil_moisture_residual[0],
soil_moisture_capacity[0],
)
+ # Add topsoil vertical flow to layer below and remove that layers flow as well as
+ # evapotranspiration = root water uptake, and ensure it is within capacity
root_soil_moisture = np.clip(
soil_moisture[1] + vertical_flow[0] - vertical_flow[1] - evapotranspiration,
soil_moisture_residual[1],
soil_moisture_capacity[1],
)
+ # For all further soil layers, add the vertical flow from the layer above, remove
+ # that layers flow, and ensure it is within capacity
if len(vertical_flow) == 2:
soil_moisture_updated = np.stack((top_soil_moisture, root_soil_moisture))
@@ -183,15 +188,15 @@ def convert_soil_moisture_to_water_potential(
water retention curvature parameter.
Args:
- soil_moisture: Volumetric relative water content [unitless]
- air_entry_water_potential: Water potential at which soil pores begin to aerate
+ soil_moisture: Volumetric relative water content, [unitless]
+ air_entry_water_potential: Water potential at which soil pores begin to aerate,
[kPa]
- water_retention_curvature: Curvature of water retention curve [unitless]
+ water_retention_curvature: Curvature of water retention curve, [unitless]
soil_moisture_capacity: The relative water content at which the soil is fully
- saturated [unitless].
+ saturated, [unitless].
Returns:
- An estimate of the water potential of the soil [kPa]
+ An estimate of the water potential of the soil, [kPa]
"""
return air_entry_water_potential * (
@@ -199,7 +204,7 @@ def convert_soil_moisture_to_water_potential(
)
-def update_groundwater_storge(
+def update_groundwater_storage(
groundwater_storage: NDArray[np.float32],
vertical_flow_to_groundwater: NDArray[np.float32],
bypass_flow: NDArray[np.float32],
@@ -262,20 +267,20 @@ def update_groundwater_storge(
the value of ath:`GW_{loss}`, the larger the amount of water that leaves the system.
Args:
- groundwater_storage: amount of water that is stored in the groundwater reservoir
+ groundwater_storage: Amount of water that is stored in the groundwater reservoir
, [mm]
- vertical_flow_to_groundwater: flux from the lower soil layer to groundwater for
+ vertical_flow_to_groundwater: Flow from the lower soil layer to groundwater for
this timestep, [mm]
- bypass_flow: flow that bypasses the soil matrix and drains directly to the
+ bypass_flow: Flow that bypasses the soil matrix and drains directly to the
groundwater, [mm]
- max_percolation_rate_uzlz: maximum percolation rate between upper and lower
+ max_percolation_rate_uzlz: Maximum percolation rate between upper and lower
groundwater zone, [mm d-1]
- groundwater_loss: constant amount of water that never rejoins the river channel
+ groundwater_loss: Constant amount of water that never rejoins the river channel
and is lost beyond the catchment boundaries or to deep groundwater systems,
[mm]
- reservoir_const_upper_groundwater: reservoir constant for the upper groundwater
+ reservoir_const_upper_groundwater: Reservoir constant for the upper groundwater
layer, [days]
- reservoir_const_lower_groundwater: reservoir constant for the lower groundwater
+ reservoir_const_lower_groundwater: Reservoir constant for the lower groundwater
layer, [days]
Returns:
diff --git a/virtual_ecosystem/models/hydrology/constants.py b/virtual_ecosystem/models/hydrology/constants.py
index 10cbbcb63..7e4e3cfd6 100644
--- a/virtual_ecosystem/models/hydrology/constants.py
+++ b/virtual_ecosystem/models/hydrology/constants.py
@@ -1,12 +1,12 @@
"""The :mod:`~virtual_ecosystem.models.hydrology.constants` module contains a set of
-dataclasses containing and parameters required by the
+dataclasses containing parameters required by the
:mod:`~virtual_ecosystem.models.hydrology.hydrology_model`. These parameters are
constants in that they should not be changed during a particular simulation.
TODO Soil parameters vary strongly with soil type and will require literature search and
sensitivity analysis to produce meaningful results. The current default values are just
examples within reasonable bounds.
-""" # noqa: D205, D415
+""" # noqa: D205
from dataclasses import dataclass
@@ -55,32 +55,17 @@ class HydroConsts(ConstantsDataclass):
movement of water and indicates the direction in which water will flow.
"""
- seconds_to_day: float = 86400
- """Factor to convert variable unit from seconds to day."""
-
nonlinearily_parameter: float = 2.0
"""Nonlinearity parameter n (dimensionless) in Mualem-van Genuchten model.
This parameter is a fitting shape parameters of soil water retention curve, see
:cite:p:`van_genuchten_closed-form_1980`."""
- meters_to_mm: float = 1000
- """Factor to convert variable unit from meters to millimeters."""
-
- celsius_to_kelvin: float = 273.15
- """Factor to convert variable unit from Celsius to Kelvin."""
-
- density_air: float = 1.225
- """Density of air under standard atmosphere, [kg m-3]"""
+ soil_surface_heat_transfer_coefficient: float = 12.5
+ """Heat transfer coefficient from soil to atmosphere above, [W m-2 K-1].
- latent_heat_vapourisation: float = 2.45
- """Latent heat of vapourisation under standard atmosphere, [MJ kg-1]"""
-
- gas_constant_water_vapour: float = 461.51
- """Gas constant for water vapour, [J kg-1 K-1]"""
-
- heat_transfer_coefficient: float = 12.5
- """Heat transfer coefficient, :cite:p:`van_de_griend_bare_1994` """
+ :cite:p:`van_de_griend_bare_1994`.
+ """
stream_flow_capacity: float = 5000.0
"""Stream flow capacity, [mm per timestep].
@@ -89,22 +74,10 @@ class HydroConsts(ConstantsDataclass):
At the moment, this is set as an arbitrary value, but could be used in the future to
flag flood events."""
- intercept_param_1: float = 0.935
- """Interception parameter 1.
-
- Parameter in equation that estimates maximum canopy interception capacity after
- :cite:t:`von_hoyningen-huene_interzeption_1981`."""
-
- intercept_param_2: float = 0.498
- """Interception parameter 2.
-
- Parameter in equation that estimates maximum canopy interception capacity after
- :cite:t:`von_hoyningen-huene_interzeption_1981`."""
-
- intercept_param_3: float = 0.00575
- """Interception parameter 3.
+ intercept_parameters: tuple[float, float, float] = (0.935, 0.498, 0.00575)
+ """Interception parameters.
- Parameter in equation that estimates maximum canopy interception capacity after
+ Parameters in equation that estimates maximum canopy interception capacity after
:cite:t:`von_hoyningen-huene_interzeption_1981`."""
veg_density_param: float = 0.046
diff --git a/virtual_ecosystem/models/hydrology/hydrology_model.py b/virtual_ecosystem/models/hydrology/hydrology_model.py
index e243d7340..4be9e11c9 100644
--- a/virtual_ecosystem/models/hydrology/hydrology_model.py
+++ b/virtual_ecosystem/models/hydrology/hydrology_model.py
@@ -2,18 +2,29 @@
creates a
:class:`~virtual_ecosystem.models.hydrology.hydrology_model.HydrologyModel`
class as a child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` class.
-At present a lot of the abstract methods of the parent class (e.g.
-:func:`~virtual_ecosystem.core.base_model.BaseModel.spinup`) are overwritten using
-placeholder functions that don't do anything. This will change as the Virtual Ecosystem
-model develops. The factory method
-:func:`~virtual_ecosystem.models.hydrology.hydrology_model.HydrologyModel.from_config`
-exists in a more complete state, and unpacks a small number of parameters from our
-currently pretty minimal configuration dictionary. These parameters are then used to
-generate a class instance. If errors crop here when converting the information from the
-config dictionary to the required types they are caught and then logged, and at the end
-of the unpacking an error is thrown. This error should be caught and handled by
-downstream functions so that all model configuration failures can be reported as one.
-""" # noqa: D205, D415
+
+There are still a number of open TODOs related to process implementation and improvement
+, time step and model structure, and units and module coordination.
+
+TODO processes
+
+ * spin up soil moisture and accumulated runoff
+ * set boundaries for river discharge
+ * add canopy evaporation
+ * update infiltration process
+
+TODO time step and model structure
+
+ * find a way to load daily (precipitation) data and loop over daily time_index
+ * allow for different time steps (currently only 30 days)
+ * potentially move `calculate_drainage_map` to core
+ * add abiotic constants from config
+
+TODO units and module coordination
+
+ * change temperature to Kelvin
+
+""" # noqa: D205
from __future__ import annotations
@@ -32,7 +43,12 @@ class as a child of the :class:`~virtual_ecosystem.core.base_model.BaseModel` cl
from virtual_ecosystem.core.data import Data
from virtual_ecosystem.core.exceptions import InitialisationError
from virtual_ecosystem.core.logger import LOGGER
-from virtual_ecosystem.models.hydrology import above_ground, below_ground
+from virtual_ecosystem.models.abiotic.constants import AbioticConsts
+from virtual_ecosystem.models.hydrology import (
+ above_ground,
+ below_ground,
+ hydrology_tools,
+)
from virtual_ecosystem.models.hydrology.constants import HydroConsts
@@ -40,27 +56,66 @@ class HydrologyModel(
BaseModel,
model_name="hydrology",
model_update_bounds=("1 day", "1 month"),
- required_init_vars=(
- ("precipitation", ("spatial",)),
- ("leaf_area_index", ("spatial",)),
- ("air_temperature_ref", ("spatial",)),
- ("relative_humidity_ref", ("spatial",)),
- ("atmospheric_pressure_ref", ("spatial",)),
- ("elevation", ("spatial",)),
+ vars_required_for_init=(
+ "layer_heights",
+ "elevation",
),
vars_updated=(
- "precipitation_surface", # precipitation-interception loss, input to `plants`
+ "precipitation_surface", # precipitation-interception loss
"soil_moisture",
"surface_runoff", # equivalent to SPLASH runoff
"vertical_flow",
+ "latent_heat_vapourisation",
+ "molar_density_air",
"soil_evaporation",
"surface_runoff_accumulated",
+ "subsurface_flow_accumulated",
"matric_potential",
"groundwater_storage",
"river_discharge_rate",
"total_river_discharge",
"subsurface_flow",
"baseflow",
+ "bypass_flow",
+ "aerodynamic_resistance_surface",
+ ),
+ vars_required_for_update=(
+ "air_temperature",
+ "relative_humidity",
+ "atmospheric_pressure",
+ "precipitation",
+ "wind_speed",
+ "leaf_area_index",
+ "layer_heights",
+ "soil_moisture",
+ "evapotranspiration",
+ "surface_runoff_accumulated",
+ "subsurface_flow_accumulated",
+ ),
+ vars_populated_by_init=(
+ "soil_moisture",
+ "groundwater_storage",
+ # "air_temperature", # NOTE also initiated in abiotic models, order?
+ # "relative_humidity", # NOTE also initiated in abiotic models, order?
+ "wind_speed",
+ # "atmospheric_pressure", # NOTE also initiated in abiotic models, order?
+ "surface_runoff_accumulated",
+ "subsurface_flow_accumulated",
+ ),
+ vars_populated_by_first_update=(
+ "precipitation_surface", # precipitation-interception loss
+ "surface_runoff",
+ "bypass_flow",
+ "soil_evaporation",
+ "vertical_flow",
+ "matric_potential",
+ "subsurface_flow",
+ "baseflow",
+ "total_river_discharge",
+ "river_discharge_rate",
+ "latent_heat_vapourisation",
+ "molar_density_air",
+ "aerodynamic_resistance_surface",
),
):
"""A class describing the hydrology model.
@@ -69,21 +124,15 @@ class HydrologyModel(
data: The data object to be used in the model.
core_components: The core components used across models.
initial_soil_moisture: The initial volumetric relative water content [unitless]
- for all layers.
+ for all layers. This will be converted to soil moisture in mm.
initial_groundwater_saturation: Initial level of groundwater saturation (between
- 0 and 1) for all layers and grid cells identical.
+ 0 and 1) for all layers and grid cells identical. This will be converted to
+ groundwater storage in mm.
model_constants: Set of constants for the hydrology model.
Raises:
InitialisationError: when soil moisture or saturation parameters are not numeric
- or out of [0,1] bounds.
-
- TODOs:
-
- * find a way to load daily (precipitation) data and loop over daily time_index
- * add time dimension to required_init_vars
- * allow for different time steps (currently only 30 days)
- * potentially move `calculate_drainage_map` to core
+ or out of [0, 1] bounds.
"""
def __init__(
@@ -102,7 +151,7 @@ def __init__(
("initial_soil_moisture", initial_soil_moisture),
("initial_groundwater_saturation", initial_groundwater_saturation),
):
- if not isinstance(value, (float, int)):
+ if not isinstance(value, float | int):
to_raise = InitialisationError(f"The {attr} must be numeric!")
LOGGER.error(to_raise)
raise to_raise
@@ -119,7 +168,9 @@ def __init__(
"""Initial level of groundwater saturation for all layers identical."""
self.model_constants: HydroConsts = model_constants
"""Set of constants for the hydrology model"""
- self.data.grid.set_neighbours(distance=sqrt(self.data.grid.cell_area))
+ self.core_constants = core_components.core_constants
+ """Set of core constants for the hydrology model"""
+ self.grid.set_neighbours(distance=sqrt(self.grid.cell_area))
"""Set neighbours."""
self.drainage_map = above_ground.calculate_drainage_map(
grid=self.data.grid,
@@ -127,6 +178,24 @@ def __init__(
)
"""Upstream neighbours for the calculation of accumulated horizontal flow."""
+ # Calculate layer thickness for soil moisture unit conversion and set structures
+ # and tile across grid cells
+ self.soil_layer_thickness_mm = np.tile(
+ (
+ self.layer_structure.soil_layer_thickness
+ * self.core_constants.meters_to_mm
+ )[:, None],
+ self.grid.n_cells,
+ )
+ """Soil layer thickness in mm."""
+
+ # Select aboveground layer for surface evaporation calculation
+ # TODO this needs to be replaced with 2m above ground value
+ self.surface_layer_index: int = self.layer_structure.index_surface_scalar
+ """Surface layer index."""
+
+ self._setup()
+
@classmethod
def from_config(
cls, data: Data, core_components: CoreComponents, config: Config
@@ -165,103 +234,87 @@ def from_config(
)
def setup(self) -> None:
+ """No longer in use.
+
+ TODO: Remove when the base model is updated.
+ """
+
+ def _setup(self) -> None:
"""Function to set up the hydrology model.
- At the moment, this function initializes variables that are required to run the
- first update(). Air temperature and relative humidity below the canopy are set
- to the 2 m reference values.
+ This function initializes variables that are required to run the
+ first update().
For the within grid cell hydrology, soil moisture is initialised homogenously
for all soil layers and groundwater storage is set to the percentage of it's
- capacity that was defined in the model configuration. This design might change
- with the implementation of the SPLASH model :cite:p:`davis_simple_2017` which
- will take care of part of the above-ground hydrology.
+ capacity that was defined in the model configuration.
For the hydrology across the grid, this function initialises the accumulated
surface runoff variable and the subsurface accumulated flow variable. Both
require a spinup which is currently not implemented.
"""
- # Create 1-dimensional numpy array filled with initial soil moisture values for
- # all soil layers and np.nan for atmosphere layers
- soil_moisture_values = np.repeat(
- a=[np.nan, self.initial_soil_moisture],
- repeats=[
- self.layer_structure.n_layers - len(self.layer_structure.soil_layers),
- len(self.layer_structure.soil_layers),
- ],
- )
- # Broadcast 1-dimensional array to grid and assign dimensions and coordinates
- self.data["soil_moisture"] = DataArray(
- np.broadcast_to(
- soil_moisture_values,
- (self.data.grid.n_cells, self.layer_structure.n_layers),
- ).T,
- dims=["layers", "cell_id"],
- coords={
- "layers": np.arange(self.layer_structure.n_layers),
- "layer_roles": ("layers", self.layer_structure.layer_roles),
- "cell_id": self.data.grid.cell_id,
- },
- name="soil_moisture",
- )
-
- # Create initial air temperature with reference temperature below the canopy
- # for first soil evaporation update.
- self.data["air_temperature"] = (
- DataArray(self.data["air_temperature_ref"].isel(time_index=0))
- .expand_dims("layers")
- .rename("air_temperature")
- .assign_coords(
- coords={
- "layers": [self.layer_structure.layer_roles.index("subcanopy")],
- "layer_roles": ("layers", ["subcanopy"]),
- "cell_id": self.data.grid.cell_id,
- },
- )
- )
-
- # Create initial relative humidity with reference humidity below the canopy
- # for first soil evaporation update.
- self.data["relative_humidity"] = (
- DataArray(self.data["relative_humidity_ref"].isel(time_index=0))
- .expand_dims("layers")
- .rename("relative_humidity")
- .assign_coords(
- coords={
- "layers": [self.layer_structure.layer_roles.index("subcanopy")],
- "layer_roles": ("layers", ["subcanopy"]),
- "cell_id": self.data.grid.cell_id,
- },
- )
+ # Calculate initial soil moisture, [mm]
+ self.data["soil_moisture"] = hydrology_tools.initialise_soil_moisture_mm(
+ soil_layer_thickness=self.soil_layer_thickness_mm,
+ layer_structure=self.layer_structure,
+ initial_soil_moisture=self.initial_soil_moisture,
)
- # Create initial groundwater storage variable with two layers
+ # Create initial groundwater storage variable with two layers, [mm]
+ # TODO think about including this in config, but we don't want to carry those
+ # layers around with all variables in the data object
initial_groundwater_storage = (
self.initial_groundwater_saturation
* self.model_constants.groundwater_capacity
)
self.data["groundwater_storage"] = DataArray(
- np.full((2, self.data.grid.n_cells), initial_groundwater_storage),
+ np.full((2, self.grid.n_cells), initial_groundwater_storage),
dims=("groundwater_layers", "cell_id"),
name="groundwater_storage",
)
- # Set initial above-round accumulated runoff to zero
- self.data["surface_runoff_accumulated"] = DataArray(
- np.zeros_like(self.data["elevation"]),
- dims="cell_id",
- name="surface_runoff_accumulated",
- coords={"cell_id": self.data.grid.cell_id},
- )
+ # Create subcanopy microclimate from reference height
+ # TODO this needs to be removed when variable system is up and running; only
+ # wind speed needs to be initialised when abiotic simple is used, see below
+ # TODO currently surface layer, needs to be replaced with 2m above ground
+ for var in [
+ "air_temperature",
+ "relative_humidity",
+ "wind_speed",
+ "atmospheric_pressure",
+ ]:
+ self.data[var] = (
+ DataArray(self.data[var + "_ref"].isel(time_index=0))
+ .expand_dims("layers")
+ .rename(var)
+ .assign_coords(
+ coords={
+ "layers": np.array([self.surface_layer_index]),
+ "layer_roles": ("layers", ["surface"]),
+ "cell_id": self.grid.cell_id,
+ },
+ )
+ )
- # Set initial sub-surface flow (including base flow) to zero
- self.data["subsurface_flow_accumulated"] = DataArray(
- np.zeros_like(self.data["elevation"]),
- dims="cell_id",
- name="subsurface_flow_accumulated",
- coords={"cell_id": self.data.grid.cell_id},
- )
+ # THIS IS THE ALTERNATIVE:
+ # If wind speed is not in data, which is the case if the abiotic_simple model is
+ # used, create subcanopy microclimate from reference height
+ # TODO currently surface layer, needs to be replaced with 2m above ground
+ # if "wind_speed" not in self.data:
+ # self.data["wind_speed"] = self.layer_structure.from_template()
+ # self.data["wind_speed"][self.surface_layer_index] = self.data[
+ # "wind_speed_ref"
+ # ].isel(time_index=0)
+
+ # Set initial above-ground accumulated runoff and sub-surface flow to zero
+ for var in ["surface_runoff_accumulated", "subsurface_flow_accumulated"]:
+ self.data[var] = DataArray(
+ np.zeros_like(self.data["elevation"]),
+ dims="cell_id",
+ name=var,
+ coords={"cell_id": self.grid.cell_id},
+ )
def spinup(self) -> None:
"""Placeholder function to spin up the hydrology model."""
@@ -273,17 +326,23 @@ def update(self, time_index: int, **kwargs: Any) -> None:
Ecosystem and updates the following variables in the `data` object:
* precipitation_surface, [mm]
- * soil_moisture, [-]
+ * soil_moisture, [mm]
* matric_potential, [kPa]
- * surface_runoff, [mm], equivalent to SPLASH runoff
+ * surface_runoff, [mm]
* surface_runoff_accumulated, [mm]
+ * subsurface_flow, [mm]
+ * subsurface_flow_accumulated, [mm]
* soil_evaporation, [mm]
* vertical_flow, [mm d-1]
+ * latent_heat_vapourisation, [J kg-1]
+ * molar_density_air, [mol m-3]
* groundwater_storage, [mm]
* subsurface_flow, [mm]
* baseflow, [mm]
* total_river_discharge, [mm]
* river_discharge_rate, [m3 s-1]
+ * bypass flow, [mm]
+ * aerodynamic_resistance_surface, [kg m-2 s-3]
Many of the underlying processes are problematic at a monthly timestep, which is
currently the only supported update interval. As a short-term work around, the
@@ -303,12 +362,9 @@ def update(self, time_index: int, **kwargs: Any) -> None:
: if precipitation exceeds top soil moisture capacity
, the excess water is added to runoff and top soil moisture is set to soil
moisture capacity value; if the top soil is not saturated, precipitation is
- added to the current soil moisture level and runoff is set to zero. Note that
- this function will likely change with the implementation of the SPLASH model
- :cite:p:`davis_simple_2017` in the plant module which will take care of the grid
- cell based above-ground hydrology. The accumulated surface runoff is calculated
- as the sum of current runoff and the runoff from upstream cells at the previous
- time step, see
+ added to the current soil moisture level and runoff is set to zero.
+ The accumulated surface runoff is calculated as the sum of current runoff and
+ the runoff from upstream cells at the previous time step, see
:func:`~virtual_ecosystem.models.hydrology.above_ground.accumulate_horizontal_flow`
.
@@ -334,7 +390,7 @@ def update(self, time_index: int, **kwargs: Any) -> None:
Groundwater storage and flows are modelled using two parallel linear
reservoirs, see
- :func:`~virtual_ecosystem.models.hydrology.below_ground.update_groundwater_storge`
+ :func:`~virtual_ecosystem.models.hydrology.below_ground.update_groundwater_storage`
. The horizontal flow between grid cells currently uses the same function as the
above ground runoff.
@@ -347,13 +403,13 @@ def update(self, time_index: int, **kwargs: Any) -> None:
* relative humidity, []
* atmospheric pressure, [kPa]
* precipitation, [mm]
- * wind speed (currently not implemented, default = 0.1 m s-1)
+ * wind speed, [m s-1]
* leaf area index, [m m-2]
* layer heights, [m]
- * Volumetric relative water content (previous time step), [unitless]
+ * Soil moisture (previous time step), [mm]
* evapotranspiration (current time step), [mm]
* accumulated surface runoff (previous time step), [mm]
- * accumulated subsurface runoff (previous time step), [mm]
+ * accumulated subsurface flow (previous time step), [mm]
and a number of parameters that as described in detail in
:class:`~virtual_ecosystem.models.hydrology.constants.HydroConsts`.
@@ -370,15 +426,18 @@ def update(self, time_index: int, **kwargs: Any) -> None:
seed: None | int = kwargs.pop("seed", None)
# Select variables at relevant heights for current time step
- hydro_input = setup_hydrology_input_current_timestep(
+ abiotic_constants = AbioticConsts()
+ hydro_input = hydrology_tools.setup_hydrology_input_current_timestep(
data=self.data,
time_index=time_index,
days=days,
seed=seed,
- layer_roles=self.layer_structure.layer_roles,
+ layer_structure=self.layer_structure,
+ soil_layer_thickness_mm=self.soil_layer_thickness_mm,
soil_moisture_capacity=self.model_constants.soil_moisture_capacity,
soil_moisture_residual=self.model_constants.soil_moisture_residual,
- meters_to_mm=self.model_constants.meters_to_mm,
+ core_constants=self.core_constants,
+ latent_heat_vap_equ_factors=(abiotic_constants.latent_heat_vap_equ_factors),
)
# Create lists for output variables to store daily data
@@ -389,12 +448,12 @@ def update(self, time_index: int, **kwargs: Any) -> None:
interception = above_ground.calculate_interception(
leaf_area_index=hydro_input["leaf_area_index_sum"],
precipitation=hydro_input["current_precipitation"][:, day],
- intercept_param_1=self.model_constants.intercept_param_1,
- intercept_param_2=self.model_constants.intercept_param_2,
- intercept_param_3=self.model_constants.intercept_param_3,
+ intercept_parameters=self.model_constants.intercept_parameters,
veg_density_param=self.model_constants.veg_density_param,
)
+ # TODO add canopy evaporation
+
# Precipitation that reaches the surface per day, [mm]
precipitation_surface = (
hydro_input["current_precipitation"][:, day] - interception
@@ -404,77 +463,89 @@ def update(self, time_index: int, **kwargs: Any) -> None:
# Calculate daily surface runoff of each grid cell, [mm]; replace by SPLASH
surface_runoff = above_ground.calculate_surface_runoff(
precipitation_surface=precipitation_surface,
- top_soil_moisture=hydro_input["soil_moisture_mm"][0],
- top_soil_moisture_capacity=hydro_input["top_soil_moisture_capacity_mm"],
+ top_soil_moisture=hydro_input["current_soil_moisture"][0],
+ top_soil_moisture_capacity=hydro_input["top_soil_moisture_capacity"],
)
-
daily_lists["surface_runoff"].append(surface_runoff)
# Calculate preferential bypass flow, [mm]
bypass_flow = above_ground.calculate_bypass_flow(
- top_soil_moisture=hydro_input["soil_moisture_mm"][0],
- sat_top_soil_moisture=hydro_input["top_soil_moisture_capacity_mm"],
+ top_soil_moisture=hydro_input["current_soil_moisture"][0],
+ sat_top_soil_moisture=hydro_input["top_soil_moisture_capacity"],
available_water=precipitation_surface - surface_runoff,
infiltration_shape_parameter=(
self.model_constants.infiltration_shape_parameter
),
)
+ daily_lists["bypass_flow"].append(bypass_flow)
# Calculate top soil moisture after infiltration, [mm]
soil_moisture_infiltrated = np.clip(
(
- hydro_input["soil_moisture_mm"][0]
+ hydro_input["current_soil_moisture"][0]
+ precipitation_surface
- surface_runoff
- bypass_flow,
),
0,
- hydro_input["top_soil_moisture_capacity_mm"],
+ hydro_input["top_soil_moisture_capacity"],
).squeeze()
- # Calculate daily soil evaporation, [mm]
+ # Prepare inputs for soil evaporation function
+ # TODO currently surface layer, needs to be replaced with 2m above ground
top_soil_moisture_vol = (
- soil_moisture_infiltrated / hydro_input["soil_layer_thickness"][0]
+ soil_moisture_infiltrated / self.soil_layer_thickness_mm[0]
+ )
+ latent_heat_vapourisation = (
+ hydro_input["latent_heat_vapourisation"][self.surface_layer_index]
+ / 1000.0
+ )
+ density_air_kg = (
+ hydro_input["molar_density_air"][self.surface_layer_index]
+ * self.core_constants.molecular_weight_air
+ / 1000.0
)
soil_evaporation = above_ground.calculate_soil_evaporation(
- temperature=hydro_input["subcanopy_temperature"],
- relative_humidity=hydro_input["subcanopy_humidity"],
- atmospheric_pressure=hydro_input["subcanopy_pressure"],
+ temperature=hydro_input["surface_temperature"],
+ relative_humidity=hydro_input["surface_humidity"],
+ atmospheric_pressure=hydro_input["surface_pressure"],
soil_moisture=top_soil_moisture_vol,
soil_moisture_residual=self.model_constants.soil_moisture_residual,
soil_moisture_capacity=self.model_constants.soil_moisture_capacity,
leaf_area_index=hydro_input["leaf_area_index_sum"],
- wind_speed=0.1, # m/s TODO wind_speed in data object
- celsius_to_kelvin=self.model_constants.celsius_to_kelvin,
- density_air=self.model_constants.density_air,
- latent_heat_vapourisation=(
- self.model_constants.latent_heat_vapourisation
- ),
- gas_constant_water_vapour=(
- self.model_constants.gas_constant_water_vapour
- ),
- heat_transfer_coefficient=(
- self.model_constants.heat_transfer_coefficient
+ wind_speed_surface=hydro_input["surface_wind_speed"],
+ celsius_to_kelvin=self.core_constants.zero_Celsius,
+ density_air=density_air_kg,
+ latent_heat_vapourisation=latent_heat_vapourisation,
+ gas_constant_water_vapour=self.core_constants.gas_constant_water_vapour,
+ soil_surface_heat_transfer_coefficient=(
+ self.model_constants.soil_surface_heat_transfer_coefficient
),
extinction_coefficient_global_radiation=(
self.model_constants.extinction_coefficient_global_radiation
),
)
- daily_lists["soil_evaporation"].append(soil_evaporation)
+ daily_lists["soil_evaporation"].append(soil_evaporation["soil_evaporation"])
+ daily_lists["aerodynamic_resistance_surface"].append(
+ soil_evaporation["aerodynamic_resistance_surface"]
+ )
# Calculate top soil moisture after evap and combine with lower layers, [mm]
- soil_moisture_evap: NDArray[np.float32] = np.concatenate(
+ soil_moisture_evap_mm: NDArray[np.float32] = np.concatenate(
(
np.expand_dims(
np.clip(
- (soil_moisture_infiltrated - soil_evaporation),
- hydro_input["top_soil_moisture_residual_mm"],
- hydro_input["top_soil_moisture_capacity_mm"],
+ (
+ soil_moisture_infiltrated
+ - soil_evaporation["soil_evaporation"]
+ ),
+ hydro_input["top_soil_moisture_residual"],
+ hydro_input["top_soil_moisture_capacity"],
),
axis=0,
),
- hydro_input["soil_moisture_mm"][1:],
+ hydro_input["current_soil_moisture"][1:],
)
)
@@ -483,8 +554,9 @@ def update(self, time_index: int, **kwargs: Any) -> None:
# spatial scale of this model and this can only be treated as a very rough
# approximation to discuss nutrient leaching.
vertical_flow = below_ground.calculate_vertical_flow(
- soil_moisture=soil_moisture_evap / hydro_input["soil_layer_thickness"],
- soil_layer_thickness=hydro_input["soil_layer_thickness"], # mm
+ soil_moisture=soil_moisture_evap_mm
+ / self.soil_layer_thickness_mm, # vol
+ soil_layer_thickness=self.soil_layer_thickness_mm, # mm
soil_moisture_capacity=(
self.model_constants.soil_moisture_capacity
), # vol
@@ -497,34 +569,31 @@ def update(self, time_index: int, **kwargs: Any) -> None:
hydraulic_gradient=self.model_constants.hydraulic_gradient, # m/m
nonlinearily_parameter=self.model_constants.nonlinearily_parameter,
groundwater_capacity=self.model_constants.groundwater_capacity,
- seconds_to_day=self.model_constants.seconds_to_day,
+ seconds_to_day=self.core_constants.seconds_to_day,
)
daily_lists["vertical_flow"].append(vertical_flow)
# Update soil moisture by +/- vertical flow to each layer and remove root
# water uptake by plants (transpiration), [mm]
soil_moisture_updated = below_ground.update_soil_moisture(
- soil_moisture=soil_moisture_evap,
- vertical_flow=vertical_flow,
- evapotranspiration=hydro_input["current_evapotranspiration"],
- soil_moisture_capacity=(
+ soil_moisture=soil_moisture_evap_mm, # mm
+ vertical_flow=vertical_flow, # mm
+ evapotranspiration=hydro_input["current_evapotranspiration"], # mm
+ soil_moisture_capacity=( # mm
self.model_constants.soil_moisture_capacity
- * hydro_input["soil_layer_thickness"]
+ * self.soil_layer_thickness_mm
),
- soil_moisture_residual=(
+ soil_moisture_residual=( # mm
self.model_constants.soil_moisture_residual
- * hydro_input["soil_layer_thickness"]
+ * self.soil_layer_thickness_mm
),
)
-
- daily_lists["soil_moisture"].append(
- soil_moisture_updated / hydro_input["soil_layer_thickness"]
- )
+ daily_lists["soil_moisture"].append(soil_moisture_updated)
# Convert soil moisture to matric potential
matric_potential = below_ground.convert_soil_moisture_to_water_potential(
soil_moisture=(
- soil_moisture_updated / hydro_input["soil_layer_thickness"]
+ soil_moisture_updated / self.soil_layer_thickness_mm # vol
),
air_entry_water_potential=(
self.model_constants.air_entry_water_potential
@@ -537,7 +606,7 @@ def update(self, time_index: int, **kwargs: Any) -> None:
daily_lists["matric_potential"].append(matric_potential)
# calculate below ground horizontal flow and update ground water
- below_ground_flow = below_ground.update_groundwater_storge(
+ below_ground_flow = below_ground.update_groundwater_storage(
groundwater_storage=hydro_input["groundwater_storage"],
vertical_flow_to_groundwater=vertical_flow[-1],
bypass_flow=bypass_flow,
@@ -556,99 +625,104 @@ def update(self, time_index: int, **kwargs: Any) -> None:
for var in ["groundwater_storage", "subsurface_flow", "baseflow"]:
daily_lists[var].append(below_ground_flow[var])
+ # Calculate horizontal flow
+ # Calculate accumulated runoff for each cell (me+sum of upstream neighbours)
+ new_accumulated_runoff = above_ground.accumulate_horizontal_flow(
+ drainage_map=self.drainage_map,
+ current_flow=surface_runoff,
+ previous_accumulated_flow=hydro_input["previous_accumulated_runoff"],
+ )
+ daily_lists["surface_runoff_accumulated"].append(new_accumulated_runoff)
+
+ # Calculate subsurface accumulated flow, [mm]
+ new_subsurface_flow_accumulated = above_ground.accumulate_horizontal_flow(
+ drainage_map=self.drainage_map,
+ current_flow=np.array(
+ below_ground_flow["subsurface_flow"] + below_ground_flow["baseflow"]
+ ),
+ previous_accumulated_flow=(
+ hydro_input["previous_subsurface_flow_accumulated"]
+ ),
+ )
+ daily_lists["subsurface_flow_accumulated"].append(
+ new_subsurface_flow_accumulated
+ )
+
+ # Calculate total river discharge as sum of above- and below-ground flow
+ total_river_discharge = (
+ new_accumulated_runoff + new_subsurface_flow_accumulated
+ )
+ daily_lists["total_river_discharge"].append(total_river_discharge)
+
+ # Convert total discharge to river discharge rate, [m3 s-1]
+ river_discharge_rate = above_ground.convert_mm_flow_to_m3_per_second(
+ river_discharge_mm=total_river_discharge,
+ area=self.grid.cell_area,
+ days=days,
+ seconds_to_day=self.core_constants.seconds_to_day,
+ meters_to_millimeters=self.core_constants.meters_to_mm,
+ )
+ daily_lists["river_discharge_rate"].append(river_discharge_rate)
+
# update inputs for next day
- hydro_input["soil_moisture_mm"] = soil_moisture_updated
+ hydro_input["current_soil_moisture"] = soil_moisture_updated
hydro_input["groundwater_storage"] = below_ground_flow[
"groundwater_storage"
]
+ hydro_input["previous_accumulated_runoff"] = new_accumulated_runoff
+ hydro_input["subsurface_flow_accumulated"] = new_subsurface_flow_accumulated
# create output dict as intermediate step to not overwrite data directly
soil_hydrology = {}
- # Calculate monthly accumulated/mean values with 'cell_id' dimension only
+ # Return monthly latent heat of vapourisation and molar density of air
+ # (currently only one value per month, will be average with daily input)
+ for var in ["latent_heat_vapourisation", "molar_density_air"]:
+ soil_hydrology[var] = DataArray(
+ hydro_input[var],
+ dims=self.data["layer_heights"].dims,
+ coords=self.data["layer_heights"].coords,
+ )
+
+ # Calculate monthly accumulated/mean values for hydrology variables
for var in [
"precipitation_surface",
"surface_runoff",
"soil_evaporation",
"subsurface_flow",
"baseflow",
+ "bypass_flow",
+ "surface_runoff_accumulated",
+ "subsurface_flow_accumulated",
+ "total_river_discharge",
]:
soil_hydrology[var] = DataArray(
np.sum(np.stack(daily_lists[var], axis=1), axis=1),
dims="cell_id",
- coords={"cell_id": self.data.grid.cell_id},
+ coords={"cell_id": self.grid.cell_id},
)
- soil_hydrology["vertical_flow"] = DataArray( # vertical flow thought top soil
+ soil_hydrology["vertical_flow"] = DataArray( # vertical flow through top soil
np.mean(np.stack(daily_lists["vertical_flow"][0], axis=1), axis=1),
dims="cell_id",
- coords={"cell_id": self.data.grid.cell_id},
+ coords={"cell_id": self.grid.cell_id},
)
+ for var in ["river_discharge_rate", "aerodynamic_resistance_surface"]:
+ soil_hydrology[var] = DataArray(
+ np.mean(np.stack(daily_lists[var], axis=1), axis=1),
+ dims="cell_id",
+ coords={"cell_id": self.grid.cell_id},
+ )
+
# Return mean soil moisture, [-], and matric potential, [kPa], and add
# atmospheric layers (nan)
for var in ["soil_moisture", "matric_potential"]:
- soil_hydrology[var] = DataArray(
- np.concatenate(
- (
- np.full(
- (
- self.layer_structure.n_layers
- - self.layer_structure.layer_roles.count("soil"),
- self.data.grid.n_cells,
- ),
- np.nan,
- ),
- np.mean(
- np.stack(daily_lists[var], axis=0),
- axis=0,
- ),
- ),
- ),
- dims=self.data["layer_heights"].dims,
- coords=self.data["layer_heights"].coords,
+ soil_hydrology[var] = self.layer_structure.from_template()
+ soil_hydrology[var][self.layer_structure.index_all_soil] = np.mean(
+ np.stack(daily_lists[var], axis=0), axis=0
)
- # Calculate accumulated runoff for each cell (me + sum of upstream neighbours)
- new_accumulated_runoff = above_ground.accumulate_horizontal_flow(
- drainage_map=self.drainage_map,
- current_flow=np.array(soil_hydrology["surface_runoff"]),
- previous_accumulated_flow=hydro_input["previous_accumulated_runoff"],
- )
-
- soil_hydrology["surface_runoff_accumulated"] = DataArray(
- new_accumulated_runoff, dims="cell_id"
- )
-
- # Calculate subsurface accumulated flow, [mm]
- new_subsurface_flow_accumulated = above_ground.accumulate_horizontal_flow(
- drainage_map=self.drainage_map,
- current_flow=np.array(
- soil_hydrology["subsurface_flow"] + soil_hydrology["baseflow"]
- ),
- previous_accumulated_flow=(
- hydro_input["previous_subsurface_flow_accumulated"]
- ),
- )
-
- # Calculate total river discharge as sum of above- and below-ground flow, [mm]
- total_river_discharge = new_accumulated_runoff + new_subsurface_flow_accumulated
- soil_hydrology["total_river_discharge"] = DataArray(
- total_river_discharge, dims="cell_id"
- )
-
- # Convert total discharge to river discharge rate, [m3 s-1]
- river_discharge_rate = above_ground.convert_mm_flow_to_m3_per_second(
- river_discharge_mm=total_river_discharge,
- area=self.data.grid.cell_area,
- days=days,
- seconds_to_day=self.model_constants.seconds_to_day,
- meters_to_millimeters=self.model_constants.meters_to_mm,
- )
- soil_hydrology["river_discharge_rate"] = DataArray(
- river_discharge_rate, dims="cell_id"
- )
-
# Save last state of groundwater stoage, [mm]
soil_hydrology["groundwater_storage"] = DataArray(
daily_lists["groundwater_storage"][day],
@@ -660,127 +734,3 @@ def update(self, time_index: int, **kwargs: Any) -> None:
def cleanup(self) -> None:
"""Placeholder function for hydrology model cleanup."""
-
-
-def calculate_layer_thickness(
- soil_layer_heights: NDArray[np.float32],
- meters_to_mm: float,
-) -> NDArray[np.float32]:
- """Calculate layer thickness from soil layer depth profile.
-
- Args:
- soil_layer_heights: soil layer heights, [m]
- meters_to_mm: meter to millimeter conversion factor
-
- Returns:
- soil layer thickness, mm
- """
-
- return np.diff(soil_layer_heights, axis=0, prepend=0) * (-meters_to_mm)
-
-
-def setup_hydrology_input_current_timestep(
- data: Data,
- time_index: int,
- days: int,
- seed: None | int,
- layer_roles: list[str],
- soil_moisture_capacity: float,
- soil_moisture_residual: float,
- meters_to_mm: float,
-) -> dict[str, NDArray[np.float32]]:
- """Select and pre-process inputs to hydrology.update() for current time step.
-
- The function resturns a dictionary with the following variables:
-
- * current_precipitation
- * subcanopy_temperature
- * subcanopy_humidity
- * subcanopy_pressure
- * leaf_area_index_sum
- * current_evapotranspiration
- * soil_layer_heights
- * soil_layer_thickness
- * top_soil_moisture_capacity_mm
- * top_soil_moisture_residual_mm
- * soil_moisture_mm
- * previous_accumulated_runoff
- * previous_subsurface_flow_accumulated
- * groundwater_storage
-
- Args:
- data: Data object that contains inputs from the microclimate model, the plant
- model, and the hydrology model that are required for current update
- time_index: time index
- days: number of days
- seed: seed for random rainfall generator
- layer_roles: list of layer roles
- soil_moisture_capacity: soil moisture capacity, unitless
- soil_moisture_residual: soil moisture residual, unitless
- meters_to_mm: factor to convert between meters and millimieters
-
- Returns:
- dictionary with all variables that are required to run one hydrology update()
- """
-
- output = {}
-
- # Get atmospheric variables
- output["current_precipitation"] = above_ground.distribute_monthly_rainfall(
- (data["precipitation"].isel(time_index=time_index)).to_numpy(),
- num_days=days,
- seed=seed,
- )
- output["subcanopy_temperature"] = (
- data["air_temperature"].isel(layers=layer_roles.index("subcanopy"))
- ).to_numpy()
- output["subcanopy_humidity"] = (
- data["relative_humidity"].isel(layers=layer_roles.index("subcanopy"))
- ).to_numpy()
- output["subcanopy_pressure"] = (
- data["atmospheric_pressure_ref"].isel(time_index=time_index).to_numpy()
- )
-
- # Get inputs from plant model
- output["leaf_area_index_sum"] = data["leaf_area_index"].sum(dim="layers").to_numpy()
- output["current_evapotranspiration"] = (
- data["evapotranspiration"].sum(dim="layers") / days
- ).to_numpy()
-
- # Select soil variables
- output["soil_layer_heights"] = (
- data["layer_heights"].isel(layers=data["layer_roles"] == "soil").to_numpy()
- )
-
- # FIXME - there's an implicit axis order built into these calculations (vertical
- # profile is axis 0) that needs fixing.
-
- output["soil_layer_thickness"] = calculate_layer_thickness( # [mm]
- soil_layer_heights=output["soil_layer_heights"],
- meters_to_mm=meters_to_mm,
- )
- output["top_soil_moisture_capacity_mm"] = (
- soil_moisture_capacity * output["soil_layer_thickness"][0]
- )
- output["top_soil_moisture_residual_mm"] = (
- soil_moisture_residual * output["soil_layer_thickness"][0]
- )
-
- # Convert soil moisture (volumetric relative water content) to mm as follows:
- # water content in mm = relative water content / 100 * depth in mm
- # Example: for 20% water at 40 cm this would be: 20/100 * 400mm = 80 mm
- output["soil_moisture_mm"] = (
- data["soil_moisture"].isel(layers=data["layer_roles"] == "soil")
- * output["soil_layer_thickness"]
- ).to_numpy()
-
- # Get accumulated runoff/flow and ground water level from previous time step
- output["previous_accumulated_runoff"] = data[
- "surface_runoff_accumulated"
- ].to_numpy()
- output["previous_subsurface_flow_accumulated"] = data[
- "subsurface_flow_accumulated"
- ].to_numpy()
- output["groundwater_storage"] = data["groundwater_storage"].to_numpy()
-
- return output
diff --git a/virtual_ecosystem/models/hydrology/hydrology_tools.py b/virtual_ecosystem/models/hydrology/hydrology_tools.py
new file mode 100644
index 000000000..4195e2d19
--- /dev/null
+++ b/virtual_ecosystem/models/hydrology/hydrology_tools.py
@@ -0,0 +1,167 @@
+"""Functions to set up hydrology model and select data for current time step."""
+
+import numpy as np
+from numpy.typing import NDArray
+from xarray import DataArray
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.core.core_components import LayerStructure
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.models.abiotic import abiotic_tools
+from virtual_ecosystem.models.hydrology import above_ground
+
+
+def setup_hydrology_input_current_timestep(
+ data: Data,
+ time_index: int,
+ days: int,
+ seed: None | int,
+ layer_structure: LayerStructure,
+ soil_layer_thickness_mm: NDArray[np.float32],
+ soil_moisture_capacity: float | NDArray[np.float32],
+ soil_moisture_residual: float | NDArray[np.float32],
+ core_constants: CoreConsts,
+ latent_heat_vap_equ_factors: list[float],
+) -> dict[str, NDArray[np.float32]]:
+ """Select and pre-process inputs for hydrology.update() for current time step.
+
+ The hydrology model currently loops over 30 days per month. Atmospheric variables
+ near the surface are selected here and kept constant for the whole month. Daily
+ timeseries of precipitation and evapotranspiration are generated from monthly
+ values in `data` to be used in the daily loop. States of other hydrology variables
+ are selected and updated in the daily loop.
+
+ The function returns a dictionary with the following variables:
+
+ * latent_heat_vapourisation
+ * molar_density_air
+
+ * surface_temperature (TODO switch to subcanopy_temperature)
+ * surface_humidity (TODO switch to subcanopy_humidity)
+ * surface_pressure (TODO switch to subcanopy_pressure)
+ * surface_wind_speed (TODO switch to subcanopy_wind_speed)
+ * leaf_area_index_sum
+ * current_precipitation
+ * current_evapotranspiration
+ * current_soil_moisture
+ * top_soil_moisture_capacity
+ * top_soil_moisture_residual
+ * previous_accumulated_runoff
+ * previous_subsurface_flow_accumulated
+ * groundwater_storage
+
+ Args:
+ data: Data object that contains inputs from the microclimate model, the plant
+ model, and the hydrology model that are required for current update
+ time_index: Time index of current time step
+ days: Number of days in core time step
+ seed: Seed for random rainfall generator
+ layer_structure: The LayerStructure instance for a simulation.
+ soil_layer_thickness_mm: The thickness of the soil layer, [mm]
+ soil_moisture_capacity: Soil moisture capacity, unitless
+ soil_moisture_residual: Soil moisture residual, unitless
+ core_constants: Set of core constants share across all models
+ latent_heat_vap_equ_factors: Factors in calculation of latent heat of
+ vapourisation.
+
+ Returns:
+ dictionary with all variables that are required to run one hydrology update()
+ daily loop
+ """
+
+ output = {}
+
+ # Calculate latent heat of vapourisation and density of air for all layers
+ latent_heat_vapourisation = abiotic_tools.calculate_latent_heat_vapourisation(
+ temperature=data["air_temperature"].to_numpy(),
+ celsius_to_kelvin=core_constants.zero_Celsius,
+ latent_heat_vap_equ_factors=latent_heat_vap_equ_factors,
+ )
+ output["latent_heat_vapourisation"] = latent_heat_vapourisation
+
+ molar_density_air = abiotic_tools.calculate_molar_density_air(
+ temperature=data["air_temperature"].to_numpy(),
+ atmospheric_pressure=data["atmospheric_pressure"].to_numpy(),
+ standard_mole=core_constants.standard_mole,
+ standard_pressure=core_constants.standard_pressure,
+ celsius_to_kelvin=core_constants.zero_Celsius,
+ )
+ output["molar_density_air"] = molar_density_air
+
+ # Get atmospheric variables
+ output["current_precipitation"] = above_ground.distribute_monthly_rainfall(
+ (data["precipitation"].isel(time_index=time_index)).to_numpy(),
+ num_days=days,
+ seed=seed,
+ )
+
+ # named 'surface_...' for now TODO needs to be replaced with 2m above ground
+ # We explicitly get a scalar index for the surface layer to extract the values as a
+ # 1D array of grid cells and not a 2D array with a singleton layer dimension.
+ for out_var, in_var in (
+ ("surface_temperature", "air_temperature"),
+ ("surface_humidity", "relative_humidity"),
+ ("surface_wind_speed", "wind_speed"),
+ ("surface_pressure", "atmospheric_pressure"),
+ ):
+ output[out_var] = data[in_var][layer_structure.index_surface_scalar].to_numpy()
+
+ # Get inputs from plant model
+ output["leaf_area_index_sum"] = data["leaf_area_index"].sum(dim="layers").to_numpy()
+ output["current_evapotranspiration"] = (
+ data["evapotranspiration"].sum(dim="layers") / days
+ ).to_numpy()
+
+ # Select soil variables
+ output["top_soil_moisture_capacity"] = (
+ soil_moisture_capacity * soil_layer_thickness_mm[0]
+ )
+ output["top_soil_moisture_residual"] = (
+ soil_moisture_residual * soil_layer_thickness_mm[0]
+ )
+ output["current_soil_moisture"] = ( # drop above ground layers
+ data["soil_moisture"][layer_structure.index_all_soil]
+ ).to_numpy()
+
+ # Get accumulated runoff/flow and ground water level from previous time step
+ output["previous_accumulated_runoff"] = data[
+ "surface_runoff_accumulated"
+ ].to_numpy()
+ output["previous_subsurface_flow_accumulated"] = data[
+ "subsurface_flow_accumulated"
+ ].to_numpy()
+ output["groundwater_storage"] = data["groundwater_storage"].to_numpy()
+
+ return output
+
+
+def initialise_soil_moisture_mm(
+ layer_structure: LayerStructure,
+ initial_soil_moisture: float,
+ soil_layer_thickness: NDArray[np.float32],
+) -> DataArray:
+ """Initialise soil moisture in mm.
+
+ Args:
+ layer_structure: LayerStructure object that contains information about the
+ number and identities of vertical layers
+ initial_soil_moisture: Initial relative soil moisture, dimensionless
+ soil_layer_thickness: The soil layer thickness in mm.
+
+ Returns:
+ soil moisture, [mm]
+ """
+
+ # Create a data array filled with initial soil moisture values for all soil layers
+ # and np.nan for atmosphere layers
+
+ soil_moisture = layer_structure.from_template(array_name="soil_moisture")
+
+ # The layer_structure.soil_layer_thickness is an np.array so as long as initial soil
+ # moisture is either a scalar or an np array of similar length, this will broadcast
+ # into the soil layers as a column vector.
+ soil_moisture[layer_structure.index_all_soil] = (
+ initial_soil_moisture * soil_layer_thickness
+ )
+
+ return soil_moisture
diff --git a/virtual_ecosystem/models/litter/__init__.py b/virtual_ecosystem/models/litter/__init__.py
index 5dc3c1731..10fb8710c 100644
--- a/virtual_ecosystem/models/litter/__init__.py
+++ b/virtual_ecosystem/models/litter/__init__.py
@@ -7,10 +7,16 @@
LitterModel class which consolidates the functionality of the litter model into a
single class, which the high level functions of the Virtual Ecosystem can then make
use of.
-* The :mod:`~virtual_ecosystem.models.litter.litter_pools` provides the set of litter
+* :mod:`~virtual_ecosystem.models.litter.carbon` provides the set of litter carbon
pools that the litter model is comprised of.
-* The :mod:`~virtual_ecosystem.models.litter.constants` provides a set of dataclasses
+* :mod:`~virtual_ecosystem.models.litter.chemistry` tracks the chemistry (lignin,
+ nitrogen and phosphorus) of the litter pools.
+* :mod:`~virtual_ecosystem.models.litter.input_partition` handles the partitioning
+ of biomass input between the different litter pools.
+* :mod:`~virtual_ecosystem.models.litter.env_factors` provides the functions
+ capturing the impact of environmental factors on litter decay.
+* :mod:`~virtual_ecosystem.models.litter.constants` provides a set of dataclasses
containing the constants required by the broader litter model.
-""" # noqa: D205, D415
+""" # noqa: D205
from virtual_ecosystem.models.litter.litter_model import LitterModel # noqa: F401
diff --git a/virtual_ecosystem/models/litter/carbon.py b/virtual_ecosystem/models/litter/carbon.py
new file mode 100644
index 000000000..5fb59ff60
--- /dev/null
+++ b/virtual_ecosystem/models/litter/carbon.py
@@ -0,0 +1,436 @@
+"""The ``models.litter.carbon`` module tracks the carbon content of the litter pools
+for the Virtual Ecosystem. Pools are divided into above and below ground pools, with
+below ground pools affected by both soil moisture and temperature, and above ground
+pools just affected by soil surface temperatures. The pools are also divided based on
+the recalcitrance of their inputs, dead wood is given a separate pool, and all other
+inputs are divided between metabolic and structural pools. Recalcitrant litter contains
+hard to break down compounds, principally lignin. The metabolic litter pool contains the
+non-recalcitrant litter and so breaks down quickly. Whereas, the structural litter
+contains the recalcitrant litter.
+
+We consider 5 pools rather than 6, as it's not really possible to parametrise the below
+ground dead wood pool. So, all dead wood gets included in the above ground woody litter
+pool.
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+from xarray import DataArray
+
+from virtual_ecosystem.core.constants import CoreConsts
+from virtual_ecosystem.core.core_components import LayerStructure
+from virtual_ecosystem.models.litter.chemistry import calculate_litter_chemistry_factor
+from virtual_ecosystem.models.litter.constants import LitterConsts
+from virtual_ecosystem.models.litter.env_factors import (
+ calculate_environmental_factors,
+)
+
+
+def calculate_decay_rates(
+ above_metabolic: NDArray[np.float32],
+ above_structural: NDArray[np.float32],
+ woody: NDArray[np.float32],
+ below_metabolic: NDArray[np.float32],
+ below_structural: NDArray[np.float32],
+ lignin_above_structural: NDArray[np.float32],
+ lignin_woody: NDArray[np.float32],
+ lignin_below_structural: NDArray[np.float32],
+ air_temperatures: DataArray,
+ soil_temperatures: DataArray,
+ water_potentials: DataArray,
+ layer_structure: LayerStructure,
+ constants: LitterConsts,
+) -> dict[str, NDArray[np.float32]]:
+ """Calculate the decay rate for all five of the litter pools.
+
+ Args:
+ above_metabolic: Above ground metabolic litter pool [kg C m^-2]
+ above_structural: Above ground structural litter pool [kg C m^-2]
+ woody: The woody litter pool [kg C m^-2]
+ below_metabolic: Below ground metabolic litter pool [kg C m^-2]
+ below_structural: Below ground structural litter pool [kg C m^-2]
+ lignin_above_structural: Proportion of above ground structural pool which is
+ lignin [unitless]
+ lignin_woody: Proportion of dead wood pool which is lignin [unitless]
+ lignin_below_structural: Proportion of below ground structural pool which is
+ lignin [unitless]
+ air_temperatures: Air temperatures, for all above ground layers [C]
+ soil_temperatures: Soil temperatures, for all soil layers [C]
+ water_potentials: Water potentials, for all soil layers [kPa]
+ layer_structure: The LayerStructure instance for the simulation.
+ constants: Set of constants for the litter model
+
+ Decay rates depend on lignin proportions as well as a range of environmental
+ factors. These environmental factors are calculated as part of this function.
+
+ Returns:
+ A dictionary containing the decay rate for each of the five litter pools.
+ """
+
+ # Calculate environmental factors
+ env_factors = calculate_environmental_factors(
+ air_temperatures=air_temperatures,
+ soil_temperatures=soil_temperatures,
+ water_potentials=water_potentials,
+ layer_structure=layer_structure,
+ constants=constants,
+ )
+
+ # Calculate decay rate for each pool
+ metabolic_above_decay = calculate_litter_decay_metabolic_above(
+ temperature_factor=env_factors["temp_above"],
+ litter_pool_above_metabolic=above_metabolic,
+ litter_decay_coefficient=constants.litter_decay_constant_metabolic_above,
+ )
+ structural_above_decay = calculate_litter_decay_structural_above(
+ temperature_factor=env_factors["temp_above"],
+ litter_pool_above_structural=above_structural,
+ lignin_proportion=lignin_above_structural,
+ litter_decay_coefficient=constants.litter_decay_constant_structural_above,
+ lignin_inhibition_factor=constants.lignin_inhibition_factor,
+ )
+ woody_decay = calculate_litter_decay_woody(
+ temperature_factor=env_factors["temp_above"],
+ litter_pool_woody=woody,
+ lignin_proportion=lignin_woody,
+ litter_decay_coefficient=constants.litter_decay_constant_woody,
+ lignin_inhibition_factor=constants.lignin_inhibition_factor,
+ )
+ metabolic_below_decay = calculate_litter_decay_metabolic_below(
+ temperature_factor=env_factors["temp_below"],
+ moisture_factor=env_factors["water"],
+ litter_pool_below_metabolic=below_metabolic,
+ litter_decay_coefficient=constants.litter_decay_constant_metabolic_below,
+ )
+ structural_below_decay = calculate_litter_decay_structural_below(
+ temperature_factor=env_factors["temp_below"],
+ moisture_factor=env_factors["water"],
+ litter_pool_below_structural=below_structural,
+ lignin_proportion=lignin_below_structural,
+ litter_decay_coefficient=constants.litter_decay_constant_structural_below,
+ lignin_inhibition_factor=constants.lignin_inhibition_factor,
+ )
+
+ # Then return all the decay rates in a dictionary
+ return {
+ "metabolic_above": metabolic_above_decay,
+ "structural_above": structural_above_decay,
+ "woody": woody_decay,
+ "metabolic_below": metabolic_below_decay,
+ "structural_below": structural_below_decay,
+ }
+
+
+def calculate_total_C_mineralised(
+ decay_rates: dict[str, NDArray[np.float32]],
+ model_constants: LitterConsts,
+ core_constants: CoreConsts,
+) -> NDArray[np.float32]:
+ """Calculate the total carbon mineralisation rate from all five litter pools.
+
+ Args:
+ decay_rates: Dictionary containing the rates of decay for all 5 litter pools
+ [kg C m^-2 day^-1]
+ model_constants: Set of constants for the litter model
+ core_constants: Set of core constants shared between all models
+
+ Returns:
+ Rate of carbon mineralisation from litter into soil [kg C m^-3 day^-1].
+ """
+
+ # Calculate mineralisation from each pool
+ metabolic_above_mineral = calculate_carbon_mineralised(
+ decay_rates["metabolic_above"],
+ carbon_use_efficiency=model_constants.cue_metabolic,
+ )
+ structural_above_mineral = calculate_carbon_mineralised(
+ decay_rates["structural_above"],
+ carbon_use_efficiency=model_constants.cue_structural_above_ground,
+ )
+ woody_mineral = calculate_carbon_mineralised(
+ decay_rates["woody"],
+ carbon_use_efficiency=model_constants.cue_woody,
+ )
+ metabolic_below_mineral = calculate_carbon_mineralised(
+ decay_rates["metabolic_below"],
+ carbon_use_efficiency=model_constants.cue_metabolic,
+ )
+ structural_below_mineral = calculate_carbon_mineralised(
+ decay_rates["structural_below"],
+ carbon_use_efficiency=model_constants.cue_structural_below_ground,
+ )
+
+ # Calculate mineralisation rate
+ total_C_mineralisation_rate = (
+ metabolic_above_mineral
+ + structural_above_mineral
+ + woody_mineral
+ + metabolic_below_mineral
+ + structural_below_mineral
+ )
+
+ # Convert mineralisation rate into kg m^-3 units (from kg m^-2)
+ return total_C_mineralisation_rate / core_constants.max_depth_of_microbial_activity
+
+
+def calculate_updated_pools(
+ above_metabolic: NDArray[np.float32],
+ above_structural: NDArray[np.float32],
+ woody: NDArray[np.float32],
+ below_metabolic: NDArray[np.float32],
+ below_structural: NDArray[np.float32],
+ decomposed_excrement: NDArray[np.float32],
+ decomposed_carcasses: NDArray[np.float32],
+ decay_rates: dict[str, NDArray[np.float32]],
+ plant_inputs: dict[str, NDArray[np.float32]],
+ update_interval: float,
+) -> dict[str, NDArray[np.float32]]:
+ """Calculate the updated mass of each litter pool.
+
+ This function is not intended to be used continuously, and returns the new value for
+ each pool after the update interval, rather than a rate of change to be integrated.
+
+ Args:
+ above_metabolic: Above ground metabolic litter pool [kg C m^-2]
+ above_structural: Above ground structural litter pool [kg C m^-2]
+ woody: The woody litter pool [kg C m^-2]
+ below_metabolic: Below ground metabolic litter pool [kg C m^-2]
+ below_structural: Below ground structural litter pool [kg C m^-2]
+ decomposed_excrement: Input rate of excrement from the animal model [kg C m^-2
+ day^-1]
+ decomposed_carcasses: Input rate of (partially) decomposed carcass biomass from
+ the animal model [kg C m^-2 day^-1]
+ decay_rates: Dictionary containing the rates of decay for all 5 litter pools
+ [kg C m^-2 day^-1]
+ plant_inputs: Dictionary containing the amount of each litter type that is added
+ from the plant model in this time step [kg C m^-2]
+ update_interval: Interval that the litter pools are being updated for [days]
+ constants: Set of constants for the litter model
+
+ Returns:
+ Dictionary containing the updated pool densities for all 5 litter pools (above
+ ground metabolic, above ground structural, dead wood, below ground metabolic,
+ and below ground structural) [kg C m^-2]
+ """
+
+ # Net pool changes are found by combining input and decay rates, and then
+ # multiplying by the update time step.
+ change_in_metabolic_above = (
+ plant_inputs["above_ground_metabolic"]
+ + (decomposed_excrement + decomposed_carcasses - decay_rates["metabolic_above"])
+ * update_interval
+ )
+ change_in_structural_above = plant_inputs["above_ground_structural"] - (
+ decay_rates["structural_above"] * update_interval
+ )
+ change_in_woody = plant_inputs["woody"] - (decay_rates["woody"] * update_interval)
+ change_in_metabolic_below = plant_inputs["below_ground_metabolic"] - (
+ decay_rates["metabolic_below"] * update_interval
+ )
+ change_in_structural_below = plant_inputs["below_ground_structural"] - (
+ decay_rates["structural_below"] * update_interval
+ )
+
+ # New value for each pool is found and returned in a dictionary
+ return {
+ "above_metabolic": above_metabolic + change_in_metabolic_above,
+ "above_structural": above_structural + change_in_structural_above,
+ "woody": woody + change_in_woody,
+ "below_metabolic": below_metabolic + change_in_metabolic_below,
+ "below_structural": below_structural + change_in_structural_below,
+ }
+
+
+def calculate_litter_decay_metabolic_above(
+ temperature_factor: NDArray[np.float32],
+ litter_pool_above_metabolic: NDArray[np.float32],
+ litter_decay_coefficient: float,
+) -> NDArray[np.float32]:
+ """Calculate decay of above ground metabolic litter pool.
+
+ This function is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ temperature_factor: A multiplicative factor capturing the impact of temperature
+ on litter decomposition [unitless]
+ litter_pool_above_metabolic: The size of the above ground metabolic litter pool
+ [kg C m^-2]
+ litter_decay_coefficient: The decay coefficient for the above ground metabolic
+ litter pool [day^-1]
+
+ Returns:
+ Rate of decay of the above ground metabolic litter pool [kg C m^-2 day^-1]
+ """
+
+ return litter_decay_coefficient * temperature_factor * litter_pool_above_metabolic
+
+
+def calculate_litter_decay_structural_above(
+ temperature_factor: NDArray[np.float32],
+ litter_pool_above_structural: NDArray[np.float32],
+ lignin_proportion: NDArray[np.float32],
+ litter_decay_coefficient: float,
+ lignin_inhibition_factor: float,
+) -> NDArray[np.float32]:
+ """Calculate decay of above ground structural litter pool.
+
+ This function is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ temperature_factor: A multiplicative factor capturing the impact of temperature
+ on litter decomposition [unitless]
+ litter_pool_above_structural: The size of the above ground structural litter
+ pool [kg C m^-2]
+ lignin_proportion: The proportion of the above ground structural pool which is
+ lignin [unitless]
+ litter_decay_coefficient: The decay coefficient for the above ground structural
+ litter pool [day^-1]
+ lignin_inhibition_factor: An exponential factor expressing the extent to which
+ lignin inhibits the breakdown of litter [unitless]
+
+ Returns:
+ Rate of decay of the above ground structural litter pool [kg C m^-2 day^-1]
+ """
+
+ litter_chemistry_factor = calculate_litter_chemistry_factor(
+ lignin_proportion, lignin_inhibition_factor=lignin_inhibition_factor
+ )
+
+ return (
+ litter_decay_coefficient
+ * temperature_factor
+ * litter_pool_above_structural
+ * litter_chemistry_factor
+ )
+
+
+def calculate_litter_decay_woody(
+ temperature_factor: NDArray[np.float32],
+ litter_pool_woody: NDArray[np.float32],
+ lignin_proportion: NDArray[np.float32],
+ litter_decay_coefficient: float,
+ lignin_inhibition_factor: float,
+) -> NDArray[np.float32]:
+ """Calculate decay of the woody litter pool.
+
+ This function is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ temperature_factor: A multiplicative factor capturing the impact of temperature
+ on litter decomposition [unitless]
+ litter_pool_woody: The size of the woody litter pool [kg C m^-2]
+ lignin_proportion: The proportion of the woody litter pool which is lignin
+ [unitless]
+ litter_decay_coefficient: The decay coefficient for the woody litter pool
+ [day^-1]
+ lignin_inhibition_factor: An exponential factor expressing the extent to which
+ lignin inhibits the breakdown of litter [unitless]
+
+ Returns:
+ Rate of decay of the woody litter pool [kg C m^-2 day^-1]
+ """
+
+ litter_chemistry_factor = calculate_litter_chemistry_factor(
+ lignin_proportion, lignin_inhibition_factor=lignin_inhibition_factor
+ )
+
+ return (
+ litter_decay_coefficient
+ * temperature_factor
+ * litter_pool_woody
+ * litter_chemistry_factor
+ )
+
+
+def calculate_litter_decay_metabolic_below(
+ temperature_factor: NDArray[np.float32],
+ moisture_factor: NDArray[np.float32],
+ litter_pool_below_metabolic: NDArray[np.float32],
+ litter_decay_coefficient: float,
+) -> NDArray[np.float32]:
+ """Calculate decay of below ground metabolic litter pool.
+
+ This function is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ temperature_factor: A multiplicative factor capturing the impact of temperature
+ on litter decomposition [unitless]
+ moisture_factor: A multiplicative factor capturing the impact of soil moisture
+ on litter decomposition [unitless]
+ litter_pool_below_metabolic: The size of the below ground metabolic litter pool
+ [kg C m^-2]
+ litter_decay_coefficient: The decay coefficient for the below ground metabolic
+ litter pool [day^-1]
+
+ Returns:
+ Rate of decay of the below ground metabolic litter pool [kg C m^-2 day^-1]
+ """
+
+ return (
+ litter_decay_coefficient
+ * temperature_factor
+ * moisture_factor
+ * litter_pool_below_metabolic
+ )
+
+
+def calculate_litter_decay_structural_below(
+ temperature_factor: NDArray[np.float32],
+ moisture_factor: NDArray[np.float32],
+ litter_pool_below_structural: NDArray[np.float32],
+ lignin_proportion: NDArray[np.float32],
+ litter_decay_coefficient: float,
+ lignin_inhibition_factor: float,
+) -> NDArray[np.float32]:
+ """Calculate decay of below ground structural litter pool.
+
+ This function is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ temperature_factor: A multiplicative factor capturing the impact of temperature
+ on litter decomposition [unitless]
+ moisture_factor: A multiplicative factor capturing the impact of soil moisture
+ on litter decomposition [unitless]
+ litter_pool_below_structural: The size of the below ground structural litter
+ pool [kg C m^-2]
+ lignin_proportion: The proportion of the below ground structural pool which is
+ lignin [unitless]
+ litter_decay_coefficient: The decay coefficient for the below ground structural
+ litter pool [day^-1]
+ lignin_inhibition_factor: An exponential factor expressing the extent to which
+ lignin inhibits the breakdown of litter [unitless]
+
+ Returns:
+ Rate of decay of the below ground structural litter pool [kg C m^-2 day^-1]
+ """
+
+ litter_chemistry_factor = calculate_litter_chemistry_factor(
+ lignin_proportion, lignin_inhibition_factor=lignin_inhibition_factor
+ )
+
+ return (
+ litter_decay_coefficient
+ * temperature_factor
+ * moisture_factor
+ * litter_chemistry_factor
+ * litter_pool_below_structural
+ )
+
+
+def calculate_carbon_mineralised(
+ litter_decay_rate: NDArray[np.float32], carbon_use_efficiency: float
+) -> NDArray[np.float32]:
+ """Calculate fraction of litter decay that gets mineralised.
+
+ TODO - This function could also be used to track carbon respired, if/when we decide
+ to track that.
+
+ Args:
+ litter_decay_rate: Rate at which litter pool is decaying [kg C m^-2 day^-1]
+ carbon_use_efficiency: Carbon use efficiency of litter pool [unitless]
+
+ Returns:
+ Rate at which carbon is mineralised from the litter pool [kg C m^-2 day^-1]
+ """
+
+ return carbon_use_efficiency * litter_decay_rate
diff --git a/virtual_ecosystem/models/litter/chemistry.py b/virtual_ecosystem/models/litter/chemistry.py
new file mode 100644
index 000000000..6c029a859
--- /dev/null
+++ b/virtual_ecosystem/models/litter/chemistry.py
@@ -0,0 +1,517 @@
+"""The ``models.litter.chemistry`` module tracks the chemistry of the litter pools. This
+involves both the polymer content (i.e. lignin content of the litter), as well as the
+litter stoichiometry (i.e. nitrogen and phosphorus content).
+
+The amount of lignin in both the structural pools and the dead wood pool is tracked, but
+not for the metabolic pool because by definition it contains no lignin. Nitrogen and
+phosphorus content are tracked for every pool.
+
+Nitrogen and phosphorus contents do not have an explicit impact on decay rates, instead
+these contents determine how input material is split between pools (see
+:mod:`~virtual_ecosystem.models.litter.input_partition`), which indirectly captures the
+impact of N and P stoichiometry on litter decomposition rates. By contrast, the impact
+of lignin on decay rates is directly calculated.
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+from xarray import DataArray
+
+from virtual_ecosystem.core.data import Data
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+
+class LitterChemistry:
+ """This class handles the chemistry of litter pools.
+
+ This class contains methods to calculate the changes in the litter pool chemistry
+ based on the contents of the `data` object, as well as method to calculate total
+ mineralisation based on litter pool decay rates.
+ """
+
+ def __init__(self, data: Data, constants: LitterConsts):
+ self.data = data
+ self.structural_to_metabolic_n_ratio = constants.structural_to_metabolic_n_ratio
+
+ def calculate_new_pool_chemistries(
+ self,
+ plant_inputs: dict[str, NDArray[np.float32]],
+ metabolic_splits: dict[str, NDArray[np.float32]],
+ updated_pools: dict[str, NDArray[np.float32]],
+ ) -> dict[str, DataArray]:
+ """Method to calculate the updated chemistry of each litter pool.
+
+ All pools contain nitrogen and phosphorus, so this is updated for every pool.
+ Only the structural (above and below ground) pools and the woody pools contain
+ lignin, so it is only updated for those pools.
+
+ Args:
+ plant_inputs: Dictionary containing the amount of each litter type that is
+ added from the plant model in this time step [kg C m^-2]
+ metabolic_splits: Dictionary containing the proportion of each input that
+ goes to the relevant metabolic pool. This is for three input types:
+ leaves, reproductive tissues and roots [unitless]
+ updated_pools: Dictionary containing the updated pool densities for all 5
+ litter pools [kg C m^-2]
+ """
+
+ # Find lignin and nitrogen contents of the litter input flows
+ input_lignin = self.calculate_litter_input_lignin_concentrations(
+ plant_input_above_struct=plant_inputs["above_ground_structural"],
+ plant_input_below_struct=plant_inputs["below_ground_structural"],
+ )
+ input_c_n_ratios = self.calculate_litter_input_nitrogen_ratios(
+ metabolic_splits=metabolic_splits,
+ struct_to_meta_nitrogen_ratio=self.structural_to_metabolic_n_ratio,
+ )
+
+ # Then use to find the changes
+ change_in_lignin = self.calculate_lignin_updates(
+ plant_inputs=plant_inputs,
+ input_lignin=input_lignin,
+ updated_pools=updated_pools,
+ )
+ change_in_c_n_ratios = self.calculate_c_n_ratio_updates(
+ plant_inputs=plant_inputs,
+ input_c_n_ratios=input_c_n_ratios,
+ updated_pools=updated_pools,
+ )
+
+ # List all the variables this function outputs, which are then used to generate
+ # the dictionaries to return
+ lignin_variable_names = ["above_structural", "woody", "below_structural"]
+ nutrient_variable_names = [
+ "above_metabolic",
+ "above_structural",
+ "woody",
+ "below_metabolic",
+ "below_structural",
+ ]
+
+ lignin_changes = {
+ f"lignin_{name}": DataArray(
+ self.data[f"lignin_{name}"] + change_in_lignin[name], dims="cell_id"
+ )
+ for name in lignin_variable_names
+ }
+ nitrogen_changes = {
+ f"c_n_ratio_{name}": DataArray(
+ self.data[f"c_n_ratio_{name}"] + change_in_c_n_ratios[name],
+ dims="cell_id",
+ )
+ for name in nutrient_variable_names
+ }
+
+ return lignin_changes | nitrogen_changes
+
+ def calculate_litter_input_lignin_concentrations(
+ self,
+ plant_input_below_struct: NDArray[np.float32],
+ plant_input_above_struct: NDArray[np.float32],
+ ) -> dict[str, NDArray[np.float32]]:
+ """Calculate the concentration of lignin for each plant biomass to litter flow.
+
+ By definition the metabolic litter pools do not contain lignin, so all input
+ lignin flows to the structural and woody pools. As the input biomass gets split
+ between pools, the lignin concentration of the input to the structural pools
+ will be higher than it was in the input biomass.
+
+ For the woody litter there's no structural-metabolic split so the lignin
+ concentration of the litter input is the same as that of the dead wood
+ production. For the below ground structural litter, the total lignin content of
+ root input must be found, this is then converted back into a concentration
+ relative to the input into the below structural litter pool. For the above
+ ground structural litter pool, the same approach is taken with the combined
+ total lignin content of the leaf and reproductive matter inputs being found, and
+ then converted to a back into a concentration.
+
+ Args:
+ plant_input_below_struct: Plant input to below ground structural litter pool
+ [kg C m^-2]
+ plant_input_above_struct: Plant input to above ground structural litter pool
+ [kg C m^-2]
+
+ Returns:
+ Dictionary containing the lignin concentration of the input to each of the
+ three lignin containing litter pools (woody, above and below ground
+ structural) [kg lignin kg C^-1]
+ """
+
+ lignin_proportion_woody = self.data["deadwood_lignin"]
+
+ lignin_proportion_below_structural = (
+ self.data["root_turnover_lignin"]
+ * self.data["root_turnover"]
+ / plant_input_below_struct
+ )
+
+ lignin_proportion_above_structural = (
+ (self.data["leaf_turnover_lignin"] * self.data["leaf_turnover"])
+ + (
+ self.data["plant_reproductive_tissue_turnover_lignin"]
+ * self.data["plant_reproductive_tissue_turnover"]
+ )
+ ) / plant_input_above_struct
+
+ return {
+ "woody": lignin_proportion_woody.to_numpy(),
+ "below_structural": lignin_proportion_below_structural.to_numpy(),
+ "above_structural": lignin_proportion_above_structural.to_numpy(),
+ }
+
+ def calculate_litter_input_nitrogen_ratios(
+ self,
+ metabolic_splits: dict[str, NDArray[np.float32]],
+ struct_to_meta_nitrogen_ratio: float,
+ ) -> dict[str, NDArray[np.float32]]:
+ """Calculate the carbon to nitrogen ratio for each plant biomass to litter flow.
+
+ The ratio for the input to the woody litter pool just matches the ratio of the
+ deadwood input. For the below ground pools, the ratios of the flows from root
+ turnover into the metabolic and structural pools is calculated. A similar
+ approach is taken for the above ground metabolic and structural pools, but here
+ a weighted average of the two contributions to each pool (leaf and reproductive
+ tissue turnover) must be taken.
+
+ Args:
+ metabolic_splits: Dictionary containing the proportion of each input that
+ goes to the relevant metabolic pool. This is for three input types:
+ leaves, reproductive tissues and roots [unitless]
+ struct_to_meta_nitrogen_ratio: Ratio of the carbon to nitrogen ratios of
+ structural vs metabolic litter pools [unitless]
+
+ Returns:
+ Dictionary containing the carbon to nitrogen ratios of the input to each of
+ the pools [unitless]
+ """
+
+ # Calculate c_n_ratio split for each (non-wood) input biomass type
+ root_c_n_ratio_meta, root_c_n_ratio_struct = (
+ calculate_nutrient_split_between_litter_pools(
+ input_c_nut_ratio=self.data["root_turnover_c_n_ratio"].to_numpy(),
+ metabolic_split=metabolic_splits["roots"],
+ struct_to_meta_nutrient_ratio=struct_to_meta_nitrogen_ratio,
+ )
+ )
+
+ leaf_c_n_ratio_meta, leaf_c_n_ratio_struct = (
+ calculate_nutrient_split_between_litter_pools(
+ input_c_nut_ratio=self.data["leaf_turnover_c_n_ratio"].to_numpy(),
+ metabolic_split=metabolic_splits["leaves"],
+ struct_to_meta_nutrient_ratio=struct_to_meta_nitrogen_ratio,
+ )
+ )
+
+ reprod_c_n_ratio_meta, reprod_c_n_ratio_struct = (
+ calculate_nutrient_split_between_litter_pools(
+ input_c_nut_ratio=self.data[
+ "plant_reproductive_tissue_turnover_c_n_ratio"
+ ].to_numpy(),
+ metabolic_split=metabolic_splits["reproductive"],
+ struct_to_meta_nutrient_ratio=struct_to_meta_nitrogen_ratio,
+ )
+ )
+
+ c_n_ratio_below_metabolic = root_c_n_ratio_meta
+ c_n_ratio_below_structural = root_c_n_ratio_struct
+ c_n_ratio_woody = self.data["deadwood_c_n_ratio"].to_numpy()
+ # Inputs with multiple sources have to be weighted
+ c_n_ratio_above_metabolic = np.divide(
+ (
+ leaf_c_n_ratio_meta
+ * self.data["leaf_turnover"]
+ * metabolic_splits["leaves"]
+ )
+ + (
+ reprod_c_n_ratio_meta
+ * self.data["plant_reproductive_tissue_turnover"]
+ * metabolic_splits["reproductive"]
+ ),
+ (self.data["leaf_turnover"] * metabolic_splits["leaves"])
+ + (
+ self.data["plant_reproductive_tissue_turnover"]
+ * metabolic_splits["reproductive"]
+ ),
+ )
+
+ c_n_ratio_above_structural = np.divide(
+ (
+ leaf_c_n_ratio_struct
+ * self.data["leaf_turnover"]
+ * (1 - metabolic_splits["leaves"])
+ )
+ + (
+ reprod_c_n_ratio_struct
+ * self.data["plant_reproductive_tissue_turnover"]
+ * (1 - metabolic_splits["reproductive"])
+ ),
+ (self.data["leaf_turnover"] * (1 - metabolic_splits["leaves"]))
+ + (
+ self.data["plant_reproductive_tissue_turnover"]
+ * (1 - metabolic_splits["reproductive"])
+ ),
+ )
+
+ return {
+ "woody": c_n_ratio_woody,
+ "below_metabolic": c_n_ratio_below_metabolic,
+ "below_structural": c_n_ratio_below_structural,
+ "above_metabolic": c_n_ratio_above_metabolic,
+ "above_structural": c_n_ratio_above_structural,
+ }
+
+ def calculate_lignin_updates(
+ self,
+ plant_inputs: dict[str, NDArray[np.float32]],
+ input_lignin: dict[str, NDArray[np.float32]],
+ updated_pools: dict[str, NDArray[np.float32]],
+ ) -> dict[str, NDArray[np.float32]]:
+ """Calculate the changes in lignin proportion for the relevant litter pools.
+
+ The relevant pools are the two structural pools, and the dead wood pool. This
+ function calculates the total change over the entire time step, so cannot be
+ used in an integration process.
+
+ Args:
+ plant_inputs: Dictionary containing the amount of each litter type that is
+ added from the plant model in this time step [kg C m^-2]
+ input_lignin: Dictionary containing the lignin concentration of the input to
+ each of the three lignin containing litter pools [kg lignin kg C^-1]
+ updated_pools: Dictionary containing the updated pool densities for all 5
+ litter pools [kg C m^-2]
+
+ Returns:
+ Dictionary containing the updated lignin proportions for the 3 relevant
+ litter pools (above ground structural, dead wood, and below ground
+ structural) [unitless]
+ """
+
+ change_in_lignin_above_structural = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["above_ground_structural"],
+ updated_pool_carbon=updated_pools["above_structural"],
+ input_conc=input_lignin["above_structural"],
+ old_pool_conc=self.data["lignin_above_structural"].to_numpy(),
+ )
+ change_in_lignin_woody = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["woody"],
+ updated_pool_carbon=updated_pools["woody"],
+ input_conc=input_lignin["woody"],
+ old_pool_conc=self.data["lignin_woody"].to_numpy(),
+ )
+ change_in_lignin_below_structural = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["below_ground_structural"],
+ updated_pool_carbon=updated_pools["below_structural"],
+ input_conc=input_lignin["below_structural"],
+ old_pool_conc=self.data["lignin_below_structural"].to_numpy(),
+ )
+
+ return {
+ "above_structural": change_in_lignin_above_structural,
+ "woody": change_in_lignin_woody,
+ "below_structural": change_in_lignin_below_structural,
+ }
+
+ def calculate_c_n_ratio_updates(
+ self,
+ plant_inputs: dict[str, NDArray[np.float32]],
+ input_c_n_ratios: dict[str, NDArray[np.float32]],
+ updated_pools: dict[str, NDArray[np.float32]],
+ ) -> dict[str, NDArray[np.float32]]:
+ """Calculate the changes in carbon nitrogen ratios for all litter pools.
+
+ This function calculates the total change over the entire time step, so cannot
+ be used in an integration process.
+
+ Args:
+ plant_inputs: Dictionary containing the amount of each litter type that is
+ added from the plant model in this time step [kg C m^-2]
+ input_c_n_ratios: Dictionary containing the carbon to nitrogen ratios of the
+ input to each of the litter pools [unitless]
+ updated_pools: Dictionary containing the updated pool densities for all 5
+ litter pools [kg C m^-2]
+
+ Returns:
+ Dictionary containing the updated carbon nitrogen ratios for all of the
+ litter pools [unitless]
+ """
+
+ change_in_n_above_metabolic = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["above_ground_metabolic"],
+ updated_pool_carbon=updated_pools["above_metabolic"],
+ input_conc=input_c_n_ratios["above_metabolic"],
+ old_pool_conc=self.data["c_n_ratio_above_metabolic"].to_numpy(),
+ )
+ change_in_n_above_structural = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["above_ground_structural"],
+ updated_pool_carbon=updated_pools["above_structural"],
+ input_conc=input_c_n_ratios["above_structural"],
+ old_pool_conc=self.data["c_n_ratio_above_structural"].to_numpy(),
+ )
+ change_in_n_woody = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["woody"],
+ updated_pool_carbon=updated_pools["woody"],
+ input_conc=input_c_n_ratios["woody"],
+ old_pool_conc=self.data["c_n_ratio_woody"].to_numpy(),
+ )
+ change_in_n_below_metabolic = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["below_ground_metabolic"],
+ updated_pool_carbon=updated_pools["below_metabolic"],
+ input_conc=input_c_n_ratios["below_metabolic"],
+ old_pool_conc=self.data["c_n_ratio_below_metabolic"].to_numpy(),
+ )
+ change_in_n_below_structural = calculate_change_in_chemical_concentration(
+ input_carbon=plant_inputs["below_ground_structural"],
+ updated_pool_carbon=updated_pools["below_structural"],
+ input_conc=input_c_n_ratios["below_structural"],
+ old_pool_conc=self.data["c_n_ratio_below_structural"].to_numpy(),
+ )
+
+ return {
+ "above_metabolic": change_in_n_above_metabolic,
+ "above_structural": change_in_n_above_structural,
+ "woody": change_in_n_woody,
+ "below_metabolic": change_in_n_below_metabolic,
+ "below_structural": change_in_n_below_structural,
+ }
+
+ def calculate_N_mineralisation(
+ self,
+ decay_rates: dict[str, NDArray[np.float32]],
+ active_microbe_depth: float,
+ ) -> dict[str, NDArray[np.float32]]:
+ """Method to calculate the amount of nitrogen mineralised by litter decay.
+
+ This function finds the nitrogen mineralisation rate of each litter pool, by
+ dividing the rate of decay (in carbon terms) by the carbon to nitrogen ratio of
+ each pool. These are then summed to find the total rate of nitrogen
+ mineralisation from litter. Finally, this rate is converted from per area units
+ (which the litter model works in) to per volume units (which the soil model
+ works in) by dividing the rate by the depth of soil considered to be microbially
+ active.
+
+ Args:
+ decay_rates: Dictionary containing the rates of decay for all 5 litter pools
+ [kg C m^-2 day^-1]
+ active_microbe_depth: Maximum depth of microbial activity in the soil layers
+ [m]
+
+ Returns:
+ The total rate of nitrogen mineralisation from litter [kg C m^-3 day^-1].
+ """
+
+ # Find nitrogen mineralisation rate for each pool
+ above_meta_n_mineral = (
+ decay_rates["metabolic_above"] / self.data["c_n_ratio_above_metabolic"]
+ )
+ above_struct_n_mineral = (
+ decay_rates["structural_above"] / self.data["c_n_ratio_above_structural"]
+ )
+ woody_n_mineral = decay_rates["woody"] / self.data["c_n_ratio_woody"]
+ below_meta_n_mineral = (
+ decay_rates["metabolic_below"] / self.data["c_n_ratio_below_metabolic"]
+ )
+ below_struct_n_mineral = (
+ decay_rates["structural_below"] / self.data["c_n_ratio_below_structural"]
+ )
+
+ # Sum them to find total rate of nitrogen mineralisation
+ total_N_mineralisation_rate = (
+ above_meta_n_mineral
+ + above_struct_n_mineral
+ + woody_n_mineral
+ + below_meta_n_mineral
+ + below_struct_n_mineral
+ )
+
+ # Convert from per area to per volume units
+ return total_N_mineralisation_rate / active_microbe_depth
+
+
+def calculate_litter_chemistry_factor(
+ lignin_proportion: NDArray[np.float32], lignin_inhibition_factor: float
+) -> NDArray[np.float32]:
+ """Calculate the effect that litter chemistry has on litter decomposition rates.
+
+ This expression is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ lignin_proportion: The proportion of the polymers in the litter pool that are
+ lignin (or similar) [unitless]
+ lignin_inhibition_factor: An exponential factor expressing the extent to which
+ lignin inhibits the breakdown of litter [unitless]
+
+ Returns:
+ A factor that captures the impact of litter chemistry on litter decay rates
+ """
+
+ return np.exp(lignin_inhibition_factor * lignin_proportion)
+
+
+def calculate_change_in_chemical_concentration(
+ input_carbon: NDArray[np.float32],
+ updated_pool_carbon: NDArray[np.float32],
+ input_conc: NDArray[np.float32],
+ old_pool_conc: NDArray[np.float32],
+) -> NDArray[np.float32]:
+ """Calculate the change in the chemical concentration of a particular litter pool.
+
+ This change is found by calculating the difference between the previous
+ concentration of the pool and the concentration of the inputs. This difference is
+ then multiplied by the ratio of the mass of carbon added to pool and the final
+ (carbon) mass of the pool. This function can be used for all chemicals of interest,
+ i.e. lignin, nitrogen and phosphorus. This function is agnostic to concentration
+ type, so either proportions of total carbon or carbon:nutrient ratios can be
+ used. However, the concentration type used must be the same for the old pool and the
+ litter input.
+
+ Args:
+ input_carbon: The total carbon mass of inputs to the litter pool [kg C m^-2]
+ updated_pool_carbon: The total carbon mass of the litter pool after inputs and
+ decay [kg C m^-2]
+ input_conc: The concentration of the chemical of interest in the (carbon) input
+ [unitless]
+ old_pool_conc: The concentration of the chemical of interest in the original
+ litter pool [unitless]
+
+ Returns:
+ The total change in the chemical concentration of the pool over the full time
+ step [unitless]
+ """
+
+ return (input_carbon / updated_pool_carbon) * (input_conc - old_pool_conc)
+
+
+def calculate_nutrient_split_between_litter_pools(
+ input_c_nut_ratio: NDArray[np.float32],
+ metabolic_split: NDArray[np.float32],
+ struct_to_meta_nutrient_ratio: float,
+) -> tuple[NDArray[np.float32], NDArray[np.float32]]:
+ """Function to calculate the split of input nutrients between litter pools.
+
+ Following :cite:t:`kirschbaum_modelling_2002`, we assume that the nutrient content
+ of the structural and metabolic litter pools are in a fixed proportion. This ratio
+ can vary between nutrients but doesn't vary between above and below ground pools.
+ This is a simplifying assumption to allow us to capture the faster turnover of
+ nutrients relative to carbon, without having to build (and parametrise) a model
+ where every nutrient effects decay rate of every pool.
+
+ Args:
+ input_c_nut_ratio: Carbon:nutrient ratio of input organic matter [unitless]
+ metabolic_split: Proportion of organic matter input that flows to the metabolic
+ litter pool [unitless]
+ struct_to_meta_nutrient_ratio: Ratio of the carbon to nutrient ratios of
+ structural vs metabolic litter pools [unitless]
+
+ Returns:
+ A tuple containing the carbon to nitrogen ratio of the organic matter input to
+ the metabolic and structural litter pools, in that order.
+ """
+
+ c_n_ratio_meta_input = np.divide(
+ input_c_nut_ratio,
+ metabolic_split + struct_to_meta_nutrient_ratio * (1 - metabolic_split),
+ )
+
+ c_n_ratio_struct_input = struct_to_meta_nutrient_ratio * c_n_ratio_meta_input
+
+ return (c_n_ratio_meta_input, c_n_ratio_struct_input)
diff --git a/virtual_ecosystem/models/litter/constants.py b/virtual_ecosystem/models/litter/constants.py
index 0fedf8641..20a31433a 100644
--- a/virtual_ecosystem/models/litter/constants.py
+++ b/virtual_ecosystem/models/litter/constants.py
@@ -2,7 +2,7 @@
constants and parameters for the
:mod:`~virtual_ecosystem.models.litter.litter_model`. These parameters are constants
in that they should not be changed during a particular simulation.
-""" # noqa: D205, D415
+""" # noqa: D205
# TODO - Need to track down better estimates of the carbon use efficiencies.
@@ -82,44 +82,6 @@ class LitterConsts(ConstantsDataclass):
Value is taken from :cite:t:`kirschbaum_modelling_2002`.
"""
- litter_input_to_metabolic_above: float = 0.000280628
- """Litter input rate to metabolic above ground litter pool [kg C m^-2 day^-1].
-
- This value was estimated (very unsystematically) from SAFE project data. This
- constant will eventually be removed once the litter is linked to other models.
- """
-
- litter_input_to_structural_above: float = 0.00071869
- """Litter input rate to metabolic above ground litter pool [kg C m^-2 day^-1].
-
- This value was estimated (very unsystematically) from SAFE project data. This
- constant will eventually be removed once the litter is linked to other models.
- """
-
- litter_input_to_woody: float = 0.002586
- """Litter input rate to woody litter pool [kg C m^-2 day^-1].
-
- This was calculated assuming that dead wood pools in old growth forest are at steady
- state. So, that the input will equal the dead wood respiration divided by 1 minus
- the carbon use efficiency. The value for dead wood respiration for old growth forest
- was taken from :cite:t:`mills_tropical_2023`. This constant will eventually be
- removed once the litter is linked to other models.
- """
-
- litter_input_to_metabolic_below: float = 0.00042
- """Litter input rate to metabolic below ground litter pool [kg C m^-2 day^-1].
-
- This value was estimated (very unsystematically) from SAFE project data. This
- constant will eventually be removed once the litter is linked to other models.
- """
-
- litter_input_to_structural_below: float = 0.00048
- """Litter input rate to structural below ground litter pool [kg C m^-2 day^-1].
-
- This value was estimated (very unsystematically) from SAFE project data. This
- constant will eventually be removed once the litter is linked to other models.
- """
-
cue_metabolic: float = 0.45
"""Carbon use efficiency of metabolic litter decay [unitless].
@@ -158,23 +120,26 @@ class LitterConsts(ConstantsDataclass):
This value is taken from :cite:t:`kirschbaum_modelling_2002`.
"""
- lignin_proportion_above_structural_input: float = 0.25
- """Lignin proportion of input to the above ground structural litter pool [unitless].
-
- TODO - The number given here is made up (but within reasonable bounds). However,
- this is a quantity that should be generated by the plant model.
+ max_metabolic_fraction_of_input: float = 0.85
+ """Maximum proportion of input plant biomass that can go to metabolic litter.
+
+ [unitless]. The value is taken from :cite:t:`krinner_dynamic_2005`.
"""
- lignin_proportion_wood_input: float = 0.3
- """Lignin proportion of dead wood input [unitless].
-
- TODO - The number given here is made up (but within reasonable bounds). However,
- this is a quantity that should be generated by the plant model.
+ structural_metabolic_split_sensitivity: float = 0.018
+ """Sets the sensitive of the split between metabolic and structural litter.
+
+ i.e. how much the split of input biomass between these two litter pools changes in
+ response to changes in nitrogen and lignin concentrations [unitless]. The value is
+ taken from :cite:t:`krinner_dynamic_2005`.
"""
- lignin_proportion_below_structural_input: float = 0.2
- """Lignin proportion of input to the below ground structural litter pool [unitless].
-
- TODO - The number given here is made up (but within reasonable bounds). However,
- this is a quantity that should be generated by the plant model.
+ structural_to_metabolic_n_ratio: float = 5.0
+ """Ratio of the carbon to nitrogen ratios of structural vs metabolic litter pools.
+
+ Following :cite:t:`kirschbaum_modelling_2002`, we assume that the nitrogen content
+ of the structural and metabolic litter pools are in a fixed proportion. This
+ parameter sets how many times higher the carbon to nitrogen ratio of each structural
+ pool is relative to its corresponding metabolic pool. The default value is also
+ taken from :cite:t:`kirschbaum_modelling_2002`.
"""
diff --git a/virtual_ecosystem/models/litter/env_factors.py b/virtual_ecosystem/models/litter/env_factors.py
new file mode 100644
index 000000000..27ba1eaf8
--- /dev/null
+++ b/virtual_ecosystem/models/litter/env_factors.py
@@ -0,0 +1,244 @@
+"""The ``models.litter.env_factors`` module contains functions that are used to
+capture the impact that environmental factors have on litter decay rates. These include
+temperature and soil water potential.
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+from xarray import DataArray
+
+from virtual_ecosystem.core.core_components import LayerStructure
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+
+def calculate_environmental_factors(
+ air_temperatures: DataArray,
+ soil_temperatures: DataArray,
+ water_potentials: DataArray,
+ layer_structure: LayerStructure,
+ constants: LitterConsts,
+):
+ """Calculate the impact of the environment has on litter decay across litter layers.
+
+ For the above ground layer the impact of temperature is calculated, and for the
+ below ground layer the effect of temperature and soil water potential are both
+ calculated.
+
+ The relevant above ground temperature is the surface temperature, which can be
+ easily extracted from the temperature data. It's more complex for the below ground
+ temperature and the water potential as the relevant values are averages across the
+ microbially active depth. These are calculated by averaging across the soil layers
+ with each layer weighted by the proportion of the total microbially active depth it
+ represents.
+
+ If a shallow microbially active depth is used then below ground litter decomposition
+ will be exposed to a high degree of environmental variability. This is
+ representative of the real world, but needs to be kept in mind when comparing to
+ other models.
+
+ Args:
+ air_temperatures: Air temperatures, for all above ground layers [C]
+ soil_temperatures: Soil temperatures, for all soil layers [C]
+ water_potentials: Water potentials, for all soil layers [kPa]
+ layer_structure: The LayerStructure instance for the simulation.
+ constants: Set of constants for the litter model
+
+ Returns:
+ A dictionary containing three environmental factors, one for the effect of
+ temperature on above ground litter decay, one for the effect of temperature on
+ below ground litter decay, and one for the effect of soil water potential on
+ below ground litter decay.
+ """
+
+ temperatures = {
+ "surface": air_temperatures[layer_structure.index_surface_scalar].to_numpy(),
+ # TODO - This currently takes uses the surface temperature for the first layer.
+ # Once we start change the default to use a thin topsoil layer that should be
+ # used here instead
+ "below_ground": average_temperature_over_microbially_active_layers(
+ soil_temperatures=soil_temperatures,
+ surface_temperature=air_temperatures[
+ layer_structure.index_surface_scalar
+ ].to_numpy(),
+ layer_structure=layer_structure,
+ ),
+ }
+ water_potential = average_water_potential_over_microbially_active_layers(
+ water_potentials=water_potentials, layer_structure=layer_structure
+ )
+
+ temperature_factors = {
+ level: calculate_temperature_effect_on_litter_decomp(
+ temperature=temp,
+ reference_temp=constants.litter_decomp_reference_temp,
+ offset_temp=constants.litter_decomp_offset_temp,
+ temp_response=constants.litter_decomp_temp_response,
+ )
+ for (level, temp) in temperatures.items()
+ }
+
+ # Calculate the water factor (relevant for below ground layers)
+ water_factor = calculate_soil_water_effect_on_litter_decomp(
+ water_potential=water_potential,
+ water_potential_halt=constants.litter_decay_water_potential_halt,
+ water_potential_opt=constants.litter_decay_water_potential_optimum,
+ moisture_response_curvature=constants.moisture_response_curvature,
+ )
+
+ return {
+ "temp_above": temperature_factors["surface"],
+ "temp_below": temperature_factors["below_ground"],
+ "water": water_factor,
+ }
+
+
+def calculate_temperature_effect_on_litter_decomp(
+ temperature: NDArray[np.float32],
+ reference_temp: float,
+ offset_temp: float,
+ temp_response: float,
+) -> NDArray[np.float32]:
+ """Calculate the effect that temperature has on litter decomposition rates.
+
+ This function is taken from :cite:t:`kirschbaum_modelling_2002`.
+
+ Args:
+ temperature: The temperature of the litter layer [C]
+ reference_temp: The reference temperature for changes in litter decomposition
+ rates with temperature [C]
+ offset_temp: Temperature offset [C]
+ temp_response: Factor controlling response strength to changing temperature
+ [unitless]
+
+ Returns:
+ A multiplicative factor capturing the impact of temperature on litter
+ decomposition [unitless]
+ """
+
+ return np.exp(
+ temp_response * (temperature - reference_temp) / (temperature + offset_temp)
+ )
+
+
+def calculate_soil_water_effect_on_litter_decomp(
+ water_potential: NDArray[np.float32],
+ water_potential_halt: float,
+ water_potential_opt: float,
+ moisture_response_curvature: float,
+) -> NDArray[np.float32]:
+ """Calculate the effect that soil water potential has on litter decomposition rates.
+
+ This function is only relevant for the below ground litter pools. Its functional
+ form is taken from :cite:t:`moyano_responses_2013`.
+
+ Args:
+ water_potential: Soil water potential [kPa]
+ water_potential_halt: Water potential at which all microbial activity stops
+ [kPa]
+ water_potential_opt: Optimal water potential for microbial activity [kPa]
+ moisture_response_curvature: Parameter controlling the curvature of the moisture
+ response function [unitless]
+
+ Returns:
+ A multiplicative factor capturing the impact of moisture on below ground litter
+ decomposition [unitless]
+ """
+
+ # TODO - Need to make sure that this function is properly defined for a plausible
+ # range of matric potentials.
+
+ # Calculate how much moisture suppresses microbial activity
+ supression = (
+ (np.log10(-water_potential) - np.log10(-water_potential_opt))
+ / (np.log10(-water_potential_halt) - np.log10(-water_potential_opt))
+ ) ** moisture_response_curvature
+
+ return 1 - supression
+
+
+def average_temperature_over_microbially_active_layers(
+ soil_temperatures: DataArray,
+ surface_temperature: NDArray[np.float32],
+ layer_structure: LayerStructure,
+) -> NDArray[np.float32]:
+ """Average soil temperatures over the microbially active layers.
+
+ First the average temperature is found for each layer. Then an average across the
+ microbially active depth is taken, weighting by how much of the microbially active
+ depth lies within each layer.
+
+ Args:
+ soil_temperatures: Soil temperatures to be averaged [C]
+ surface_temperature: Air temperature just above the soil surface [C]
+ layer_structure: The LayerStructure instance for the simulation.
+
+ Returns:
+ The average temperature across the soil depth considered to be microbially
+ active [C]
+ """
+
+ # Find weighting for each layer in the average by dividing the microbially active
+ # depth in each layer by the total depth of microbial activity
+ layer_weights = (
+ layer_structure.soil_layer_active_thickness
+ / layer_structure.max_depth_of_microbial_activity
+ )
+
+ # Find the average for each layer
+ layer_averages = np.empty((layer_weights.shape[0], soil_temperatures.shape[1]))
+ layer_averages[0, :] = (
+ surface_temperature + soil_temperatures[layer_structure.index_topsoil]
+ ) / 2.0
+
+ for index in range(1, len(layer_structure.soil_layer_active_thickness)):
+ layer_averages[index, :] = (
+ soil_temperatures[layer_structure.index_topsoil_scalar + index - 1]
+ + soil_temperatures[layer_structure.index_topsoil_scalar + index]
+ ) / 2.0
+
+ return np.dot(layer_weights, layer_averages)
+
+
+def average_water_potential_over_microbially_active_layers(
+ water_potentials: DataArray,
+ layer_structure: LayerStructure,
+) -> NDArray[np.float32]:
+ """Average water potentials over the microbially active layers.
+
+ The average water potential is found for each layer apart from the top layer. This
+ is because for the top layer a sensible average can't be taken as water potential is
+ not defined for the surface layer. In this case, the water potential at the maximum
+ layer height is just treated as the average of the layer. This is a reasonable
+ assumption if the first soil layer is shallow.
+
+ These water potentials are then averaged across the microbially active depth,
+ weighting by how much of the microbially active depth lies within each layer.
+
+ Args:
+ water_potentials: Soil water potentials to be averaged [kPa]
+ layer_structure: The LayerStructure instance for the simulation.
+
+ Returns:
+ The average water potential across the soil depth considered to be microbially
+ active [kPa]
+ """
+
+ # Find weighting for each layer in the average by dividing the microbially active
+ # depth in each layer by the total depth of microbial activity
+ layer_weights = (
+ layer_structure.soil_layer_active_thickness
+ / layer_structure.max_depth_of_microbial_activity
+ )
+
+ # Find the average for each layer
+ layer_averages = np.empty((layer_weights.shape[0], water_potentials.shape[1]))
+ # Top layer cannot be averaged
+ layer_averages[0, :] = water_potentials[layer_structure.index_topsoil]
+
+ for index in range(1, len(layer_structure.soil_layer_active_thickness)):
+ layer_averages[index, :] = (
+ water_potentials[layer_structure.index_topsoil_scalar + index - 1]
+ + water_potentials[layer_structure.index_topsoil_scalar + index]
+ ) / 2.0
+
+ return np.dot(layer_weights, layer_averages)
diff --git a/virtual_ecosystem/models/litter/input_partition.py b/virtual_ecosystem/models/litter/input_partition.py
new file mode 100644
index 000000000..94ce14759
--- /dev/null
+++ b/virtual_ecosystem/models/litter/input_partition.py
@@ -0,0 +1,183 @@
+"""The ``models.litter.input_partition`` module handles the partitioning of dead plant
+and animal matter into the various pools of the litter model.
+""" # noqa: D205
+
+import numpy as np
+from numpy.typing import NDArray
+
+from virtual_ecosystem.core.logger import LOGGER
+from virtual_ecosystem.models.litter.constants import LitterConsts
+
+# TODO - It makes sense for the animal pools to be handled here, but need to think about
+# how the partition works with the plant partition, Animals do not contain lignin, so if
+# I used the standard function on animal carcasses and excrement the maximum amount
+# (85%) will end up in the metabolic pool, which I think is basically fine, with bones
+# not being explicitly modelled I think this is fine. This will have to change once
+# bones are included.
+
+
+def calculate_metabolic_proportions_of_input(
+ leaf_turnover_lignin_proportion: NDArray[np.float32],
+ reproduct_turnover_lignin_proportion: NDArray[np.float32],
+ root_turnover_lignin_proportion: NDArray[np.float32],
+ leaf_turnover_c_n_ratio: NDArray[np.float32],
+ reproduct_turnover_c_n_ratio: NDArray[np.float32],
+ root_turnover_c_n_ratio: NDArray[np.float32],
+ constants: LitterConsts,
+) -> dict[str, NDArray[np.float32]]:
+ """Calculate the proportion of each input type that flows to the metabolic pool.
+
+ This function is used for roots, leaves and reproductive tissue, but not deadwood
+ because everything goes into a single woody litter pool. It is not used for animal
+ inputs either as they all flow into just the metabolic pool.
+
+ Args:
+ leaf_turnover_lignin_proportion: Proportion of carbon in turned over leaves that
+ is lignin [kg lignin kg C^-1]
+ reproduct_turnover_lignin_proportion: Proportion of carbon in turned over
+ reproductive tissues that is lignin [kg lignin kg C^-1]
+ root_turnover_lignin_proportion: Proportion of carbon in turned over roots that
+ is lignin [kg lignin kg C^-1]
+ leaf_turnover_c_n_ratio: Carbon:nitrogen ratio of turned over leaves [unitless]
+ reproduct_turnover_c_n_ratio: Carbon:nitrogen ratio of turned over reproductive
+ tissues [unitless]
+ root_turnover_c_n_ratio: Carbon:nitrogen ratio of turned over roots [unitless]
+ constants: Set of constants for the litter model.
+
+ Returns:
+ A dictionary containing the proportion of the input that goes to the relevant
+ metabolic pool. This is for three input types: leaves, reproductive tissues and
+ roots [unitless]
+ """
+
+ # Calculate split of each input biomass type
+ leaves_metabolic_split = split_pool_into_metabolic_and_structural_litter(
+ lignin_proportion=leaf_turnover_lignin_proportion,
+ carbon_nitrogen_ratio=leaf_turnover_c_n_ratio,
+ max_metabolic_fraction=constants.max_metabolic_fraction_of_input,
+ split_sensitivity=constants.structural_metabolic_split_sensitivity,
+ )
+ repoduct_metabolic_split = split_pool_into_metabolic_and_structural_litter(
+ lignin_proportion=reproduct_turnover_lignin_proportion,
+ carbon_nitrogen_ratio=reproduct_turnover_c_n_ratio,
+ max_metabolic_fraction=constants.max_metabolic_fraction_of_input,
+ split_sensitivity=constants.structural_metabolic_split_sensitivity,
+ )
+ roots_metabolic_split = split_pool_into_metabolic_and_structural_litter(
+ lignin_proportion=root_turnover_lignin_proportion,
+ carbon_nitrogen_ratio=root_turnover_c_n_ratio,
+ max_metabolic_fraction=constants.max_metabolic_fraction_of_input,
+ split_sensitivity=constants.structural_metabolic_split_sensitivity,
+ )
+
+ return {
+ "leaves": leaves_metabolic_split,
+ "reproductive": repoduct_metabolic_split,
+ "roots": roots_metabolic_split,
+ }
+
+
+def partion_plant_inputs_between_pools(
+ deadwood_production: NDArray[np.float32],
+ leaf_turnover: NDArray[np.float32],
+ reproduct_turnover: NDArray[np.float32],
+ root_turnover: NDArray[np.float32],
+ metabolic_splits: dict[str, NDArray[np.float32]],
+):
+ """Function to partition input biomass between the various litter pools.
+
+ All deadwood is added to the woody litter pool. Reproductive biomass (fruits and
+ flowers) and leaves are split between the above ground metabolic and structural
+ pools based on lignin concentration and carbon nitrogen ratios. Root biomass is
+ split between the below ground metabolic and structural pools based on lignin
+ concentration and carbon nitrogen ratios.
+
+ Args:
+ deadwood_production: Amount of dead wood produced [kg C m^-2]
+ leaf_turnover: Amount of leaf turnover [kg C m^-2]
+ reproduct_turnover: Turnover of plant reproductive tissues (i.e. fruits and
+ flowers) [kg C m^-2]
+ root_turnover: Turnover of roots (coarse and fine) turnover [kg C m^-2]
+ metabolic_splits: Dictionary containing the proportion of each input that goes
+ to the relevant metabolic pool. This is for three input types: leaves,
+ reproductive tissues and roots [unitless]
+
+ Returns:
+ A dictionary containing the biomass flow into each of the five litter pools
+ (woody, above ground metabolic, above ground structural, below ground metabolic
+ and below ground structural)
+ """
+
+ # Calculate input to each of the five litter pools
+ woody_input = deadwood_production
+ above_ground_metabolic_input = (
+ metabolic_splits["leaves"] * leaf_turnover
+ + metabolic_splits["reproductive"] * reproduct_turnover
+ )
+ above_ground_strutural_input = (
+ (1 - metabolic_splits["leaves"]) * leaf_turnover
+ + (1 - metabolic_splits["reproductive"]) * reproduct_turnover
+ ) # fmt: off
+ below_ground_metabolic_input = metabolic_splits["roots"] * root_turnover
+ below_ground_structural_input = (1 - metabolic_splits["roots"]) * root_turnover
+
+ return {
+ "woody": woody_input,
+ "above_ground_metabolic": above_ground_metabolic_input,
+ "above_ground_structural": above_ground_strutural_input,
+ "below_ground_metabolic": below_ground_metabolic_input,
+ "below_ground_structural": below_ground_structural_input,
+ }
+
+
+def split_pool_into_metabolic_and_structural_litter(
+ lignin_proportion: NDArray[np.float32],
+ carbon_nitrogen_ratio: NDArray[np.float32],
+ max_metabolic_fraction: float,
+ split_sensitivity: float,
+) -> NDArray[np.float32]:
+ """Calculate the split of input biomass between metabolic and structural pools.
+
+ This division depends on the lignin and nitrogen content of the input biomass, the
+ functional form is taken from :cite:t:`parton_dynamics_1988`.
+
+ TODO - This can almost certainly be extended to include phosphorus co-limitation.
+
+ Args:
+ lignin_proportion: Proportion of input biomass carbon that is lignin [kg lignin
+ kg C^-1]
+ carbon_nitrogen_ratio: Ratio of carbon to nitrogen for the input biomass
+ [unitless]
+ max_metabolic_fraction: Fraction of pool that becomes metabolic litter for the
+ easiest to breakdown case, i.e. no lignin, ample nitrogen [unitless]
+ split_sensitivity: Sets how rapidly the split changes in response to changing
+ lignin and nitrogen contents [unitless]
+
+ Raises:
+ ValueError: If any of the metabolic fractions drop below zero, or if any
+ structural fraction is less than the lignin proportion (which would push the
+ lignin proportion of the structural litter input above 100%).
+
+ Returns:
+ The fraction of the biomass that goes to the metabolic pool [unitless]
+ """
+
+ metabolic_fraction = max_metabolic_fraction - split_sensitivity * (
+ lignin_proportion * carbon_nitrogen_ratio
+ )
+
+ if np.any(metabolic_fraction < 0.0):
+ to_raise = ValueError(
+ "Fraction of input biomass going to metabolic pool has dropped below zero!"
+ )
+ LOGGER.error(to_raise)
+ raise to_raise
+ elif np.any(1 - metabolic_fraction < lignin_proportion):
+ to_raise = ValueError(
+ "Fraction of input biomass going to structural biomass is less than the "
+ "lignin fraction!"
+ )
+ LOGGER.error(to_raise)
+ raise to_raise
+ else:
+ return metabolic_fraction
diff --git a/virtual_ecosystem/models/litter/litter_model.py b/virtual_ecosystem/models/litter/litter_model.py
index 69847da62..501daeda1 100644
--- a/virtual_ecosystem/models/litter/litter_model.py
+++ b/virtual_ecosystem/models/litter/litter_model.py
@@ -14,7 +14,7 @@ class instance. If errors crop here when converting the information from the con
then logged, and at the end of the unpacking an error is thrown. This error should be
caught and handled by downstream functions so that all model configuration failures can
be reported as one.
-""" # noqa: D205, D415
+""" # noqa: D205
# TODO - At the moment this model only receives two things from the animal model,
# excrement and decayed carcass biomass. Both of these are simply added to the above
@@ -45,9 +45,16 @@ class instance. If errors crop here when converting the information from the con
from virtual_ecosystem.core.data import Data
from virtual_ecosystem.core.exceptions import InitialisationError
from virtual_ecosystem.core.logger import LOGGER
+from virtual_ecosystem.models.litter.carbon import (
+ calculate_decay_rates,
+ calculate_total_C_mineralised,
+ calculate_updated_pools,
+)
+from virtual_ecosystem.models.litter.chemistry import LitterChemistry
from virtual_ecosystem.models.litter.constants import LitterConsts
-from virtual_ecosystem.models.litter.litter_pools import (
- calculate_change_in_litter_variables,
+from virtual_ecosystem.models.litter.input_partition import (
+ calculate_metabolic_proportions_of_input,
+ partion_plant_inputs_between_pools,
)
@@ -55,15 +62,48 @@ class LitterModel(
BaseModel,
model_name="litter",
model_update_bounds=("30 minutes", "3 months"),
- required_init_vars=(
- ("litter_pool_above_metabolic", ("spatial",)),
- ("litter_pool_above_structural", ("spatial",)),
- ("litter_pool_woody", ("spatial",)),
- ("litter_pool_below_metabolic", ("spatial",)),
- ("litter_pool_below_structural", ("spatial",)),
- ("lignin_above_structural", ("spatial",)),
- ("lignin_woody", ("spatial",)),
- ("lignin_below_structural", ("spatial",)),
+ vars_required_for_init=(
+ "litter_pool_above_metabolic",
+ "litter_pool_above_structural",
+ "litter_pool_woody",
+ "litter_pool_below_metabolic",
+ "litter_pool_below_structural",
+ "lignin_above_structural",
+ "lignin_woody",
+ "lignin_below_structural",
+ "c_n_ratio_above_metabolic",
+ "c_n_ratio_above_structural",
+ "c_n_ratio_woody",
+ "c_n_ratio_below_metabolic",
+ "c_n_ratio_below_structural",
+ ),
+ vars_populated_by_init=(),
+ vars_required_for_update=(
+ "litter_pool_above_metabolic",
+ "litter_pool_above_structural",
+ "litter_pool_woody",
+ "litter_pool_below_metabolic",
+ "litter_pool_below_structural",
+ "lignin_above_structural",
+ "lignin_woody",
+ "lignin_below_structural",
+ "c_n_ratio_above_metabolic",
+ "c_n_ratio_above_structural",
+ "c_n_ratio_woody",
+ "c_n_ratio_below_metabolic",
+ "c_n_ratio_below_structural",
+ "deadwood_production",
+ "leaf_turnover",
+ "plant_reproductive_tissue_turnover",
+ "root_turnover",
+ "deadwood_lignin",
+ "leaf_turnover_lignin",
+ "plant_reproductive_tissue_turnover_lignin",
+ "root_turnover_lignin",
+ "deadwood_c_n_ratio",
+ "leaf_turnover_c_n_ratio",
+ "plant_reproductive_tissue_turnover_c_n_ratio",
+ "root_turnover_c_n_ratio",
),
vars_updated=(
"litter_pool_above_metabolic",
@@ -74,7 +114,17 @@ class LitterModel(
"lignin_above_structural",
"lignin_woody",
"lignin_below_structural",
+ "c_n_ratio_above_metabolic",
+ "c_n_ratio_above_structural",
+ "c_n_ratio_woody",
+ "c_n_ratio_below_metabolic",
+ "c_n_ratio_below_structural",
+ "litter_C_mineralisation_rate",
+ "litter_N_mineralisation_rate",
+ ),
+ vars_populated_by_first_update=(
"litter_C_mineralisation_rate",
+ "litter_N_mineralisation_rate",
),
):
"""A class defining the litter model.
@@ -137,18 +187,32 @@ def __init__(
LOGGER.error(to_raise)
raise to_raise
+ # Check that nutrient ratios are not negative
+ nutrient_ratios = [
+ "c_n_ratio_above_metabolic",
+ "c_n_ratio_above_structural",
+ "c_n_ratio_woody",
+ "c_n_ratio_below_metabolic",
+ "c_n_ratio_below_structural",
+ ]
+ negative_ratios = []
+ for ratio in nutrient_ratios:
+ if np.any(data[ratio] < 0):
+ negative_ratios.append(ratio)
+
+ if negative_ratios:
+ to_raise = InitialisationError(
+ f"Negative nutrient ratios found in: {', '.join(negative_ratios)}"
+ )
+ LOGGER.error(to_raise)
+ raise to_raise
+
+ self.litter_chemistry = LitterChemistry(data, constants=model_constants)
+ """Litter chemistry object for tracking of litter pool chemistries."""
+
self.model_constants = model_constants
"""Set of constants for the litter model."""
- # Find first soil layer from the list of layer roles
- self.top_soil_layer_index: int = self.layer_structure.layer_roles.index("soil")
- """The layer in the data object representing the first soil layer."""
- # Find first soil layer from the list of layer roles
- self.surface_layer_index: int = self.layer_structure.layer_roles.index(
- "surface"
- )
- """The layer in the data object representing the surface layer."""
-
@classmethod
def from_config(
cls, data: Data, core_components: CoreComponents, config: Config
@@ -187,26 +251,18 @@ def spinup(self) -> None:
def update(self, time_index: int, **kwargs: Any) -> None:
"""Calculate changes in the litter pools and use them to update the pools.
+ This function first calculates the decay rates for each litter pool, as well as
+ the total carbon mineralisation rate. Once this is done, plant inputs to each
+ pool are calculated, and used to find the new mass and lignin concentration of
+ each litter pool.
+
Args:
time_index: The index representing the current time step in the data object.
+ **kwargs: Further arguments to the update method.
"""
- # Find change in litter variables using the function
- updated_variables = calculate_change_in_litter_variables(
- surface_temp=self.data["air_temperature"][
- self.surface_layer_index
- ].to_numpy(),
- topsoil_temp=self.data["soil_temperature"][
- self.top_soil_layer_index
- ].to_numpy(),
- water_potential=self.data["matric_potential"][
- self.top_soil_layer_index
- ].to_numpy(),
- model_constants=self.model_constants,
- core_constants=self.core_constants,
- update_interval=self.model_timing.update_interval_quantity.to(
- "day"
- ).magnitude,
+ # Calculate the litter pool decay rates
+ decay_rates = calculate_decay_rates(
above_metabolic=self.data["litter_pool_above_metabolic"].to_numpy(),
above_structural=self.data["litter_pool_above_structural"].to_numpy(),
woody=self.data["litter_pool_woody"].to_numpy(),
@@ -215,14 +271,115 @@ def update(self, time_index: int, **kwargs: Any) -> None:
lignin_above_structural=self.data["lignin_above_structural"].to_numpy(),
lignin_woody=self.data["lignin_woody"].to_numpy(),
lignin_below_structural=self.data["lignin_below_structural"].to_numpy(),
+ air_temperatures=self.data["air_temperature"],
+ soil_temperatures=self.data["soil_temperature"],
+ water_potentials=self.data["matric_potential"],
+ layer_structure=self.layer_structure,
+ constants=self.model_constants,
+ )
+
+ # Find the plant inputs to each of the litter pools
+ metabolic_splits = calculate_metabolic_proportions_of_input(
+ leaf_turnover_lignin_proportion=self.data[
+ "leaf_turnover_lignin"
+ ].to_numpy(),
+ reproduct_turnover_lignin_proportion=self.data[
+ "plant_reproductive_tissue_turnover_lignin"
+ ].to_numpy(),
+ root_turnover_lignin_proportion=self.data[
+ "root_turnover_lignin"
+ ].to_numpy(),
+ leaf_turnover_c_n_ratio=self.data["leaf_turnover_c_n_ratio"].to_numpy(),
+ reproduct_turnover_c_n_ratio=self.data[
+ "plant_reproductive_tissue_turnover_c_n_ratio"
+ ].to_numpy(),
+ root_turnover_c_n_ratio=self.data["root_turnover_c_n_ratio"].to_numpy(),
+ constants=self.model_constants,
+ )
+
+ plant_inputs = partion_plant_inputs_between_pools(
+ deadwood_production=self.data["deadwood_production"].to_numpy(),
+ leaf_turnover=self.data["leaf_turnover"].to_numpy(),
+ reproduct_turnover=self.data[
+ "plant_reproductive_tissue_turnover"
+ ].to_numpy(),
+ root_turnover=self.data["root_turnover"].to_numpy(),
+ metabolic_splits=metabolic_splits,
+ )
+
+ # Calculate the updated pool masses
+ updated_pools = calculate_updated_pools(
+ above_metabolic=self.data["litter_pool_above_metabolic"].to_numpy(),
+ above_structural=self.data["litter_pool_above_structural"].to_numpy(),
+ woody=self.data["litter_pool_woody"].to_numpy(),
+ below_metabolic=self.data["litter_pool_below_metabolic"].to_numpy(),
+ below_structural=self.data["litter_pool_below_structural"].to_numpy(),
decomposed_excrement=self.data["decomposed_excrement"].to_numpy(),
decomposed_carcasses=self.data["decomposed_carcasses"].to_numpy(),
+ decay_rates=decay_rates,
+ plant_inputs=plant_inputs,
+ update_interval=self.model_timing.update_interval_quantity.to(
+ "day"
+ ).magnitude,
+ )
+
+ # Calculate all the litter chemistry changes
+ updated_chemistries = self.litter_chemistry.calculate_new_pool_chemistries(
+ plant_inputs=plant_inputs,
+ metabolic_splits=metabolic_splits,
+ updated_pools=updated_pools,
+ )
+
+ # Calculate the total mineralisation rates from the litter
+ total_C_mineralisation_rate = calculate_total_C_mineralised(
+ decay_rates,
+ model_constants=self.model_constants,
+ core_constants=self.core_constants,
+ )
+ total_N_mineralisation_rate = self.litter_chemistry.calculate_N_mineralisation(
+ decay_rates=decay_rates,
+ active_microbe_depth=self.core_constants.max_depth_of_microbial_activity,
)
- # Construct dictionary of data arrays
+ # Construct dictionary of data arrays to return
updated_litter_variables = {
- variable: DataArray(updated_variables[variable], dims="cell_id")
- for variable in updated_variables.keys()
+ "litter_pool_above_metabolic": DataArray(
+ updated_pools["above_metabolic"], dims="cell_id"
+ ),
+ "litter_pool_above_structural": DataArray(
+ updated_pools["above_structural"], dims="cell_id"
+ ),
+ "litter_pool_woody": DataArray(updated_pools["woody"], dims="cell_id"),
+ "litter_pool_below_metabolic": DataArray(
+ updated_pools["below_metabolic"], dims="cell_id"
+ ),
+ "litter_pool_below_structural": DataArray(
+ updated_pools["below_structural"], dims="cell_id"
+ ),
+ "lignin_above_structural": DataArray(
+ updated_chemistries["lignin_above_structural"], dims="cell_id"
+ ),
+ "lignin_woody": updated_chemistries["lignin_woody"],
+ "lignin_below_structural": updated_chemistries["lignin_below_structural"],
+ "c_n_ratio_above_metabolic": updated_chemistries[
+ "c_n_ratio_above_metabolic"
+ ],
+ "c_n_ratio_above_structural": updated_chemistries[
+ "c_n_ratio_above_structural"
+ ],
+ "c_n_ratio_woody": updated_chemistries["c_n_ratio_woody"],
+ "c_n_ratio_below_metabolic": updated_chemistries[
+ "c_n_ratio_below_metabolic"
+ ],
+ "c_n_ratio_below_structural": updated_chemistries[
+ "c_n_ratio_below_structural"
+ ],
+ "litter_C_mineralisation_rate": DataArray(
+ total_C_mineralisation_rate, dims="cell_id"
+ ),
+ "litter_N_mineralisation_rate": DataArray(
+ total_N_mineralisation_rate, dims="cell_id"
+ ),
}
# And then use then to update the litter variables
diff --git a/virtual_ecosystem/models/litter/litter_pools.py b/virtual_ecosystem/models/litter/litter_pools.py
deleted file mode 100644
index 20b3eb7f9..000000000
--- a/virtual_ecosystem/models/litter/litter_pools.py
+++ /dev/null
@@ -1,761 +0,0 @@
-"""The ``models.litter.litter_pools`` module simulates the litter pools for the Virtual
-Ecosystem. Pools are divided into above and below ground pools, with below ground pools
-affected by both soil moisture and temperature, and above ground pools just affected by
-soil surface temperatures. The pools are also divided based on the recalcitrance of
-their inputs, dead wood is given a separate pool, and all other inputs are divided
-between metabolic and structural pools. Recalcitrant litter contains hard to break down
-compounds, principally lignin. The metabolic litter pool contains the non-recalcitrant
-litter and so breaks down quickly. Whereas, the structural litter contains the
-recalcitrant litter.
-
-We consider 5 pools rather than 6, as it's not really possible to parametrise the below
-ground dead wood pool. So, all dead wood gets included in the above ground woody litter
-pool.
-
-The amount of lignin in both the structural pools and the dead wood pool is tracked.
-This is tracked because litter chemistry is a major determinant of litter decay rates.
-""" # noqa: D205, D415
-
-import numpy as np
-from numpy.typing import NDArray
-
-from virtual_ecosystem.core.constants import CoreConsts
-from virtual_ecosystem.models.litter.constants import LitterConsts
-
-
-def calculate_change_in_litter_variables(
- surface_temp: NDArray[np.float32],
- topsoil_temp: NDArray[np.float32],
- water_potential: NDArray[np.float32],
- above_metabolic: NDArray[np.float32],
- above_structural: NDArray[np.float32],
- woody: NDArray[np.float32],
- below_metabolic: NDArray[np.float32],
- below_structural: NDArray[np.float32],
- lignin_above_structural: NDArray[np.float32],
- lignin_woody: NDArray[np.float32],
- lignin_below_structural: NDArray[np.float32],
- decomposed_excrement: NDArray[np.float32],
- decomposed_carcasses: NDArray[np.float32],
- update_interval: float,
- model_constants: LitterConsts,
- core_constants: CoreConsts,
-) -> dict[str, NDArray[np.float32]]:
- """Calculate changes for all the litter variables (pool sizes and chemistries).
-
- Args:
- surface_temp: Temperature of soil surface, which is assumed to be the same
- temperature as the above ground litter [C]
- topsoil_temp: Temperature of topsoil layer, which is assumed to be the same
- temperature as the below ground litter [C]
- water_potential: Water potential of the topsoil layer [kPa]
- above_metabolic: Above ground metabolic litter pool [kg C m^-2]
- above_structural: Above ground structural litter pool [kg C m^-2]
- woody: The woody litter pool [kg C m^-2]
- below_metabolic: Below ground metabolic litter pool [kg C m^-2]
- below_structural: Below ground structural litter pool [kg C m^-2]
- lignin_above_structural: Proportion of above ground structural pool which is
- lignin [unitless]
- lignin_woody: Proportion of dead wood pool which is lignin [unitless]
- lignin_below_structural: Proportion of below ground structural pool which is
- lignin [unitless]
- decomposed_excrement: Input rate of excrement from the animal model [kg C m^-2
- day^-1]
- decomposed_carcasses: Input rate of (partially) decomposed carcass biomass from
- the animal model [kg C m^-2 day^-1]
- update_interval: Interval that the litter pools are being updated for [days]
- model_constants: Set of constants for the litter model
- core_constants: Set of core constants shared between all models
-
- Returns:
- The new value for each of the litter pools, and the total mineralisation rate.
- """
-
- # Calculate the factors which capture the impact that temperature and soil water
- # content have on litter decay rates
- environmental_factors = calculate_environmental_factors(
- surface_temp=surface_temp,
- topsoil_temp=topsoil_temp,
- water_potential=water_potential,
- constants=model_constants,
- )
-
- # Calculate the litter pool decay rates
- decay_rates = calculate_decay_rates(
- above_metabolic=above_metabolic,
- above_structural=above_structural,
- woody=woody,
- below_metabolic=below_metabolic,
- below_structural=below_structural,
- lignin_above_structural=lignin_above_structural,
- lignin_woody=lignin_woody,
- lignin_below_structural=lignin_below_structural,
- environmental_factors=environmental_factors,
- constants=model_constants,
- )
-
- # Calculate the total mineralisation of carbon from the litter
- total_C_mineralisation_rate = calculate_total_C_mineralised(
- decay_rates, model_constants=model_constants, core_constants=core_constants
- )
-
- # Calculate the updated pool masses
- updated_pools = calculate_updated_pools(
- above_metabolic=above_metabolic,
- above_structural=above_structural,
- woody=woody,
- below_metabolic=below_metabolic,
- below_structural=below_structural,
- decomposed_excrement=decomposed_excrement,
- decomposed_carcasses=decomposed_carcasses,
- decay_rates=decay_rates,
- update_interval=update_interval,
- constants=model_constants,
- )
-
- # Find the changes in the lignin concentrations of the 3 relevant pools
- change_in_lignin = calculate_lignin_updates(
- lignin_above_structural=lignin_above_structural,
- lignin_woody=lignin_woody,
- lignin_below_structural=lignin_below_structural,
- updated_pools=updated_pools,
- update_interval=update_interval,
- constants=model_constants,
- )
-
- # Construct dictionary of data arrays to return
- new_litter_pools = {
- "litter_pool_above_metabolic": updated_pools["above_metabolic"],
- "litter_pool_above_structural": updated_pools["above_structural"],
- "litter_pool_woody": updated_pools["woody"],
- "litter_pool_below_metabolic": updated_pools["below_metabolic"],
- "litter_pool_below_structural": updated_pools["below_structural"],
- "lignin_above_structural": lignin_above_structural
- + change_in_lignin["above_structural"],
- "lignin_woody": lignin_woody + change_in_lignin["woody"],
- "lignin_below_structural": lignin_below_structural
- + change_in_lignin["below_structural"],
- "litter_C_mineralisation_rate": total_C_mineralisation_rate,
- }
-
- return new_litter_pools
-
-
-def calculate_decay_rates(
- above_metabolic: NDArray[np.float32],
- above_structural: NDArray[np.float32],
- woody: NDArray[np.float32],
- below_metabolic: NDArray[np.float32],
- below_structural: NDArray[np.float32],
- lignin_above_structural: NDArray[np.float32],
- lignin_woody: NDArray[np.float32],
- lignin_below_structural: NDArray[np.float32],
- environmental_factors: dict[str, NDArray[np.float32]],
- constants: LitterConsts,
-) -> dict[str, NDArray[np.float32]]:
- """Calculate the decay rate for all five of the litter pools.
-
- Args:
- above_metabolic: Above ground metabolic litter pool [kg C m^-2]
- above_structural: Above ground structural litter pool [kg C m^-2]
- woody: The woody litter pool [kg C m^-2]
- below_metabolic: Below ground metabolic litter pool [kg C m^-2]
- below_structural: Below ground structural litter pool [kg C m^-2]
- lignin_above_structural: Proportion of above ground structural pool which is
- lignin [unitless]
- lignin_woody: Proportion of dead wood pool which is lignin [unitless]
- lignin_below_structural: Proportion of below ground structural pool which is
- lignin [unitless]
- environmental_factors: Factors capturing the effect that the physical
- environment (soil water + temperature) has on litter decay rates [unitless].
- constants: Set of constants for the litter model
-
- Returns:
- A dictionary containing the decay rate for each of the five litter pools.
- """
-
- # Calculate decay rate for each pool
- metabolic_above_decay = calculate_litter_decay_metabolic_above(
- environmental_factors["temp_above"],
- above_metabolic,
- litter_decay_coefficient=constants.litter_decay_constant_metabolic_above,
- )
- structural_above_decay = calculate_litter_decay_structural_above(
- environmental_factors["temp_above"],
- above_structural,
- lignin_above_structural,
- litter_decay_coefficient=constants.litter_decay_constant_structural_above,
- lignin_inhibition_factor=constants.lignin_inhibition_factor,
- )
- woody_decay = calculate_litter_decay_woody(
- environmental_factors["temp_above"],
- woody,
- lignin_woody,
- litter_decay_coefficient=constants.litter_decay_constant_woody,
- lignin_inhibition_factor=constants.lignin_inhibition_factor,
- )
- metabolic_below_decay = calculate_litter_decay_metabolic_below(
- environmental_factors["temp_below"],
- environmental_factors["water"],
- below_metabolic,
- litter_decay_coefficient=constants.litter_decay_constant_metabolic_below,
- )
- structural_below_decay = calculate_litter_decay_structural_below(
- environmental_factors["temp_below"],
- environmental_factors["water"],
- below_structural,
- lignin_below_structural,
- litter_decay_coefficient=constants.litter_decay_constant_structural_below,
- lignin_inhibition_factor=constants.lignin_inhibition_factor,
- )
-
- # Then return all the decay rates in a dictionary
- return {
- "metabolic_above": metabolic_above_decay,
- "structural_above": structural_above_decay,
- "woody": woody_decay,
- "metabolic_below": metabolic_below_decay,
- "structural_below": structural_below_decay,
- }
-
-
-def calculate_total_C_mineralised(
- decay_rates: dict[str, NDArray[np.float32]],
- model_constants: LitterConsts,
- core_constants: CoreConsts,
-) -> NDArray[np.float32]:
- """Calculate the total carbon mineralisation rate from all five litter pools.
-
- Args:
- decay_rates: Dictionary containing the rates of decay for all 5 litter pools
- [kg C m^-2 day^-1]
- model_constants: Set of constants for the litter model
- core_constants: Set of core constants shared between all models
-
- Returns:
- Rate of carbon mineralisation from litter into soil [kg C m^-3 day^-1].
- """
-
- # Calculate mineralisation from each pool
- metabolic_above_mineral = calculate_carbon_mineralised(
- decay_rates["metabolic_above"],
- carbon_use_efficiency=model_constants.cue_metabolic,
- )
- structural_above_mineral = calculate_carbon_mineralised(
- decay_rates["structural_above"],
- carbon_use_efficiency=model_constants.cue_structural_above_ground,
- )
- woody_mineral = calculate_carbon_mineralised(
- decay_rates["woody"],
- carbon_use_efficiency=model_constants.cue_woody,
- )
- metabolic_below_mineral = calculate_carbon_mineralised(
- decay_rates["metabolic_below"],
- carbon_use_efficiency=model_constants.cue_metabolic,
- )
- structural_below_mineral = calculate_carbon_mineralised(
- decay_rates["structural_below"],
- carbon_use_efficiency=model_constants.cue_structural_below_ground,
- )
-
- # Calculate mineralisation rate
- total_C_mineralisation_rate = (
- metabolic_above_mineral
- + structural_above_mineral
- + woody_mineral
- + metabolic_below_mineral
- + structural_below_mineral
- )
-
- # Convert mineralisation rate into kg m^-3 units (from kg m^-2)
- return total_C_mineralisation_rate / core_constants.depth_of_active_soil_layer
-
-
-def calculate_updated_pools(
- above_metabolic: NDArray[np.float32],
- above_structural: NDArray[np.float32],
- woody: NDArray[np.float32],
- below_metabolic: NDArray[np.float32],
- below_structural: NDArray[np.float32],
- decomposed_excrement: NDArray[np.float32],
- decomposed_carcasses: NDArray[np.float32],
- decay_rates: dict[str, NDArray[np.float32]],
- update_interval: float,
- constants: LitterConsts,
-) -> dict[str, NDArray[np.float32]]:
- """Calculate the updated mass of each litter pool.
-
- This function is not intended to be used continuously, and returns the new value for
- each pool after the update interval, rather than a rate of change to be integrated.
-
- Args:
- above_metabolic: Above ground metabolic litter pool [kg C m^-2]
- above_structural: Above ground structural litter pool [kg C m^-2]
- woody: The woody litter pool [kg C m^-2]
- below_metabolic: Below ground metabolic litter pool [kg C m^-2]
- below_structural: Below ground structural litter pool [kg C m^-2]
- decomposed_excrement: Input rate of excrement from the animal model [kg C m^-2
- day^-1]
- decomposed_carcasses: Input rate of (partially) decomposed carcass biomass from
- the animal model [kg C m^-2 day^-1]
- decay_rates: Dictionary containing the rates of decay for all 5 litter pools
- [kg C m^-2 day^-1]
- update_interval: Interval that the litter pools are being updated for [days]
- constants: Set of constants for the litter model
-
- Returns:
- Dictionary containing the updated pool densities for all 5 litter pools (above
- ground metabolic, above ground structural, dead wood, below ground metabolic,
- and below ground structural) [kg C m^-2]
- """
-
- # Net pool changes are found by combining input and decay rates, and then
- # multiplying by the update time step.
- change_in_metabolic_above = (
- constants.litter_input_to_metabolic_above
- + decomposed_excrement
- + decomposed_carcasses
- - decay_rates["metabolic_above"]
- ) * update_interval
- change_in_structural_above = (
- constants.litter_input_to_structural_above - decay_rates["structural_above"]
- ) * update_interval
- change_in_woody = (
- constants.litter_input_to_woody - decay_rates["woody"]
- ) * update_interval
- change_in_metabolic_below = (
- constants.litter_input_to_metabolic_below - decay_rates["metabolic_below"]
- ) * update_interval
- change_in_structural_below = (
- constants.litter_input_to_structural_below - decay_rates["structural_below"]
- ) * update_interval
-
- # New value for each pool is found and returned in a dictionary
- return {
- "above_metabolic": above_metabolic + change_in_metabolic_above,
- "above_structural": above_structural + change_in_structural_above,
- "woody": woody + change_in_woody,
- "below_metabolic": below_metabolic + change_in_metabolic_below,
- "below_structural": below_structural + change_in_structural_below,
- }
-
-
-def calculate_lignin_updates(
- lignin_above_structural: NDArray[np.float32],
- lignin_woody: NDArray[np.float32],
- lignin_below_structural: NDArray[np.float32],
- updated_pools: dict[str, NDArray[np.float32]],
- update_interval: float,
- constants: LitterConsts,
-) -> dict[str, NDArray[np.float32]]:
- """Calculate the changes in lignin proportion for the relevant litter pools.
-
- The relevant pools are the two structural pools, and the dead wood pool. This
- function calculates the total change over the entire time step, so cannot be used in
- an integration process.
-
- Args:
- lignin_above_structural: Proportion of above ground structural pool which is
- lignin [unitless]
- lignin_woody: Proportion of dead wood pool which is lignin [unitless]
- lignin_below_structural: Proportion of below ground structural pool which is
- lignin [unitless]
- updated_pools: Dictionary containing the updated pool densities for all 5 litter
- pools [kg C m^-2]
- update_interval: Interval that the litter pools are being updated for [days]
- constants: Set of constants for the litter model
-
- Returns:
- Dictionary containing the updated lignin proportions for the 3 relevant litter
- pools (above ground structural, dead wood, and below ground structural) [kg C
- m^-2]
- """
-
- change_in_lignin_above_structural = calculate_change_in_lignin(
- input_carbon=constants.litter_input_to_structural_above * update_interval,
- updated_pool_carbon=updated_pools["above_structural"],
- input_lignin=constants.lignin_proportion_above_structural_input,
- old_pool_lignin=lignin_above_structural,
- )
- change_in_lignin_woody = calculate_change_in_lignin(
- input_carbon=constants.litter_input_to_woody * update_interval,
- updated_pool_carbon=updated_pools["woody"],
- input_lignin=constants.lignin_proportion_wood_input,
- old_pool_lignin=lignin_woody,
- )
- change_in_lignin_below_structural = calculate_change_in_lignin(
- input_carbon=constants.litter_input_to_structural_below * update_interval,
- updated_pool_carbon=updated_pools["below_structural"],
- input_lignin=constants.lignin_proportion_below_structural_input,
- old_pool_lignin=lignin_below_structural,
- )
-
- return {
- "above_structural": change_in_lignin_above_structural,
- "woody": change_in_lignin_woody,
- "below_structural": change_in_lignin_below_structural,
- }
-
-
-def calculate_environmental_factors(
- surface_temp: NDArray[np.float32],
- topsoil_temp: NDArray[np.float32],
- water_potential: NDArray[np.float32],
- constants: LitterConsts,
-) -> dict[str, NDArray[np.float32]]:
- """Calculate the impact of the environment has on litter decay across litter layers.
-
- For the above ground layer the impact of temperature is calculated, and for the
- below ground layer the effect of temperature and soil water potential are
- considered.
-
- Args:
- surface_temp: Temperature of soil surface, which is assumed to be the same
- temperature as the above ground litter [C]
- topsoil_temp: Temperature of topsoil layer, which is assumed to be the same
- temperature as the below ground litter [C]
- water_potential: Water potential of the topsoil layer [kPa]
- constants: Set of constants for the litter model
-
- Returns:
- A dictionary containing three environmental factors, one for the effect of
- temperature on above ground litter decay, one for the effect of temperature on
- below ground litter decay, and one for the effect of soil water potential on
- below ground litter decay.
- """
- # Calculate temperature factor for the above ground litter layers
- temperature_factor_above = calculate_temperature_effect_on_litter_decomp(
- temperature=surface_temp,
- reference_temp=constants.litter_decomp_reference_temp,
- offset_temp=constants.litter_decomp_offset_temp,
- temp_response=constants.litter_decomp_temp_response,
- )
- # Calculate temperature factor for the below ground litter layers
- temperature_factor_below = calculate_temperature_effect_on_litter_decomp(
- temperature=topsoil_temp,
- reference_temp=constants.litter_decomp_reference_temp,
- offset_temp=constants.litter_decomp_offset_temp,
- temp_response=constants.litter_decomp_temp_response,
- )
- # Calculate the water factor (relevant for below ground layers)
- water_factor = calculate_moisture_effect_on_litter_decomp(
- water_potential=water_potential,
- water_potential_halt=constants.litter_decay_water_potential_halt,
- water_potential_opt=constants.litter_decay_water_potential_optimum,
- moisture_response_curvature=constants.moisture_response_curvature,
- )
-
- # Return all three factors in a single dictionary
- return {
- "temp_above": temperature_factor_above,
- "temp_below": temperature_factor_below,
- "water": water_factor,
- }
-
-
-def calculate_temperature_effect_on_litter_decomp(
- temperature: NDArray[np.float32],
- reference_temp: float,
- offset_temp: float,
- temp_response: float,
-) -> NDArray[np.float32]:
- """Calculate the effect that temperature has on litter decomposition rates.
-
- This function is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- temperature: The temperature of the litter layer [C]
- reference_temp: The reference temperature for changes in litter decomposition
- rates with temperature [C]
- offset_temp: Temperature offset [C]
- temp_response: Factor controlling response strength to changing temperature
- [unitless]
-
- Returns:
- A multiplicative factor capturing the impact of temperature on litter
- decomposition [unitless]
- """
-
- return np.exp(
- temp_response * (temperature - reference_temp) / (temperature + offset_temp)
- )
-
-
-def calculate_moisture_effect_on_litter_decomp(
- water_potential: NDArray[np.float32],
- water_potential_halt: float,
- water_potential_opt: float,
- moisture_response_curvature: float,
-) -> NDArray[np.float32]:
- """Calculate the effect that soil moisture has on litter decomposition rates.
-
- This function is only relevant for the below ground litter pools. Its functional
- form is taken from :cite:t:`moyano_responses_2013`.
-
- Args:
- water_potential: Soil water potential [kPa]
- water_potential_halt: Water potential at which all microbial activity stops
- [kPa]
- water_potential_opt: Optimal water potential for microbial activity [kPa]
- moisture_response_curvature: Parameter controlling the curvature of the moisture
- response function [unitless]
-
- Returns:
- A multiplicative factor capturing the impact of moisture on below ground litter
- decomposition [unitless]
- """
-
- # TODO - Need to make sure that this function is properly defined for a plausible
- # range of matric potentials.
-
- # Calculate how much moisture suppresses microbial activity
- supression = (
- (np.log10(-water_potential) - np.log10(-water_potential_opt))
- / (np.log10(-water_potential_halt) - np.log10(-water_potential_opt))
- ) ** moisture_response_curvature
-
- return 1 - supression
-
-
-def calculate_litter_chemistry_factor(
- lignin_proportion: NDArray[np.float32], lignin_inhibition_factor: float
-) -> NDArray[np.float32]:
- """Calculate the effect that litter chemistry has on litter decomposition rates.
-
- This expression is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- lignin_proportion: The proportion of the polymers in the litter pool that are
- lignin (or similar) [unitless]
- lignin_inhibition_factor: An exponential factor expressing the extent to which
- lignin inhibits the breakdown of litter [unitless]
-
- Returns:
- A factor that captures the impact of litter chemistry on litter decay rates
- """
-
- return np.exp(lignin_inhibition_factor * lignin_proportion)
-
-
-def calculate_litter_decay_metabolic_above(
- temperature_factor: NDArray[np.float32],
- litter_pool_above_metabolic: NDArray[np.float32],
- litter_decay_coefficient: float,
-) -> NDArray[np.float32]:
- """Calculate decay of above ground metabolic litter pool.
-
- This function is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- temperature_factor: A multiplicative factor capturing the impact of temperature
- on litter decomposition [unitless]
- litter_pool_above_metabolic: The size of the above ground metabolic litter pool
- [kg C m^-2]
- litter_decay_coefficient: The decay coefficient for the above ground metabolic
- litter pool [day^-1]
-
- Returns:
- Rate of decay of the above ground metabolic litter pool [kg C m^-2 day^-1]
- """
-
- return litter_decay_coefficient * temperature_factor * litter_pool_above_metabolic
-
-
-def calculate_litter_decay_structural_above(
- temperature_factor: NDArray[np.float32],
- litter_pool_above_structural: NDArray[np.float32],
- lignin_proportion: NDArray[np.float32],
- litter_decay_coefficient: float,
- lignin_inhibition_factor: float,
-) -> NDArray[np.float32]:
- """Calculate decay of above ground structural litter pool.
-
- This function is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- temperature_factor: A multiplicative factor capturing the impact of temperature
- on litter decomposition [unitless]
- litter_pool_above_structural: The size of the above ground structural litter
- pool [kg C m^-2]
- lignin_proportion: The proportion of the above ground structural pool which is
- lignin [unitless]
- litter_decay_coefficient: The decay coefficient for the above ground structural
- litter pool [day^-1]
- lignin_inhibition_factor: An exponential factor expressing the extent to which
- lignin inhibits the breakdown of litter [unitless]
-
- Returns:
- Rate of decay of the above ground structural litter pool [kg C m^-2 day^-1]
- """
-
- litter_chemistry_factor = calculate_litter_chemistry_factor(
- lignin_proportion, lignin_inhibition_factor=lignin_inhibition_factor
- )
-
- return (
- litter_decay_coefficient
- * temperature_factor
- * litter_pool_above_structural
- * litter_chemistry_factor
- )
-
-
-def calculate_litter_decay_woody(
- temperature_factor: NDArray[np.float32],
- litter_pool_woody: NDArray[np.float32],
- lignin_proportion: NDArray[np.float32],
- litter_decay_coefficient: float,
- lignin_inhibition_factor: float,
-) -> NDArray[np.float32]:
- """Calculate decay of the woody litter pool.
-
- This function is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- temperature_factor: A multiplicative factor capturing the impact of temperature
- on litter decomposition [unitless]
- litter_pool_woody: The size of the woody litter pool [kg C m^-2]
- lignin_proportion: The proportion of the woody litter pool which is lignin
- [unitless]
- litter_decay_coefficient: The decay coefficient for the woody litter pool
- [day^-1]
- lignin_inhibition_factor: An exponential factor expressing the extent to which
- lignin inhibits the breakdown of litter [unitless]
-
- Returns:
- Rate of decay of the woody litter pool [kg C m^-2 day^-1]
- """
-
- litter_chemistry_factor = calculate_litter_chemistry_factor(
- lignin_proportion, lignin_inhibition_factor=lignin_inhibition_factor
- )
-
- return (
- litter_decay_coefficient
- * temperature_factor
- * litter_pool_woody
- * litter_chemistry_factor
- )
-
-
-def calculate_litter_decay_metabolic_below(
- temperature_factor: NDArray[np.float32],
- moisture_factor: NDArray[np.float32],
- litter_pool_below_metabolic: NDArray[np.float32],
- litter_decay_coefficient: float,
-) -> NDArray[np.float32]:
- """Calculate decay of below ground metabolic litter pool.
-
- This function is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- temperature_factor: A multiplicative factor capturing the impact of temperature
- on litter decomposition [unitless]
- moisture_factor: A multiplicative factor capturing the impact of soil moisture
- on litter decomposition [unitless]
- litter_pool_below_metabolic: The size of the below ground metabolic litter pool
- [kg C m^-2]
- litter_decay_coefficient: The decay coefficient for the below ground metabolic
- litter pool [day^-1]
-
- Returns:
- Rate of decay of the below ground metabolic litter pool [kg C m^-2 day^-1]
- """
-
- return (
- litter_decay_coefficient
- * temperature_factor
- * moisture_factor
- * litter_pool_below_metabolic
- )
-
-
-def calculate_litter_decay_structural_below(
- temperature_factor: NDArray[np.float32],
- moisture_factor: NDArray[np.float32],
- litter_pool_below_structural: NDArray[np.float32],
- lignin_proportion: NDArray[np.float32],
- litter_decay_coefficient: float,
- lignin_inhibition_factor: float,
-) -> NDArray[np.float32]:
- """Calculate decay of below ground structural litter pool.
-
- This function is taken from :cite:t:`kirschbaum_modelling_2002`.
-
- Args:
- temperature_factor: A multiplicative factor capturing the impact of temperature
- on litter decomposition [unitless]
- moisture_factor: A multiplicative factor capturing the impact of soil moisture
- on litter decomposition [unitless]
- litter_pool_below_structural: The size of the below ground structural litter
- pool [kg C m^-2]
- lignin_proportion: The proportion of the below ground structural pool which is
- lignin [unitless]
- litter_decay_coefficient: The decay coefficient for the below ground structural
- litter pool [day^-1]
- lignin_inhibition_factor: An exponential factor expressing the extent to which
- lignin inhibits the breakdown of litter [unitless]
-
- Returns:
- Rate of decay of the below ground structural litter pool [kg C m^-2 day^-1]
- """
-
- litter_chemistry_factor = calculate_litter_chemistry_factor(
- lignin_proportion, lignin_inhibition_factor=lignin_inhibition_factor
- )
-
- return (
- litter_decay_coefficient
- * temperature_factor
- * moisture_factor
- * litter_chemistry_factor
- * litter_pool_below_structural
- )
-
-
-def calculate_carbon_mineralised(
- litter_decay_rate: NDArray[np.float32], carbon_use_efficiency: float
-) -> NDArray[np.float32]:
- """Calculate fraction of litter decay that gets mineralised.
-
- TODO - This function could also be used to track carbon respired, if/when we decide
- to track that.
-
- Args:
- litter_decay_rate: Rate at which litter pool is decaying [kg C m^-2 day^-1]
- carbon_use_efficiency: Carbon use efficiency of litter pool [unitless]
-
- Returns:
- Rate at which carbon is mineralised from the litter pool [kg C m^-2 day^-1]
- """
-
- return carbon_use_efficiency * litter_decay_rate
-
-
-def calculate_change_in_lignin(
- input_carbon: float | NDArray[np.float32],
- updated_pool_carbon: NDArray[np.float32],
- input_lignin: float | NDArray[np.float32],
- old_pool_lignin: NDArray[np.float32],
-) -> NDArray[np.float32]:
- """Calculate the change in the lignin concentration of a particular litter pool.
-
- This change is found by calculating the difference between the previous lignin
- concentration of the pool and the lignin concentration of the inputs. This
- difference is then multiplied by the ratio of the mass of carbon added to pool and
- the final (carbon) mass of the pool.
-
- Args:
- input_carbon: The total carbon mass of inputs to the litter pool [kg C m^-2]
- updated_pool_carbon: The total carbon mass of the litter pool after inputs and
- decay [kg C m^-2]
- input_lignin: The proportion of the input carbon that is lignin [unitless]
- old_pool_lignin: The proportion of the carbon mass of the original litter pool
- that was lignin [unitless]
-
- Returns:
- The total change in the lignin concentration of the pool over the full time step
- [unitless]
- """
-
- return (input_carbon / (updated_pool_carbon)) * (input_lignin - old_pool_lignin)
diff --git a/virtual_ecosystem/models/plants/canopy.py b/virtual_ecosystem/models/plants/canopy.py
index 0e829a236..f42f2bd15 100644
--- a/virtual_ecosystem/models/plants/canopy.py
+++ b/virtual_ecosystem/models/plants/canopy.py
@@ -3,13 +3,12 @@
NOTE - much of this will be outsourced to pyrealm.
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
import numpy as np
from numpy.typing import NDArray
-from xarray import DataArray
from virtual_ecosystem.core.core_components import LayerStructure
from virtual_ecosystem.core.data import Data
@@ -151,9 +150,9 @@ def build_canopy_arrays(
def initialise_canopy_layers(data: Data, layer_structure: LayerStructure) -> Data:
"""Initialise the canopy layer height and leaf area index data.
- This function initialises four data arrays describing the plant canopy structure and
- soil layer structure within a Data object: ``layer_heights``, ``leaf_area_index``,
- ``layer_fapar``, ``layer_leaf_mass`` and ``layer_absorbed_irradiation``.
+ This function initialises the following data arrays describing the plant canopy
+ structure and soil layer structure within a Data object: ``layer_heights``,
+ ``leaf_area_index``, ``layer_fapar``, ``layer_leaf_mass`` and ``canopy_absorption``.
Args:
data: A Data object to update.
@@ -175,7 +174,7 @@ def initialise_canopy_layers(data: Data, layer_structure: LayerStructure) -> Dat
"leaf_area_index",
"layer_fapar",
"layer_leaf_mass",
- "layer_absorbed_irradiation",
+ "canopy_absorption",
)
layers_found = set(layers_to_create).intersection(data.data.variables)
@@ -187,32 +186,18 @@ def initialise_canopy_layers(data: Data, layer_structure: LayerStructure) -> Dat
LOGGER.critical(msg)
raise InitialisationError(msg)
- # Define the layers
- layer_shape = (layer_structure.n_layers, data.grid.n_cells)
-
+ # Initialise a data array for each layer from the layer structure template
for each_layer_name in layers_to_create:
- # Set the layers
- data[each_layer_name] = DataArray(
- data=np.full(layer_shape, fill_value=np.nan),
- dims=("layers", "cell_id"),
- coords={
- "layers": np.arange(layer_structure.n_layers),
- "layer_roles": ("layers", layer_structure.layer_roles),
- "cell_id": data.grid.cell_id,
- },
- )
+ data[each_layer_name] = layer_structure.from_template()
# Initialise the fixed layer heights
- data["layer_heights"].loc[dict(layers=data["layer_roles"] == "soil")] = (
- np.row_stack(layer_structure.soil_layers)
+ # TODO: See issue #442 about centralising the layer_heights variable initialisation
+ data["layer_heights"].loc[dict(layers=layer_structure.index_all_soil)] = (
+ layer_structure.soil_layer_depths.reshape(-1, 1)
)
- data["layer_heights"].loc[dict(layers=data["layer_roles"] == "surface")] = (
+ data["layer_heights"].loc[dict(layers=layer_structure.index_surface)] = (
layer_structure.surface_layer_height
)
- data["layer_heights"].loc[dict(layers=data["layer_roles"] == "subcanopy")] = (
- layer_structure.subcanopy_layer_height
- )
-
return data
diff --git a/virtual_ecosystem/models/plants/community.py b/virtual_ecosystem/models/plants/community.py
index 0985eb718..f5448cc51 100644
--- a/virtual_ecosystem/models/plants/community.py
+++ b/virtual_ecosystem/models/plants/community.py
@@ -5,7 +5,7 @@
NOTE - much of this will be outsourced to pyrealm.
-""" # noqa: D205, D415
+""" # noqa: D205
from collections.abc import Mapping
from dataclasses import dataclass, field
diff --git a/virtual_ecosystem/models/plants/constants.py b/virtual_ecosystem/models/plants/constants.py
index 2afd1ead4..bdac8b27a 100644
--- a/virtual_ecosystem/models/plants/constants.py
+++ b/virtual_ecosystem/models/plants/constants.py
@@ -1,6 +1,6 @@
"""This submodule contains a set of dataclasses containing constants used
in the :mod:`~virtual_ecosystem.models.plants` module.
-""" # noqa: D205, D415
+""" # noqa: D205
from dataclasses import dataclass
diff --git a/virtual_ecosystem/models/plants/functional_types.py b/virtual_ecosystem/models/plants/functional_types.py
index 4a9cd2ff7..8837c6173 100644
--- a/virtual_ecosystem/models/plants/functional_types.py
+++ b/virtual_ecosystem/models/plants/functional_types.py
@@ -78,7 +78,7 @@ def from_config(cls, config: Config) -> Flora:
pft_dict[pft.pft_name] = pft
except Exception as excep:
LOGGER.critical(
- f"Error generating plant functional type: {str(excep)}"
+ f"Error generating plant functional type: {excep!s}"
)
raise
else:
diff --git a/virtual_ecosystem/models/plants/plants_model.py b/virtual_ecosystem/models/plants/plants_model.py
index 31e2067a1..d54f58485 100644
--- a/virtual_ecosystem/models/plants/plants_model.py
+++ b/virtual_ecosystem/models/plants/plants_model.py
@@ -1,14 +1,14 @@
"""The :mod:`~virtual_ecosystem.models.plants.plants_model` module creates
:class:`~virtual_ecosystem.models.plants.plants_model.PlantsModel` class as a child of
the :class:`~virtual_ecosystem.core.base_model.BaseModel` class.
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
from typing import Any
import numpy as np
-import xarray
+import xarray as xr
from virtual_ecosystem.core.base_model import BaseModel
from virtual_ecosystem.core.config import Config
@@ -29,20 +29,61 @@ class PlantsModel(
BaseModel,
model_name="plants",
model_update_bounds=("1 day", "1 year"),
- required_init_vars=(
- ("plant_cohorts_cell_id", tuple()),
- ("plant_cohorts_pft", tuple()),
- ("plant_cohorts_n", tuple()),
- ("plant_cohorts_dbh", tuple()),
- ("photosynthetic_photon_flux_density", ("spatial",)),
+ vars_required_for_init=(
+ "plant_cohorts_cell_id",
+ "plant_cohorts_pft",
+ "plant_cohorts_n",
+ "plant_cohorts_dbh",
+ "photosynthetic_photon_flux_density",
+ ),
+ vars_populated_by_init=(
+ "leaf_area_index", # NOTE - LAI is integrated into the full layer roles
+ "layer_heights", # NOTE - includes soil, canopy and above canopy heights
+ "layer_fapar",
+ "layer_leaf_mass", # NOTE - placeholder resource for herbivory
+ "canopy_absorption",
+ ),
+ vars_required_for_update=(
+ "plant_cohorts_cell_id",
+ "plant_cohorts_pft",
+ "plant_cohorts_n",
+ "plant_cohorts_dbh",
+ "photosynthetic_photon_flux_density",
),
vars_updated=(
"leaf_area_index", # NOTE - LAI is integrated into the full layer roles
"layer_heights", # NOTE - includes soil, canopy and above canopy heights
"layer_fapar",
"layer_leaf_mass", # NOTE - placeholder resource for herbivory
- "layer_absorbed_irradiation",
+ "canopy_absorption",
"evapotranspiration",
+ "deadwood_production",
+ "leaf_turnover",
+ "plant_reproductive_tissue_turnover",
+ "root_turnover",
+ "deadwood_lignin",
+ "leaf_turnover_lignin",
+ "plant_reproductive_tissue_turnover_lignin",
+ "root_turnover_lignin",
+ "deadwood_c_n_ratio",
+ "leaf_turnover_c_n_ratio",
+ "plant_reproductive_tissue_turnover_c_n_ratio",
+ "root_turnover_c_n_ratio",
+ ),
+ vars_populated_by_first_update=(
+ "evapotranspiration",
+ "deadwood_production",
+ "leaf_turnover",
+ "plant_reproductive_tissue_turnover",
+ "root_turnover",
+ "deadwood_lignin",
+ "leaf_turnover_lignin",
+ "plant_reproductive_tissue_turnover_lignin",
+ "root_turnover_lignin",
+ "deadwood_c_n_ratio",
+ "leaf_turnover_c_n_ratio",
+ "plant_reproductive_tissue_turnover_c_n_ratio",
+ "root_turnover_c_n_ratio",
),
):
"""A class defining the plants model.
@@ -119,16 +160,15 @@ def __init__(
)
"""A reference to the global data object."""
- self._canopy_layer_indices = np.arange(
- 1, self.layer_structure.canopy_layers + 1
- )
+ # This is widely used internally so store it as an attribute.
+ self._canopy_layer_indices = self.layer_structure.index_canopy
"""The indices of the canopy layers within wider vertical profile"""
# Run the canopy initialisation - update the canopy structure from the initial
# cohort data and then initialise the irradiance using the first observation for
# PPFD.
self.update_canopy_layers()
- self.set_absorbed_irradiance(time_index=0)
+ self.set_canopy_absorption(time_index=0)
@classmethod
def from_config(
@@ -161,7 +201,7 @@ def from_config(
)
except Exception as excep:
LOGGER.critical(
- f"Error creating plants model from configuration: {str(excep)}"
+ f"Error creating plants model from configuration: {excep!s}"
)
raise excep
@@ -186,16 +226,20 @@ def update(self, time_index: int, **kwargs: Any) -> None:
Args:
time_index: The index representing the current time step in the data object.
+ **kwargs: Further arguments to the update method.
"""
# Update the canopy layers
self.update_canopy_layers()
- self.set_absorbed_irradiance(time_index=time_index)
+ self.set_canopy_absorption(time_index=time_index)
# Estimate the GPP and growth with the updated this update
self.estimate_gpp(time_index=time_index)
self.allocate_gpp()
+ # Calculate the turnover of each plant biomass pool
+ self.calculate_turnover()
+
def cleanup(self) -> None:
"""Placeholder function for plants model cleanup."""
@@ -213,12 +257,12 @@ def update_canopy_layers(self) -> None:
* the whole canopy leaf mass within the layers (``layer_leaf_mass``), and
* the absorbed irradiance in each layer, including the remaining incident
- radation at ground level (``layer_absorbed_irradiation``).
+ radation at ground level (``canopy_absorption``).
"""
# Retrive the canopy model arrays and insert into the data object.
canopy_data = build_canopy_arrays(
self.communities,
- n_canopy_layers=self.layer_structure.canopy_layers,
+ n_canopy_layers=self.layer_structure.n_canopy_layers,
)
# Insert the canopy layers into the data objects
@@ -233,7 +277,7 @@ def update_canopy_layers(self) -> None:
+ self.layer_structure.above_canopy_height_offset
)
- def set_absorbed_irradiance(self, time_index: int) -> None:
+ def set_canopy_absorption(self, time_index: int) -> None:
"""Set the absorbed irradiance across the canopy.
This method takes the photosynthetic photon flux density at the top of the
@@ -258,9 +302,10 @@ def set_absorbed_irradiance(self, time_index: int) -> None:
# Store the absorbed irradiance in the data object and add the remaining
# irradiance at the surface layer level
- self.data["layer_absorbed_irradiation"][:] = absorbed_irradiance
+ # NOTE - this is only the _PPFD_ at ground level not the SWDown.
+ self.data["canopy_absorption"][:] = absorbed_irradiance
ground = np.where(self.data["layer_roles"].data == "surface")[0]
- self.data["layer_absorbed_irradiation"][ground] = ground_irradiance
+ self.data["canopy_absorption"][ground] = ground_irradiance
def estimate_gpp(self, time_index: int) -> None:
"""Estimate the gross primary productivity within plant cohorts.
@@ -316,26 +361,26 @@ def estimate_gpp(self, time_index: int) -> None:
# This will give an array of the light use efficiency per layer per cell,
# Get an array where populated canopy layers are one otherwise nan
- canopy_heights = self.data["layer_heights"].where(
- self.data["layers"].isin(self._canopy_layer_indices)
+ filled_canopy = xr.where(
+ (self.data["layer_heights"] * self._canopy_layer_indices[:, None]) > 0,
+ 1,
+ np.nan,
)
- is_canopy = xarray.ones_like(canopy_heights).where(canopy_heights > 0)
# Set a representative place holder LUE in gC mol-1 for now
- self.data["layer_light_use_efficiency"] = is_canopy * 0.3
+ self.data["layer_light_use_efficiency"] = filled_canopy * 0.3
# The LUE can then be scaled by the calculated absorbed irradiance, which is
# the product of the layer specific fapar and the downwelling PPFD. In practice,
# this will use something like:
#
# pmodel.estimate_productivity(
- # fapar=1, ppfd=self.data["layer_absorbed_irradiation"]
+ # fapar=1, ppfd=self.data["canopy_absorption"]
# )
# but for now:
self.data["layer_gpp_per_m2"] = (
- self.data["layer_light_use_efficiency"]
- * self.data["layer_absorbed_irradiation"]
+ self.data["layer_light_use_efficiency"] * self.data["canopy_absorption"]
)
# We then have the gross primary productivity in µg C m-2 s-1 within each
@@ -366,7 +411,7 @@ def estimate_gpp(self, time_index: int) -> None:
# Estimate evapotranspiration
# - currently just a placeholder for something more involved
- self.data["evapotranspiration"] = is_canopy * 20
+ self.data["evapotranspiration"] = filled_canopy * 20
def allocate_gpp(self) -> None:
"""Calculate the allocation of GPP to growth and respiration.
@@ -384,3 +429,39 @@ def allocate_gpp(self) -> None:
# arbitrarily use the ceiling of the gpp in kilos as a cm increase in
# dbh to provide an annual increment that relates to GPP.
cohort.dbh += np.ceil(cohort.gpp / (1e6 * 1e3)) / 1e2
+
+ def calculate_turnover(self) -> None:
+ """Calculate turnover of each plant biomass pool.
+
+ This function calculates the turnover rate for each plant biomass pool (wood,
+ leaves, roots, and reproductive tissues). As well as this the lignin
+ concentration and carbon nitrogen ratio of each turnover flow is calculated.
+
+ Warning:
+ At present, this function literally just returns constant values for each of
+ the variables it returns.
+ """
+
+ # All outputs are just constants at the moment
+ self.data["deadwood_production"] = xr.full_like(self.data["elevation"], 0.075)
+ self.data["leaf_turnover"] = xr.full_like(self.data["elevation"], 0.027)
+ self.data["plant_reproductive_tissue_turnover"] = xr.full_like(
+ self.data["elevation"], 0.003
+ )
+ self.data["root_turnover"] = xr.full_like(self.data["elevation"], 0.027)
+ self.data["deadwood_lignin"] = xr.full_like(self.data["elevation"], 0.545)
+ self.data["leaf_turnover_lignin"] = xr.full_like(self.data["elevation"], 0.05)
+ self.data["plant_reproductive_tissue_turnover_lignin"] = xr.full_like(
+ self.data["elevation"], 0.01
+ )
+ self.data["root_turnover_lignin"] = xr.full_like(self.data["elevation"], 0.2)
+ self.data["deadwood_c_n_ratio"] = xr.full_like(self.data["elevation"], 56.5)
+ self.data["leaf_turnover_c_n_ratio"] = xr.full_like(
+ self.data["elevation"], 25.5
+ )
+ self.data["plant_reproductive_tissue_turnover_c_n_ratio"] = xr.full_like(
+ self.data["elevation"], 12.5
+ )
+ self.data["root_turnover_c_n_ratio"] = xr.full_like(
+ self.data["elevation"], 45.6
+ )
diff --git a/virtual_ecosystem/models/soil/__init__.py b/virtual_ecosystem/models/soil/__init__.py
index ded2a09b5..5378cc8e5 100644
--- a/virtual_ecosystem/models/soil/__init__.py
+++ b/virtual_ecosystem/models/soil/__init__.py
@@ -12,6 +12,6 @@
the impact of environmental factors on microbial rates.
* The :mod:`~virtual_ecosystem.models.soil.constants` provides a set of dataclasses
containing the constants required by the broader soil model.
-""" # noqa: D205, D415
+""" # noqa: D205
from virtual_ecosystem.models.soil.soil_model import SoilModel # noqa: F401
diff --git a/virtual_ecosystem/models/soil/carbon.py b/virtual_ecosystem/models/soil/carbon.py
index 93ade420f..e95605680 100644
--- a/virtual_ecosystem/models/soil/carbon.py
+++ b/virtual_ecosystem/models/soil/carbon.py
@@ -2,7 +2,7 @@
Ecosystem. At the moment five pools are modelled, these are low molecular weight carbon
(LMWC), mineral associated organic matter (MAOM), microbial biomass, particulate organic
matter (POM), and POM degrading enzymes.
-""" # noqa: D205, D415
+""" # noqa: D205
from dataclasses import dataclass
@@ -12,6 +12,7 @@
from virtual_ecosystem.core.constants import CoreConsts
from virtual_ecosystem.models.soil.constants import SoilConsts
from virtual_ecosystem.models.soil.env_factors import (
+ EnvironmentalEffectFactors,
calculate_environmental_effect_factors,
calculate_leaching_rate,
calculate_temperature_effect_on_microbes,
@@ -19,29 +20,58 @@
@dataclass
-class MicrobialBiomassLoss:
- """A data class to store the various biomass losses from microbial biomass."""
+class MicrobialChanges:
+ """Changes due to microbial uptake, biomass production and losses."""
- maintenance_synthesis: NDArray[np.float32]
- """Rate at which biomass must be synthesised to balance losses [kg C m^-3 day^-1].
+ lmwc_uptake: NDArray[np.float32]
+ """Total rate of microbial uptake of low molecular weight carbon.
+
+ Units of [kg C m^-3 day^-1]."""
+
+ microbe_change: NDArray[np.float32]
+ """Rate of change of microbial biomass pool [kg C m^-3 day^-1]."""
+
+ pom_enzyme_change: NDArray[np.float32]
+ """Rate of change of particulate organic matter degrading enzyme pool.
+
+ Units of [kg C m^-3 day^-1].
+ """
+
+ maom_enzyme_change: NDArray[np.float32]
+ """Rate of change of mineral associated organic matter degrading enzyme pool.
+
+ Units of [kg C m^-3 day^-1].
"""
- pom_enzyme_production: NDArray[np.float32]
- """Rate at which POM degrading enzymes are produced [kg C m^-3 day^-1]."""
- maom_enzyme_production: NDArray[np.float32]
- """Rate at which MAOM degrading enzymes are produced [kg C m^-3 day^-1]."""
- necromass_decay_to_lmwc: NDArray[np.float32]
- """Rate at which biomass is lost to the LMWC pool [kg C m^-3 day^-1]."""
- necromass_decay_to_pom: NDArray[np.float32]
- """Rate at which biomass is lost to the POM pool [kg C m^-3 day^-1]."""
-
-
-# TODO - This function should probably be shortened, leaving as is for the moment as a
-# sensible split will probably be more obvious once more is added to this function.
+
+ necromass_generation: NDArray[np.float32]
+ """Rate at which necromass is being produced [kg C m^-3 day^-1]."""
+
+
+@dataclass
+class EnzymeMediatedRates:
+ """Rates of each enzyme mediated transfer between pools."""
+
+ pom_to_lmwc: NDArray[np.float32]
+ """Rate of particulate organic matter decomposition to low molecular weight carbon.
+
+ Units of [kg C m^-3 day^-1].
+ """
+
+ maom_to_lmwc: NDArray[np.float32]
+ """Rate of mineral associated organic matter decomposition to LMWC.
+
+ Units of [kg C m^-3 day^-1].
+ """
+
+
+# TODO - This function should probably be shortened. I've done some work on this
+# already, but I need to keep an eye on it as new pools are added.
def calculate_soil_carbon_updates(
soil_c_pool_lmwc: NDArray[np.float32],
soil_c_pool_maom: NDArray[np.float32],
soil_c_pool_microbe: NDArray[np.float32],
soil_c_pool_pom: NDArray[np.float32],
+ soil_c_pool_necromass: NDArray[np.float32],
soil_enzyme_pom: NDArray[np.float32],
soil_enzyme_maom: NDArray[np.float32],
pH: NDArray[np.float32],
@@ -67,14 +97,16 @@ def calculate_soil_carbon_updates(
soil_c_pool_maom: Mineral associated organic matter pool [kg C m^-3]
soil_c_pool_microbe: Microbial biomass (carbon) pool [kg C m^-3]
soil_c_pool_pom: Particulate organic matter pool [kg C m^-3]
+ soil_c_pool_necromass: Microbial necromass pool [kg C m^-3]
soil_enzyme_pom: Amount of enzyme class which breaks down particulate organic
matter [kg C m^-3]
soil_enzyme_maom: Amount of enzyme class which breaks down mineral associated
organic matter [kg C m^-3]
pH: pH values for each soil grid cell [unitless]
bulk_density: bulk density values for each soil grid cell [kg m^-3]
- soil_moisture: relative water content for each soil grid cell [unitless]
+ soil_moisture: amount of water contained by each soil layer [mm]
soil_water_potential: Soil water potential for each grid cell [kPa]
+ vertical_flow_rate: The vertical flow rate [TODO]
soil_temp: soil temperature for each soil grid cell [degrees C]
clay_fraction: The clay fraction for each soil grid cell [unitless]
mineralisation_rate: Amount of litter mineralised into POM pool [kg C m^-3
@@ -95,154 +127,256 @@ def calculate_soil_carbon_updates(
clay_fraction=clay_fraction,
constants=model_constants,
)
-
- microbial_uptake, microbial_assimilation = calculate_microbial_carbon_uptake(
+ # find changes related to microbial uptake, growth and decay
+ microbial_changes = calculate_microbial_changes(
soil_c_pool_lmwc=soil_c_pool_lmwc,
soil_c_pool_microbe=soil_c_pool_microbe,
- water_factor=env_factors.water,
- pH_factor=env_factors.pH,
+ soil_enzyme_pom=soil_enzyme_pom,
+ soil_enzyme_maom=soil_enzyme_maom,
soil_temp=soil_temp,
+ env_factors=env_factors,
constants=model_constants,
)
- biomass_losses = determine_microbial_biomass_losses(
- soil_c_pool_microbe=soil_c_pool_microbe,
+ # find changes driven by the enzyme pools
+ enzyme_mediated = calculate_enzyme_mediated_rates(
+ soil_enzyme_pom=soil_enzyme_pom,
+ soil_enzyme_maom=soil_enzyme_maom,
+ soil_c_pool_pom=soil_c_pool_pom,
+ soil_c_pool_maom=soil_c_pool_maom,
soil_temp=soil_temp,
- clay_factor_decay=env_factors.clay_decay,
+ env_factors=env_factors,
constants=model_constants,
)
- pom_enzyme_turnover = calculate_enzyme_turnover(
- enzyme_pool=soil_enzyme_pom,
- turnover_rate=model_constants.pom_enzyme_turnover_rate,
- )
- maom_enzyme_turnover = calculate_enzyme_turnover(
- enzyme_pool=soil_enzyme_maom,
- turnover_rate=model_constants.maom_enzyme_turnover_rate,
- )
+
labile_carbon_leaching = calculate_leaching_rate(
solute_density=soil_c_pool_lmwc,
vertical_flow_rate=vertical_flow_rate,
soil_moisture=soil_moisture,
solubility_coefficient=model_constants.solubility_coefficient_lmwc,
- soil_layer_thickness=core_constants.depth_of_active_soil_layer,
)
- pom_decomposition_rate = calculate_enzyme_mediated_decomposition(
- soil_c_pool=soil_c_pool_pom,
- soil_enzyme=soil_enzyme_pom,
- water_factor=env_factors.water,
- pH_factor=env_factors.pH,
- clay_factor_saturation=env_factors.clay_saturation,
- soil_temp=soil_temp,
- reference_temp=model_constants.arrhenius_reference_temp,
- max_decomp_rate=model_constants.max_decomp_rate_pom,
- activation_energy_rate=model_constants.activation_energy_pom_decomp_rate,
- half_saturation=model_constants.half_sat_pom_decomposition,
- activation_energy_sat=model_constants.activation_energy_pom_decomp_saturation,
+
+ # Calculate transfers between the lmwc, necromass and maom pools
+ maom_desorption_to_lmwc = calculate_maom_desorption(
+ soil_c_pool_maom=soil_c_pool_maom,
+ desorption_rate_constant=model_constants.maom_desorption_rate,
)
- # Calculate how pom decomposition is split between lmwc and maom pools
- pom_decomposition_to_lmwc = (
- pom_decomposition_rate * model_constants.pom_decomposition_fraction_lmwc
+ necromass_decay_to_lmwc = calculate_necromass_breakdown(
+ soil_c_pool_necromass=soil_c_pool_necromass,
+ necromass_decay_rate=model_constants.necromass_decay_rate,
)
- pom_decomposition_to_maom = pom_decomposition_rate * (
- 1 - model_constants.pom_decomposition_fraction_lmwc
+ necromass_sorption_to_maom = calculate_sorption_to_maom(
+ soil_c_pool=soil_c_pool_necromass,
+ sorption_rate_constant=model_constants.necromass_sorption_rate,
)
- maom_decomposition_to_lmwc = calculate_enzyme_mediated_decomposition(
- soil_c_pool=soil_c_pool_maom,
- soil_enzyme=soil_enzyme_maom,
- water_factor=env_factors.water,
- pH_factor=env_factors.pH,
- clay_factor_saturation=env_factors.clay_saturation,
- soil_temp=soil_temp,
- reference_temp=model_constants.arrhenius_reference_temp,
- max_decomp_rate=model_constants.max_decomp_rate_maom,
- activation_energy_rate=model_constants.activation_energy_maom_decomp_rate,
- half_saturation=model_constants.half_sat_maom_decomposition,
- activation_energy_sat=model_constants.activation_energy_maom_decomp_saturation,
+ lmwc_sorption_to_maom = calculate_sorption_to_maom(
+ soil_c_pool=soil_c_pool_lmwc,
+ sorption_rate_constant=model_constants.lmwc_sorption_rate,
)
# Determine net changes to the pools
delta_pools_ordered["soil_c_pool_lmwc"] = (
- pom_decomposition_to_lmwc
- + biomass_losses.necromass_decay_to_lmwc
- + pom_enzyme_turnover
- + maom_decomposition_to_lmwc
- - microbial_uptake
+ enzyme_mediated.pom_to_lmwc
+ + enzyme_mediated.maom_to_lmwc
+ + maom_desorption_to_lmwc
+ + necromass_decay_to_lmwc
+ - microbial_changes.lmwc_uptake
+ - lmwc_sorption_to_maom
- labile_carbon_leaching
)
delta_pools_ordered["soil_c_pool_maom"] = (
- pom_decomposition_to_maom - maom_decomposition_to_lmwc
- )
- delta_pools_ordered["soil_c_pool_microbe"] = (
- microbial_assimilation - biomass_losses.maintenance_synthesis
+ necromass_sorption_to_maom
+ + lmwc_sorption_to_maom
+ - enzyme_mediated.maom_to_lmwc
+ - maom_desorption_to_lmwc
)
+ delta_pools_ordered["soil_c_pool_microbe"] = microbial_changes.microbe_change
delta_pools_ordered["soil_c_pool_pom"] = (
- mineralisation_rate
- + biomass_losses.necromass_decay_to_pom
- - pom_decomposition_rate
- )
- delta_pools_ordered["soil_enzyme_pom"] = (
- biomass_losses.pom_enzyme_production - pom_enzyme_turnover
+ mineralisation_rate - enzyme_mediated.pom_to_lmwc
)
- delta_pools_ordered["soil_enzyme_maom"] = (
- biomass_losses.maom_enzyme_production - maom_enzyme_turnover
+ delta_pools_ordered["soil_c_pool_necromass"] = (
+ microbial_changes.necromass_generation
+ - necromass_decay_to_lmwc
+ - necromass_sorption_to_maom
)
+ delta_pools_ordered["soil_enzyme_pom"] = microbial_changes.pom_enzyme_change
+ delta_pools_ordered["soil_enzyme_maom"] = microbial_changes.maom_enzyme_change
# Create output array of pools in desired order
return np.concatenate(list(delta_pools_ordered.values()))
-def determine_microbial_biomass_losses(
+def calculate_microbial_changes(
+ soil_c_pool_lmwc: NDArray[np.float32],
soil_c_pool_microbe: NDArray[np.float32],
+ soil_enzyme_pom: NDArray[np.float32],
+ soil_enzyme_maom: NDArray[np.float32],
soil_temp: NDArray[np.float32],
- clay_factor_decay: NDArray[np.float32],
+ env_factors: EnvironmentalEffectFactors,
constants: SoilConsts,
-) -> MicrobialBiomassLoss:
- """Calculate all of the losses from the microbial biomass pool.
+):
+ """Calculate the changes for the microbial biomass and enzyme pools.
- Microbes need to synthesis new biomass at a certain rate just to maintain their
- current biomass. This function calculates this overall rate and the various losses
- that contribute to this rate. The main sources of this loss are the external
- excretion of enzymes, cell death, and protein degradation.
+ This function calculates the uptake of low molecular weight carbon by the microbial
+ biomass pool and uses this to calculate the net change in the pool. The net change
+ in each enzyme pool is found, and finally the total rate at which necromass is
+ created is found.
Args:
+ soil_c_pool_lmwc: Low molecular weight carbon pool [kg C m^-3]
soil_c_pool_microbe: Microbial biomass (carbon) pool [kg C m^-3]
+ soil_enzyme_pom: Amount of enzyme class which breaks down particulate organic
+ matter [kg C m^-3]
+ soil_enzyme_maom: Amount of enzyme class which breaks down mineral associated
+ organic matter [kg C m^-3]
soil_temp: soil temperature for each soil grid cell [degrees C]
- clay_factor_decay: A factor capturing the impact of soil clay fraction on
- necromass decay destination [unitless]
+ env_factors: Data class containing the various factors through which the
+ environment effects soil cycling rates.
constants: Set of constants for the soil model.
Returns:
- A dataclass containing all the losses from the microbial biomass pool.
+ A dataclass containing the rate at which microbes uptake LMWC, the rate of
+ change in the microbial biomass pool and the enzyme pools.
"""
- # Calculate the rate of maintenance synthesis
- maintenance_synthesis = calculate_maintenance_biomass_synthesis(
+ # Calculate uptake, growth rate, and loss rate
+ microbial_uptake, biomass_growth = calculate_microbial_carbon_uptake(
+ soil_c_pool_lmwc=soil_c_pool_lmwc,
soil_c_pool_microbe=soil_c_pool_microbe,
+ water_factor=env_factors.water,
+ pH_factor=env_factors.pH,
soil_temp=soil_temp,
constants=constants,
)
+ biomass_loss = calculate_maintenance_biomass_synthesis(
+ soil_c_pool_microbe=soil_c_pool_microbe,
+ soil_temp=soil_temp,
+ constants=constants,
+ )
+ # Find changes in each enzyme pool
+ pom_enzyme_net_change, maom_enzyme_net_change, enzyme_denaturation = (
+ calculate_enzyme_changes(
+ soil_enzyme_pom=soil_enzyme_pom,
+ soil_enzyme_maom=soil_enzyme_maom,
+ biomass_loss=biomass_loss,
+ constants=constants,
+ )
+ )
- # Calculation the production of each enzyme class
- pom_enzyme_production = constants.maintenance_pom_enzyme * maintenance_synthesis
- maom_enzyme_production = constants.maintenance_maom_enzyme * maintenance_synthesis
-
- # Remaining maintenance synthesis is used to replace degraded proteins and cells
- replacement_synthesis = (
+ # Find fraction of loss that isn't enzyme production
+ true_loss = (
1 - constants.maintenance_pom_enzyme - constants.maintenance_maom_enzyme
- ) * maintenance_synthesis
+ ) * biomass_loss
+
+ return MicrobialChanges(
+ lmwc_uptake=microbial_uptake,
+ microbe_change=biomass_growth - biomass_loss,
+ pom_enzyme_change=pom_enzyme_net_change,
+ maom_enzyme_change=maom_enzyme_net_change,
+ necromass_generation=enzyme_denaturation + true_loss,
+ )
+
+
+def calculate_enzyme_mediated_rates(
+ soil_enzyme_pom: NDArray[np.float32],
+ soil_enzyme_maom: NDArray[np.float32],
+ soil_c_pool_pom: NDArray[np.float32],
+ soil_c_pool_maom: NDArray[np.float32],
+ soil_temp: NDArray[np.float32],
+ env_factors: EnvironmentalEffectFactors,
+ constants: SoilConsts,
+) -> EnzymeMediatedRates:
+ """Calculate the rates of each enzyme mediated reaction.
+
+ Args:
+ soil_enzyme_pom: Amount of enzyme class which breaks down particulate organic
+ matter [kg C m^-3]
+ soil_enzyme_maom: Amount of enzyme class which breaks down mineral associated
+ organic matter [kg C m^-3]
+ soil_c_pool_pom: Particulate organic matter pool [kg C m^-3]
+ soil_c_pool_maom: Mineral associated organic matter pool [kg C m^-3]
+ soil_temp: soil temperature for each soil grid cell [degrees C]
+ env_factors: Data class containing the various factors through which the
+ environment effects soil cycling rates.
+ constants: Set of constants for the soil model.
+
+ Returns:
+ A dataclass containing the enzyme mediated decomposition rates of both the
+ particulate organic matter (POM) and mineral associated organic matter (MAOM)
+ pool.
+ """
+
+ pom_decomposition_to_lmwc = calculate_enzyme_mediated_decomposition(
+ soil_c_pool=soil_c_pool_pom,
+ soil_enzyme=soil_enzyme_pom,
+ soil_temp=soil_temp,
+ env_factors=env_factors,
+ reference_temp=constants.arrhenius_reference_temp,
+ max_decomp_rate=constants.max_decomp_rate_pom,
+ activation_energy_rate=constants.activation_energy_pom_decomp_rate,
+ half_saturation=constants.half_sat_pom_decomposition,
+ activation_energy_sat=constants.activation_energy_pom_decomp_saturation,
+ )
+ maom_decomposition_to_lmwc = calculate_enzyme_mediated_decomposition(
+ soil_c_pool=soil_c_pool_maom,
+ soil_enzyme=soil_enzyme_maom,
+ soil_temp=soil_temp,
+ env_factors=env_factors,
+ reference_temp=constants.arrhenius_reference_temp,
+ max_decomp_rate=constants.max_decomp_rate_maom,
+ activation_energy_rate=constants.activation_energy_maom_decomp_rate,
+ half_saturation=constants.half_sat_maom_decomposition,
+ activation_energy_sat=constants.activation_energy_maom_decomp_saturation,
+ )
+
+ return EnzymeMediatedRates(
+ pom_to_lmwc=pom_decomposition_to_lmwc, maom_to_lmwc=maom_decomposition_to_lmwc
+ )
+
+
+def calculate_enzyme_changes(
+ soil_enzyme_pom: NDArray[np.float32],
+ soil_enzyme_maom: NDArray[np.float32],
+ biomass_loss: NDArray[np.float32],
+ constants: SoilConsts,
+) -> tuple[NDArray[np.float32], NDArray[np.float32], NDArray[np.float32]]:
+ """Calculate the changes to the concentration of each enzyme pool.
+
+ Enzyme production rates are assumed to scale linearly with the total biomass loss
+ rate of the microbes. These are combined with turnover rates to find the net change
+ in each enzyme pool. The total enzyme denaturation rate is also calculated.
+
+ Args:
+ soil_enzyme_pom: Amount of enzyme class which breaks down particulate organic
+ matter [kg C m^-3]
+ soil_enzyme_maom: Amount of enzyme class which breaks down mineral associated
+ organic matter [kg C m^-3]
+ biomass_loss: Rate a which the microbial biomass pool loses biomass, this is a
+ combination of enzyme excretion, protein degradation, and cell death [kg C
+ m^-3 day^-1]
+ constants: Set of constants for the soil model.
- # TODO - This split will change when a necromass pool is introduced
- # Calculate fraction of necromass that decays to LMWC
- necromass_proportion_to_lmwc = constants.necromass_to_lmwc * clay_factor_decay
- # These proteins and cells that are replaced decay into either the POM or LMWC pool
- necromass_to_lmwc = necromass_proportion_to_lmwc * replacement_synthesis
- necromass_to_pom = (1 - necromass_proportion_to_lmwc) * replacement_synthesis
+ Returns:
+ A tuple containing the net rate of change in the POM enzyme pool, the net rate
+ of change in the MAOM enzyme pool, and the total enzyme denaturation rate.
+ """
+
+ # Calculate production an turnover of each enzyme class
+ pom_enzyme_production = constants.maintenance_pom_enzyme * biomass_loss
+ maom_enzyme_production = constants.maintenance_maom_enzyme * biomass_loss
+ pom_enzyme_turnover = calculate_enzyme_turnover(
+ enzyme_pool=soil_enzyme_pom,
+ turnover_rate=constants.pom_enzyme_turnover_rate,
+ )
+ maom_enzyme_turnover = calculate_enzyme_turnover(
+ enzyme_pool=soil_enzyme_maom,
+ turnover_rate=constants.maom_enzyme_turnover_rate,
+ )
- return MicrobialBiomassLoss(
- maintenance_synthesis=maintenance_synthesis,
- pom_enzyme_production=pom_enzyme_production,
- maom_enzyme_production=maom_enzyme_production,
- necromass_decay_to_lmwc=necromass_to_lmwc,
- necromass_decay_to_pom=necromass_to_pom,
+ # return net changes in the two enzyme pools and the necromass
+ return (
+ pom_enzyme_production - pom_enzyme_turnover,
+ maom_enzyme_production - maom_enzyme_turnover,
+ pom_enzyme_turnover + maom_enzyme_turnover,
)
@@ -391,10 +525,8 @@ def calculate_microbial_carbon_uptake(
def calculate_enzyme_mediated_decomposition(
soil_c_pool: NDArray[np.float32],
soil_enzyme: NDArray[np.float32],
- water_factor: NDArray[np.float32],
- pH_factor: NDArray[np.float32],
- clay_factor_saturation: NDArray[np.float32],
soil_temp: NDArray[np.float32],
+ env_factors: EnvironmentalEffectFactors,
reference_temp: float,
max_decomp_rate: float,
activation_energy_rate: float,
@@ -411,13 +543,9 @@ def calculate_enzyme_mediated_decomposition(
soil_c_pool: Size of organic matter pool [kg C m^-3]
soil_enzyme: Amount of enzyme class which breaks down the organic matter pool in
question [kg C m^-3]
- water_factor: A factor capturing the impact of soil water potential on microbial
- rates [unitless]
- pH_factor: A factor capturing the impact of soil pH on microbial rates
- [unitless]
- clay_factor_saturation: A factor capturing the impact of soil clay fraction on
- enzyme saturation constants [unitless]
soil_temp: soil temperature for each soil grid cell [degrees C]
+ env_factors: Data class containing the various factors through which the
+ environment effects soil cycling rates.
reference_temp: The reference temperature that enzyme rates were determined
relative to [degrees C]
max_decomp_rate: The maximum rate of substrate decomposition (at the reference
@@ -446,11 +574,80 @@ def calculate_enzyme_mediated_decomposition(
)
# Calculate the adjusted rate and saturation constants
- rate_constant = max_decomp_rate * temp_factor_rate * water_factor * pH_factor
+ rate_constant = (
+ max_decomp_rate * temp_factor_rate * env_factors.water * env_factors.pH
+ )
saturation_constant = (
- half_saturation * temp_factor_saturation * clay_factor_saturation
+ half_saturation * temp_factor_saturation * env_factors.clay_saturation
)
return (
rate_constant * soil_enzyme * soil_c_pool / (saturation_constant + soil_c_pool)
)
+
+
+def calculate_maom_desorption(
+ soil_c_pool_maom: NDArray[np.float32], desorption_rate_constant: float
+):
+ """Calculate the rate of mineral associated organic matter (MAOM) desorption.
+
+ This function is independent of soil temperature, moisture, pH, clay fraction and
+ bulk density. All of these things are known to effect real world desorption rates.
+ However, to simplify the parameterisation we only include these effects on microbial
+ rates. This may be something we want to alter in future.
+
+ Args:
+ soil_c_pool_maom: Size of the mineral associated organic matter pool [kg C m^-3]
+ desorption_rate_constant: Rate constant for MAOM desorption [day^-1]
+
+ Returns:
+ The rate of MAOM desorption to LMWC [kg C m^-3 day^-1]
+ """
+
+ return desorption_rate_constant * soil_c_pool_maom
+
+
+def calculate_sorption_to_maom(
+ soil_c_pool: NDArray[np.float32], sorption_rate_constant: float
+):
+ """Calculate that a carbon pool sorbs to become mineral associated organic matter.
+
+ Carbon from both the low molecular weight carbon pool and the necromass pool can
+ sorb to minerals to form MAOM, so this function can be used for either pool.
+
+ This function is independent of soil temperature, moisture, pH, clay fraction and
+ bulk density. All of these things are known to effect real world desorption rates.
+ However, to simplify the parameterisation we only include these effects on microbial
+ rates. This may be something we want to alter in future.
+
+ Args:
+ soil_c_pool: Size of carbon pool [kg C m^-3]
+ sorption_rate_constant: Rate constant for sorption to MAOM [day^-1]
+
+ Returns:
+ The rate of sorption to MAOM [kg C m^-3 day^-1]
+ """
+
+ return sorption_rate_constant * soil_c_pool
+
+
+def calculate_necromass_breakdown(
+ soil_c_pool_necromass: NDArray[np.float32], necromass_decay_rate: float
+) -> NDArray[np.float32]:
+ """Calculate breakdown rate of necromass into low molecular weight carbon (LMWC).
+
+ This function calculate necromass breakdown to LMWC as a simple exponential decay.
+ This decay is not effected by temperature or any other environmental factor. The
+ idea is to keep this function as simple as possible, because it will be hard to
+ parametrise even without additional complications. However, this is a simplification
+ to bear in mind when planning future model improvements.
+
+ Args:
+ soil_c_pool_necromass: Size of the microbial necromass pool [kg C m^-3]
+ necromass_decay_rate: Rate at which necromass decays into LMWC [day^-1]
+
+ Returns:
+ The amount of necromass that breakdown to LMWC [kg C m^-3 day^-1]
+ """
+
+ return necromass_decay_rate * soil_c_pool_necromass
diff --git a/virtual_ecosystem/models/soil/constants.py b/virtual_ecosystem/models/soil/constants.py
index 4f505e817..94596453d 100644
--- a/virtual_ecosystem/models/soil/constants.py
+++ b/virtual_ecosystem/models/soil/constants.py
@@ -5,6 +5,8 @@
from dataclasses import dataclass
+import numpy as np
+
from virtual_ecosystem.core.constants_class import ConstantsDataclass
# TODO - Once lignin is tracked a large number of constants will have to be duplicated
@@ -200,12 +202,6 @@ class SoilConsts(ConstantsDataclass):
[unitless]. Value taken from :cite:t:`wang_development_2013`.
"""
- necromass_to_lmwc: float = 0.25
- """Proportion of necromass that flows to LMWC rather than POM [unitless].
-
- Value taken from :cite:t:`wang_development_2013`.
- """
-
# TODO - The 4 constants below should take different values for fungi and bacteria,
# once that separation is implemented.
min_pH_microbes: float = 2.5
@@ -253,23 +249,42 @@ class SoilConsts(ConstantsDataclass):
The value of this constant is taken from :cite:t:`fatichi_mechanistic_2019`.
"""
- clay_necromass_decay_exponent: float = -0.8
- """Change in proportion of necromass which decays with increasing soil clay content.
+ solubility_coefficient_lmwc: float = 0.05
+ """Solubility coefficient for low molecular weight organic carbon [unitless].
- [unitless]. The function this is used in is an exponential, and the sign should be
- negative so increases in clay leads to a lower proportion of necromass decaying to
- LMWC. The value of this constant is taken from :cite:t:`fatichi_mechanistic_2019`.
+ Value taken from :cite:t:`fatichi_mechanistic_2019`, where it is estimated in quite
+ a loose manner.
"""
- pom_decomposition_fraction_lmwc: float = 0.5
- """Fraction of decomposed POM that becomes LMWC rather than MAOM [unitless].
+ necromass_decay_rate: float = (1 / 3) * np.log(2)
+ """Rate at which microbial necromass decays to low molecular weight carbon [day^-1]
- Value taken from :cite:t:`wang_development_2013`.
+ I have not been able to track down any data on this, so for now choosing a rate that
+ corresponds to halving every three days. This parameter is a key target for tracking
+ down data for and for sensitivity analysis.
"""
- solubility_coefficient_lmwc: float = 0.05
- """Solubility coefficient for low molecular weight organic carbon [unitless].
+ maom_desorption_rate: float = 1e-5
+ """Rate constant for mineral associated organic matter desorption [day^-1]
+
+ The default value of this rate is not based on data. It was instead chosen to be
+ small relative to the rate at which microbes breakdown LMWC. This is another key
+ target for sensitivity analysis.
+ """
- Value taken from :cite:t:`fatichi_mechanistic_2019`, where it is estimated in quite
- a loose manner.
+ lmwc_sorption_rate: float = 1e-3
+ """Rate constant for low molecular weight carbon sorption to minerals [day^-1]
+
+ The default value of this rate is not based on data. It was instead chosen so that
+ the ratio of LWMC to mineral associated organic matter would tend to 1/100, in the
+ absence of microbes. This is another key target for sensitivity analysis.
+ """
+
+ necromass_sorption_rate: float = 1.0 * np.log(2)
+ """Rate constant for necromass sorption to minerals [day^-1]
+
+ The default value was chosen to be three times the value of
+ :attr:`necromass_decay_rate`, this means that 75% of necromass becomes MAOM with the
+ remainder becoming LMWC. Replacing this with a function that depends on
+ environmental conditions is a post release goal.
"""
diff --git a/virtual_ecosystem/models/soil/env_factors.py b/virtual_ecosystem/models/soil/env_factors.py
index fdb6a8816..18f3e6623 100644
--- a/virtual_ecosystem/models/soil/env_factors.py
+++ b/virtual_ecosystem/models/soil/env_factors.py
@@ -1,7 +1,7 @@
"""The ``models.soil.env_factors`` module contains functions that are used to
capture the impact that environmental factors have on microbial rates. These include
temperature, soil water potential, pH and soil texture.
-""" # noqa: D205, D415
+""" # noqa: D205
from dataclasses import dataclass
@@ -23,8 +23,6 @@ class EnvironmentalEffectFactors:
"""Impact of soil pH on enzymatic rates [unitless]."""
clay_saturation: NDArray[np.float32]
"""Impact of soil clay fraction on enzyme saturation constants [unitless]."""
- clay_decay: NDArray[np.float32]
- """Impact of soil clay fraction on necromass decay destination [unitless]."""
def calculate_environmental_effect_factors(
@@ -71,17 +69,12 @@ def calculate_environmental_effect_factors(
base_protection=constants.base_soil_protection,
protection_with_clay=constants.soil_protection_with_clay,
)
- clay_factor_decay = calculate_clay_impact_on_necromass_decay(
- clay_fraction=clay_fraction,
- decay_exponent=constants.clay_necromass_decay_exponent,
- )
# Combine all factors into a single EnvironmentalFactors object
return EnvironmentalEffectFactors(
water=water_factor,
pH=pH_factor,
clay_saturation=clay_factor_saturation,
- clay_decay=clay_factor_decay,
)
@@ -101,7 +94,7 @@ def calculate_temperature_effect_on_microbes(
Args:
soil_temperature: The temperature of the soil [C]
activation_energy: Energy of activation [J mol^-1]
- soil_temperature: The reference temperature of the Arrhenius equation [C]
+ reference_temperature: The reference temperature of the Arrhenius equation [C]
Returns:
A multiplicative factor capturing the effect of temperature on microbial rates
@@ -248,32 +241,11 @@ def calculate_clay_impact_on_enzyme_saturation(
return base_protection + protection_with_clay * clay_fraction
-def calculate_clay_impact_on_necromass_decay(
- clay_fraction: NDArray[np.float32], decay_exponent: float
-) -> NDArray[np.float32]:
- """Calculate the impact that soil clay has on necromass decay to LMWC.
-
- Necromass which doesn't breakdown fully gets added to the POM pool instead.
-
- Args:
- clay_fraction: The fraction of the soil which is clay [unitless]
- sorption_exponent: Controls the impact that differences in soil clay content
- have on the proportion of necromass that decays to LMWC [unitless]
-
- Returns:
- A multiplicative factor capturing the impact that soil clay has on the
- proportion of necromass decay which sorbs to form POM [unitless]
- """
-
- return np.exp(decay_exponent * clay_fraction)
-
-
def calculate_leaching_rate(
solute_density: NDArray[np.float32],
vertical_flow_rate: NDArray[np.float32],
soil_moisture: NDArray[np.float32],
solubility_coefficient: float,
- soil_layer_thickness: float,
) -> NDArray[np.float32]:
"""Calculate leaching rate for a given solute based on flow rate.
@@ -281,26 +253,17 @@ def calculate_leaching_rate(
of solute that is expected to be found in dissolved form is calculated by
multiplying the solute density by its solubility coefficient. This is then
multiplied by the frequency with which the water column is completely replaced, i.e.
- the ratio of vertical flow rate to water column height.
+ the ratio of vertical flow rate to soil moisture in mm.
Args:
solute_density: The density of the solute in the soil [kg solute m^-3]
vertical_flow_rate: Rate of flow downwards through the soil [mm day^-1]
- soil_moisture: Volumetric relative water content of the soil [unitless]
+ soil_moisture: Volume of water contained in topsoil layer [mm]
solubility_coefficient: The solubility coefficient of the solute in question
[unitless]
- soil_layer_thickness: Thickness of the biogeochemically active soil layer [m]
Returns:
The rate at which the solute in question is leached [kg solute m^-3 day^-1]
"""
- # Vertical flow rate has to be converted into m day^-1
- vert_flow_meters = vertical_flow_rate / 1e3
-
- return (
- solubility_coefficient
- * solute_density
- * vert_flow_meters
- / (soil_moisture * soil_layer_thickness)
- )
+ return solubility_coefficient * solute_density * vertical_flow_rate / soil_moisture
diff --git a/virtual_ecosystem/models/soil/soil_model.py b/virtual_ecosystem/models/soil/soil_model.py
index 137d307ce..ce1487bd3 100644
--- a/virtual_ecosystem/models/soil/soil_model.py
+++ b/virtual_ecosystem/models/soil/soil_model.py
@@ -14,7 +14,7 @@
logged, and at the end of the unpacking an error is thrown. This error should be caught
and handled by downstream functions so that all model configuration failures can be
reported as one.
-""" # noqa: D205, D415
+""" # noqa: D205
from __future__ import annotations
@@ -45,23 +45,38 @@ class SoilModel(
BaseModel,
model_name="soil",
model_update_bounds=("30 minutes", "3 months"),
- required_init_vars=(
- ("soil_c_pool_maom", ("spatial",)),
- ("soil_c_pool_lmwc", ("spatial",)),
- ("soil_c_pool_microbe", ("spatial",)),
- ("soil_c_pool_pom", ("spatial",)),
- ("pH", ("spatial",)),
- ("bulk_density", ("spatial",)),
- ("clay_fraction", ("spatial",)),
+ vars_required_for_init=(
+ "soil_c_pool_maom",
+ "soil_c_pool_lmwc",
+ "soil_c_pool_microbe",
+ "soil_c_pool_pom",
+ "soil_enzyme_pom",
+ "soil_enzyme_maom",
+ "soil_c_pool_necromass",
+ "pH",
+ "bulk_density",
+ "clay_fraction",
+ ),
+ vars_populated_by_init=(),
+ vars_required_for_update=(
+ "soil_c_pool_maom",
+ "soil_c_pool_lmwc",
+ "soil_c_pool_microbe",
+ "soil_c_pool_pom",
+ "soil_c_pool_necromass",
+ "soil_enzyme_pom",
+ "soil_enzyme_maom",
),
vars_updated=(
"soil_c_pool_maom",
"soil_c_pool_lmwc",
"soil_c_pool_microbe",
"soil_c_pool_pom",
+ "soil_c_pool_necromass",
"soil_enzyme_pom",
"soil_enzyme_maom",
),
+ vars_populated_by_first_update=(),
):
"""A class defining the soil model.
@@ -93,6 +108,9 @@ def __init__(
or np.any(data["soil_c_pool_lmwc"] < 0.0)
or np.any(data["soil_c_pool_microbe"] < 0.0)
or np.any(data["soil_c_pool_pom"] < 0.0)
+ or np.any(data["soil_enzyme_pom"] < 0.0)
+ or np.any(data["soil_enzyme_maom"] < 0.0)
+ or np.any(data["soil_c_pool_necromass"] < 0.0)
):
to_raise = InitialisationError(
"Initial carbon pools contain at least one negative value!"
@@ -100,13 +118,9 @@ def __init__(
LOGGER.error(to_raise)
raise to_raise
- # Find first soil layer from the list of layer roles
- self.top_soil_layer_index = self.layer_structure.layer_roles.index("soil")
- """The layer in the data object representing the first soil layer."""
-
# TODO - At the moment the soil model only cares about the very top layer. As
# both the soil and abiotic models get more complex this might well change.
- self.model_constants = model_constants
+ self.model_constants: SoilConsts = model_constants
"""Set of constants for the soil model."""
@classmethod
@@ -150,6 +164,7 @@ def update(self, time_index: int, **kwargs: Any) -> None:
Args:
time_index: The index representing the current time step in the data object.
+ **kwargs: Further arguments to the update method.
"""
# Find carbon pool updates by integration
@@ -211,7 +226,7 @@ def integrate(self) -> dict[str, DataArray]:
args=(
self.data,
no_cells,
- self.top_soil_layer_index,
+ self.layer_structure.index_topsoil_scalar,
delta_pools_ordered,
self.model_constants,
self.core_constants,
@@ -221,8 +236,9 @@ def integrate(self) -> dict[str, DataArray]:
# Check if integration failed
if not output.success:
LOGGER.error(
- "Integration of soil module failed with following message: %s"
- % str(output.message)
+ "Integration of soil module failed with following message: {}".format( # noqa: UP032
+ str(output.message)
+ )
)
raise IntegrationError()