Dependencies:
#1115 [E5-F1] ──┐
#1116 [E5-F2] ──┤
#1117 [E5-F3] ──┼──► #THIS [E5-F6]
#1118 [E5-F4] ──┤
#1119 [E5-F5] ──┘
Summary
Generate implementation issues for feature E5-F6: Documentation and Examples.
Complete documentation for the non-isothermal condensation feature: sweep all new code for docstring gaps, add a Theory document explaining the non-isothermal mass transfer derivation, create a usage example notebook demonstrating all three latent heat strategies and comparing isothermal vs non-isothermal growth, and update development plan documentation with final status.
Feature Plan
Document: adw-docs/dev-plans/features/E5-F6-documentation-examples.md
Parent Epic: E5: Non-Isothermal Condensation with Latent Heat (adw-docs/dev-plans/epics/E5-non-isothermal-condensation.md)
Phases to Generate
| Phase |
Description |
Size |
| E5-F6-P1 |
Add docstrings and Theory document update |
S (~60 LOC) |
| E5-F6-P2 |
Create usage example notebook |
M (~100 LOC) |
| E5-F6-P3 |
Update development documentation |
XS (~20 LOC) |
Dependencies
ADW Instructions
When processing this issue:
- Read the feature plan document:
adw-docs/dev-plans/features/E5-F6-documentation-examples.md
- Read the parent epic for context:
adw-docs/dev-plans/epics/E5-non-isothermal-condensation.md
- For each phase in the Phase Checklist (E5-F6-P1 through E5-F6-P3), create an implementation issue with:
- Full technical details from the feature plan
- Specific file paths from the feature plan's scope section
- Test file paths (co-located in module
tests/ directories)
- Co-located testing: tests ship with implementation in every phase
- Coverage target: 80-85% per phase
- Set dependency chain: E5-F6-P1 → E5-F6-P2 → E5-F6-P3
- Label all phases with
agent, blocked, type:complete, model:default
Files to Create/Modify
- Modify: All new source files from E5-F1 through E5-F4 — docstring gap sweep
- Create or Update:
docs/Theory/Technical/Dynamics/Condensation_Equations.md — non-isothermal mass transfer derivation
- Create:
docs/Examples/Dynamics/non_isothermal_condensation_example.py — py:percent format usage example
- Create:
docs/Examples/Dynamics/non_isothermal_condensation_example.ipynb — synced notebook (via Jupytext)
- Modify:
adw-docs/dev-plans/README.md — epic status update
- Modify:
adw-docs/dev-plans/epics/index.md — epic index update
- Modify:
adw-docs/dev-plans/features/index.md — feature index update
Testing Strategy
Documentation Validation
| Check |
Tool |
Phase |
| Docstring format |
ruff check particula/ --fix + ruff format |
P1 |
| Theory document links |
Manual review + mkdocs build |
P1 |
| Notebook execution |
run_notebook tool |
P2 |
| Notebook sync |
validate_notebook --sync |
P2 |
| Dev-plan links |
Manual review |
P3 |
Notebook Test Cases
- Strategy demos: Each latent heat strategy produces expected output
- Comparison plot: Isothermal vs non-isothermal curves visually distinct
- Energy tracking:
last_latent_heat_energy attribute accessible and non-zero for L > 0
- Cloud activation: Water droplet grows at reduced rate with non-isothermal correction
- No internal imports: Only
import particula as par and submodules
Literature Citations to Include
- Topping & Bane (2022) Eq. 2.36
- Seinfeld & Pandis (2016) Eq. 13.3
- Rogers & Yau (1989) Ch. 7
Dependencies:
#1115 [E5-F1] ──┐
#1116 [E5-F2] ──┤
#1117 [E5-F3] ──┼──► #THIS [E5-F6]
#1118 [E5-F4] ──┤
#1119 [E5-F5] ──┘
Summary
Generate implementation issues for feature E5-F6: Documentation and Examples.
Complete documentation for the non-isothermal condensation feature: sweep all new code for docstring gaps, add a Theory document explaining the non-isothermal mass transfer derivation, create a usage example notebook demonstrating all three latent heat strategies and comparing isothermal vs non-isothermal growth, and update development plan documentation with final status.
Feature Plan
Document:
adw-docs/dev-plans/features/E5-F6-documentation-examples.mdParent Epic: E5: Non-Isothermal Condensation with Latent Heat (
adw-docs/dev-plans/epics/E5-non-isothermal-condensation.md)Phases to Generate
Dependencies
mkdocsfor documentation buildsADW Instructions
When processing this issue:
adw-docs/dev-plans/features/E5-F6-documentation-examples.mdadw-docs/dev-plans/epics/E5-non-isothermal-condensation.mdtests/directories)agent,blocked,type:complete,model:defaultFiles to Create/Modify
docs/Theory/Technical/Dynamics/Condensation_Equations.md— non-isothermal mass transfer derivationdocs/Examples/Dynamics/non_isothermal_condensation_example.py— py:percent format usage exampledocs/Examples/Dynamics/non_isothermal_condensation_example.ipynb— synced notebook (via Jupytext)adw-docs/dev-plans/README.md— epic status updateadw-docs/dev-plans/epics/index.md— epic index updateadw-docs/dev-plans/features/index.md— feature index updateTesting Strategy
Documentation Validation
ruff check particula/ --fix+ruff formatrun_notebooktoolvalidate_notebook --syncNotebook Test Cases
last_latent_heat_energyattribute accessible and non-zero for L > 0import particula as parand submodulesLiterature Citations to Include