Updates to comments/docstrings/documentation

Author: ConnectedSystems

docs/src/EnsembleNode.md

@@ -0,0 +1,7 @@
+# GR4J
+
+```@autodocs
+Modules = [Streamfall]
+Order   = [:function, :type]
+Pages   = ["EnsembleNode.jl"]
+```

docs/src/SYMHYD.md

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

src/IHACRESNode.jl

@@ -35,7 +35,7 @@ Base.@kwdef mutable struct BilinearNode{P, A<:Real} <: IHACRESNode
         Param(150.0, bounds=(50.0, 200.0)) # ctf
     ]
 
-    storage::Array{A} = [100.0]
+    storage::Array{A} = [100.0]  # CMD
     quick_store::Array{A} = [0.0]
     slow_store::Array{A} = [0.0]
     outflow::Array{A} = []
@@ -541,6 +541,14 @@ function update_params!(node::BilinearNode, d::Float64, d2::Float64, e::Float64,
     node.b = Param(b, bounds=node.b.bounds::Tuple)
     node.storage_coef = Param(s_coef, bounds=node.storage_coef.bounds::Tuple)
     node.alpha = Param(alpha, bounds=node.alpha.bounds::Tuple)
+    # node.d = d
+    # node.d2 = d2
+    # node.e = e
+    # node.f = f
+    # node.a = a
+    # node.b = b
+    # node.storage_coef = s_coef
+    # node.alpha = alpha
 
     return nothing
 end
@@ -565,6 +573,14 @@ function update_params!(node::BilinearNode, d::Float64, d2::Float64, e::Float64,
     node.b = Param(b, bounds=node.b.bounds::Tuple)
     node.storage_coef = Param(s_coef, bounds=node.storage_coef.bounds::Tuple)
     node.alpha = Param(alpha, bounds=node.alpha.bounds::Tuple)
+    # node.d = d
+    # node.d2 = d2
+    # node.e = e
+    # node.f = f
+    # node.a = a
+    # node.b = b
+    # node.storage_coef = s_coef
+    # node.alpha = alpha
 
     n_lparams = node.level_params
     node.level_params = [

src/Node.jl

@@ -17,7 +17,7 @@ Base.@kwdef mutable struct GenericNode <: NetworkNode
 end
 
 
-"""Create an arbitrary node."""
+"""Create node of a given type."""
 function create_node(node::Type{<:NetworkNode}, name::String, area::Float64)
     return node{Param, Float64}(; name=name, area=area)
 end

src/plotting.jl

@@ -110,7 +110,7 @@ end
 
 
 """
-    temporal_cross_section(dates, obs; ylabel=nothing, period::Function=month)
+    temporal_cross_section(dates, obs; ylabel=nothing, period::Function=monthday)
 
 Provides indication of temporal variation and uncertainty across time, grouped by `period`.
 
@@ -125,7 +125,7 @@ Filters out leap days.
 - `period::Function` : Method from `Dates` package to group (defaults to `monthday`)
 """
 function temporal_cross_section(dates, obs;
-                                title="", ylabel="Median Error", label=nothing, 
+                                title="", ylabel="ME", label=nothing, 
                                 period::Function=monthday,
                                 kwargs...)  # show_extremes::Bool=false, 
     if isnothing(label)
@@ -153,6 +153,8 @@ function temporal_cross_section(dates, obs;
         else
             target = xsect_res.cross_section
         end
+    else
+        target = xsect_res.cross_section
     end
 
     x_section = target.median
@@ -171,10 +173,8 @@ function temporal_cross_section(dates, obs;
         delete!(kwargs, :yaxis)
     end
 
-    xsect_df = xsect_res.cross_section
-
     # Display indicator values using original data instead of log-transformed data
-    med = xsect_df.median
+    med = xsect_res.cross_section.median
     m_ind = round(mean(med), digits=2)
     sd_ind = round(std(med), digits=2)
 
@@ -186,7 +186,7 @@ function temporal_cross_section(dates, obs;
     fig = plot(xlabels, lower_95, fillrange=upper_95, color="lightblue", alpha=0.3, label="CI₉₅ μ: $(wr95_m_ind), σ: $(wr95_sd_ind)", linealpha=0)
     plot!(fig, xlabels, lower_75, fillrange=upper_75, color="lightblue", alpha=0.5, label="CI₇₅ μ: $(wr75_m_ind), σ: $(wr75_sd_ind)", linealpha=0)
     plot!(fig, xlabels, x_section,
-            label="$(label) μ: $(m_ind), σ: $(sd_ind)",
+            label="Median of $(label) μ: $(m_ind), σ: $(sd_ind)",
             color="black",
             xlabel=nameof(period),
             ylabel=ylabel,