malcolmSQ commited on
Commit
3f105b6
·
1 Parent(s): 560f9fd

Update README: describe discrete and continuous declining increment models, config flag, and display names

Browse files
models/declining_increment/README.md CHANGED
@@ -5,6 +5,24 @@ This folder documents the **Declining Increment** growth model used in the Mangr
5
  - **Growth Model:** Declining Increment (annual increment declines linearly to zero; total size is the sum of non-negative increments)
6
  - **Parameters:** See `configs/declining_increment.yaml`
7
  - **Purpose:** For comparison with other models; may be appropriate for species or sites where growth slows with age.
8
- - **Usage:** Available as a tab in the dashboard for side-by-side comparison.
9
 
10
- **Note:** In this model, total DBH and height are calculated by summing annual increments, which decline to zero but never go negative. This ensures that size never decreases or becomes negative.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  - **Growth Model:** Declining Increment (annual increment declines linearly to zero; total size is the sum of non-negative increments)
6
  - **Parameters:** See `configs/declining_increment.yaml`
7
  - **Purpose:** For comparison with other models; may be appropriate for species or sites where growth slows with age.
8
+ - **Usage:** Available as a tab in the dashboard for side-by-side comparison, or as a standalone dashboard.
9
 
10
+ ## Model Details
11
+
12
+ ### Discrete Version (Default)
13
+ - **Logic:** Growth is calculated by summing annual increments for each year of age. The increment for year \(i\) is \( r_0 \cdot \max(0, 1 - \frac{i-1}{T_m}) \).
14
+ - **No Negative Growth:** Increments decline to zero but never go negative, so DBH and height never decrease.
15
+ - **Fractional Years:** If the age is not an integer, a proportional part of the next increment is added.
16
+ - **Mortality:** Annual mortality is compounded each year according to the schedule in the config.
17
+
18
+ ### Continuous Version (Optional)
19
+ - **Logic:** Uses the analytical formula:
20
+ \( \text{size}(t) = \text{initial} + r_0 \cdot (t - \frac{t^2}{2T_m}) \)
21
+ - **How to Enable:** Set `continuous_growth: true` in `configs/declining_increment.yaml`.
22
+ - **Implications:** This version is smoother and may yield slightly different results than the discrete sum, especially for short time periods or small Tm.
23
+
24
+ ### Display Names
25
+ - Species are now displayed as "Rhizophora spp." and "Avicennia germinans" throughout the dashboard for clarity.
26
+
27
+ **Note:**
28
+ This model is flexible and can be toggled between discrete and continuous modes via the config. Small differences in ERs compared to other implementations (e.g., Jupyter notebooks) may arise from differences in how increments, mortality, or fractional years are handled.