Merge pull request #978 from ProjectTorreyPines/feat/study_database

Introduce In‑Memory Study Database Type

Author: TimSlendebroek

src/FUSE.jl

@@ -178,6 +178,7 @@ include("studies.jl")
 include(joinpath("studies", "database_generator.jl"))
 include(joinpath("studies", "multi_objective_optimization.jl"))
 include(joinpath("studies", "TGLF_database.jl"))
+include(joinpath("studies", "study_database.jl"))
 include(joinpath("studies", "experiment_postdictive.jl"))
 
 #= ========= =#

src/optimization.jl

@@ -206,7 +206,7 @@ function optimization_engine(
         df[!, :elapsed_time] = fill(time()-start_time, nrow(df))
 
         # save simulation data
-        save_database("tmp_h5_output", parent_group, (save_dd ? dd : nothing), ini, act, tmp_log_io;
+        save_study_database("tmp_h5_output", parent_group, (save_dd ? dd : nothing), ini, act, tmp_log_io;
             timer=true, freeze=false, overwrite_groups=true)
 
         # Write into temporary csv files, in case the whole Julia session is crashed
@@ -250,7 +250,7 @@ function optimization_engine(
         df[!, :elapsed_time] = fill(time()-start_time, nrow(df))
 
         # save empty dd and error to directory
-        save_database("tmp_h5_output", parent_group, nothing, ini, act, tmp_log_io;
+        save_study_database("tmp_h5_output", parent_group, nothing, ini, act, tmp_log_io;
             error_info=e, timer=true, freeze=false, overwrite_groups=true, kw...)
 
         # Write into temporary csv files, in case the whole Julia session is crashed

src/studies/database_generator.jl

@@ -227,7 +227,7 @@ function run_case(study::AbstractStudy, item::Int, ::Val{:hdf5}; kw...)
         df[!, :worker_id] = fill(myid, nrow(df))
         df[!, :elapsed_time] = fill(time() - start_time, nrow(df))
 
-        save_database("tmp_h5_output", parent_group, (sty.save_dd ? dd : IMAS.dd()), ini, act, tmp_log_io; timer=true, freeze=false, overwrite_groups=true, kw...)
+        save_study_database("tmp_h5_output", parent_group, (sty.save_dd ? dd : IMAS.dd()), ini, act, tmp_log_io; timer=true, freeze=false, overwrite_groups=true, kw...)
 
         # Write into temporary csv files, in case the whole Julia session is crashed
         tmp_csv_folder = "tmp_csv_output"
@@ -253,7 +253,7 @@ function run_case(study::AbstractStudy, item::Int, ::Val{:hdf5}; kw...)
         df[!, :elapsed_time] = fill(time() - start_time, nrow(df))
 
         # save empty dd and error to directory
-        save_database("tmp_h5_output", parent_group, nothing, ini, act, tmp_log_io; error_info=e, timer=true, freeze=false, overwrite_groups=true, kw...)
+        save_study_database("tmp_h5_output", parent_group, nothing, ini, act, tmp_log_io; error_info=e, timer=true, freeze=false, overwrite_groups=true, kw...)
 
         # Write into temporary csv files, in case the whole Julia session is crashed
         tmp_csv_folder = "tmp_csv_output"

src/studies/multi_objective_optimization.jl

@@ -39,6 +39,7 @@ mutable struct StudyMultiObjectiveOptimizer{T<:Real} <: AbstractStudy
     dataframe::Union{DataFrame,Missing}
     datafame_filtered::Union{DataFrame,Missing}
     generation::Int
+    workflow::Union{Function,Missing}
 end
 
 function StudyMultiObjectiveOptimizer(
@@ -50,8 +51,7 @@ function StudyMultiObjectiveOptimizer(
     kw...
 )
     sty = OverrideParameters(sty; kw...)
-    study = StudyMultiObjectiveOptimizer(sty, ini, act, constraint_functions, objective_functions, nothing, missing, missing, 0)
-
+    study = StudyMultiObjectiveOptimizer(sty, ini, act, constraint_functions, objective_functions, nothing, missing, missing, 0, missing)
     check_and_create_file_save_mode(sty)
 
     parallel_environment(sty.server, sty.n_workers)
@@ -102,7 +102,6 @@ function _run(study::StudyMultiObjectiveOptimizer)
         @info "released workers"
 
     else
-        setup(study)
         optimization_parameters = Dict(
             :N => sty.population_size,
             :iterations => sty.number_of_generations,
@@ -111,8 +110,12 @@ function _run(study::StudyMultiObjectiveOptimizer)
 
         @assert !isempty(sty.save_folder) "Specify where you would like to store your optimization results in sty.save_folder"
 
+        if ismissing(study.workflow)
+            study.workflow = optimization_workflow_default
+        end
+
         study.state = workflow_multiobjective_optimization(
-            study.ini, study.act, ActorWholeFacility, study.objective_functions, study.constraint_functions;
+            study.ini, study.act, study.workflow, study.objective_functions, study.constraint_functions;
             optimization_parameters..., generation_offset=study.generation, sty.database_policy,
             sty.number_of_generations, sty.population_size)
 
@@ -233,4 +236,15 @@ function filter_outputs(outputs::DataFrame, constraint_symbols::Vector{Symbol})
     constraint_values = [outputs[i, key] for key in constraint_symbols, i in 1:n]
     all_constraint_idxs = findall(i -> all(x -> x == 0.0, constraint_values[:, i]), 1:n)
     return outputs[all_constraint_idxs, :]
+end
+
+"""
+    optimization_workflow_default(ini::ParametersAllInits, act::ParametersAllActors)
+Default optimization workflow when study.workflow isn't set, initializes and runs the whole facility actor
+"""
+function optimization_workflow_default(ini::ParametersAllInits, act::ParametersAllActors)
+    dd = FUSE.IMAS.dd()
+    FUSE.init(dd, ini, act)
+    FUSE.ActorWholeFacility(dd, act)
+    return dd
 end