archeo 2.0.0.dev1__tar.gz → 2.0.0.dev2__tar.gz

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archeo
-Version: 2.0.0.dev1
+Version: 2.0.0.dev2
 Summary: Bayesian framework for inferring natal kick, ancestral masses and spins of black holes.
 Author-email: wyhwong <wyhwong@link.cuhk.edu.hk>
 License-Expression: MIT

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/archeo/preset/simulation/agnostic.py

@@ -8,7 +8,9 @@ from archeo.simulation.simulate_merger import simulate_black_hole_mergers
 from archeo.utils.parallel import get_n_workers
 
 
-def simulate_agnostic_precession_spin_binaries(size: int = 1000, n_workers: int = 1) -> PipelineOutput:
+def simulate_agnostic_precession_spin_binaries(
+    size: int = 1000, n_workers: int = 1, random_state: int = 42
+) -> PipelineOutput:
     """Simulate a population of agnostic precession spin binaries.
 
     Args:
@@ -17,6 +19,7 @@ def simulate_agnostic_precession_spin_binaries(size: int = 1000, n_workers: int
         n_workers (int): The number of workers to use for parallel processing.
             Default is 1.
             If -1, it will use all available cores.
+        random_state (int): Random state for reproducibility. Default is 42.
 
     Returns:
         SimulationOutput: tuple(pd.DataFrame, BinaryGenerator)
@@ -32,12 +35,16 @@ def simulate_agnostic_precession_spin_binaries(size: int = 1000, n_workers: int
         secondary_black_hole_source=bh_generator,
         is_aligned_spin=False,
     )
-    black_hole_mergers = simulate_black_hole_mergers(binary_generator, Fits.NRSUR7DQ4REMNANT, size, n_workers)
+    black_hole_mergers = simulate_black_hole_mergers(
+        binary_generator, Fits.NRSUR7DQ4REMNANT, size, n_workers, random_state
+    )
     df_binaries = convert_simulated_binaries_to_dataframe(black_hole_mergers)
     return df_binaries, binary_generator
 
 
-def simulate_agnostic_aligned_spin_binaries(size: int = 1000, n_workers: int = 1) -> PipelineOutput:
+def simulate_agnostic_aligned_spin_binaries(
+    size: int = 1000, n_workers: int = 1, random_state: int = 42
+) -> PipelineOutput:
     """Simulate a population of agnostic aligned spin binaries.
 
     Args:
@@ -46,6 +53,7 @@ def simulate_agnostic_aligned_spin_binaries(size: int = 1000, n_workers: int = 1
         n_workers (int): The number of workers to use for parallel processing.
             Default is 1.
             If -1, it will use all available cores.
+        random_state (int): Random state for reproducibility. Default is 42.
 
     Returns:
         SimulationOutput: tuple(pd.DataFrame, BinaryGenerator)
@@ -61,6 +69,8 @@ def simulate_agnostic_aligned_spin_binaries(size: int = 1000, n_workers: int = 1
         secondary_black_hole_source=bh_generator,
         is_aligned_spin=True,
     )
-    black_hole_mergers = simulate_black_hole_mergers(binary_generator, Fits.NRSUR3DQ8REMNANT, size, n_workers)
+    black_hole_mergers = simulate_black_hole_mergers(
+        binary_generator, Fits.NRSUR3DQ8REMNANT, size, n_workers, random_state
+    )
     df_binaries = convert_simulated_binaries_to_dataframe(black_hole_mergers)
     return df_binaries, binary_generator

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/archeo/preset/simulation/n_generation.py

@@ -16,6 +16,7 @@ def simulate_multi_generation_precession_spin_binaries(
     df_bh2_binaries: Optional[pd.DataFrame] = None,
     size: int = 1000,
     n_workers: int = 1,
+    random_state: int = 42,
 ) -> PipelineOutput:
     """Simulate a population of multi-generation precession spin binaries.
 
@@ -30,6 +31,7 @@ def simulate_multi_generation_precession_spin_binaries(
         n_workers (int): The number of workers to use for parallel processing.
             Default is 1.
             If -1, it will use all available cores.
+        random_state (int): Random state for reproducibility. Default is 42.
 
     Returns:
         SimulationOutput: tuple(pd.DataFrame, BinaryGenerator)
@@ -50,7 +52,9 @@ def simulate_multi_generation_precession_spin_binaries(
         secondary_black_hole_source=bh2_generator,
         is_aligned_spin=False,
     )
-    black_hole_mergers = simulate_black_hole_mergers(binary_generator, Fits.NRSUR7DQ4REMNANT, size, n_workers)
+    black_hole_mergers = simulate_black_hole_mergers(
+        binary_generator, Fits.NRSUR7DQ4REMNANT, size, n_workers, random_state
+    )
     df_binaries = convert_simulated_binaries_to_dataframe(black_hole_mergers)
     return df_binaries, binary_generator
 
@@ -60,6 +64,7 @@ def simulate_multi_generation_aligned_spin_binaries(
     df_bh2_binaries: Optional[pd.DataFrame] = None,
     size: int = 1000,
     n_workers: int = 1,
+    random_state: int = 42,
 ) -> PipelineOutput:
     """Simulate a population of multi-generation aligned spin binaries.
 
@@ -74,6 +79,7 @@ def simulate_multi_generation_aligned_spin_binaries(
         n_workers (int): The number of workers to use for parallel processing.
             Default is 1.
             If -1, it will use all available cores.
+        random_state (int): Random state for reproducibility. Default is 42.
 
     Returns:
         SimulationOutput: tuple(pd.DataFrame, BinaryGenerator)
@@ -94,6 +100,8 @@ def simulate_multi_generation_aligned_spin_binaries(
         secondary_black_hole_source=bh2_generator,
         is_aligned_spin=True,
     )
-    black_hole_mergers = simulate_black_hole_mergers(binary_generator, Fits.NRSUR3DQ8REMNANT, size, n_workers)
+    black_hole_mergers = simulate_black_hole_mergers(
+        binary_generator, Fits.NRSUR3DQ8REMNANT, size, n_workers, random_state
+    )
     df_binaries = convert_simulated_binaries_to_dataframe(black_hole_mergers)
     return df_binaries, binary_generator

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/archeo/preset/simulation/second_generation.py

@@ -7,7 +7,9 @@ from archeo.simulation.simulate_merger import simulate_black_hole_mergers
 from archeo.utils.parallel import get_n_workers
 
 
-def simulate_second_generation_precession_spin_binaries(size: int = 1000, n_workers: int = 1) -> PipelineOutput:
+def simulate_second_generation_precession_spin_binaries(
+    size: int = 1000, n_workers: int = 1, random_state: int = 42
+) -> PipelineOutput:
     """Simulate a population of second generation precession spin binaries.
 
     Args:
@@ -16,6 +18,7 @@ def simulate_second_generation_precession_spin_binaries(size: int = 1000, n_work
         n_workers (int): The number of workers to use for parallel processing.
             Default is 1.
             If -1, it will use all available cores.
+        random_state (int): Random state for reproducibility. Default is 42.
 
     Returns:
         SimulationOutput: tuple(pd.DataFrame, BinaryGenerator)
@@ -31,12 +34,16 @@ def simulate_second_generation_precession_spin_binaries(size: int = 1000, n_work
         secondary_black_hole_source=bh_generator,
         is_aligned_spin=False,
     )
-    black_hole_mergers = simulate_black_hole_mergers(binary_generator, Fits.NRSUR7DQ4REMNANT, size, n_workers)
+    black_hole_mergers = simulate_black_hole_mergers(
+        binary_generator, Fits.NRSUR7DQ4REMNANT, size, n_workers, random_state
+    )
     df_binaries = convert_simulated_binaries_to_dataframe(black_hole_mergers)
     return df_binaries, binary_generator
 
 
-def simulate_second_generation_aligned_spin_binaries(size: int = 1000, n_workers: int = 1) -> PipelineOutput:
+def simulate_second_generation_aligned_spin_binaries(
+    size: int = 1000, n_workers: int = 1, random_state: int = 42
+) -> PipelineOutput:
     """Simulate a population of second generation aligned spin binaries.
 
     Args:
@@ -45,6 +52,7 @@ def simulate_second_generation_aligned_spin_binaries(size: int = 1000, n_workers
         n_workers (int): The number of workers to use for parallel processing.
             Default is 1.
             If -1, it will use all available cores.
+        random_state (int): Random state for reproducibility. Default is 42.
 
     Returns:
         SimulationOutput: tuple(pd.DataFrame, BinaryGenerator)
@@ -60,6 +68,8 @@ def simulate_second_generation_aligned_spin_binaries(size: int = 1000, n_workers
         secondary_black_hole_source=bh_generator,
         is_aligned_spin=True,
     )
-    black_hole_mergers = simulate_black_hole_mergers(binary_generator, Fits.NRSUR3DQ8REMNANT, size, n_workers)
+    black_hole_mergers = simulate_black_hole_mergers(
+        binary_generator, Fits.NRSUR3DQ8REMNANT, size, n_workers, random_state
+    )
     df_binaries = convert_simulated_binaries_to_dataframe(black_hole_mergers)
     return df_binaries, binary_generator

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/archeo/simulation/simulate_merger.py

@@ -67,6 +67,7 @@ def simulate_black_hole_mergers(
     fits: Fits,
     size: int,
     n_workers: int = 1,
+    random_state: int = 42,
 ) -> BlackHoleMergers:
     """Simulate black hole mergers.
 
@@ -75,19 +76,20 @@ def simulate_black_hole_mergers(
         fits (Fits): surfinBH model to use for the simulation
         size (int): Number of mergers to simulate
         n_workers (int): Number of worker processes to use for parallelization. Default is 1.
+        random_state (int): Random state for reproducibility. Default is 42.
     Returns:
         BlackHoleMergers: List of tuples containing the binaries and their resulting black holes
     """
 
     if n_workers == 1:
-        return _simulate_black_hole_mergers(binary_generator, fits, size)
+        return _simulate_black_hole_mergers(binary_generator, fits, size, random_state)
 
     # If n_workers > 1, we can parallelize the simulation by splitting the size into chunks
     chunk_size = size // n_workers
     results = multiprocess_run(
         func=_simulate_black_hole_mergers,
         input_kwargs=[
-            {"binary_generator": binary_generator, "fits": fits, "size": chunk_size, "random_state": 42 + i}
+            {"binary_generator": binary_generator, "fits": fits, "size": chunk_size, "random_state": random_state + i}
             for i in range(n_workers)
         ],
         n_processes=n_workers,
@@ -99,7 +101,7 @@ def simulate_black_hole_mergers(
         # If there are any remaining mergers to simulate (due to rounding), simulate them in the main process
         remaining_size = size - len(black_hole_mergers)
         remaining_bh_mergers = _simulate_black_hole_mergers(
-            binary_generator, fits, remaining_size, random_state=42 + n_workers
+            binary_generator, fits, remaining_size, random_state=random_state + n_workers
         )
         black_hole_mergers.extend(remaining_bh_mergers)
 

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/archeo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archeo
-Version: 2.0.0.dev1
+Version: 2.0.0.dev2
 Summary: Bayesian framework for inferring natal kick, ancestral masses and spins of black holes.
 Author-email: wyhwong <wyhwong@link.cuhk.edu.hk>
 License-Expression: MIT

{archeo-2.0.0.dev1 → archeo-2.0.0.dev2}/pyproject.toml

@@ -16,7 +16,7 @@ classifiers = [
     "Operating System :: OS Independent"
 ]
 keywords = ["black-holes", "gravitational-waves", "black-hole-archeology"]
-version = "2.0.0.dev1"
+version = "2.0.0.dev2"
 readme = "README.md"
 requires-python = ">=3.11,<3.14"
 dependencies = [