Merge pull request #742 from mimiframework/sobol

GlobalSA and Sobol Fixes

Author: lrennels

Project.toml

@@ -43,7 +43,7 @@ Distributions = "0.21, 0.22, 0.23"
 Electron = "1.1, 2.0, 3.0"
 FileIO = "1"
 FilePaths = "0.8"
-GlobalSensitivityAnalysis = "0.0.9, 0.0.10"
+GlobalSensitivityAnalysis = "1.0"
 GraphPlot = "0.3, 0.4"
 IterTools = "1.3"
 IteratorInterfaceExtensions = "0.1.1, 1"

docs/src/tutorials/tutorial_5.md

@@ -205,7 +205,7 @@ sd = @defsim begin
     # Exclude the sampling() call, or use the following for simple random sampling:
     # sampling(MCSData)
 
-    # For Sobol sampling, specify N, and calc_second_order, which defaults to false.
+    # For Sobol sampling, specify N, and calc_second_order, which defaults to true.
     # sampling(SobolData, N=10000, calc_second_order=true)
 
     # assign RVs to model Parameters

src/mcs/sobol.jl

@@ -4,7 +4,7 @@ import GlobalSensitivityAnalysis
 mutable struct SobolData <: AbstractSimulationData
     calc_second_order::Bool
 
-    function SobolData(;calc_second_order = false)
+    function SobolData(;calc_second_order = true)
         return new(calc_second_order)
     end
 end
@@ -50,15 +50,15 @@ function sample!(sim_inst::SobolSimulationInstance, samplesize::Int)
     end
 end
 
-function analyze(sim_inst::SobolSimulationInstance, model_output::AbstractArray{<:Number, N}; num_resamples::Union{Nothing, Int} = 10_000, conf_level::Union{Nothing, Number} = 0.95) where N
+function analyze(sim_inst::SobolSimulationInstance, model_output::AbstractArray{<:Number, N}; num_resamples::Union{Nothing, Int} = 10_000, conf_level::Union{Nothing, Number} = 0.95, N_override::Union{Nothing, Int}=nothing, progress_meter::Bool = true) where N
 
     if sim_inst.trials == 0
         error("Cannot analyze simulation with 0 trials.")
     end
 
     payload = create_GSA_payload(sim_inst)
 
-    return GlobalSensitivityAnalysis.analyze(payload, model_output; num_resamples = num_resamples, conf_level = conf_level)
+    return GlobalSensitivityAnalysis.analyze(payload, model_output; num_resamples = num_resamples, conf_level = conf_level, N_override = N_override, progress_meter = progress_meter)
 end
 
 function create_GSA_payload(sim_inst::SobolSimulationInstance)

test/mcs/test_defmcs_sobol.jl

@@ -68,7 +68,8 @@ results_disk[!,2] = Symbol.(results_disk[!,2])
 
 # do some analysis
 E = CSVFiles.load(joinpath(output_dir, "emissions_E.csv")) |> DataFrame
-results = analyze(si, E[1:60:end, 3]; num_resamples = 10_000, conf_level = 0.95)
+results = analyze(si, E[1:60:end, 3]; progress_meter = false, N_override = 100)
+results = analyze(si, E[1:60:end, 3]; progress_meter = false, num_resamples = 10_000, conf_level = 0.95)
 
 function show_E_Region(year::Int; region = "Region1", bins=40)
     df = @from i in E begin