Skip to content

SIP333 docs #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alomir merged 2 commits into from
May 12, 2026
Merged

SIP333 docs #335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f68ca4d
update model structure b/c not all source is in sipnet.c
dlebauer May 12, 2026
de3023c
added check limitations to code-structure doc
dlebauer May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/developer-guide/code-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ This guide documents how state is advanced each timestep and the conventions tha
- Zero all `fluxes.*` and `fluxes.event*`.

2) Compute fluxes (pure calculations)
- `calculateFluxes()` computes photosynthesis, respiration, water/snow, etc.
- `processEvents()` converts scheduled/instant events to `fluxes.event*` deltas (no pool mutation).
- No function in this phase mutates `envi.*` or `trackers.*`.

- `calculateFluxes()` computes photosynthesis, respiration, water/snow, etc.
- `checkLimitations()` may adjust already-computed fluxes when a flux is resource limited.
- No function in this phase mutates `envi.*` or `trackers.*`.

3) Apply pool updates (single place)
- `updateMainPools()` updates leafC, woodC, soil water and snow pools
- `updatePoolsForSoil()` updates soil carbon pools
- `updateNitrogenPools()` updates mineral, soil organic, and litter nitrogen pools.
- `updatePoolsForEvents()` updates pools for fluxes from events
- The above functions are the only code that changes `envi.*`.
- For each pool P: ΔP = ((sum of rate fluxes to P) + (sum of event fluxes to P)) * climate.length
Expand Down
4 changes: 2 additions & 2 deletions docs/model-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This document provides an overview of the SIPNET model’s structure. It was wri
- Focus on features currently in regular use.

There are multiple ways to configure the model structure, and not all model structures or components are listed.
Implementation in source code (sipnet.c) is annotated with references to specific publications.
Implementation in source code is annotated with references to specific publications.

#### Notes on notation:

Expand Down Expand Up @@ -1174,7 +1174,7 @@ nitrogen (calculated from the leaf C:N ratio) is also transferred to the litter
**Event parameters:**

| Parameter | Value | Description |
|-----------|----------------------|-------------------|
| --------- | -------------------- | ----------------- |
Copy link
Copy Markdown
Member Author

@dlebauer dlebauer May 12, 2026

Choose a reason for hiding this comment

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

this was an auto-formatter - let me know if I should change my autoformatting settings

Copy link
Copy Markdown
Collaborator

@Alomir Alomir May 12, 2026

Choose a reason for hiding this comment

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

That would be nice - my IDE complains about the spaces (which perhaps I could change?)

| Year | integer | Year |
| Day | integer | Day of year |
| Type | `leafon` / `leafoff` | The type of event |
Expand Down
Loading