redback 1.0.0__tar.gz → 1.0.2__tar.gz

{redback-1.0.0 → redback-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: redback
-Version: 1.0.0
+Version: 1.0.2
 Summary: A Bayesian inference pipeline for electromagnetic transients
 Home-page: https://github.com/nikhil-sarin/redback
 Author: Nikhil Sarin, Moritz Huebner
@@ -17,7 +17,7 @@ License-File: LICENCE.md
 ![Python package](https://github.com/nikhil-sarin/redback/workflows/Python%20application/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/nikhil-sarin/redback/badge.svg?branch=master)](https://coveralls.io/github/nikhil-sarin/redback?branch=master)
 ![PyPI](https://img.shields.io/pypi/v/redback)
-
+[![arXiv](https://img.shields.io/badge/arXiv-2308.12806-00ff00.svg)](https://arxiv.org/abs/2308.12806)
 # Redback
 Introducing REDBACK, a bayesian inference software package for fitting electromagnetic transients
 
@@ -45,9 +45,12 @@ Simulate single transients or populations or simulate a full survey including no
 
 ### Contributing
 If you are interested in contributing please join the redback 
-[slack](https://join.slack.com/t/redback-group/shared_invite/zt-21rsoa26s-kibI8MiA1JiIKM0wCMp5rQ)
+[slack](https://join.slack.com/t/redback-group/shared_invite/zt-2gp2chjq8-lG15C4YorVW4PmL86dYuVw)
 and email [Nikhil Sarin](mailto:nikhil.sarin@su.se?subject=Contributing%20to%20redback).
 
 To make changes to redback, we require users to use a merge request system. 
 
-
+### User/Dev calls
+We have regular calls for users and developers. 
+These include tutorials on specific redback functionality as well as discussions of new features/feature requests, 
+and Q/A. Please join the slack to get details of these calls.

{redback-1.0.0 → redback-1.0.2}/README.md

@@ -2,7 +2,7 @@
 ![Python package](https://github.com/nikhil-sarin/redback/workflows/Python%20application/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/github/nikhil-sarin/redback/badge.svg?branch=master)](https://coveralls.io/github/nikhil-sarin/redback?branch=master)
 ![PyPI](https://img.shields.io/pypi/v/redback)
-
+[![arXiv](https://img.shields.io/badge/arXiv-2308.12806-00ff00.svg)](https://arxiv.org/abs/2308.12806)
 # Redback
 Introducing REDBACK, a bayesian inference software package for fitting electromagnetic transients
 
@@ -30,9 +30,12 @@ Simulate single transients or populations or simulate a full survey including no
 
 ### Contributing
 If you are interested in contributing please join the redback 
-[slack](https://join.slack.com/t/redback-group/shared_invite/zt-21rsoa26s-kibI8MiA1JiIKM0wCMp5rQ)
+[slack](https://join.slack.com/t/redback-group/shared_invite/zt-2gp2chjq8-lG15C4YorVW4PmL86dYuVw)
 and email [Nikhil Sarin](mailto:nikhil.sarin@su.se?subject=Contributing%20to%20redback).
 
 To make changes to redback, we require users to use a merge request system. 
 
-
+### User/Dev calls
+We have regular calls for users and developers. 
+These include tutorials on specific redback functionality as well as discussions of new features/feature requests, 
+and Q/A. Please join the slack to get details of these calls.

{redback-1.0.0 → redback-1.0.2}/redback/__init__.py

@@ -2,3 +2,7 @@ from redback import analysis, constants, get_data, redback_errors, priors, resul
     transient_models, utils, photosphere, sed, interaction_processes, constraints, plotting, model_library, simulate_transients
 from redback.transient import afterglow, kilonova, prompt, supernova, tde
 from redback.sampler import fit_model
+from redback.utils import setup_logger
+
+__version__ = "1.0.2"
+setup_logger(log_level='info')

{redback-1.0.0 → redback-1.0.2}/redback/constraints.py

@@ -2,6 +2,7 @@ import numpy as np
 import redback.eos as eos
 from redback.constants import *
 from redback.utils import calc_tfb
+from scipy.interpolate import interp1d
 
 def slsn_constraint(parameters):
     """
@@ -23,7 +24,7 @@ def slsn_constraint(parameters):
     neutrino_energy = 1e51
     total_energy = kinetic_energy + neutrino_energy
     # ensure rotational energy is greater than total output energy
-    converted_parameters['erot_constraint'] = rotational_energy - total_energy
+    converted_parameters['erot_constraint'] = total_energy/rotational_energy
     # ensure t_nebula is greater than 100 days
     converted_parameters['t_nebula_min'] = tnebula - 100
     return converted_parameters
@@ -43,7 +44,7 @@ def basic_magnetar_powered_sn_constraints(parameters):
     kinetic_energy = 0.5 * mej * vej**2
     rotational_energy = 2.6e52 * (mass_ns/1.4)**(3./2.) * p0**(-2)
     # ensure rotational energy is greater than total output energy
-    converted_parameters['erot_constraint'] = rotational_energy - kinetic_energy
+    converted_parameters['erot_constraint'] = kinetic_energy/rotational_energy
     return converted_parameters
 
 def general_magnetar_powered_sn_constraints(parameters):
@@ -61,7 +62,7 @@ def general_magnetar_powered_sn_constraints(parameters):
     tau = parameters['tsd']
     rotational_energy = 2*l0*tau
     # ensure rotational energy is greater than total output energy
-    converted_parameters['erot_constraint'] = rotational_energy - kinetic_energy
+    converted_parameters['erot_constraint'] = kinetic_energy/rotational_energy
     return converted_parameters
     
 def general_magnetar_powered_supernova_constraints(parameters):
@@ -77,7 +78,7 @@ def general_magnetar_powered_supernova_constraints(parameters):
     nn = parameters['nn']    
     rotational_energy = (nn-1)*l0*tau/2.0
     # ensure rotational energy is less than the maximum spin down energy
-    converted_parameters['erot_constraint'] = 1e53 - rotational_energy
+    converted_parameters['erot_constraint'] = rotational_energy/1e53
     return converted_parameters    
 
 def tde_constraints(parameters):
@@ -91,7 +92,7 @@ def tde_constraints(parameters):
     rp = parameters['pericenter_radius']
     mass_bh = parameters['mass_bh']
     schwarzchild_radius = (2 * graviational_constant * mass_bh * solar_mass /(speed_of_light**2))/au_cgs
-    converted_parameters['disruption_radius'] = rp - schwarzchild_radius
+    converted_parameters['disruption_radius'] = schwarzchild_radius/rp
     return converted_parameters
 
 def gaussianrise_tde_constraints(parameters):
@@ -103,13 +104,11 @@ def gaussianrise_tde_constraints(parameters):
     converted_parameters = parameters.copy()
     ms = parameters['stellar_mass']
     mbh6 = parameters['mbh_6']
-    etamin = 0.01*(ms**(-7./15.))*(mbh6**(2./3.))
     betamax = 12.*(ms**(7./15.))*(mbh6**(-2./3.))
     tfb = calc_tfb(binding_energy_const=0.8, mbh_6=mbh6,stellar_mass=ms)/86400
     tfb_obs = tfb * (1 + parameters['redshift'])
-    converted_parameters['eta_low'] = converted_parameters['eta'] - etamin
-    converted_parameters['beta_high'] = betamax - converted_parameters['beta']
-    converted_parameters['tfb_max'] = tfb_obs - converted_parameters['peak_time']
+    converted_parameters['beta_high'] = converted_parameters['beta']/betamax
+    converted_parameters['tfb_max'] = converted_parameters['peak_time']/tfb_obs
     return converted_parameters
 
 def nuclear_burning_constraints(parameters):
@@ -126,7 +125,7 @@ def nuclear_burning_constraints(parameters):
     kinetic_energy = 0.5 * mej * (vej / 2.0) ** 2
     excess_constant = -(56.0 / 4.0 * 2.4249 - 53.9037) / proton_mass * mev_cgs
     emax = excess_constant * mej * fnickel
-    converted_parameters['emax_constraint'] = emax - kinetic_energy
+    converted_parameters['emax_constraint'] = kinetic_energy/emax
     return converted_parameters
 
 def simple_fallback_constraints(parameters):
@@ -149,7 +148,7 @@ def simple_fallback_constraints(parameters):
     neutrino_energy = 1e51
     total_energy = e_fallback + neutrino_energy
     # ensure total energy is greater than kinetic energy
-    converted_parameters['en_constraint'] = total_energy - kinetic_energy
+    converted_parameters['en_constraint'] = kinetic_energy/total_energy
     # ensure t_nebula is greater than 100 days
     converted_parameters['t_nebula_min'] = tnebula - 100
     return converted_parameters
@@ -162,15 +161,18 @@ def csm_constraints(parameters):
     :param parameters: dictionary of parameters
     :return: converted_parameters dictionary where the violated samples are thrown out
     """
-    from redback.utils import get_csm_properties
     converted_parameters = parameters.copy()
     mej = parameters['mej']
     csm_mass = parameters['csm_mass']
     kappa = parameters['kappa']
     r0 = parameters['r0']
     vej = parameters['vej']
-    nn = parameters.get('nn', np.ones(len(mej)) * 12.)
-    delta = parameters.get('delta', np.ones(len(mej)))
+    if hasattr(parameters['mej'], "__len__"):
+        nn = parameters.get('nn', np.ones(len(mej)) * 8.)
+        delta = parameters.get('delta', np.ones(len(mej)))
+    else:
+        nn = parameters.get('nn', 12.)
+        delta = parameters.get('delta', 0.)
     eta = parameters['eta']
     rho = parameters['rho']
 
@@ -180,12 +182,16 @@ def csm_constraints(parameters):
     vej = vej * km_cgs
     Esn = 3. * vej ** 2 * mej / 10.
 
-    AA = np.zeros(len(mej))
-    Bf = np.zeros(len(mej))
-    for x in range(len(mej)):
-        csm_properties = get_csm_properties(nn[x], eta[x])
-        AA[x] = csm_properties.AA
-        Bf[x] = csm_properties.Bf
+    ns = [6, 7, 8, 9, 10, 12, 14]
+    Bfs = [1.377, 1.299, 1.267, 1.250, 1.239, 1.226, 1.218]
+    As = [0.62, 0.27, 0.15, 0.096, 0.067, 0.038, 0.025]
+
+    Bf_func = interp1d(ns, Bfs)
+    A_func = interp1d(ns, As)
+
+    Bf = Bf_func(nn)
+    AA = A_func(nn)
+
     qq = rho * r0 ** eta
     # outer CSM shell radius
     radius_csm = ((3.0 - eta) / (4.0 * np.pi * qq) * csm_mass + r0 ** (3.0 - eta)) ** (
@@ -203,14 +209,14 @@ def csm_constraints(parameters):
                    (3.0 - delta) * (nn - 3.0) * mej) ** ((nn - 5.0) / 2.0))
 
     tshock = ((radius_csm - r0) / Bf / (AA * g_n / qq) ** (
-                       1. / (nn - eta))) ** ((nn - eta) /(nn - 3))
+                       1. / (nn - eta))) ** ((nn - eta) / (nn - 3))
 
-    diffusion_time = np.sqrt(2. * kappa * mass_csm_threshold /(vej * 13.7 * 3.e10))
+    diffusion_time = np.sqrt(2. * kappa * mass_csm_threshold / (vej * 13.7 * 3.e10))
     # ensure shock crossing time is greater than diffusion time
-    # converted_parameters['shock_time'] = tshock - diffusion_time
+    converted_parameters['shock_time'] = diffusion_time/tshock
     # ensure photospheric radius is within the csm i.e., r_photo < radius_csm and r_photo > r0
-    converted_parameters['photosphere_constraint_1'] = radius_csm - r_photosphere
-    converted_parameters['photosphere_constraint_2'] = r_photosphere - r0
+    converted_parameters['photosphere_constraint_1'] = r_photosphere/radius_csm
+    converted_parameters['photosphere_constraint_2'] = r0/r_photosphere
     return converted_parameters
 
 def piecewise_polytrope_eos_constraints(parameters):

{redback-1.0.0 → redback-1.0.2}/redback/ejecta_relations.py

@@ -288,7 +288,7 @@ class TwoComponentBNS(object):
 
 
 class TwoComponentNSBH(object):
-    def __init__(self, mass_bh, mass_ns, chi_eff, lambda_ns, zeta):
+    def __init__(self, mass_bh, mass_ns, chi_bh, lambda_ns, zeta):
         """
         Relations to connect intrinsic GW parameters to extrinsic kilonova parameters
         for a neutron star black hole merger with two components using relations from Kawaguchi et al. 2016.
@@ -296,14 +296,14 @@ class TwoComponentNSBH(object):
 
         :param mass_bh: mass of black hole
         :param mass_2: mass of neutron star
-        :param chi_eff: effective spin of black hole
+        :param chi_bh: spin of black hole along Z axis
         :param lambda_ns: tidal deformability of neutron star
         :param zeta: fraction of disk that gets unbound
         """
         self.mass_bh = mass_bh
         self.mass_ns = mass_ns
         self.mass_ratio = mass_bh/mass_ns
-        self.chi_eff = chi_eff
+        self.chi_bh = chi_bh
         self.lambda_ns = lambda_ns
         self.zeta = zeta
         self.reference = ['https://ui.adsabs.harvard.edu/abs/2016ApJ...825...52K/abstract',
@@ -320,7 +320,7 @@ class TwoComponentNSBH(object):
 
         :return: Normalized radius of the Innermost Stable Circular Orbit
         """
-        chi_bh = self.chi_eff
+        chi_bh = self.chi_bh
         z1 = 1 + (1 - chi_bh ** 2) ** (1 / 3) * (
                 (1 + chi_bh) ** (1 / 3) + (1 - chi_bh) ** (1 / 3))
         z2 = np.sqrt(3 * chi_bh ** 2 + z1 ** 2)
@@ -378,20 +378,20 @@ class TwoComponentNSBH(object):
         return mej_disk_wind
 
 class OneComponentNSBH(object):
-    def __init__(self, mass_bh, mass_ns, chi_eff, lambda_ns):
+    def __init__(self, mass_bh, mass_ns, chi_bh, lambda_ns):
         """
         Relations to connect intrinsic GW parameters to extrinsic kilonova parameters
         for a neutron star black hole merger with one component (zone) from Kawaguchi et al. 2016.
 
         :param mass_bh: mass of black hole
         :param mass_2: mass of neutron star
-        :param chi_eff: effective spin of black hole
+        :param chi_bh: spin of black hole along z axis
         :param lambda_ns: tidal deformability of neutron star
         """
         self.mass_bh = mass_bh
         self.mass_ns = mass_ns
         self.mass_ratio = mass_bh/mass_ns
-        self.chi_eff = chi_eff
+        self.chi_bh = chi_bh
         self.lambda_ns = lambda_ns
         self.reference = 'https://ui.adsabs.harvard.edu/abs/2016ApJ...825...52K/abstract'
         self.risco = self.isco_radius
@@ -405,7 +405,7 @@ class OneComponentNSBH(object):
 
         :return: isco radius
         """
-        chi = self.chi_eff
+        chi = self.chi_bh
         z1 = 1 + ((1 - chi * chi) ** (1 / 3.0)) * (((1 + chi) ** (1 / 3.0)) + (1 - chi) ** (1 / 3.0))
         z2 = (3 * chi * chi + z1 * z1) ** (1 / 2.0)
         risco = 3 + z2 - np.sign(chi) * ((3 - z1) * (3 + z1 + 2 * z2)) ** (1 / 2.0)

{redback-1.0.0 → redback-1.0.2}/redback/get_data/lasair.py

@@ -58,8 +58,8 @@ class LasairDataGetter(DataGetter):
                 f"Are you sure you are using the right alias?")
         data = pd.read_html(self.url)
         data = data[1]
-        data['diff_magnitude'] = [data['magpsf'].iloc[x].split(" ")[0] for x in range(len(data))]
-        data['diff_magnitude_error'] = [data['magpsf'].iloc[x].split(" ")[-1] for x in range(len(data))]
+        data['diff_magnitude'] = [data['unforced mag'].iloc[x].split(" ")[0] for x in range(len(data))]
+        data['diff_magnitude_error'] = [data['unforced mag'].iloc[x].split(" ")[-1] for x in range(len(data))]
 
         logger.warning('Using the difference magnitude to calculate quantities. '
                        'Reduce the data yourself if you would like to use a reference magnitude')
@@ -67,7 +67,6 @@ class LasairDataGetter(DataGetter):
         # Change the dataframe to the correct raw dataframe format
         del data['UTC']
         del data['images']
-        del data['magpsf']
         data.to_csv(self.raw_file_path, index=False)
         logger.info(f"Retrieved data for {self.transient}.")
 
@@ -83,7 +82,7 @@ class LasairDataGetter(DataGetter):
             return pd.read_csv(self.processed_file_path)
 
         raw_data = pd.read_csv(self.raw_file_path)
-        raw_data = raw_data[raw_data['difference flux status'] != 'limit']
+        raw_data = raw_data[raw_data['unforced mag status'] != 'limit']
         lasair_to_general_bands = {"g": "ztfg", "r": "ztfr", "i":'ztfi'}
         processed_data = pd.DataFrame()
 

{redback-1.0.0 → redback-1.0.2}/redback/get_data/swift.py

@@ -199,9 +199,9 @@ class SwiftDataGetter(GRBDataGetter):
         driver = fetch_driver()
         try:
             driver.get(self.grb_website)
-            driver.find_element_by_xpath("//select[@name='xrtsub']/option[text()='no']").click()
+            driver.find_element("xpath", "//select[@name='xrtsub']/option[text()='no']").click()
             time.sleep(20)
-            driver.find_element_by_id("xrt_DENSITY_makeDownload").click()
+            driver.find_element("id","xrt_DENSITY_makeDownload").click()
             time.sleep(20)
             grb_url = driver.current_url
             # scrape the data
@@ -227,19 +227,19 @@ class SwiftDataGetter(GRBDataGetter):
             # select option for BAT bin_size
             bat_binning = 'batxrtbin'
             if check_element(driver, bat_binning):
-                driver.find_element_by_xpath("//select[@name='batxrtbin']/option[text()='SNR 4']").click()
+                driver.find_element("xpath", "//select[@name='batxrtbin']/option[text()='SNR 4']").click()
             # select option for subplot
             subplot = "batxrtsub"
             if check_element(driver, subplot):
-                driver.find_element_by_xpath("//select[@name='batxrtsub']/option[text()='no']").click()
+                driver.find_element("xpath","//select[@name='batxrtsub']/option[text()='no']").click()
             # Select option for flux density
             flux_density1 = "batxrtband1"
             flux_density0 = "batxrtband0"
             if (check_element(driver, flux_density1)) and (check_element(driver, flux_density0)):
-                driver.find_element_by_xpath(".//*[@id='batxrtband1']").click()
-                driver.find_element_by_xpath(".//*[@id='batxrtband0']").click()
+                driver.find_element("xpath",".//*[@id='batxrtband1']").click()
+                driver.find_element("xpath",".//*[@id='batxrtband0']").click()
             # Generate data file
-            driver.find_element_by_xpath(".//*[@id='batxrt_XRTBAND_makeDownload']").click()
+            driver.find_element("xpath",".//*[@id='batxrt_XRTBAND_makeDownload']").click()
             time.sleep(20)
             grb_url = driver.current_url
             driver.quit()

{redback-1.0.0 → redback-1.0.2}/redback/interaction_processes.py

@@ -165,8 +165,6 @@ class CSMDiffusion(object):
         # photosphere radius
         r_photosphere = self.r_photosphere
 
-        tau_diff = (self.kappa * self.csm_mass) / (13.8 * speed_of_light * r_photosphere) / day_to_s
-
         # mass of the optically thick CSM (tau > 2/3).
         mass_csm_threshold = self.mass_csm_threshold
 
@@ -180,7 +178,7 @@ class CSMDiffusion(object):
         lu = len(uniq_times)
 
         num = int(round(timesteps / 2.0))
-        lsp = np.logspace(np.log10(tau_diff /self.dense_times[-1]) + minimum_log_spacing, 0, num)
+        lsp = np.logspace(np.log10(t0 /self.dense_times[-1]) + minimum_log_spacing, 0, num)
         xm = np.unique(np.concatenate((lsp, 1 - lsp)))
 
         int_times = tb + (uniq_times.reshape(lu, 1) - tb) * xm
@@ -192,7 +190,6 @@ class CSMDiffusion(object):
 
         uniq_lums = np.trapz(int_args, int_times, axis=1)
         uniq_lums *= np.exp(-int_tes/t0)/t0
-
         new_lums = uniq_lums[np.searchsorted(uniq_times, self.time)]
         return new_lums