Rename user_fields to vocs_field_names

Author: shuds13

libensemble/generators.py

@@ -213,12 +213,12 @@ def finalize(self) -> None:
         self.gen_result = self._running_gen_f.result()
 
     def export(
-        self, user_fields: bool = False, as_dicts: bool = False
+        self, vocs_field_names: bool = False, as_dicts: bool = False
     ) -> tuple[npt.NDArray | list | None, dict | None, int | None]:
         """Return the generator's results
         Parameters
         ----------
-        user_fields : bool, optional
+        vocs_field_names : bool, optional
             If True, return local_H with variables unmapped from arrays back to individual fields.
             Default is False.
         as_dicts : bool, optional
@@ -227,7 +227,7 @@ def export(
         Returns
         -------
         local_H : npt.NDArray | list
-            Generator history array (unmapped if user_fields=True, as dicts if as_dicts=True).
+            Generator history array (unmapped if vocs_field_names=True, as dicts if as_dicts=True).
         persis_info : dict
             Persistent information.
         tag : int
@@ -236,10 +236,10 @@ def export(
         if not self.gen_result:
             return (None, None, None)
         local_H, persis_info, tag = self.gen_result
-        if user_fields and local_H is not None and self.variables_mapping:
+        if vocs_field_names and local_H is not None and self.variables_mapping:
             local_H = unmap_numpy_array(local_H, self.variables_mapping)
         if as_dicts and local_H is not None:
-            if user_fields and self.variables_mapping:
+            if vocs_field_names and self.variables_mapping:
                 local_H = np_to_list_dicts(local_H, self.variables_mapping)
             else:
                 local_H = np_to_list_dicts(local_H)

libensemble/tests/unit_tests/test_persistent_aposmm.py

@@ -584,8 +584,8 @@ def _run_aposmm_export_test(variables_mapping):
         assert "x" in H.dtype.names and H["x"].ndim == 2
         assert "f" in H.dtype.names and H["f"].ndim == 1
 
-    # Test export with user_fields
-    H_unmapped, _, _ = aposmm.export(user_fields=True)
+    # Test export with vocs_field_names
+    H_unmapped, _, _ = aposmm.export(vocs_field_names=True)
     print(f"H_unmapped: {H_unmapped}")  # Debug
     if H_unmapped is not None:
         assert "core" in H_unmapped.dtype.names
@@ -598,7 +598,7 @@ def _run_aposmm_export_test(variables_mapping):
     assert "x" in H_dicts[0]  # x remains as array
     assert "f" in H_dicts[0]
     # Test export with both options
-    H_both, _, _ = aposmm.export(user_fields=True, as_dicts=True)
+    H_both, _, _ = aposmm.export(vocs_field_names=True, as_dicts=True)
     assert isinstance(H_both, list)
     assert "core" in H_both[0]
     assert "edge" in H_both[0]