Add abiotic documentation - Githubissues

ImperialCollegeLondon / virtual_ecosystem

This repository is the home for the codebase for the Virtual Ecosystem project.

https://virtual-ecosystem.readthedocs.io

BSD 3-Clause "New" or "Revised" License

9 stars 1 forks source link

Add abiotic documentation #500

Closed vgro closed 2 months ago

vgro commented 3 months ago

This PR adds the theory for the abiotic components of the Virtual Ecosystem. So far, I have added the overview, microclimate, and a draft of hydrology. I would appreciate feedback on structure and content before I put a lot of effort in adding references and repeating the exercise for the hydrology.

You can read the docs here https://virtual-ecosystem.readthedocs.io/en/add_abiotic_documentation/virtual_ecosystem/abiotic_theory.html https://virtual-ecosystem.readthedocs.io/en/add_abiotic_documentation/virtual_ecosystem/microclimate_theory.html https://virtual-ecosystem.readthedocs.io/en/add_abiotic_documentation/virtual_ecosystem/hydrology_theory.html

Type of change

[x] New feature (non-breaking change which adds functionality)
[ ] Optimization (back-end change that speeds up the code)
[ ] Bug fix (non-breaking change which fixes an issue)

Key checklist

[x] Make sure you've run the pre-commit checks: $ pre-commit run -a
[ ] All tests pass: $ poetry run pytest

Further checks

[ ] Code is commented, particularly in hard-to-understand areas
[ ] Tests added that prove fix is effective or that feature works
[x] Relevant documentation reviewed and updated

codecov-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.91%. Comparing base (5171294) to head (46cd4af).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## develop #500 +/- ## ======================================== Coverage 94.91% 94.91% ======================================== Files 70 70 Lines 3857 3857 ======================================== Hits 3661 3661 Misses 196 196 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.