archeo 2.0.0.dev2__tar.gz → 2.0.0.dev4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archeo
-Version: 2.0.0.dev2
+Version: 2.0.0.dev4
 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
@@ -33,10 +33,6 @@ Requires-Dist: seaborn>=0.13.2
 Requires-Dist: surfinbh>=1.2.7
 Requires-Dist: tabulate>=0.10.0
 Requires-Dist: tqdm>=4.67.3
-Provides-Extra: ui
-Requires-Dist: nbformat>=5.10.4; extra == "ui"
-Requires-Dist: plotly>=6.6.0; extra == "ui"
-Requires-Dist: streamlit>=1.55.0; extra == "ui"
 Dynamic: license-file
 
 # ARCHEO (V2)
@@ -196,20 +192,6 @@ archeo.visualize_posterior_estimation({"GW190521": df_posterior}, output_dir="./
 
 To import archeo in your Python code, please refer to the documentation page at [https://wyhwong.github.io/archeo/](https://wyhwong.github.io/archeo/).
 
-## Try our UI
-
-Archeo also provides a simple web-based user interface to visualize the distributions of remnant properties.
-To run the UI locally, simply run the following command:
-
-```bash
-pip3 install archeo[ui]
-python3 -m archeo.ui
-```
-
-Then the UI will be available at [localhost:8501](http://localhost:8501).
-
-You may also try our [demo version](https://archeo.streamlit.app/) online, which is hosted on Streamlit Community Cloud.
-
 ## Getting Help
 
 The code is maintained by [Henry Wong](https://github.com/wyhwong) under [Juan Calderon Bustillo](https://git.ligo.org/juan.calderonbustillo)'s supervision. You can find the [list of contributors](https://github.com/wyhwong/archeo/graphs/contributors) here. Please report bugs by raising an issue on our [GitHub](https://github.com/wyhwong/archeo) repository.

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/README.md

@@ -155,20 +155,6 @@ archeo.visualize_posterior_estimation({"GW190521": df_posterior}, output_dir="./
 
 To import archeo in your Python code, please refer to the documentation page at [https://wyhwong.github.io/archeo/](https://wyhwong.github.io/archeo/).
 
-## Try our UI
-
-Archeo also provides a simple web-based user interface to visualize the distributions of remnant properties.
-To run the UI locally, simply run the following command:
-
-```bash
-pip3 install archeo[ui]
-python3 -m archeo.ui
-```
-
-Then the UI will be available at [localhost:8501](http://localhost:8501).
-
-You may also try our [demo version](https://archeo.streamlit.app/) online, which is hosted on Streamlit Community Cloud.
-
 ## Getting Help
 
 The code is maintained by [Henry Wong](https://github.com/wyhwong) under [Juan Calderon Bustillo](https://git.ligo.org/juan.calderonbustillo)'s supervision. You can find the [list of contributors](https://github.com/wyhwong/archeo/graphs/contributors) here. Please report bugs by raising an issue on our [GitHub](https://github.com/wyhwong/archeo) repository.

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/bayesian/importance_sampling/resampler/assume_independence.py

@@ -33,7 +33,7 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
         nbins = self.get_nbins(samples.name)
         return get_histogram_1d(samples, nbins=nbins, bounds=self.bounds[samples.name])
 
-    def get_likelihood_samples_1d(self, random_state=42, ztol=1e-8) -> np.ndarray:
+    def get_likelihood_samples_1d(self, random_state=42) -> np.ndarray:
         """Get samples for likelihood function"""
 
         weights = np.ones(len(self.posterior_samples))
@@ -42,7 +42,7 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
             prior_hist = self._get_hist_1d(self.prior_samples[col])
             rv = rv_histogram(
                 (
-                    self._safe_divide(1.0, prior_hist, ztol=ztol),
+                    self._safe_divide(1.0, prior_hist),
                     self.get_edges(col_name=col),
                 )
             )
@@ -55,7 +55,7 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
             random_state=random_state,
         )
 
-    def _get_posterior_sample_weights_1d(self, col_name: str, ztol=1e-8) -> np.ndarray:
+    def _get_posterior_sample_weights_1d(self, col_name: str) -> np.ndarray:
         """Get the weights for the importance sampling"""
 
         weights = np.ones(len(self.posterior_samples))
@@ -63,17 +63,13 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
         prior_hist = self._get_hist_1d(self.prior_samples[col_name])
         new_prior_hist = self._get_hist_1d(self.new_prior_samples[col_name])
         # Avoid division by zero
-        ratio = self._safe_divide(new_prior_hist, prior_hist, ztol=ztol)
+        ratio = self._safe_divide(new_prior_hist, prior_hist)
         rv = rv_histogram((ratio, self.get_edges(col_name)))
         weights *= rv.pdf(self.posterior_samples[col_name])
 
         return weights
 
-    def get_bayes_factor_1d(
-        self,
-        bootstrapping: bool = False,
-        ztol=1e-8,
-    ) -> float:
+    def get_bayes_factor_1d(self, bootstrapping: bool = False) -> float:
         """Compute the Bayes factor between two models"""
 
         if bootstrapping:
@@ -81,14 +77,12 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
                 prior_samples=self.prior_samples.sample(n=len(self.prior_samples), replace=True),
                 posterior_samples=self.posterior_samples.sample(n=len(self.posterior_samples), replace=True),
                 new_prior_samples=self.new_prior_samples.sample(n=len(self.new_prior_samples), replace=True),
-                ztol=ztol,
             )
 
         return self._get_bayes_factor_1d(
             prior_samples=self.prior_samples,
             posterior_samples=self.posterior_samples,
             new_prior_samples=self.new_prior_samples,
-            ztol=ztol,
         )
 
     def _get_bayes_factor_1d(
@@ -96,7 +90,6 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
         prior_samples: pd.DataFrame,
         posterior_samples: pd.DataFrame,
         new_prior_samples: pd.DataFrame,
-        ztol=1e-8,
     ) -> float:
         """Compute the Bayes factor between two models
 
@@ -111,19 +104,17 @@ class ISDataAssumeIndependence(ImportanceSamplingDataBase):
             prior_hist = self._get_hist_1d(prior_samples[col])
             posterior_hist = self._get_hist_1d(posterior_samples[col])
             new_prior_hist = self._get_hist_1d(new_prior_samples[col])
-            bf *= np.sum(posterior_hist * self._safe_divide(new_prior_hist, prior_hist, ztol=ztol)) * self.get_binwidth(
-                col
-            )
+            bf *= np.sum(posterior_hist * self._safe_divide(new_prior_hist, prior_hist)) * self.get_binwidth(col)
 
         return bf
 
-    def get_reweighted_samples_1d(self, ztol=1e-8, random_state=42) -> pd.DataFrame:
+    def get_reweighted_samples_1d(self, random_state=42) -> pd.DataFrame:
         """Get the reweighted samples for the importance sampling"""
 
         weights = np.ones(len(self.posterior_samples))
 
         for col in self.common_columns:
-            weights *= self._get_posterior_sample_weights_1d(col_name=col, ztol=ztol)
+            weights *= self._get_posterior_sample_weights_1d(col_name=col)
 
         reweighted_samples = self.posterior_samples.sample(
             n=len(self.posterior_samples),

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/bayesian/importance_sampling/resampler/base.py

@@ -1,5 +1,3 @@
-from typing import Optional
-
 import numpy as np
 import pandas as pd
 from pydantic import BaseModel, ConfigDict
@@ -21,6 +19,7 @@ class ImportanceSamplingDataBase(BaseModel, frozen=True):
     new_prior_samples: pd.DataFrame
     binsize_spin: float = 0.05
     binsize_mass: float = 1.0
+    ztol: float = 1e-8
 
     @property
     def common_columns(self) -> list[str]:
@@ -53,7 +52,7 @@ class ImportanceSamplingDataBase(BaseModel, frozen=True):
 
         return bounds
 
-    def get_binsize(self, col_name: str) -> Optional[float]:
+    def get_binsize(self, col_name: str) -> float:
 
         if col_name.startswith("a"):
             return self.binsize_spin
@@ -63,7 +62,7 @@ class ImportanceSamplingDataBase(BaseModel, frozen=True):
 
         raise ValueError(f"Unknown column name {col_name}")
 
-    def get_nbins(self, col_name: str) -> Optional[int]:
+    def get_nbins(self, col_name: str) -> int:
         """Get the number of bins for a given column name"""
 
         binsize = self.get_binsize(col_name)
@@ -83,8 +82,7 @@ class ImportanceSamplingDataBase(BaseModel, frozen=True):
         edges = self.get_edges(col_name)
         return edges[1] - edges[0]
 
-    @staticmethod
-    def _safe_divide(a: np.ndarray, b: np.ndarray, ztol: float = 1e-8) -> np.ndarray:
+    def _safe_divide(self, a: np.ndarray, b: np.ndarray) -> np.ndarray:
         """Safe division to avoid division by zero"""
 
-        return np.where(b > ztol, np.exp(np.log(a) - np.log(b)), 0.0)
+        return np.where(b > self.ztol, np.exp(np.log(a) - np.log(b)), 0.0)

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/bayesian/importance_sampling/resampler/generic.py

@@ -37,7 +37,7 @@ class ISDataGeneric(ImportanceSamplingDataBase):
         samples_array = df_samples.to_numpy()
         return get_histogram_dd(samples_array, nbins=nbins, bounds=bounds)
 
-    def get_likelihood_samples_dd(self, random_state=42, ztol=1e-8) -> np.ndarray:
+    def get_likelihood_samples_dd(self, random_state=42) -> np.ndarray:
         """Get samples for likelihood function"""
 
         edges = {}
@@ -45,7 +45,7 @@ class ISDataGeneric(ImportanceSamplingDataBase):
             edges[col] = self.get_edges(col)
 
         prior_hist = self._get_hist_dd(self.prior_samples[self.common_columns])
-        weights_matrix = self._safe_divide(1.0, prior_hist, ztol=ztol)
+        weights_matrix = self._safe_divide(1.0, prior_hist)
 
         def _get_pdf(row: pd.Series):
             idx = tuple(np.searchsorted(edges[col], row[col], side="right") - 1 for col in self.common_columns)
@@ -60,7 +60,7 @@ class ISDataGeneric(ImportanceSamplingDataBase):
             random_state=random_state,
         )
 
-    def _get_posterior_sample_weights_dd(self, ztol=1e-8) -> pd.Series:
+    def _get_posterior_sample_weights_dd(self) -> pd.Series:
         """Get the weights for the importance sampling"""
 
         edges = {}
@@ -70,7 +70,7 @@ class ISDataGeneric(ImportanceSamplingDataBase):
         prior_hist = self._get_hist_dd(self.prior_samples[self.common_columns])
         new_prior_hist = self._get_hist_dd(self.new_prior_samples[self.common_columns])
         # Avoid division by zero
-        weights_matrix = self._safe_divide(new_prior_hist, prior_hist, ztol=ztol)
+        weights_matrix = self._safe_divide(new_prior_hist, prior_hist)
 
         def _get_pdf(row: pd.Series):
             idx = tuple(np.searchsorted(edges[col], row[col], side="right") - 1 for col in self.common_columns)
@@ -78,7 +78,7 @@ class ISDataGeneric(ImportanceSamplingDataBase):
 
         return self.posterior_samples.apply(_get_pdf, axis=1)
 
-    def get_bayes_factor_dd(self, bootstrapping: bool = False, ztol=1e-8) -> float:
+    def get_bayes_factor_dd(self, bootstrapping: bool = False) -> float:
         """Compute the Bayes factor between two models"""
 
         if bootstrapping:
@@ -86,14 +86,12 @@ class ISDataGeneric(ImportanceSamplingDataBase):
                 prior_samples=self.prior_samples.sample(n=len(self.prior_samples), replace=True),
                 posterior_samples=self.posterior_samples.sample(n=len(self.posterior_samples), replace=True),
                 new_prior_samples=self.new_prior_samples.sample(n=len(self.new_prior_samples), replace=True),
-                ztol=ztol,
             )
 
         return self._get_bayes_factor_dd(
             prior_samples=self.prior_samples,
             posterior_samples=self.posterior_samples,
             new_prior_samples=self.new_prior_samples,
-            ztol=ztol,
         )
 
     def _get_bayes_factor_dd(
@@ -101,7 +99,6 @@ class ISDataGeneric(ImportanceSamplingDataBase):
         prior_samples: pd.DataFrame,
         posterior_samples: pd.DataFrame,
         new_prior_samples: pd.DataFrame,
-        ztol=1e-8,
     ) -> float:
         """Compute the Bayes factor between two models
 
@@ -116,14 +113,14 @@ class ISDataGeneric(ImportanceSamplingDataBase):
         new_prior_hist_bh = self._get_hist_dd(new_prior_samples[[c for c in self.common_columns]])
         prior_hist_bh = self._get_hist_dd(prior_samples[[c for c in self.common_columns]])
         posterior_hist_bh = self._get_hist_dd(posterior_samples[[c for c in self.common_columns]])
-        bf *= np.sum(posterior_hist_bh * self._safe_divide(new_prior_hist_bh, prior_hist_bh, ztol=ztol)) * bin_auc
+        bf *= np.sum(posterior_hist_bh * self._safe_divide(new_prior_hist_bh, prior_hist_bh)) * bin_auc
 
         return bf
 
-    def get_reweighted_samples_dd(self, ztol=1e-8, random_state=42) -> pd.DataFrame:
+    def get_reweighted_samples_dd(self, random_state=42) -> pd.DataFrame:
         """Get the reweighted samples for the importance sampling"""
 
-        weights = self._get_posterior_sample_weights_dd(ztol=ztol)
+        weights = self._get_posterior_sample_weights_dd()
 
         return self.posterior_samples.sample(
             n=len(self.posterior_samples),

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/bayesian/importance_sampling/resampler/interface.py

@@ -20,16 +20,16 @@ class ImportanceSamplingData(ISDataGeneric, ISDataAssumeIndependence, Interface)
     assume_parameter_independence: bool = False
 
     @pre_release
-    def get_likelihood_samples(self, random_state=42, ztol=1e-8) -> np.ndarray:
+    def get_likelihood_samples(self, random_state=42) -> np.ndarray:
         """Get samples for likelihood function"""
 
         if self.assume_parameter_independence:
-            return self.get_likelihood_samples_1d(random_state=random_state, ztol=ztol)
+            return self.get_likelihood_samples_1d(random_state=random_state)
 
-        return self.get_likelihood_samples_dd(random_state=random_state, ztol=ztol)
+        return self.get_likelihood_samples_dd(random_state=random_state)
 
     @pre_release
-    def get_bayes_factor(self, bootstrapping: bool = False, ztol=1e-8) -> float:
+    def get_bayes_factor(self, bootstrapping: bool = False) -> float:
         """Compute the Bayes factor between two models
 
         NOTE: In this implementation, the likelihood function remains untouched.
@@ -41,18 +41,12 @@ class ImportanceSamplingData(ISDataGeneric, ISDataAssumeIndependence, Interface)
             return 0.0
 
         if self.assume_parameter_independence:
-            return self.get_bayes_factor_1d(bootstrapping=bootstrapping, ztol=ztol)
+            return self.get_bayes_factor_1d(bootstrapping=bootstrapping)
 
-        return self.get_bayes_factor_dd(bootstrapping=bootstrapping, ztol=ztol)
+        return self.get_bayes_factor_dd(bootstrapping=bootstrapping)
 
     @pre_release
-    def sample_bayes_factor(
-        self,
-        n: int,
-        ztol=1e-8,
-        is_parallel: bool = False,
-        n_threads: int | None = None,
-    ) -> BayesFactor:
+    def sample_bayes_factor(self, n: int, is_parallel: bool = False, n_threads: int | None = None) -> BayesFactor:
         """Sample the Bayes factor for the importance sampling"""
 
         if self.new_prior_samples.empty:
@@ -63,29 +57,27 @@ class ImportanceSamplingData(ISDataGeneric, ISDataAssumeIndependence, Interface)
                 return BayesFactor(
                     samples=multithread_run(
                         func=self.get_bayes_factor_1d,
-                        input_kwargs=[{"bootstrapping": True, "ztol": ztol} for _ in range(n)],
+                        input_kwargs=[{"bootstrapping": True} for _ in range(n)],
                         n_threads=n_threads,
                     )
                 )
-            return BayesFactor(
-                samples=[self.get_bayes_factor_1d(bootstrapping=True, ztol=ztol) for _ in tqdm(range(n))]
-            )
+            return BayesFactor(samples=[self.get_bayes_factor_1d(bootstrapping=True) for _ in tqdm(range(n))])
 
         if is_parallel:
             return BayesFactor(
                 samples=multithread_run(
                     func=self.get_bayes_factor_dd,
-                    input_kwargs=[{"bootstrapping": True, "ztol": ztol} for _ in range(n)],
+                    input_kwargs=[{"bootstrapping": True} for _ in range(n)],
                     n_threads=n_threads,
                 )
             )
-        return BayesFactor(samples=[self.get_bayes_factor_dd(bootstrapping=True, ztol=ztol) for _ in tqdm(range(n))])
+        return BayesFactor(samples=[self.get_bayes_factor_dd(bootstrapping=True) for _ in tqdm(range(n))])
 
     @pre_release
-    def get_reweighted_samples(self, ztol=1e-8, random_state=42) -> pd.DataFrame:
+    def get_reweighted_samples(self, random_state=42) -> pd.DataFrame:
         """Get the reweighted samples for the importance sampling"""
 
         if self.assume_parameter_independence:
-            return self.get_reweighted_samples_1d(ztol=ztol, random_state=random_state)
+            return self.get_reweighted_samples_1d(random_state=random_state)
 
-        return self.get_reweighted_samples_dd(ztol=ztol, random_state=random_state)
+        return self.get_reweighted_samples_dd(random_state=random_state)

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/data_structures/physics/binary.py

@@ -1,7 +1,7 @@
 from typing import TypeAlias
 
 import numpy as np
-from pydantic import BaseModel
+from pydantic import BaseModel, NonNegativeFloat, PositiveFloat
 
 from archeo.data_structures.math import Domain
 from archeo.data_structures.physics.black_hole import BlackHole, BlackHoleSource
@@ -18,13 +18,13 @@ class Binary(BaseModel, frozen=True):
     secondary_black_hole: BlackHole
 
     @property
-    def mass_ratio(self) -> float:
+    def mass_ratio(self) -> PositiveFloat:
         """Calculate the mass ratio (q) for the binary."""
 
         return self.primary_black_hole.mass / self.secondary_black_hole.mass
 
     @property
-    def precession_spin(self) -> float:
+    def precession_spin(self) -> NonNegativeFloat:
         """Calculate the precession spin parameter (chi_p) for the binary."""
 
         q = self.primary_black_hole.mass / self.secondary_black_hole.mass
@@ -33,7 +33,7 @@ class Binary(BaseModel, frozen=True):
         return np.maximum(a1h, (4 / q + 3) / (3 / q + 4) / q * a2h)
 
     @property
-    def effective_spin(self) -> float:
+    def effective_spin(self) -> NonNegativeFloat:
         """Calculate the effective spin parameter (chi_eff) for the binary."""
 
         m1 = self.primary_black_hole.mass
@@ -55,7 +55,7 @@ class BinaryGenerator(BaseModel, frozen=True):
     is_aligned_spin: bool = False
     enforce_source_binding: bool = False
 
-    def draw(self, size: int = 1) -> list[Binary]:
+    def draw(self, size: int = 1) -> Binaries:
         """Generate a list of binaries based on the specified sources and mass ratio domain."""
 
         binaries = []

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/data_structures/physics/black_hole.py

@@ -101,12 +101,15 @@ class BlackHolePopulation(BaseModel, frozen=True):
         return np.random.choice(self.black_holes, size=size, replace=True).tolist()
 
     @classmethod
-    def from_simulation_results(cls, df: pd.DataFrame) -> "BlackHolePopulation":
+    def from_simulation_results(
+        cls,
+        df: pd.DataFrame,
+        phi_distribution: Distribution = Uniform(low=0, high=2 * np.pi),
+        theta_distribution: Distribution = Uniform(low=0, high=np.pi),
+    ) -> "BlackHolePopulation":
         """Create a black hole population from simulation results."""
 
-        phi_distribution = Uniform(low=0, high=2 * np.pi)
         phis = phi_distribution.draw(size=len(df))
-        theta_distribution = Uniform(low=0, high=np.pi)
         thetas = theta_distribution.draw(size=len(df))
 
         return cls(

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo/data_structures/physics/mahapatra.py

@@ -33,7 +33,7 @@ class MahapatraMassFunction(BaseModel, DistributionBase, frozen=True):
     def probis(self) -> np.ndarray:
         """Probabilities of the masses."""
 
-        probis = self.smoothing_func(self.masses)
+        probis = self._smoothing_func(self.masses)
         probis /= probis.sum()
         return probis
 
@@ -43,7 +43,7 @@ class MahapatraMassFunction(BaseModel, DistributionBase, frozen=True):
         mp = masses - self.mass.low
         return np.exp(self.dm / mp + self.dm / (mp - self.dm))
 
-    def smoothing_func(self, masses: np.ndarray) -> np.ndarray:
+    def _smoothing_func(self, masses: np.ndarray) -> np.ndarray:
         """Smoothing function."""
 
         probis = masses.copy()

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archeo
-Version: 2.0.0.dev2
+Version: 2.0.0.dev4
 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
@@ -33,10 +33,6 @@ Requires-Dist: seaborn>=0.13.2
 Requires-Dist: surfinbh>=1.2.7
 Requires-Dist: tabulate>=0.10.0
 Requires-Dist: tqdm>=4.67.3
-Provides-Extra: ui
-Requires-Dist: nbformat>=5.10.4; extra == "ui"
-Requires-Dist: plotly>=6.6.0; extra == "ui"
-Requires-Dist: streamlit>=1.55.0; extra == "ui"
 Dynamic: license-file
 
 # ARCHEO (V2)
@@ -196,20 +192,6 @@ archeo.visualize_posterior_estimation({"GW190521": df_posterior}, output_dir="./
 
 To import archeo in your Python code, please refer to the documentation page at [https://wyhwong.github.io/archeo/](https://wyhwong.github.io/archeo/).
 
-## Try our UI
-
-Archeo also provides a simple web-based user interface to visualize the distributions of remnant properties.
-To run the UI locally, simply run the following command:
-
-```bash
-pip3 install archeo[ui]
-python3 -m archeo.ui
-```
-
-Then the UI will be available at [localhost:8501](http://localhost:8501).
-
-You may also try our [demo version](https://archeo.streamlit.app/) online, which is hosted on Streamlit Community Cloud.
-
 ## Getting Help
 
 The code is maintained by [Henry Wong](https://github.com/wyhwong) under [Juan Calderon Bustillo](https://git.ligo.org/juan.calderonbustillo)'s supervision. You can find the [list of contributors](https://github.com/wyhwong/archeo/graphs/contributors) here. Please report bugs by raising an issue on our [GitHub](https://github.com/wyhwong/archeo) repository.

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo.egg-info/SOURCES.txt

@@ -45,9 +45,6 @@ archeo/preset/simulation/n_generation.py
 archeo/preset/simulation/second_generation.py
 archeo/simulation/__init__.py
 archeo/simulation/simulate_merger.py
-archeo/ui/__init__.py
-archeo/ui/app.py
-archeo/ui/visualization.py
 archeo/utils/__init__.py
 archeo/utils/decorator.py
 archeo/utils/env.py

{archeo-2.0.0.dev2 → archeo-2.0.0.dev4}/archeo.egg-info/requires.txt

@@ -11,8 +11,3 @@ seaborn>=0.13.2
 surfinbh>=1.2.7
 tabulate>=0.10.0
 tqdm>=4.67.3
-
-[ui]
-nbformat>=5.10.4
-plotly>=6.6.0
-streamlit>=1.55.0

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

@@ -16,7 +16,7 @@ classifiers = [
     "Operating System :: OS Independent"
 ]
 keywords = ["black-holes", "gravitational-waves", "black-hole-archeology"]
-version = "2.0.0.dev2"
+version = "2.0.0.dev4"
 readme = "README.md"
 requires-python = ">=3.11,<3.14"
 dependencies = [
@@ -35,13 +35,6 @@ dependencies = [
     "tqdm>=4.67.3",
 ]
 
-[project.optional-dependencies]
-ui = [
-    "nbformat>=5.10.4",
-    "plotly>=6.6.0",
-    "streamlit>=1.55.0",
-]
-
 [project.urls]
 homepage = "https://pypi.org/project/archeo/"
 repository = "https://github.com/wyhwong/archeo"
@@ -52,6 +45,8 @@ dev = [
     "ipykernel>=6.9.2, <7.0.0",
     "pre-commit>=4.5.1",
     "pyarrow>=23.0.1",
+    "pyinstrument>=5.1.2",
+    "pylint>=4.0.5",
     "pytest>=9.0.2",
     "pytest-cov>=7.0.0",
 ]
@@ -60,11 +55,6 @@ mkdocs = [
     "mkdocs-jupyter>=0.25.1",
     "mkdocs-mermaid2-plugin>=1.2.3",
 ]
-ui = [
-    "nbformat>=5.10.4",
-    "plotly>=6.6.0",
-    "streamlit>=1.55.0",
-]
 
 [tool.black]
 line-length = 120

archeo-2.0.0.dev2/archeo/ui/__init__.py

@@ -1,8 +0,0 @@
-import subprocess
-
-import archeo
-
-
-# Run the Streamlit app
-dist_path = archeo.__path__[0]
-subprocess.run(["streamlit", "run", f"{dist_path}/ui/app.py"])  # pylint: disable=subprocess-run-check

archeo-2.0.0.dev2/archeo/ui/app.py

@@ -1,123 +0,0 @@
-import plotly.graph_objects as go
-import streamlit as st
-
-from archeo.constants.enum import Fits
-from archeo.data_structures.distribution import Uniform
-from archeo.data_structures.math import Domain
-from archeo.data_structures.physics.binary import BinaryGenerator
-from archeo.data_structures.physics.black_hole import BlackHoleGenerator
-from archeo.postprocessing.dataframe import convert_simulated_binaries_to_dataframe
-from archeo.simulation.simulate_merger import simulate_black_hole_mergers
-from archeo.ui.visualization import add_pdf
-
-
-st.set_page_config(page_title="Exploring Distribution of Remnant Properties", layout="wide")
-
-###############################################
-#                Sidebar Content              #
-###############################################
-
-st.sidebar.markdown("## Configure Your Ancestral Priors")
-
-# Store slider values in session state
-prior_name = st.sidebar.text_input("Name of the prior", "My prior")
-spin_setting = st.sidebar.selectbox("Spin setting", ["Aligned spin", "Precession spin"])
-n_samples = st.sidebar.slider("Number of samples", min_value=1000, max_value=10000, value=1000)
-n_workers = st.sidebar.slider("Number of workers", min_value=1, max_value=16, value=1)
-q_range = st.sidebar.slider("Mass ratio $q$", min_value=1.0, max_value=6.0, value=(1.0, 6.0))
-
-st.sidebar.markdown("#### Primary Black Hole Settings")
-m1_range = st.sidebar.slider("Mass $m_1$", min_value=5.0, max_value=200.0, value=(5.0, 200.0))
-a1_range = st.sidebar.slider("Spin $\\chi_1$", min_value=0.0, max_value=0.99, value=(0.0, 0.99))
-
-if spin_setting == "Precession spin":
-    phi1_range = st.sidebar.slider("Azimuthal angle $\\phi_1$", min_value=0.0, max_value=2.0, value=(0.0, 2.0))
-    theta1_range = st.sidebar.slider("Polar angle $\\theta_1$", min_value=0.0, max_value=1.0, value=(0.0, 1.0))
-else:
-    phi1_range = theta1_range = (0.0, 0.0)
-
-st.sidebar.markdown("#### Secondary Black Hole Settings")
-m2_range = st.sidebar.slider("Mass $m_2$", min_value=5.0, max_value=200.0, value=(5.0, 200.0))
-a2_range = st.sidebar.slider("Spin $\\chi_2$", min_value=0.0, max_value=0.99, value=(0.0, 0.99))
-
-if spin_setting == "Precession spin":
-    phi2_range = st.sidebar.slider("Azimuthal angle $\\phi_2$", min_value=0.0, max_value=2.0, value=(0.0, 2.0))
-    theta2_range = st.sidebar.slider("Polar angle $\\theta_2$", min_value=0.0, max_value=1.0, value=(0.0, 1.0))
-else:
-    phi2_range = theta2_range = (0.0, 0.0)
-
-###############################################
-#                Main Content                 #
-###############################################
-
-st.markdown(
-    """
-    # Exploring Distribution of Remnant Properties
-
-    ## Introduction
-
-    This application allows users to configure the distributions for properties
-    of black hole binaries and visualize the distribution of their remnant
-    properties. By adjusting mass, spin, and alignment settings, users can generate
-    samples and study the properties of remnant black holes.
-
-    If you found hierarchical formation of black holes interesting and want to learn more,
-    please refer to our paper:
-
-    [1] Carlos Araújo Álvarez, Henry W. Y. Wong, Juan Calderón Bustillo. "Kicking Time
-        Back in Black Hole Mergers: Ancestral Masses, Spins, Birth Recoils, and
-        Hierarchical-formation Viability of GW190521." The Astrophysical Journal
-        977.2 (2024): 220.
-    """
-)
-
-
-if "figs" not in st.session_state:
-    st.session_state["figs"] = {}
-    for col, label in {
-        "k_f": "Birth Recoil k<sub>f</sub> [km s<sup>-1</sup>]",
-        "a_f": "Spin χ<sub>f</sub> [-]",
-        "m_f": "Mass m<sub>f</sub> [M<sub>Sun</sub>]",
-    }.items():
-        st.session_state.figs[col] = go.Figure()
-        st.session_state.figs[col].update_layout(
-            title="Probability Density Function",
-            xaxis_title=label,
-            yaxis_title="Density",
-            showlegend=True,
-            barmode="overlay",
-        )
-
-if st.sidebar.button("Run"):
-
-    fits = Fits.NRSUR7DQ4REMNANT if spin_setting == "Precession spin" else Fits.NRSUR3DQ8REMNANT
-    generator_bh1 = BlackHoleGenerator(
-        mass_distribution=Uniform(low=m1_range[0], high=m1_range[1]),
-        spin_magnitude_distribution=Uniform(low=a1_range[0], high=a1_range[1]),
-        phi_distribution=Uniform(low=phi1_range[0], high=phi1_range[1]),
-        theta_distribution=Uniform(low=theta1_range[0], high=theta1_range[1]),
-    )
-    generator_bh2 = BlackHoleGenerator(
-        mass_distribution=Uniform(low=m2_range[0], high=m2_range[1]),
-        spin_magnitude_distribution=Uniform(low=a2_range[0], high=a2_range[1]),
-        phi_distribution=Uniform(low=phi2_range[0], high=phi2_range[1]),
-        theta_distribution=Uniform(low=theta2_range[0], high=theta2_range[1]),
-    )
-    binary_generator = BinaryGenerator(
-        primary_black_hole_source=generator_bh1,
-        secondary_black_hole_source=generator_bh2,
-        mass_ratio_domain=Domain(low=q_range[0], high=q_range[1]),
-        is_aligned_spin=(spin_setting == "Aligned spin"),
-    )
-
-    with st.spinner("Running simulation... Please wait..."):
-
-        black_hole_mergers = simulate_black_hole_mergers(binary_generator, fits, n_samples, n_workers)
-        df = convert_simulated_binaries_to_dataframe(black_hole_mergers)
-
-        st.write("## Visualization of Remnant Properties")
-        for col in ["k_f", "a_f", "m_f"]:
-            add_pdf(st.session_state.figs[col], df[col], prior_name)
-            st.plotly_chart(st.session_state.figs[col])
-
-    st.success("Simulation completed!")

archeo-2.0.0.dev2/archeo/ui/visualization.py

@@ -1,15 +0,0 @@
-import pandas as pd
-import plotly.graph_objects as go
-
-
-def add_pdf(fig: go.Figure, series: pd.Series, label: str) -> None:
-    """Plot the distribution of a column in a dataframe."""
-
-    fig.add_trace(
-        go.Histogram(
-            x=series,
-            histnorm="probability density",
-            opacity=0.75,
-            name=label,
-        )
-    )