archeo 2.0.0.dev6__tar.gz → 2.0.0.dev7__tar.gz

{archeo-2.0.0.dev6 → archeo-2.0.0.dev7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archeo
-Version: 2.0.0.dev6
+Version: 2.0.0.dev7
 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.dev7/archeo/constants/bayesian.py

@@ -0,0 +1,3 @@
+DEFAULT_BINSIZE_MASS: float = 2.0
+DEFAULT_BINSIZE_SPIN: float = 0.1
+ASSUME_PARAMETER_INDEPENDENCE: bool = False

archeo-2.0.0.dev7/archeo/constants/physics.py

@@ -0,0 +1,58 @@
+import enum
+
+import pandas as pd
+from pydantic import BaseModel, NonNegativeFloat
+
+
+SPEED_OF_LIGHT = 299792.458  # km/s
+
+
+class _TypicalHostEscapeVelocityMeta(BaseModel):
+    v_esc: NonNegativeFloat  # km s^-1
+    short: str
+    latex: str
+
+
+class TypicalHostEscapeVelocity(enum.Enum):
+    """Escape velocity (units: km s^-1)."""
+
+    GLOBULAR_CLUSTER = _TypicalHostEscapeVelocityMeta(v_esc=50.0, short="GC", latex=r"$v_{esc, GC}$")
+    MILKY_WAY = _TypicalHostEscapeVelocityMeta(v_esc=600.0, short="MW", latex=r"$v_{esc, MW}$")
+    NUCLEAR_STAR_CLUSTER = _TypicalHostEscapeVelocityMeta(v_esc=1500.0, short="NSC", latex=r"$v_{esc, NSC}$")
+    ELLIPTICAL_GALAXY = _TypicalHostEscapeVelocityMeta(v_esc=2500.0, short="EG", latex=r"$v_{esc, EG}$")
+
+    @property
+    def v_esc(self) -> float:
+        return self.value.v_esc
+
+    @property
+    def short(self) -> str:
+        return self.value.short
+
+    @property
+    def latex(self) -> str:
+        return self.value.latex
+
+    def compute_p2g(
+        self,
+        df: pd.DataFrame,
+        max_mass: float = 65.0,
+        kf_col: str = "k_f",
+        m1_col: str = "m_1",
+        m2_col: str = "m_2",
+    ) -> float:
+        """Probability of being 2nd-generation under this escape velocity."""
+
+        if df.empty:
+            return 0.0
+
+        mask = (df[kf_col] <= self.v_esc) & (df[m1_col] <= max_mass) & (df[m2_col] <= max_mass)
+        return mask.mean() * 100.0
+
+    @classmethod
+    def latex_to_values(cls) -> dict[str, float]:
+        return {m.latex: m.v_esc for m in cls}
+
+    @classmethod
+    def short_to_values(cls) -> dict[str, float]:
+        return {m.short: m.v_esc for m in cls}

{archeo-2.0.0.dev6 → archeo-2.0.0.dev7}/archeo/visualization/base.py

@@ -5,7 +5,7 @@ import matplotlib.pyplot as plt
 import numpy as np
 import pandas as pd
 
-from archeo.constants.physics import EscapeVelocity
+from archeo.constants.physics import TypicalHostEscapeVelocity
 from archeo.data_structures.visualization import Labels, Padding
 from archeo.utils.fs import check_and_create_dir
 from archeo.utils.logger import get_logger
@@ -112,7 +112,7 @@ def add_escape_velocity(ax, v_max: float, y_max: float, log_xscale: bool = False
 
     colors = iter(mcolors.TABLEAU_COLORS.keys())
     # Plot vertical lines and labels (escape velocities)
-    for label, v_esc in EscapeVelocity.to_vlines().items():
+    for label, v_esc in TypicalHostEscapeVelocity.latex_to_values().items():
         # Skip if out of scope
         if v_esc > v_max:
             return

{archeo-2.0.0.dev6 → archeo-2.0.0.dev7}/archeo/visualization/estimation.py

@@ -8,7 +8,7 @@ import numpy as np
 import pandas as pd
 import seaborn as sns
 
-from archeo.constants.physics import EscapeVelocity
+from archeo.constants.physics import TypicalHostEscapeVelocity
 from archeo.data_structures.visualization import Labels, Padding
 from archeo.utils.logger import get_logger
 from archeo.visualization import base
@@ -363,7 +363,7 @@ def table_estimates(
     data = {
         "": dfs.keys(),
         "Recovery Rate": [df["m_1"].notna().sum() / df.shape[0] for df in dfs.values()],
-        **{f"p2g_{v_esc.short()}": [v_esc.compute_p2g(df) for df in dfs.values()] for v_esc in EscapeVelocity},
+        **{f"p2g_{v_esc.short}": [v_esc.compute_p2g(df) for df in dfs.values()] for v_esc in TypicalHostEscapeVelocity},
     }
 
     for col, name in col_to_names.items():

{archeo-2.0.0.dev6 → archeo-2.0.0.dev7}/archeo.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: archeo
-Version: 2.0.0.dev6
+Version: 2.0.0.dev7
 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.dev6 → archeo-2.0.0.dev7}/pyproject.toml

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

archeo-2.0.0.dev6/archeo/constants/bayesian.py

@@ -1,3 +0,0 @@
-DEFAULT_BINSIZE_MASS = 2.0
-DEFAULT_BINSIZE_SPIN = 0.1
-ASSUME_PARAMETER_INDEPENDENCE = False

archeo-2.0.0.dev6/archeo/constants/physics.py

@@ -1,70 +0,0 @@
-import enum
-
-import pandas as pd
-
-
-SPEED_OF_LIGHT = 299792.458  # km/s
-
-
-class EscapeVelocity(enum.Enum):
-    """Escape velocity (Unit in km s^-1)"""
-
-    GLOBULAR_CLUSTER = 50.0
-    MILKY_WAY = 600.0
-    NUCLEAR_STAR_CLUSTER = 1500.0
-    ELLIPTICAL_GALAXY = 2500.0
-
-    def label(self) -> str:
-        """Return the escape velocity label"""
-
-        if self is EscapeVelocity.GLOBULAR_CLUSTER:
-            return "$v_{esc, GC}$"
-
-        if self is EscapeVelocity.MILKY_WAY:
-            return "$v_{esc, MW}$"
-
-        if self is EscapeVelocity.NUCLEAR_STAR_CLUSTER:
-            return "$v_{esc, NSC}$"
-
-        if self is EscapeVelocity.ELLIPTICAL_GALAXY:
-            return "$v_{esc, EG}$"
-
-        raise ValueError(f"Unknown escape velocity {self}")
-
-    def short(self) -> str:
-        """Return the short name of the escape velocity"""
-
-        if self is EscapeVelocity.GLOBULAR_CLUSTER:
-            return "GC"
-
-        if self is EscapeVelocity.MILKY_WAY:
-            return "MW"
-
-        if self is EscapeVelocity.NUCLEAR_STAR_CLUSTER:
-            return "NSC"
-
-        if self is EscapeVelocity.ELLIPTICAL_GALAXY:
-            return "EG"
-
-        raise ValueError(f"Unknown escape velocity {self}")
-
-    def compute_p2g(self, df: pd.DataFrame) -> float:
-        """Return the probability of
-        the black hole being a 2nd generation black hole
-        under different escape velocity conditions."""
-
-        if df.empty:
-            return 0.0
-
-        mask = (df["k_f"] <= self.value) & (df["m_1"] <= 65) & (df["m_2"] <= 65)
-        return mask.sum() / len(df) * 100.0
-
-    @classmethod
-    def to_vlines(cls) -> dict[str, float]:
-        """Return a dictionary for vlines plotting
-
-        Returns:
-            vlines (Dict[str, float]): The escape velocity vlines.
-        """
-
-        return {esc_vel.label(): esc_vel.value for esc_vel in cls}