Skip to content

Commit 4256af9

Browse files
Update example
1 parent d39e62c commit 4256af9

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

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
```

0 commit comments

Comments
 (0)