Fix typo that propagated throughout

SYMHYD -> SIMHYD

Author: ConnectedSystems

README.md

@@ -16,7 +16,7 @@ This package includes implementations of the following:
 - GR4J
 - HyMod
 - IHACRES
-- SYMHYD
+- SIMHYD
 
 Performance is expected to be similar to implementations in C and Fortran.
 
@@ -26,7 +26,7 @@ Naive timings (using `@time`) for an example dataset spanning 1963-07-05 - 2014-
   0.016502 seconds (469.25 k allocations: 12.902 MiB)
 - GR4JNode \
   0.015274 seconds (224.75 k allocations: 5.584 MiB)
-- SYMHYDNode \
+- SIMHYDNode \
   0.039540 seconds (638.01 k allocations: 15.190 MiB, 46.99% gc time)
 - IHACRESBilinearNode \
   0.021734 seconds (675.63 k allocations: 17.773 MiB)

docs/make.jl

@@ -40,7 +40,7 @@ makedocs(sitename="Streamfall Documentation",
                 "API/nodes/IHACRES.md",
                 "API/nodes/HyMod.md",
                 "API/nodes/GR4J.md",
-                "API/nodes/SYMHYD.md",
+                "API/nodes/SIMHYD.md",
                 "API/nodes/Dam.md"
             ],
             "API/plotting.md",

docs/src/API/nodes/SYMHYD.md docs/src/API/nodes/SIMHYD.mddocs/src/API/nodes/SYMHYD.md renamed to docs/src/API/nodes/SIMHYD.md

@@ -1,7 +1,7 @@
-# SYMHYD
+# SIMHYD
 
 ```@autodocs
 Modules = [Streamfall]
 Order   = [:function, :type]
-Pages   = ["Nodes/SYMHYD/SYMHYDNode.jl"]
+Pages   = ["Nodes/SIMHYD/SIMHYDNode.jl"]
 ```

docs/src/examples/calibration/custom_calibration.md

@@ -173,16 +173,16 @@ obs_data = CSV.read(
 Qo = extract_flow(obs_data, "410730")
 climate = extract_climate(obs_data)
 
-# Create one instance each of IHACRES_CMD, GR4J and SYMHYD
+# Create one instance each of IHACRES_CMD, GR4J and SIMHYD
 ihacres_node = create_node(IHACRESBilinearNode, "410730_ihacres", 129.2)
 gr4j_node = create_node(GR4JNode, "410730_gr4j", 129.2)
-symhyd_node = create_node(SYMHYDNode, "410730_symhyd", 129.2)
+simhyd_node = create_node(SIMHYDNode, "410730_simhyd", 129.2)
 
 # Create a weighted ensemble with equal weights
 # The default behavior is to combine component predictions with a normalized weighted sum.
 ensemble = create_node(
     WeightedEnsembleNode, 
-    [ihacres_node, gr4j_node, symhyd_node], 
+    [ihacres_node, gr4j_node, simhyd_node], 
     [0.5, 0.5, 0.5]
 )
 
@@ -222,13 +222,13 @@ end
 custom_metrics = Dict(
     "410730_ihacres" => (obs, sim) -> 1.0 - Streamfall.NmKGE(obs, sim),
     "410730_gr4j" => custom_low_flow_objective,
-    "410730_symhyd" => (obs, sim) -> 1.0 - Streamfall.NmKGE(obs, sim)
+    "410730_simhyd" => (obs, sim) -> 1.0 - Streamfall.NmKGE(obs, sim)
 )
 
 # Copy flow data (these can be nodes in a network)
 Qo[:, "410730_ihacres"] = Qo[:, "410730"]
 Qo[:, "410730_gr4j"] = Qo[:, "410730"]
-Qo[:, "410730_symhyd"] = Qo[:, "410730"]
+Qo[:, "410730_simhyd"] = Qo[:, "410730"]
 
 # Copy climate data for each node (these can be nodes in a network)
 insertcols!(
@@ -239,9 +239,9 @@ insertcols!(
     "410730_gr4j_P" => climate.climate_data[:, "410730_P"], 
     "410730_gr4j_PET" => climate.climate_data[:, "410730_PET"], 
     "410730_gr4j_Q" => climate.climate_data[:, "410730_Q"],
-    "410730_symhyd_P" => climate.climate_data[:, "410730_P"], 
-    "410730_symhyd_PET" => climate.climate_data[:, "410730_PET"], 
-    "410730_symhyd_Q" => climate.climate_data[:, "410730_Q"]
+    "410730_simhyd_P" => climate.climate_data[:, "410730_P"], 
+    "410730_simhyd_PET" => climate.climate_data[:, "410730_PET"], 
+    "410730_simhyd_Q" => climate.climate_data[:, "410730_Q"]
 )
 
 # Use the custom objective function in calibration

docs/src/examples/evaluation/model_comparison.md

@@ -45,13 +45,13 @@ end
 # Create individual nodes
 hymod_node = create_node(SimpleHyModNode, "410730", 129.2)
 gr4j_node = create_node(GR4JNode, "410730", 129.2)
-symhyd_node = create_node(SYMHYDNode, "410730", 129.2)
+simhyd_node = create_node(SIMHYDNode, "410730", 129.2)
 ihacres_node = create_node(IHACRESBilinearNode, "410730", 129.2)
 
 
 # Calibrate each node separately using multiprocessing
-node_types = ["HyMod", "GR4J", "SYMHYD", "IHACRES"]
-node_list = [hymod_node, gr4j_node, symhyd_node, ihacres_node]
+node_types = ["HyMod", "GR4J", "SIMHYD", "IHACRES"]
+node_list = [hymod_node, gr4j_node, simhyd_node, ihacres_node]
 result = pmap(opt_func, node_list)
 
 # Create comparison plot

docs/src/index.md

@@ -12,7 +12,7 @@ This package includes implementations of the following:
 - GR4J
 - HyMod
 - IHACRES
-- SYMHYD
+- SIMHYD
 
 Performance is expected to be similar to implementations in C and Fortran.
 
@@ -59,7 +59,7 @@ more "hands-on" overview.
     </td>
   </tr>
   <tr>
-    <td>SYMHYD</td>
+    <td>SIMHYD</td>
     <td>-</td>
     <td>
     Chiew, F. H. S., Peel, M. C., Western, A. W., Singh, V. P., & Frevert, D. (2002). Application and testing of the simple rainfall-runoff model SIMHYD. Mathematical models of small watershed hydrology and applications, 335-367.

examples/node_comparison.jl

@@ -34,13 +34,13 @@ end
 # Create individual nodes
 hymod_node = create_node(SimpleHyModNode, "410730", 129.2)
 gr4j_node = create_node(GR4JNode, "410730", 129.2)
-symhyd_node = create_node(SYMHYDNode, "410730", 129.2)
+simhyd_node = create_node(SIMHYDNode, "410730", 129.2)
 ihacres_node = create_node(IHACRESBilinearNode, "410730", 129.2)
 
 
 # Calibrate each node separately using multiprocessing
-node_names = ["HyMod", "GR4J", "SYMHYD", "IHACRES"]
-node_list = [hymod_node, gr4j_node, symhyd_node, ihacres_node]
+node_names = ["HyMod", "GR4J", "SIMHYD", "IHACRES"]
+node_list = [hymod_node, gr4j_node, simhyd_node, ihacres_node]
 result = pmap(opt_func, node_list)
 
 

src/Nodes/SYMHYD/SYMHYDNode.jl src/Nodes/SIMHYD/SIMHYDNode.jlsrc/Nodes/SYMHYD/SYMHYDNode.jl renamed to src/Nodes/SIMHYD/SIMHYDNode.jl

@@ -2,9 +2,9 @@ using Parameters
 using ModelParameters
 
 
-const SYMHYD_SOIL_ET_CONST = 10.0
+const SIMHYD_SOIL_ET_CONST = 10.0
 
-Base.@kwdef mutable struct SYMHYDNode{P, A<:AbstractFloat} <: NetworkNode
+Base.@kwdef mutable struct SIMHYDNode{P,A<:AbstractFloat} <: NetworkNode
     name::String
     area::A
 
@@ -34,12 +34,12 @@ end
 
 
 """
-    SYMHYDNode(name::String, spec::AbstractDict)::SYMHYDNode
+    SIMHYDNode(name::String, spec::AbstractDict)::SIMHYDNode
 
-Create SYMHYD node from spec.
+Create SIMHYD node from spec.
 """
-function SYMHYDNode(name::String, spec::AbstractDict)::SYMHYDNode
-    n = create_node(SYMHYDNode, name, spec["area"])
+function SIMHYDNode(name::String, spec::AbstractDict)::SIMHYDNode
+    n = create_node(SIMHYDNode, name, spec["area"])
     node_params = spec["parameters"]
     node_params["sm_store"] = [node_params["initial_sm_store"]]
     node_params["gw_store"] = [node_params["initial_gw_store"]]
@@ -70,10 +70,10 @@ function SYMHYDNode(name::String, spec::AbstractDict)::SYMHYDNode
     return n
 end
 
-function prep_state!(node::SYMHYDNode, sim_length::Int64)::Nothing
-    resize!(node.sm_store, sim_length+1)
-    resize!(node.gw_store, sim_length+1)
-    resize!(node.total_store, sim_length+1)
+function prep_state!(node::SIMHYDNode, sim_length::Int64)::Nothing
+    resize!(node.sm_store, sim_length + 1)
+    resize!(node.gw_store, sim_length + 1)
+    resize!(node.total_store, sim_length + 1)
     node.sm_store[2:end] .= 0.0
     node.gw_store[2:end] .= 0.0
     node.total_store[2:end] .= 0.0
@@ -88,11 +88,11 @@ end
 
 """
     run_timestep!(
-        node::SYMHYDNode, climate::Climate, ts::Int;
+        node::SIMHYDNode, climate::Climate, ts::Int;
         inflow=nothing, extraction=extraction, exchange=nothing
     )::AbstractFloat
     run_timestep!(
-        node::SYMHYDNode,
+        node::SIMHYDNode,
         rain::F,
         et::F,
         ts::Int;
@@ -101,26 +101,26 @@ end
         exchange=nothing
     )::F where {F<:AbstractFloat}
 
-Run SYMHYD for a given timestep.
+Run SIMHYD for a given timestep.
 """
 function run_timestep!(
-    node::SYMHYDNode, climate::Climate, ts::Int;
+    node::SIMHYDNode, climate::Climate, ts::Int;
     inflow=nothing, extraction=extraction, exchange=nothing
 )::AbstractFloat
     P, E = climate_values(node, climate, ts)
 
     return run_timestep!(node, P, E, ts; inflow=inflow, extraction=extraction, exchange=exchange)
 end
 function run_timestep!(
-    node::SYMHYDNode,
+    node::SIMHYDNode,
     rain::F,
     et::F,
     ts::Int;
     inflow=nothing,
     extraction=nothing,
     exchange=nothing
 )::F where {F<:AbstractFloat}
-    sm_store, gw_store, total_store, total_runoff, baseflow, event_runoff = run_symhyd(node, rain, et, ts)
+    sm_store, gw_store, total_store, total_runoff, baseflow, event_runoff = run_simhyd(node, rain, et, ts)
 
     node_name = node.name
     wo = timestep_value(ts, node_name, "releases", extraction)
@@ -138,15 +138,15 @@ function run_timestep!(
 end
 
 
-function update_state!(node::SYMHYDNode, sm_store, gw_store, total_store, outflow, baseflow, quickflow)
+function update_state!(node::SIMHYDNode, sm_store, gw_store, total_store, outflow, baseflow, quickflow)
     push!(node.sm_store, sm_store)
     push!(node.gw_store, gw_store)
     push!(node.total_store, total_store)
     push!(node.outflow, outflow)
     push!(node.baseflow, baseflow)
     push!(node.quickflow, quickflow)
 end
-function update_state!(node::SYMHYDNode, ts::Int64, sm_store, gw_store, total_store, outflow, baseflow, quickflow)
+function update_state!(node::SIMHYDNode, ts::Int64, sm_store, gw_store, total_store, outflow, baseflow, quickflow)
     node.sm_store[ts+1] = sm_store
     node.gw_store[ts+1] = gw_store
     node.total_store[ts+1] = total_store
@@ -157,7 +157,7 @@ end
 
 """
     update_params!(
-        node::SYMHYDNode,
+        node::SIMHYDNode,
         baseflow_coef::Float64,
         impervious_threshold::Float64,
         infiltration_coef::Float64,
@@ -172,7 +172,7 @@ end
 Update model parameters.
 """
 function update_params!(
-    node::SYMHYDNode,
+    node::SIMHYDNode,
     baseflow_coef::Float64,
     impervious_threshold::Float64,
     infiltration_coef::Float64,
@@ -198,11 +198,11 @@ end
 
 
 """
-    reset!(node::SYMHYDNode)::Nothing
+    reset!(node::SIMHYDNode)::Nothing
 
 Reset node. Clears all states back to their initial values.
 """
-function reset!(node::SYMHYDNode)::Nothing
+function reset!(node::SIMHYDNode)::Nothing
     # stores
     node.sm_store = [node.sm_store[1]]
     node.gw_store = [node.gw_store[1]]
@@ -218,18 +218,18 @@ end
 
 
 """
-    run_symhyd(node::SYMHYDNode, P::F, ET::F, ts::Int64)::NTuple{6,F} where {F<:Float64}
+    run_simhyd(node::SIMHYDNode, P::F, ET::F, ts::Int64)::NTuple{6,F} where {F<:Float64}
 
-Run SYMHYD for a single time step with given inputs and state variables.
+Run SIMHYD for a single time step with given inputs and state variables.
 """
-function run_symhyd(node::SYMHYDNode, P::F, ET::F, ts::Int64)::NTuple{6,F} where {F<:Float64}
+function run_simhyd(node::SIMHYDNode, P::F, ET::F, ts::Int64)::NTuple{6,F} where {F<:Float64}
 
     sm_store::F = node.sm_store[ts]
     gw_store::F = node.gw_store[ts]
     total_store::F = node.total_store[ts]
 
     pervious_incident::F = P
-	impervious_incident::F = P
+    impervious_incident::F = P
 
     impervious_ET::F = min(node.impervious_threshold, impervious_incident)
     impervious_runoff::F = impervious_incident - impervious_ET
@@ -264,7 +264,7 @@ function run_symhyd(node::SYMHYDNode, P::F, ET::F, ts::Int64)::NTuple{6,F} where
     baseflow_runoff::F = node.baseflow_coef.val::F * gw_store
     gw_store -= baseflow_runoff
 
-    soil_ET::F = min(sm_store, min(ET - interception_ET, sm_fraction*SYMHYD_SOIL_ET_CONST))
+    soil_ET::F = min(sm_store, min(ET - interception_ET, sm_fraction * SIMHYD_SOIL_ET_CONST))
     sm_store -= soil_ET
 
     pervious_frac::F = node.pervious_fraction.val::F
@@ -274,6 +274,6 @@ function run_symhyd(node::SYMHYDNode, P::F, ET::F, ts::Int64)::NTuple{6,F} where
     total_runoff::F = event_runoff + pervious_frac * baseflow_runoff
     baseflow::F = baseflow_runoff * pervious_frac
 
-	# values for time step...
-	return sm_store, gw_store, total_store, total_runoff, baseflow, event_runoff
+    # values for time step...
+    return sm_store, gw_store, total_store, total_runoff, baseflow, event_runoff
 end

src/Streamfall.jl

@@ -15,7 +15,7 @@ include("Nodes/IHACRES/IHACRESNode.jl")
 # include("Nodes/IHACRES/IHACRESExpuhNode.jl")
 include("Nodes/GR4J/GR4JNode.jl")
 include("Nodes/HyMod/HyModNode.jl")
-include("Nodes/SYMHYD/SYMHYDNode.jl")
+include("Nodes/SIMHYD/SIMHYDNode.jl")
 include("Nodes/DamNode.jl")
 include("Nodes/Ensembles/EnsembleNode.jl")
 
@@ -279,7 +279,7 @@ end
 # Nodes
 export NetworkNode, GenericNode, GenericDirectNode
 export IHACRES, IHACRESNode, IHACRESBilinearNode, DamNode, Climate
-export create_node, GR4JNode, HyModNode, SimpleHyModNode, SYMHYDNode
+export create_node, GR4JNode, HyModNode, SimpleHyModNode, SIMHYDNode
 export EnsembleNode, WeightedEnsembleNode, GREnsembleNode
 
 # Network

test/runtests.jl

@@ -14,7 +14,7 @@ TEST_DIR = @__DIR__
 
     gr4j = create_node(GR4JNode, "GR4J", 100.0)
     hymod = create_node(SimpleHyModNode, "HyMod", 100.0)
-    symhyd = create_node(SYMHYDNode, "SYMHYD", 100.0)
+    simhyd = create_node(SIMHYDNode, "SIMHYD", 100.0)
 
     @testset "Running a single timestep" begin
         # Prep and run a single timestep simulation for each model
@@ -31,8 +31,8 @@ TEST_DIR = @__DIR__
         Streamfall.prep_state!(hymod, 1)
         @test Streamfall.run_timestep!(hymod, 6.0, 3.0, 1) isa AbstractFloat
 
-        Streamfall.prep_state!(symhyd, 1)
-        @test Streamfall.run_timestep!(symhyd, 6.0, 3.0, 1) isa AbstractFloat
+        Streamfall.prep_state!(simhyd, 1)
+        @test Streamfall.run_timestep!(simhyd, 6.0, 3.0, 1) isa AbstractFloat
     end
 
 end