Skip to content

Commit f8f7c06

Browse files
ConnectedSystemsConnectedSystems
committed
Update example
Update indicative display
1 parent d39e62c commit f8f7c06

File tree

3 files changed

+54
-29
lines changed

3 files changed

+54
-29
lines changed

‎README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -172,18 +172,18 @@ To display an overview of a node or network:
172172
julia> node
173173
Name: 406219 [IHACRESBilinearNode]
174174
Area: 1985.73
175-
┌──────────────┬───────────┬─────────────┬─────────────┐
176-
│ Parameter │ Value │ Lower Bound │ Upper Bound │
177-
├──────────────┼───────────┼─────────────┼─────────────┤
178-
│ d │ 84.2802 │ 10.0 │ 550.0 │
179-
│ d2 │ 2.42241 │ 0.0001 │ 10.0 │
180-
│ e │ 0.812959 │ 0.1 │ 1.5 │
181-
│ f │ 2.57928 │ 0.01 │ 3.0 │
182-
│ a │ 5.92338 │ 0.1 │ 10.0 │
183-
│ b │ 0.0989926 │ 0.001 │ 0.1 │
184-
│ storage_coef │ 1.86134 │ 1.0e-10 │ 10.0 │
185-
│ alpha │ 0.727905 │ 1.0e-5 │ 1.0 │
186-
└──────────────┴───────────┴─────────────┴─────────────┘
175+
┌──────────────┬───────────┬─────────────┬─────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
176+
│ Parameter │ Value │ Lower Bound │ Upper Bound │ Description │
177+
├──────────────┼───────────┼─────────────┼─────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
178+
│ d │ 84.2802 │ 10.0 │ 550.0 │ Catchment moisture deficit threshold, higher values indicate the catchment can hold more water before generating runoff. │
179+
│ d2 │ 2.42241 │ 0.0001 │ 10.0 │ Scaling factor (d*d2) which creates a second threshold, changing the shape of effective rainfall response. │
180+
│ e │ 0.812959 │ 0.1 │ 1.5 │ PET conversion factor, controls the rate of evapotranspiration losses, converts temperature to PET. │
181+
│ f │ 2.57928 │ 0.01 │ 3.0 │ Plant stress threshold, controls at what moisture deficit plants begin to experience stress. │
182+
│ a │ 5.92338 │ 0.1 │ 10.0 │ Quickflow storage coefficient, where higher values lead to faster quickflow response. │
183+
│ b │ 0.0989926 │ 0.001 │ 0.1 │ Slowflow storage coefficient, lower values lead to slower baseflow recession. │
184+
│ storage_coef │ 1.86134 │ 1.0e-10 │ 10.0 │ Groundwater interaction factor, controling how water is exchanged with deeper groundwater. │
185+
│ alpha │ 0.727905 │ 1.0e-5 │ 1.0 │ Effective rainfall scaling factor, partitions rainfall into runoff. │
186+
└──────────────┴───────────┴─────────────┴─────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
187187
```
188188

189189
### Network specification

‎docs/src/examples/node_creation.md‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,39 @@ user-defined values.
77
using Streamfall
88

99
hymod_node = create_node(SimpleHyModNode, "410730", 129.2)
10+
# Name: 410730 [SimpleHyModNode]
11+
# Area: 129.2
12+
# ┌───────────┬───────┬─────────────┬─────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────┐
13+
# │ Parameter │ Value │ Lower Bound │ Upper Bound │ Description │
14+
# ├───────────┼───────┼─────────────┼─────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────┤
15+
# │ Sm_max │ 250.0 │ 1.0 │ 500.0 │ Maximum soil storage capacity. │
16+
# │ B │ 1.0 │ 0.0 │ 2.0 │ Controls how quickly the catchment becomes saturated as rainfall accumulates. │
17+
# │ alpha │ 0.2 │ 0.0 │ 1.0 │ The split between quick and slow flow components. Higher values direct more water through quickflow. │
18+
# │ Kf │ 0.5 │ 0.1 │ 0.9999 │ Quickflow recession. │
19+
# │ Ks │ 0.05 │ 0.001 │ 0.1 │ Slowflow recession. │
20+
# └───────────┴───────┴─────────────┴─────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────┘
1021

1122
# Hymod parameters ("hy_" prefix is simply to avoid any variable name conflicts)
12-
hy_Sm_max = 250.0
13-
hy_B = 1.0
14-
hy_alpha = 0.2
15-
hy_Kf = 0.5
16-
hy_Ks = 0.05
23+
hy_Sm_max = 370.0
24+
hy_B = 0.5
25+
hy_alpha = 0.3
26+
hy_Kf = 0.25
27+
hy_Ks = 0.25
1728

1829
# Update parameters
1930
update_params!(hymod_node, hy_Sm_max, hy_B, hy_alpha, hy_Kf, hy_Ks)
31+
32+
# The "Value" column indicates model parameters have been updated.
33+
print(hymod_node)
34+
# Name: 410730 [SimpleHyModNode]
35+
# Area: 129.2
36+
# ┌───────────┬───────┬─────────────┬─────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────┐
37+
# │ Parameter │ Value │ Lower Bound │ Upper Bound │ Description │
38+
# ├───────────┼───────┼─────────────┼─────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────┤
39+
# │ Sm_max │ 370.0 │ 1.0 │ 500.0 │ Maximum soil storage capacity. │
40+
# │ B │ 0.5 │ 0.0 │ 2.0 │ Controls how quickly the catchment becomes saturated as rainfall accumulates. │
41+
# │ alpha │ 0.3 │ 0.0 │ 1.0 │ The split between quick and slow flow components. Higher values direct more water through quickflow. │
42+
# │ Kf │ 0.25 │ 0.1 │ 0.9999 │ Quickflow recession. │
43+
# │ Ks │ 0.25 │ 0.001 │ 0.1 │ Slowflow recession. │
44+
# └───────────┴───────┴─────────────┴─────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────┘
2045
```

‎docs/src/primer.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,18 @@ Node 1
7676
--------
7777
Name: 410730 [IHACRESBilinearNode]
7878
Area: 130.0
79-
┌──────────────┬───────┬─────────────┬─────────────┐
80-
│ Parameter │ Value │ Lower Bound │ Upper Bound │
81-
├──────────────┼───────┼─────────────┼─────────────┤
82-
│ d │ 200.0 │ 10.0 │ 550.0 │
83-
│ d2 │ 2.0 │ 0.0001 │ 10.0 │
84-
│ e │ 1.0 │ 0.1 │ 1.5 │
85-
│ f │ 0.8 │ 0.01 │ 3.0 │
86-
│ a │ 0.9 │ 0.1 │ 10.0 │
87-
│ b │ 0.1 │ 0.001 │ 0.1 │
88-
│ storage_coef │ 2.9 │ 1.0e-10 │ 10.0 │
89-
│ alpha │ 0.95 │ 1.0e-5 │ 1.0 │
90-
└──────────────┴───────┴─────────────┴─────────────┘
79+
┌──────────────┬───────┬─────────────┬─────────────┬──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
80+
│ Parameter │ Value │ Lower Bound │ Upper Bound │ Description │
81+
├──────────────┼───────┼─────────────┼─────────────┼──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
82+
│ d │ 200.0 │ 10.0 │ 550.0 │ Catchment moisture deficit threshold, higher values indicate the catchment can hold more water before generating runoff. │
83+
│ d2 │ 2.0 │ 0.0001 │ 10.0 │ Scaling factor (d*d2) which creates a second threshold, changing the shape of effective rainfall response. │
84+
│ e │ 1.0 │ 0.1 │ 1.5 │ PET conversion factor, controls the rate of evapotranspiration losses, converts temperature to PET. │
85+
│ f │ 0.8 │ 0.01 │ 3.0 │ Plant stress threshold, controls at what moisture deficit plants begin to experience stress. │
86+
│ a │ 0.9 │ 0.1 │ 10.0 │ Quickflow storage coefficient, where higher values lead to faster quickflow response. │
87+
│ b │ 0.1 │ 0.001 │ 0.1 │ Slowflow storage coefficient, lower values lead to slower baseflow recession. │
88+
│ storage_coef │ 2.9 │ 1.0e-10 │ 10.0 │ Groundwater interaction factor, controling how water is exchanged with deeper groundwater. │
89+
│ alpha │ 0.95 │ 1.0e-5 │ 1.0 │ Effective rainfall scaling factor, partitions rainfall into runoff. │
90+
└──────────────┴───────┴─────────────┴─────────────┴──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
9191
```
9292

9393

0 commit comments

Comments
 (0)