creates validator that enables sim_dirs_make when sim_input_dir is enabled. slightly adjusts docs and corresponding test (#1266)

Author: jlnav

docs/data_structures/libE_specs.rst

@@ -128,6 +128,7 @@ libEnsemble is primarily customized by setting options within a ``LibeSpecs`` cl
 
                     **sim_input_dir** [str]:
                         Copy this directory's contents into the working directory upon calling the simulation function.
+                        Forms the base of a simulation directory.
 
                 .. tab-item:: Gens
 
@@ -145,6 +146,7 @@ libEnsemble is primarily customized by setting options within a ``LibeSpecs`` cl
 
                     **gen_input_dir** [str]:
                         Copy this directory's contents into the working directory upon calling the generator function.
+                        Forms the base of a generator directory.
 
         .. tab-item:: Profiling
 

libensemble/specs.py

@@ -257,6 +257,7 @@ class LibeSpecs(BaseModel):
     sim_input_dir: Optional[Union[str, Path]] = None
     """
     Copy this directory's contents into the working directory upon calling the simulation function.
+    Forms the base of a simulation directory.
     """
 
     gen_dirs_make: Optional[bool] = False
@@ -279,6 +280,7 @@ class LibeSpecs(BaseModel):
     gen_input_dir: Optional[Union[str, Path]] = None
     """
     Copy this directory's contents into the working directory upon calling the generator function.
+    Forms the base of a generator directory.
     """
 
     calc_dir_id_width: Optional[int] = 4

libensemble/tests/functionality_tests/test_sim_input_dir_option.py

@@ -37,7 +37,6 @@
 
     libE_specs["sim_input_dir"] = sim_input_dir
     libE_specs["ensemble_dir_path"] = o_ensemble
-    libE_specs["sim_dirs_make"] = False
     libE_specs["sim_dir_symlink_files"] = ["./test_sim_input_dir_option.py"]  # to cover FileExistsError catch
     libE_specs["ensemble_copy_back"] = True
 
@@ -65,8 +64,6 @@
 
     if is_manager:
         assert os.path.isdir(o_ensemble), f"Ensemble directory {o_ensemble} not created."
-        assert os.path.basename(dir_to_copy) in os.listdir(o_ensemble), "Input file not copied over."
-        with open(os.path.join(o_ensemble, "test_sim_out.txt"), "r") as f:
-            lines = f.readlines()
-
-        assert len(lines) == exit_criteria["sim_max"], "Sim output not written to ensemble dir for each sim call"
+        assert all(
+            [("copy_this" in os.listdir(os.path.join(o_ensemble, i))) for i in os.listdir(o_ensemble)]
+        ), "Sim input dir not copied to each sim dir."

libensemble/utils/pydantic_bindings.py

@@ -23,6 +23,7 @@
     check_valid_out,
     enable_save_H_when_every_K,
     genf_set_in_out_from_attrs,
+    set_calc_dirs_on_input_dir,
     set_platform_specs_to_class,
     set_workflow_dir,
     simf_set_in_out_from_attrs,
@@ -117,6 +118,7 @@ class Config:
             "check_any_workers_and_disable_rm_if_tcp": check_any_workers_and_disable_rm_if_tcp,
             "enable_save_H_when_every_K": enable_save_H_when_every_K,
             "set_workflow_dir": set_workflow_dir,
+            "set_calc_dirs_on_input_dir": set_calc_dirs_on_input_dir,
         },
     )
 

libensemble/utils/specs_checkers.py

@@ -104,6 +104,14 @@ def _check_set_workflow_dir(values):
     return values
 
 
+def _check_set_calc_dirs_on_input_dir(values):
+    if scg(values, "sim_input_dir") and not scg(values, "sim_dirs_make"):
+        scs(values, "sim_dirs_make", True)
+    if scg(values, "gen_input_dir") and not scg(values, "gen_dirs_make"):
+        scs(values, "gen_dirs_make", True)
+    return values
+
+
 def _check_logical_cores(values):
     if scg(values, "cores_per_node") and scg(values, "logical_cores_per_node"):
         assert (

libensemble/utils/validators.py

@@ -11,6 +11,7 @@
     _check_H0,
     _check_logical_cores,
     _check_output_fields,
+    _check_set_calc_dirs_on_input_dir,
     _check_set_workflow_dir,
 )
 
@@ -111,6 +112,10 @@ def enable_save_H_when_every_K(cls, values):
     def set_workflow_dir(cls, values):
         return _check_set_workflow_dir(values)
 
+    @root_validator
+    def set_calc_dirs_on_input_dir(cls, values):
+        return _check_set_calc_dirs_on_input_dir(values)
+
     @root_validator
     def check_exit_criteria(cls, values):
         return _check_exit_criteria(values)
@@ -202,6 +207,10 @@ def enable_save_H_when_every_K(self):
     def set_workflow_dir(self):
         return _check_set_workflow_dir(self)
 
+    @model_validator(mode="after")
+    def set_calc_dirs_on_input_dir(self):
+        return _check_set_calc_dirs_on_input_dir(self)
+
     @model_validator(mode="after")
     def check_exit_criteria(self):
         return _check_exit_criteria(self)