Skip to content

Add proper explanation of soil carbon and macronutrient cycles to the soil model documentation#752

Merged
jacobcook1995 merged 46 commits intodevelopfrom
662-improve-soil-nutrient-documentation
May 22, 2025
Merged

Add proper explanation of soil carbon and macronutrient cycles to the soil model documentation#752
jacobcook1995 merged 46 commits intodevelopfrom
662-improve-soil-nutrient-documentation

Conversation

@jacobcook1995
Copy link
Copy Markdown
Collaborator

@jacobcook1995 jacobcook1995 commented Feb 19, 2025

Description

This PR is an attempt to improve the documentation of the soil carbon and macronutrient cycles. It is currently in very early draft stage, it is mainly being put up as a pull request so that me and @hrlai can both contribute to it.

The documentation for this branch is built here, the relevant section is The Virtual Ecosystem -> Theory -> Soil theory.

Fixes #662

@jacobcook1995 jacobcook1995 linked an issue Feb 19, 2025 that may be closed by this pull request
@jacobcook1995 jacobcook1995 marked this pull request as draft February 19, 2025 09:17
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Feb 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.79%. Comparing base (abd205d) to head (667e029).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #752   +/-   ##
========================================
  Coverage    94.79%   94.79%           
========================================
  Files           75       75           
  Lines         5592     5592           
========================================
  Hits          5301     5301           
  Misses         291      291           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@jacobcook1995 jacobcook1995 changed the title Split documentation of soil theory across three new pages Add proper explanation of soil carbon and macronutrient cycles to the soil model documentation Feb 19, 2025
@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@hrlai, I'm starting by working on the soil carbon cycle documentation. I don't think that section is yet in a state where it's worth your time looking at it. I'll let you know once it's reached a good enough state to be worth looking at!

@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@hrlai I've finished the soil carbon section of the docs (I still need to work on the soil nutrients section). Let me know what you think, and feel free to make edits if you think there's something incorrect, missing, etc

@hrlai
Copy link
Copy Markdown
Collaborator

hrlai commented Apr 4, 2025

@jacobcook1995 I read the new documents and added only minor edits. They look very good as a first pass to me, and I have a much better understanding of the soil module. I think this PR is ready to be merged. There might be some missing items, or things that can added; but they can wait for the next round of revision?

@hrlai hrlai marked this pull request as ready for review April 4, 2025 02:24
@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@hrlai , thanks for the changes, it's really useful to have a second set of eyes on this! I still need to flesh out the macronutrients section (and do the rearrangement that you suggested). I'll do that on this PR and get you to take another look, if that's okay?

@jacobcook1995 jacobcook1995 requested a review from hrlai May 6, 2025 09:30
@jacobcook1995
Copy link
Copy Markdown
Collaborator Author

@hrlai I've fleshed out the remaining content and restructured the environment factors section as you suggested. Let me know what you think!

Copy link
Copy Markdown
Collaborator

@hrlai hrlai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jacobcook1995 this looks ready for merging, I have only added a few very minor tweaks and little comments.

@jacobcook1995 jacobcook1995 merged commit 6f36cfd into develop May 22, 2025
16 checks passed
@jacobcook1995 jacobcook1995 deleted the 662-improve-soil-nutrient-documentation branch May 22, 2025 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve soil nutrient documentation

3 participants