Merge pull request #1141 from jd-lara/export_opt_model_setting

Export opt model setting

src/core/settings.jl

@@ -16,6 +16,7 @@ struct Settings
     export_pwl_vars::Bool
     allow_fails::Bool
     rebuild_model::Bool
+    export_optimization_model::Bool
     store_variable_names::Bool
     check_numerical_bounds::Bool
     ext::Dict{String, Any}
@@ -41,6 +42,7 @@ function Settings(
     allow_fails::Bool = false,
     check_numerical_bounds = true,
     rebuild_model = false,
+    export_optimization_model = false,
     store_variable_names = false,
     ext = Dict{String, Any}(),
 )
@@ -77,6 +79,7 @@ function Settings(
         export_pwl_vars,
         allow_fails,
         rebuild_model,
+        export_optimization_model,
         store_variable_names,
         check_numerical_bounds,
         ext,
@@ -151,6 +154,7 @@ get_detailed_optimizer_stats(settings::Settings) = settings.detailed_optimizer_s
 get_direct_mode_optimizer(settings::Settings) = settings.direct_mode_optimizer
 get_store_variable_names(settings::Settings) = settings.store_variable_names
 get_rebuild_model(settings::Settings) = settings.rebuild_model
+get_export_optimization_model(settings::Settings) = settings.export_optimization_model
 use_time_series_cache(settings::Settings) = settings.time_series_cache_size > 0
 
 function set_horizon!(settings::Settings, horizon::Dates.TimePeriod)

src/operation/decision_model.jl

@@ -114,6 +114,7 @@ function DecisionModel{M}(
     direct_mode_optimizer = false,
     store_variable_names = false,
     rebuild_model = false,
+    export_optimization_model = false,
     check_numerical_bounds = true,
     initial_time = UNSET_INI_TIME,
     time_series_cache_size::Int = IS.TIME_SERIES_CACHE_SIZE_BYTES,
@@ -139,6 +140,7 @@ function DecisionModel{M}(
         check_numerical_bounds = check_numerical_bounds,
         store_variable_names = store_variable_names,
         rebuild_model = rebuild_model,
+        export_optimization_model = export_optimization_model,
     )
     return DecisionModel{M}(template, sys, settings, jump_model; name = name)
 end
@@ -444,7 +446,7 @@ keyword arguments to that function.
   - `console_level = Logging.Error`:
   - `file_level = Logging.Info`:
   - `disable_timer_outputs = false` : Enable/Disable timing outputs
-  - `serialize::Bool = true`: If true, serialize the model to a file to allow re-execution later.
+  - `export_optimization_problem::Bool = true`: If true, serialize the model to a file to allow re-execution later.
 
 # Examples
 
@@ -459,7 +461,7 @@ function solve!(
     console_level = Logging.Error,
     file_level = Logging.Info,
     disable_timer_outputs = false,
-    serialize = true,
+    export_optimization_problem = true,
     kwargs...,
 )
     build_if_not_already_built!(
@@ -500,7 +502,7 @@ function solve!(
                         current_time,
                     )
                 end
-                if serialize
+                if export_optimization_problem
                     TimerOutputs.@timeit RUN_OPERATION_MODEL_TIMER "Serialize" begin
                         serialize_problem(model; optimizer = optimizer)
                         serialize_optimization_model(model)

src/operation/emulation_model.jl

@@ -507,7 +507,7 @@ keyword arguments to that function.
   - `export_problem_results::Bool`: If true, export OptimizationProblemResults DataFrames to CSV files.
   - `output_dir::String`: Required if the model is not already built, otherwise ignored
   - `enable_progress_bar::Bool`: Enables/Disable progress bar printing
-  - `serialize::Bool`: If true, serialize the model to a file to allow re-execution later.
+  - `export_optimization_model::Bool`: If true, serialize the model to a file to allow re-execution later.
 
 # Examples
 
@@ -522,7 +522,7 @@ function run!(
     console_level = Logging.Error,
     file_level = Logging.Info,
     disable_timer_outputs = false,
-    serialize = true,
+    export_optimization_model = true,
     kwargs...,
 )
     build_if_not_already_built!(
@@ -555,7 +555,7 @@ function run!(
                     run_impl!(model; kwargs...)
                     set_run_status!(model, RunStatus.SUCCESSFULLY_FINALIZED)
                 end
-                if serialize
+                if export_optimization_model
                     TimerOutputs.@timeit RUN_OPERATION_MODEL_TIMER "Serialize" begin
                         optimizer = get(kwargs, :optimizer, nothing)
                         serialize_problem(model; optimizer = optimizer)

src/operation/operation_model_interface.jl

@@ -104,13 +104,22 @@ end
 
 function solve_impl!(model::OperationModel)
     container = get_optimization_container(model)
+    model_name = get_name(model)
+    ts = get_current_timestamp(model)
+    output_dir = get_output_dir(model)
+
+    if get_export_optimization_model(get_settings(model))
+        model_output_dir = joinpath(output_dir, "optimization_model_exports")
+        mkpath(model_output_dir)
+        tss = replace("$(ts)", ":" => "_")
+        model_export_path = joinpath(model_output_dir, "exported_$(model_name)_$(tss).json")
+        serialize_optimization_model(container, model_export_path)
+    end
+
     status = solve_impl!(container, get_system(model))
     set_run_status!(model, status)
     if status != RunStatus.SUCCESSFULLY_FINALIZED
         settings = get_settings(model)
-        model_name = get_name(model)
-        ts = get_current_timestamp(model)
-        output_dir = get_output_dir(model)
         infeasible_opt_path = joinpath(output_dir, "infeasible_$(model_name).json")
         @error("Serializing Infeasible Problem at $(infeasible_opt_path)")
         serialize_optimization_model(container, infeasible_opt_path)

test/test_model_emulation.jl

@@ -223,7 +223,7 @@ end
             model;
             executions = 10,
             output_dir = mktempdir(; cleanup = true),
-            serialize = serialize,
+            export_optimization_model = serialize,
         ) == PSI.RunStatus.SUCCESSFULLY_FINALIZED
     end
 end

test/test_simulation_execute.jl

@@ -1,4 +1,5 @@
-function test_single_stage_sequential(in_memory, rebuild)
+function test_single_stage_sequential(in_memory, rebuild, export_model)
+    tmp_dir = mktempdir(; cleanup = true)
     template_ed = get_template_nomin_ed_simulation()
     c_sys = PSB.build_system(PSITestSystems, "c_sys5_uc")
     models = SimulationModels([
@@ -8,6 +9,7 @@ function test_single_stage_sequential(in_memory, rebuild)
             name = "ED",
             optimizer = ipopt_optimizer,
             rebuild_model = rebuild,
+            export_optimization_model = export_model,
         ),
     ])
     test_sequence =
@@ -20,20 +22,29 @@ function test_single_stage_sequential(in_memory, rebuild)
         steps = 2,
         models = models,
         sequence = test_sequence,
-        simulation_folder = mktempdir(; cleanup = true),
+        simulation_folder = tmp_dir,
     )
     build_out = build!(sim_single)
     @test build_out == PSI.SimulationBuildStatus.BUILT
     execute_out = execute!(sim_single; in_memory = in_memory)
     @test execute_out == PSI.RunStatus.SUCCESSFULLY_FINALIZED
+    return tmp_dir
 end
 
 @testset "Single stage sequential tests" begin
     for in_memory in (true, false), rebuild in (true, false)
-        test_single_stage_sequential(in_memory, rebuild)
+        test_single_stage_sequential(in_memory, rebuild, false)
     end
 end
 
+@testset "Test model export at each solve" begin
+    folder = test_single_stage_sequential(true, false, true)
+    test_path =
+        joinpath(folder, "consecutive", "problems", "ED", "optimization_model_exports")
+    @test ispath(test_path)
+    @test length(readdir(test_path)) == 2
+end
+
 function test_2_stage_decision_models_with_feedforwards(in_memory)
     template_uc = get_template_basic_uc_simulation()
     template_ed = get_template_nomin_ed_simulation()