Fix for disable_timer_outputs (#346)

* typo in docstring * fix disabling timer * add test
NREL-Sienna · Jul 31, 2023 · f50405c · f50405c
1 parent 2dfe486
commit f50405c
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 4 deletions.
diff --git a/src/base/simulation.jl b/src/base/simulation.jl
@@ -104,7 +104,7 @@ Builds the simulation object and conducts the indexing process. The original sys
 - `system_to_file::Bool` : Default `false`. Serializes the initialized system
 - `console_level::Logging` : Default `Logging.Warn`. Sets the level of logging output to the console. Can be set to `Logging.Error`, `Logging.Warn`, `Logging.Info` or `Logging.Debug`
 - `file_level::Logging` : Default `Logging.Info`. Sets the level of logging output to file. Can be set to `Logging.Error`, `Logging.Warn`, `Logging.Info` or `Logging.Debug`
-- `disable_timer_output::Bool` : Default `false`. Allows the user to display timer information about the construction and initilization of the Simulation.
+- `disable_timer_outputs::Bool` : Default `false`. Allows the user to display timer information about the construction and initilization of the Simulation.
 """
 function Simulation!(
     ::Type{T},
@@ -161,7 +161,7 @@ Builds the simulation object and conducts the indexing process. The initial cond
 - `system_to_file::Bool` : Default `false`. Serializes the initialized system
 - `console_level::Logging` : Default `Logging.Warn`. Sets the level of logging output to the console. Can be set to `Logging.Error`, `Logging.Warn`, `Logging.Info` or `Logging.Debug`
 - `file_level::Logging` : Default `Logging.Info`. Sets the level of logging output to file. Can be set to `Logging.Error`, `Logging.Warn`, `Logging.Info` or `Logging.Debug`
-- `disable_timer_output::Bool` : Default `false`. Allows the user to display timer information about the construction and initilization of the Simulation.
+- `disable_timer_outputs::Bool` : Default `false`. Allows the user to display timer information about the construction and initilization of the Simulation.
 """
 function Simulation(
     ::Type{T},
@@ -379,9 +379,11 @@ function _build!(sim::Simulation{T}; kwargs...) where {T <: SimulationModel}
     check_kwargs(kwargs, SIMULATION_ACCEPTED_KWARGS, "Simulation")
     # Branches are a super set of Lines. Passing both kwargs will
     # be redundant.
-    TimerOutputs.reset_timer!(BUILD_TIMER)
     if get(kwargs, :disable_timer_outputs, false)
-        TimerOutputs.disable_timer!(BUILD_PROBLEMS_TIMER)
+        TimerOutputs.disable_timer!(BUILD_TIMER)
+    else
+        TimerOutputs.enable_timer!(BUILD_TIMER)
+        TimerOutputs.reset_timer!(BUILD_TIMER)
     end
 
     TimerOutputs.@timeit BUILD_TIMER "Build Simulation" begin

diff --git a/test/test_base.jl b/test/test_base.jl
@@ -137,6 +137,26 @@ end
     end
 end
 
+@testset "Simulation kwargs: disable_timer_outputs" begin
+    path = mktempdir()
+    try
+        #Define Simulation Problem
+        sim = Simulation(
+            ResidualModel,
+            omib_sys, #system
+            path,
+            (0.0, 30.0); #time span
+            system_to_file = true,
+            console_level = Logging.Error,
+            disable_timer_outputs = true,
+        )
+        @test sim.status == PSID.BUILT
+    finally
+        @info("removing test files")
+        rm(path; force = true, recursive = true)
+    end
+end
+
 @testset "Hybrid Line Indexing" begin
     ## Create threebus system with more dyn lines ##
     three_bus_file_dir = joinpath(TEST_FILES_DIR, "data_tests/ThreeBusInverter.raw")