From ef0be3544ff6d400b7111c6200b3bbfc7a7dc6be Mon Sep 17 00:00:00 2001
From: Mazen Ali <mazen.ali@multiversecomputing.com>
Date: Wed, 11 Sep 2024 12:41:15 +0200
Subject: [PATCH] feat (timeit_debug): - add timeit_debug_enabled for
 TimerOutputs - update CodeTiming.md

---
 docs/src/CodeTiming.md  | 18 ++++++++++++++++++
 src/exports.jl          |  1 +
 src/global_variables.jl |  8 ++++++++
 3 files changed, 27 insertions(+)

diff --git a/docs/src/CodeTiming.md b/docs/src/CodeTiming.md
index 3fefa2a0a3..0e12e94926 100644
--- a/docs/src/CodeTiming.md
+++ b/docs/src/CodeTiming.md
@@ -8,3 +8,21 @@ If you are concerned about the performance of your code, a good place to start i
 ## Timing and benchmarking
 
 Julia has many nice timing tools available. Tools like [@time](https://docs.julialang.org/en/v1/base/base/#Base.@time) and [TimerOutputs](https://github.com/KristofferC/TimerOutputs.jl) can be used to measure the time of specific lines of code. For microbenchmarking, we recommend the [BenchmarkTools](https://github.com/JuliaCI/BenchmarkTools.jl) package. For profiling your code, see the Julia documentation on [profiling](https://docs.julialang.org/en/v1/manual/profile/).
+
+## Using TimerOutputs
+```julia
+using TimerOutputs
+using ITensors
+using NDTensors: timer
+...
+
+TimerOutputs.enable_debug_timings(ITensors)
+@timeit timer "dmrg" energy, _ = dmrg(mpo, mps;
+                                      nsweeps=nsweeps,
+                                      maxdim=maxdim,
+                                      mindim=maxdim,
+                                      cutoff=cutoff,
+                                      outputlevel=0)
+println("Energy = $energy")
+println(timer)
+```
diff --git a/src/exports.jl b/src/exports.jl
index 51fce7f746..14009242f5 100644
--- a/src/exports.jl
+++ b/src/exports.jl
@@ -35,6 +35,7 @@ export
   contract,
   # global_variables.jl
   # Methods
+  timeit_debug_enabled,
   # Macros
   @disable_warn_order,
   @reset_warn_order,
diff --git a/src/global_variables.jl b/src/global_variables.jl
index 18ef622ac2..dfea610003 100644
--- a/src/global_variables.jl
+++ b/src/global_variables.jl
@@ -209,3 +209,11 @@ function disable_contraction_sequence_optimization()
   _using_contraction_sequence_optimization[] = false
   return nothing
 end
+
+#
+# Turn debug timer for TimerOutputs on and off
+#
+
+function timeit_debug_enabled()
+  return false
+end