Update tests with latest changes

Author: ConnectedSystems

examples/run_nodes.jl

@@ -9,65 +9,67 @@ data_path = joinpath(here, "../test/data/campaspe/")
 # Load and generate stream network
 sn = load_network("Example Network", joinpath(data_path, "campaspe_network.yml"))
 
-# Load climate data
-date_format = "YYYY-mm-dd"
+# The Campaspe catchment is represented as a network of eight nodes, including one dam.
+# All nodes use the IHACRES_CMD rainfall-runoff model.
+plot_network(sn)
+
+# Load climate data - in this case from a CSV file with data for all nodes.
 climate_data = CSV.read(
-    joinpath(data_path, "climate/climate_historic.csv"),
+    joinpath(data_path, "climate", "climate.csv"),
     DataFrame;
-    comment="#",
-    dateformat=date_format
+    comment="#"
 )
 
-dam_level_fn = joinpath(data_path, "gauges/406000_historic_levels_for_fit.csv")
-dam_releases_fn = joinpath(data_path, "gauges/406000_historic_outflow.csv")
-hist_dam_levels = CSV.read(dam_level_fn, DataFrame; dateformat=date_format)
-hist_dam_releases = CSV.read(dam_releases_fn, DataFrame; dateformat=date_format)
-
-rename!(hist_dam_releases, ["406000_outflow_[ML]" => "406000_releases_[ML]"])
+# Indicate which columns are precipitation and evaporation data based on partial identifiers
+climate = Climate(climate_data, "_rain", "_evap")
 
-# Subset to same range
-climate_data, hist_dam_levels, hist_dam_releases = Streamfall.align_time_frame(
-    climate_data,
-    hist_dam_levels,
-    hist_dam_releases
+# Historic flows and dam level data
+calib_data = CSV.read(
+    joinpath(data_path, "gauges", "outflow_and_level.csv"),
+    DataFrame;
+    comment="#"
 )
 
-climate = Climate(climate_data, "_rain", "_evap")
+# Historic extractions from the dam
+extraction_data = CSV.read(
+    joinpath(data_path, "gauges", "dam_extraction.csv"),
+    DataFrame;
+    comment="#"
+)
 
 @info "Running example stream..."
 
-reset!(sn)
-
 dam_id, dam_node = sn["406000"]
-Streamfall.run_node!(sn, dam_id, climate; extraction=hist_dam_releases)
+Streamfall.run_node!(sn, dam_id, climate; extraction=extraction_data)
 
-h_data = hist_dam_levels[:, "Dam Level [mAHD]"]
-n_data = dam_node.level
+# Extract data for comparison with 1-year burn-in period
+dam_obs = calib_data[:, "406000"][366:end]
+dam_sim = dam_node.level[366:end]
 
-nnse_score = Streamfall.NNSE(h_data, n_data)
-nse_score = Streamfall.NSE(h_data, n_data)
-rmse_score = Streamfall.RMSE(h_data, n_data)
+nnse_score = Streamfall.NNSE(dam_obs, dam_sim)
+nse_score = Streamfall.NSE(dam_obs, dam_sim)
+rmse_score = Streamfall.RMSE(dam_obs, dam_sim)
 
 @info "Obj Func Scores:" rmse_score nnse_score nse_score
 
 nse = round(nse_score, digits=4)
 rmse = round(rmse_score, digits=4)
 
-
 import Dates: month, monthday, yearmonth
 
-Streamfall.temporal_cross_section(climate_data.Date, h_data, n_data; period=monthday)
-savefig("temporal_xsection_monthday_ME.png")
+climate_burnin = climate_data[366:end, :Date]
+Streamfall.temporal_cross_section(climate_burnin, dam_obs, dam_sim; period=monthday)
+# savefig("temporal_xsection_monthday_ME.png")
 
-Streamfall.temporal_cross_section(climate_data.Date, h_data, n_data; period=yearmonth)
-savefig("temporal_xsection_yearmonth_ME.png")
+Streamfall.temporal_cross_section(climate_burnin, dam_obs, dam_sim; period=yearmonth)
+# savefig("temporal_xsection_yearmonth_ME.png")
 
 # Displaying results and saving figure
-# plot(h_data,
+# plot(dam_obs,
 #      legend=:bottomleft,
 #      title="Calibrated IHACRES\n(RMSE: $(rmse); NSE: $(nse))",
 #      label="Historic", xlabel="Day", ylabel="Dam Level [mAHD]")
 
-# display(plot!(n_data, label="IHACRES"))
+# display(plot!(dam_sim, label="IHACRES"))
 
 # savefig("calibrated_example.png")

test/data/campaspe/campaspe_network.yml

@@ -4,7 +4,7 @@
   parameters:
     d: 134.06756067826717
     d2: 1.547403668682315
-    e: 1.4999999999988058
+    e: 1.0
     f: 0.9782888516330152
     a: 1.878670093410396
     b: 0.09999999999990782
@@ -18,14 +18,14 @@
   node_type: "IHACRESBilinearNode"
   area: 1985.73
   parameters:
-    d: 362.4510877543127
-    d2: 1.7219537856770573
-    e: 0.7005591278054522
-    f: 1.4769086447109885
-    a: 5.065870561569431
-    b: 0.0966380343175847
-    storage_coef: 4.534349325043295
-    alpha: 0.7372499431622979
+    d: 205.9296682315772
+    d2: 1.5219519661190162
+    e: 1.0
+    f: 1.1612900313855028
+    a: 9.999999999175559
+    b: 0.0011479482142380236
+    storage_coef: 9.99999999952744
+    alpha: 0.8917155227322869
   initial_storage: 100.0
   inlets: ~
   outlets:
@@ -38,8 +38,6 @@
   initial_storage: 0.0
   max_storage: 306000.0
   functions:
-    # Define methods that convert volume to level, area, discharge, and outflow.
-    # Methods defined here must take volume as input
     calc_dam_level: |-
       function c_dam_level(volume)
           return 156.8 + 0.9463 * volume^0.2922
@@ -48,7 +46,6 @@
       function c_dam_area(volume)
           return 0.0021 * volume^0.762
       end
-    # Discharge calculation must take volume and max_storage parameters
     calc_dam_discharge: |-
       function c_dam_discharge(volume, max_storage)
           discharge = 0.0
@@ -58,7 +55,6 @@
 
           return max(0.0, discharge)
       end
-    # Outflow must accept discharge and extraction inputs
     calc_dam_outflow: |-
       function c_dam_outflow(discharge, irrigation_extraction)
           return discharge + irrigation_extraction
@@ -73,7 +69,7 @@
   parameters:
     d: 34.44232768248571
     d2: 0.032214212326022326
-    e: 0.2152471390979227
+    e: 1.0
     f: 2.9999999999999147
     a: 1.270124950108292
     b: 0.0999999117504344
@@ -91,7 +87,7 @@
   parameters:
     d: 48.38395701197697
     d2: 2.293996656199082
-    e: 1.1158650210585603
+    e: 1.0
     f: 1.4405724030125124
     a: 3.7408302145617087
     b: 0.0011959104715538137
@@ -107,7 +103,7 @@
   parameters:
     d: 152.62331896278664
     d2: 0.5399110983080897
-    e: 1.4729023737877482
+    e: 1.0
     f: 1.6458403364664287
     a: 9.400598795169456
     b: 0.04492942366402773
@@ -125,7 +121,7 @@
   parameters:
     d: 230.10173616444285
     d2: 0.3985548134635746
-    e: 1.3664818534158052
+    e: 1.0
     f: 1.525077957112293
     a: 4.114196548002251
     b: 0.026191008249266696
@@ -142,7 +138,7 @@
   parameters:
     d: 110.53645289579511
     d2: 4.354852331236118
-    e: 1.254596727030465
+    e: 1.0
     f: 2.5833889457293613
     a: 0.30247124389394187
     b: 0.012073002123341786

test/temporal_xsection_monthday_ME.png

@@ -4,42 +4,42 @@ using Test
 using Dates, DataFrames, CSV
 using Streamfall
 
+@testset "Data alignment" begin
 
-here = @__DIR__
-climate_data = joinpath(here, "data/campaspe/climate/climate_historic.csv")
-dam_data_loc = joinpath(here, "data/campaspe/gauges")
-
-# Read in test data
-climate_data = CSV.File(climate_data, comment="#", dateformat="YYYY-mm-dd") |> DataFrame
-hist_dam_levels = CSV.File(joinpath(dam_data_loc, "406000_historic_levels_for_fit.csv"), dateformat="YYYY-mm-dd") |> DataFrame
-hist_dam_releases = CSV.File(joinpath(dam_data_loc, "406000_historic_outflow.csv"), dateformat="YYYY-mm-dd") |> DataFrame
+    here = @__DIR__
+    climate_data = joinpath(here, "data/campaspe/climate/climate_historic.csv")
+    dam_data_loc = joinpath(here, "data/campaspe/gauges")
 
+    # Read in test data
+    climate_data = CSV.File(climate_data, comment="#", dateformat="YYYY-mm-dd") |> DataFrame
+    hist_dam_levels = CSV.File(joinpath(dam_data_loc, "406000_historic_levels_for_fit.csv"), dateformat="YYYY-mm-dd") |> DataFrame
+    hist_dam_releases = CSV.File(joinpath(dam_data_loc, "406000_historic_outflow.csv"), dateformat="YYYY-mm-dd") |> DataFrame
 
-@testset "Min/max date finding" begin
-    min_date, max_date = Streamfall.find_common_timeframe(climate_data, hist_dam_levels, hist_dam_releases)
+    @testset "Min/max date finding" begin
+        min_date, max_date = Streamfall.find_common_timeframe(climate_data, hist_dam_levels, hist_dam_releases)
 
-    @test min_date == Date("1981-01-01")
-    @test max_date == Date("2015-07-30")
-end
-
-@testset "Data alignment" begin
+        @test min_date == Date("1981-01-01")
+        @test max_date == Date("2015-07-30")
+    end
 
-    # Mismatched start/end dates
-    dam_levels = hist_dam_levels[10:end, :]
-    dam_releases = hist_dam_releases[20:10000, :]
+    @testset "Aligning mismatched datasets" begin
+        # Mismatched start/end dates
+        dam_levels = hist_dam_levels[10:end, :]
+        dam_releases = hist_dam_releases[20:10000, :]
 
-    # Subset to common time period
-    c, dl, dr = Streamfall.align_time_frame(climate_data, dam_levels, dam_releases)
+        # Subset to common time period
+        c, dl, dr = Streamfall.align_time_frame(climate_data, dam_levels, dam_releases)
 
-    # Ensure time periods are the same
-    @test c.Date[1] == dl.Date[1] == dr.Date[1]
-    @test c.Date[end] == dl.Date[end] == dr.Date[end]
+        # Ensure time periods are the same
+        @test c.Date[1] == dl.Date[1] == dr.Date[1]
+        @test c.Date[end] == dl.Date[end] == dr.Date[end]
 
-    # Ensure originals have not been modified
-    @test climate_data.Date[1] != c.Date[1]
-    @test hist_dam_levels.Date[1] != dl.Date[1]
-    @test hist_dam_releases.Date[1] != dr.Date[1]
+        # Ensure originals have not been modified
+        @test climate_data.Date[1] != c.Date[1]
+        @test hist_dam_levels.Date[1] != dl.Date[1]
+        @test hist_dam_releases.Date[1] != dr.Date[1]
 
-    @test hist_dam_levels.Date[end] != dl.Date[end]
-    @test hist_dam_releases.Date[end] != dr.Date[end]
+        @test hist_dam_levels.Date[end] != dl.Date[end]
+        @test hist_dam_releases.Date[end] != dr.Date[end]
+    end
 end

test/temporal_xsection_yearmonth_ME.png

@@ -113,13 +113,13 @@ end
         # Ensure example does not error out
 
         reset!(sn)
-        run_basin!(sn, climate; extraction=hist_dam_releases)
-        @test Streamfall.RMSE(n_data, sn[dam_id].level) == 0.0
+        run_basin!(sn, climate; extraction=extraction_data)
+        @test Streamfall.RMSE(dam_obs, sn[dam_id].level[366:end]) < 2.5
 
 
         reset!(sn)
-        Streamfall.run_node!(sn, dam_id, climate; extraction=hist_dam_releases)
-        @test Streamfall.RMSE(n_data, sn[dam_id].level) == 0.0
+        Streamfall.run_node!(sn, dam_id, climate; extraction=extraction_data)
+        @test Streamfall.RMSE(dam_obs, sn[dam_id].level[366:end]) < 2.5
 
         # Ensure example results haven't changed much...
         # @test nse_score >= 0.95 && nse_score < 1.0 && rmse < 2.0