Merge pull request #510 from PyFstat/508-fix-ipg-examples

isotropic_amplitude_priors is not global anymore
PyFstat · Dec 1, 2022 · 1458a1f · 1458a1f
2 parents 5239a9a + b8252e4
commit 1458a1f
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 5 deletions.
diff --git a/examples/other_examples/PyFstat_example_InjectionParametersGenerator.py b/examples/other_examples/PyFstat_example_InjectionParametersGenerator.py
@@ -14,7 +14,7 @@
     AllSkyInjectionParametersGenerator,
     InjectionParametersGenerator,
     Writer,
-    isotropic_amplitude_priors,
+    isotropic_amplitude_distribution,
     set_up_logger,
 )
 
@@ -53,7 +53,7 @@
 amplitude_params_generator = InjectionParametersGenerator(
     priors={
         "h0": {"stats.norm": {"loc": 1e-24, "scale": 1e-26}},
-        **isotropic_amplitude_priors,
+        **isotropic_amplitude_distribution,
     },
     seed=42,
 )

diff --git a/examples/tutorials/1_generating_signals.ipynb b/examples/tutorials/1_generating_signals.ipynb
@@ -296,7 +296,7 @@
     "from generic distributions in a suitable format, ready to be fed into `pyfstat.Writer`.\n",
     "Uniform sampling across the sky is baked in the child class `pyfstat.AllSkyInjectionParametersGenerator`,\n",
     "and isotropic priors on amplitude parameters are available in \n",
-    "`pyfstat.injection_parameters.isotropic_amplitude_priors`.\n",
+    "`pyfstat.isotropic_amplitude_distribution`.\n",
     "\n",
     "All-sky searches tend to perform injection campaigns at fixed values of `h0` (or, equivalently, $\\mathcal{D}$)."
    ]
@@ -327,7 +327,7 @@
     "        \"F1\": -1e-10,\n",
     "        \"F2\": 0,\n",
     "        \"h0\": writer_kwargs[\"sqrtSX\"] / 10,  # Fix amplitude at depth 10.\n",
-    "        **pyfstat.injection_parameters.isotropic_amplitude_priors,\n",
+    "        **pyfstat.isotropic_amplitude_distribution,\n",
     "        \"tref\": writer_kwargs[\"tstart\"],\n",
     "    },\n",
     ")\n",

diff --git a/pyfstat/__init__.py b/pyfstat/__init__.py
@@ -33,6 +33,7 @@
 from .injection_parameters import (
     AllSkyInjectionParametersGenerator,
     InjectionParametersGenerator,
+    isotropic_amplitude_distribution,
 )
 from .make_sfts import (
     BinaryModulatedWriter,

diff --git a/pyfstat/injection_parameters.py b/pyfstat/injection_parameters.py
@@ -76,7 +76,7 @@ def negative_log_uniform(generator, size):
 
 We are following here R. Prix: https://dcc.ligo.org/T0900149-v6/public
 """
-isotropic_amplitude_priors = {
+isotropic_amplitude_distribution = {
     "cosi": {"stats.uniform": {"loc": -1.0, "scale": 2.0}},
     "psi": {"stats.uniform": {"loc": -0.25 * np.pi, "scale": 0.5 * np.pi}},
     "phi": {"stats.uniform": {"loc": 0, "scale": 2 * np.pi}},
@@ -377,3 +377,26 @@ def __init__(
         super().__init__(
             priors={**priors, **sky_priors}, seed=seed, generator=generator
         )
+
+
+deprecated_vars = {
+    "isotropic_amplitude_priors": "isotropic_amplitude_distribution",
+}
+
+
+def __getattr__(var_name):
+
+    current_module = __import__(__name__)
+
+    if var_name not in deprecated_vars:
+        return getattr(current_module, var_name)
+
+    current_name = deprecated_vars[var_name]
+
+    logger.warning(
+        f"Variable `{var_name}` is deprecated"
+        " and will be removed in a future release."
+        f" Please use `{current_name}` for any new code."
+    )
+
+    return getattr(current_module, current_name)