swap default of kill_canceled_sims from True to False, and briefly me…

…ntion in calc_cancel_tutorial
Libensemble · Aug 18, 2023 · d059d32 · d059d32
1 parent 2b9f466
commit d059d32
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/docs/data_structures/libE_specs.rst b/docs/data_structures/libE_specs.rst
@@ -44,7 +44,7 @@ the ``LibeSpecs`` class. When provided as a Python class, options are validated
                 When libEnsemble concludes and attempts to close down workers,
                 the number of seconds until workers are considered timed out. Worker
                 processes are then terminated.
-            "kill_canceled_sims" [bool] = ``True``:
+            "kill_canceled_sims" [bool] = ``False``:
                 Try to kill sims with ``"cancel_requested"`` set ``True``.
                 If ``False``, the manager avoids this moderate overhead.
             "disable_log_files" [bool] = ``False``:

diff --git a/docs/tutorials/calib_cancel_tutorial.rst b/docs/tutorials/calib_cancel_tutorial.rst
@@ -139,14 +139,16 @@ be processed. The manager will send kill signals to workers that are already pro
 cancelled points. These signals can be caught and acted on by the user ``sim_f``; otherwise
 they will be ignored.
 
-Allocation function
--------------------
+Allocation function and Cancellation configuration
+--------------------------------------------------
 
 The allocation function used in this example is the *only_persistent_gens* function in the
-*start_only_persistent* module. The calling script passes the following specification:
+*start_only_persistent* module. The calling script passes the following specifications:
 
 .. code-block:: python
 
+    libE_specs["kill_canceled_sims"] = True
+
     alloc_specs = {
         "alloc_f": alloc_f,
         "user": {

diff --git a/libensemble/specs.py b/libensemble/specs.py
@@ -240,7 +240,7 @@ class LibeSpecs(BaseModel):
     worker_timeout: Optional[int] = 1
     """ On libEnsemble shutdown, number of seconds after which workers considered timed out, then terminated """
 
-    kill_canceled_sims: Optional[bool] = True
+    kill_canceled_sims: Optional[bool] = False
     """
     Instructs libEnsemble to send kill signals to sims with their ``cancel_requested`` field set.
     If ``False``, the manager avoids this moderate overhead