Add separate names for combined simulation 'library' and 'domain'

CHANGELOG.md

@@ -29,6 +29,9 @@
 
 * Semi-Analytic Models
     * Improve accuracy of dynamic binary number calculation for consistent evolution models.
+* `holodeck.librarian`
+    * Added functionality to construct 'domain' sets of simulations, to explore each parameter in a parameter-space one at a time.
+    * NOTE: Standard library files will now be called "sam-library.hdf5" instead of "sam_lib.hdf5"
 
 
 ## v1.5.2 - 2024/04/12

holodeck/librarian/__init__.py

@@ -53,6 +53,8 @@
 FNAME_DOMAIN_SIM_FILE = "domain__p{pnum:06d}.npz"
 DIRNAME_LIBRARY_SIMS = "library_sims"
 DIRNAME_DOMAIN_SIMS = "domain_sims"
+FNAME_LIBRARY_COMBINED_FILE = "sam-library"    # do NOT include file suffix (i.e. 'hdf5')
+FNAME_DOMAIN_COMBINED_FILE = "sam-domain"    # do NOT include file suffix (i.e. 'hdf5')
 PSPACE_FILE_SUFFIX = ".pspace.npz"
 ARGS_CONFIG_FNAME = "config.json"
 

holodeck/librarian/libraries.py

@@ -15,6 +15,7 @@
 from holodeck.constants import YR
 from holodeck.librarian import (
     DEF_NUM_FBINS, DEF_NUM_LOUDEST, DEF_NUM_REALS, DEF_PTA_DUR,
+    FNAME_LIBRARY_COMBINED_FILE, FNAME_DOMAIN_COMBINED_FILE,
 )
 
 PARAM_NAMES__ERROR = [
@@ -1021,8 +1022,14 @@ def _get_sim_fname(path, pnum, library=True):
     return temp
 
 
-def get_sam_lib_fname(path, gwb_only):
-    fname = 'sam_lib'
+def get_sam_lib_fname(path, gwb_only, library=True):
+    # standard 'library'
+    if library:
+        fname = FNAME_LIBRARY_COMBINED_FILE
+    # 'domain' of parameter space
+    else:
+        fname = FNAME_DOMAIN_COMBINED_FILE
+
     if gwb_only:
         fname += "_gwb-only"
     lib_path = path.joinpath(fname).with_suffix(".hdf5")