Make sure that documentation of sipnet.out header reflects implementation
Maintainers usually reply within 2 days
@TianHengZhuang is already working on this.
Since Oct 20, 2026.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- markdown
- Domain
- documentation
Research direction
Start with docs/user-guide/model-outputs.md and compare its output table with the column list in a real sipnet.out header, checking that the source code that writes the header agrees with it. Add the missing nppStorage, bcdeltaC and bcdeltaN entries, then renumber the columns consecutively. Done when every header column is documented and the example header matches the smoke test output.
Written by the indexing model from the issue text.
Description
Updated scope & specification
Task
- Update
docs/user-guide/model-outputs.mdto match current supported outputs.
Requirements
- Match column names and order in
outputHeader(); verify definitions and units against implementation. - Distinguish pools, rates, timestep totals, cumulative quantities, time coordinates, and diagnostics.
- Retain
nppStorageas an accounting diagnostic, pending maintainer confirmation. Explain that it is included in reportedplantWoodC. - Exclude obsolete columns found only in disabled historical outputs, including
microbeC,bcdeltaC, andbcdeltaN. - Verify example headers and rows against an active smoke test.
- Dominant language
- C
- Stars
- 42
- Forks
- 38
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 10
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PecanProject/sipnet
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PecanProject/sipnet#435 · 1 comment ·
Maintainers usually reply within 2 days
-
Remove unused `Tracker` fieldsMay be free again @ANAMASGARD claimed this 9 days ago, and no pull request is open. Opengood first issue on hold
Difficulty 4/5 3-5 days Newbie friendliness 45/100
PecanProject/sipnet#430 · 1 comment · 1 reaction ·
Maintainers usually reply within 2 days
-
Event checks ignore every events.in record after the firstPossibly taken @ANAMASGARD claimed this 9 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 70/100
PecanProject/sipnet#429 · 3 comments · 1 assignee ·
Maintainers usually reply within 2 days
-
Events: revamp handling of "big delta" events to post-pool-updatePossibly taken @Alomir claimed this 11 days ago. Open
PecanProject/sipnet#423 · 1 assignee ·
Maintainers usually reply within 2 days
-
Missed event across a year boundary silently blocks later eventsPossibly taken @ANAMASGARD claimed this 11 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 73/100
PecanProject/sipnet#421 · 4 comments · 1 assignee ·
Maintainers usually reply within 2 days
All issues in PecanProject/sipnet
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
kmod-project/kmod#492 ·
Maintainers usually reply within 4 days
-
SDL_GPU Vulkan: wrong screen orientation on OpenHarmony (preTransform set without pre-rotation)Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
libsdl-org/SDL#16670 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
要トリアージ 辞書
Difficulty 1/5 1-3 hours Newbie friendliness 86/100
yksr-melt/Meltype#1625 · 1 reaction ·
Maintainers usually reply within 1 day
-
kind/bug priority/medium qa_automation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
yugabyte/yugabyte-db#37324 ·
Maintainers usually reply within 1 day