redback 1.1__py3-none-any.whl → 1.12.1__py3-none-any.whl

redback/transient_models/tde_models.py

@@ -28,39 +28,77 @@ def _analytic_fallback(time, l0, t_0):
 def _semianalytical_fallback():
     pass
 
+
 def _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
     """
+    Sarin and Metzger 24 cooling envelope model.
+    Also includes partial disruptions by assuming only fraction of stellar mass is disrupted.
+
     :param mbh_6: mass of supermassive black hole in units of 10^6 solar mass
     :param stellar_mass: stellar mass in units of solar masses
     :param eta: SMBH feedback efficiency (typical range: etamin - 0.1)
     :param alpha: disk viscosity
-    :param beta: TDE penetration factor (typical range: 1 - beta_max)
-    :param kwargs:
+    :param beta: TDE penetration factor (typical range: 0.1 - beta_max).
+    :param kwargs: Binding energy constant, zeta, hoverR, t_0_init, f_debris (optional, defaults to 1 unless
+                   calculate_f_debris=True), calculate_f_debris (optional, defaults to False).
     :return: named tuple with bolometric luminosity, photosphere radius, temperature, and other parameters
     """
     t_0_init = kwargs.get('t_0_init', 1.0)
     binding_energy_const = kwargs.get('binding_energy_const', 0.8)
-    zeta = kwargs.get('zeta',2.0)
+    zeta = kwargs.get('zeta', 2.0)
     hoverR = kwargs.get('hoverR', 0.3)
+    calculate_f_debris = kwargs.get('calculate_f_debris', False)
+
+    # Determine debris fraction
+    if 'f_debris' in kwargs:
+        # User explicitly provided f_debris - use that value
+        f_debris = kwargs['f_debris']
+        f_mbh = None
+        g_mstar = None
+        scaling_factor = None
+    elif calculate_f_debris:
+        # Calculate debris fraction from beta using Ryu et al. scaling
+        # R_t = r_t * f(m_bh) * g(m_star)
+        # f(m_bh) = 0.80 + 0.26 * (mbh/10^6)^0.5
+        f_mbh = 0.80 + 0.26 * (mbh_6) ** 0.5
+
+        # g(m_star) = (1.47 + exp[(M_star - 0.669)/0.137]) / (1 + 2.34 * exp[(M_star - 0.669)/0.137])
+        exp_term = np.exp((stellar_mass - 0.669) / 0.137)
+        g_mstar = (1.47 + exp_term) / (1 + 2.34 * exp_term)
+
+        # Combined scaling factor
+        scaling_factor = f_mbh * g_mstar
+
+        # f_debris = (beta * scaling_factor)^3
+        f_debris = (beta * scaling_factor) ** 3
+        f_debris = np.clip(f_debris, 0.0, 1.0)  # Ensure physical bounds
+    else:
+        # Default behavior: assume complete disruption
+        f_debris = 1.0
+        f_mbh = None
+        g_mstar = None
+        scaling_factor = None
 
     # gravitational radius
     Rg = cc.graviational_constant * mbh_6 * 1.0e6 * (cc.solar_mass / cc.speed_of_light ** (2.0))
     # stellar mass in cgs
     Mstar = stellar_mass * cc.solar_mass
+    # effective disrupted mass
+    Mdisrupt = f_debris * Mstar
     # stellar radius in cgs
     Rstar = stellar_mass ** (0.8) * cc.solar_radius
     # tidal radius
-    Rt = Rstar * (mbh_6*1.0e6 /stellar_mass) ** (1./3.)
+    Rt = Rstar * (mbh_6 * 1.0e6 / stellar_mass) ** (1. / 3.)
     # circularization radius
-    Rcirc = 2.0*Rt/beta
-    # fall-back time of most tightly bound debris
-    tfb = calc_tfb(binding_energy_const, mbh_6, stellar_mass)
+    Rcirc = 2.0 * Rt / beta
+    # fall-back time of most tightly bound debris (uses effective disrupted mass)
+    tfb = calc_tfb(binding_energy_const, mbh_6, stellar_mass * f_debris)
     # Eddington luminosity of SMBH in units of 1e40 erg/s
     Ledd40 = 1.4e4 * mbh_6
-    time_temp = np.logspace(np.log10(1.0*tfb), np.log10(5000*tfb), 5000)
-    tdays = time_temp/cc.day_to_s
+    time_temp = np.logspace(np.log10(1.0 * tfb), np.log10(5000 * tfb), 5000)
+    tdays = time_temp / cc.day_to_s
 
-    #set up grids
+    # set up grids
     # mass of envelope in Msun
     Me = np.empty_like(tdays)
     # thermal energy of envelope in units of 1e40 ergs
@@ -90,28 +128,30 @@ def _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
     # proxy x-ray luminosity (not used directly in optical light curve calculation)
     LX40 = np.empty_like(tdays)
 
-    Mdotfb = (0.8 * Mstar / (3.0 * tfb)) * (time_temp / tfb) ** (-5. / 3.)
+    # Modified fallback rate using disrupted mass
+    Mdotfb = (0.8 * Mdisrupt / (3.0 * tfb)) * (time_temp / tfb) ** (-5. / 3.)
 
     # ** initialize grid quantities at t = t_0_init [grid point 0] **
-    # initial envelope mass at t_0_init
-    Me[0] = 0.1 * Mstar + (0.4 * Mstar) * (1.0 - t_0_init**(-2. / 3.))
+    # initial envelope mass at t_0_init (scaled by disruption fraction)
+    Me[0] = f_debris * (0.1 * Mstar + (0.4 * Mstar) * (1.0 - t_0_init ** (-2. / 3.)))
     # initial envelope radius determined by energy of TDE process
-    Rv[0] = (2. * Rt**(2.0)/(5.0 * binding_energy_const * Rstar)) * (Me[0]/Mstar)
+    Rv[0] = (2. * Rt ** (2.0) / (5.0 * binding_energy_const * Rstar)) * (Me[0] / (f_debris * Mstar))
     # initial thermal energy of envelope
     Ee40[0] = ((2.0 * cc.graviational_constant * mbh_6 * 1.0e6 * Me[0]) / (5.0 * Rv[0])) * 2.0e-7
     # initial characteristic optical depth
-    Lamb[0] = 0.38 * Me[0] / (10.0 *np.pi * Rv[0] ** (2.0))
+    Lamb[0] = 0.38 * Me[0] / (10.0 * np.pi * Rv[0] ** (2.0))
     # initial photosphere radius
     Rph[0] = Rv[0] * (1.0 + np.log(Lamb[0]))
     # initial fallback stream accretion radius
     Racc[0] = zeta * Rv[0]
     # initial fallback accretion heating rate in 1e40 erg/s
-    Edotfb40[0] = (cc.graviational_constant * mbh_6 * 1.0e6 * Mdotfb[0]/Racc[0]) * (2.0e-7)
+    Edotfb40[0] = (cc.graviational_constant * mbh_6 * 1.0e6 * Mdotfb[0] / Racc[0]) * (2.0e-7)
     # initial luminosity of envelope
     Lrad[0] = Ledd40 + Edotfb40[0]
     # initial SMBH accretion timescale in s
-    tacc[0] = 2.2e-17 * (10. / (3. * alpha)) * (Rv[0] ** (2.0)) / (cc.graviational_constant * mbh_6 * 1.0e6 * Rcirc) ** (0.5) * (hoverR) ** (
-        -2.0)
+    tacc[0] = 2.2e-17 * (10. / (3. * alpha)) * (Rv[0] ** (2.0)) / (
+                cc.graviational_constant * mbh_6 * 1.0e6 * Rcirc) ** (0.5) * (hoverR) ** (
+                  -2.0)
     # initial SMBH accretion rate in g/s
     MdotBH[0] = (Me[0] / tacc[0])
     # initial SMBH feedback heating rate in 1e40 erg/s
@@ -127,7 +167,7 @@ def _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
         # update envelope radius based on its new energy
         Rv[ii] = ((2.0 * cc.graviational_constant * mbh_6 * 1.0e6 * Me[ii]) / (5.0 * Ee40[ii])) * (2.0e-7)
         # update envelope optical depth
-        Lamb[ii] = 0.38 * Me[ii] / (10.0 *np.pi * Rv[ii] ** (2.0))
+        Lamb[ii] = 0.38 * Me[ii] / (10.0 * np.pi * Rv[ii] ** (2.0))
         # update envelope photosphere radius
         Rph[ii] = Rv[ii] * (1.0 + np.log(Lamb[ii]))
         # update accretion radius
@@ -137,10 +177,11 @@ def _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
         # update total radiated luminosity
         Lrad[ii] = Ledd40 + Edotfb40[ii]
         # update photosphere temperature in K
-        Teff[ii] = 1.0e10 * ((Ledd40 + Edotfb40[ii]) / (4.0 *np.pi * cc.sigma_sb * Rph[ii] ** (2.0))) ** (0.25)
+        Teff[ii] = 1.0e10 * ((Ledd40 + Edotfb40[ii]) / (4.0 * np.pi * cc.sigma_sb * Rph[ii] ** (2.0))) ** (0.25)
         # update SMBH accretion timescale in seconds
-        tacc[ii] = 2.2e-17 * (10. / (3.0 * alpha)) * (Rv[ii] ** (2.0)) / (cc.graviational_constant * mbh_6 * 1.0e6 * Rcirc) ** (0.5) * (
-            hoverR) ** (-2.0)
+        tacc[ii] = 2.2e-17 * (10. / (3.0 * alpha)) * (Rv[ii] ** (2.0)) / (
+                    cc.graviational_constant * mbh_6 * 1.0e6 * Rcirc) ** (0.5) * (
+                       hoverR) ** (-2.0)
         # update SMBH accretion rate in g/s
         MdotBH[ii] = (Me[ii] / tacc[ii])
         # update proxy X-ray luminosity
@@ -151,19 +192,24 @@ def _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
     output = namedtuple('output', ['bolometric_luminosity', 'photosphere_temperature',
                                    'photosphere_radius', 'lum_xray', 'accretion_radius',
                                    'SMBH_accretion_rate', 'time_temp', 'nulnu',
-                                   'time_since_fb','tfb', 'lnu', 'envelope_radius', 'envelope_mass',
-                                   'rtidal', 'rcirc', 'termination_time', 'termination_time_id'])
+                                   'time_since_fb', 'tfb', 'lnu', 'envelope_radius', 'envelope_mass',
+                                   'rtidal', 'rcirc', 'termination_time', 'termination_time_id', 'f_debris',
+                                   'f_mbh', 'g_mstar', 'scaling_factor'])
     try:
-        constraint_1 = np.min(np.where(Rv < Rcirc/2.))
+        constraint_1 = np.min(np.where(Rv < Rcirc / 2.))
+        if constraint_1 == 0.:
+            # ignore constraining on Rv < Rcirc/2. if it is at the first time step
+            constraint_1 = 5000
         constraint_2 = np.min(np.where(Me < 0.0))
     except ValueError:
         constraint_1 = len(time_temp)
         constraint_2 = len(time_temp)
     constraint = np.min([constraint_1, constraint_2])
     termination_time_id = np.min([constraint_1, constraint_2])
+
     nu = 6.0e14
     expon = 1. / (np.exp(cc.planck * nu / (cc.boltzmann_constant * Teff)) - 1.0)
-    nuLnu40 = (8.0*np.pi ** (2.0) * Rph ** (2.0) / cc.speed_of_light ** (2.0))
+    nuLnu40 = (8.0 * np.pi ** (2.0) * Rph ** (2.0) / cc.speed_of_light ** (2.0))
     nuLnu40 = nuLnu40 * ((cc.planck * nu) * (nu ** (2.0))) / 1.0e30
     nuLnu40 = nuLnu40 * expon
     nuLnu40 = nuLnu40 * (nu / 1.0e10)
@@ -187,6 +233,10 @@ def _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
     output.termination_time_id = termination_time_id
     output.tfb = tfb
     output.nulnu = nuLnu40[:constraint] * 1e40
+    output.f_debris = f_debris
+    output.f_mbh = f_mbh
+    output.g_mstar = g_mstar
+    output.scaling_factor = scaling_factor
     return output
 
 @citation_wrapper('https://arxiv.org/abs/2307.15121,https://ui.adsabs.harvard.edu/abs/2022arXiv220707136M/abstract')
@@ -201,7 +251,7 @@ def cooling_envelope(time, redshift, mbh_6, stellar_mass, eta, alpha, beta, **kw
     :param eta: SMBH feedback efficiency (typical range: etamin - 0.1)
     :param alpha: disk viscosity
     :param beta: TDE penetration factor (typical range: 1 - beta_max)
-    :param kwargs: Additional parameters
+    :param kwargs: Additional parameters, check _cooling_envelope for more information
     :param frequency: Required if output_format is 'flux_density'.
         frequency to calculate - Must be same length as time array or a single number).
     :param bands: Required if output_format is 'magnitude' or 'flux'.
@@ -256,9 +306,10 @@ def cooling_envelope(time, redshift, mbh_6, stellar_mass, eta, alpha, beta, **kw
                                                               **kwargs)
 
 @citation_wrapper('https://arxiv.org/abs/2307.15121,https://ui.adsabs.harvard.edu/abs/2022arXiv220707136M/abstract')
-def gaussianrise_cooling_envelope_bolometric(time, peak_time, sigma_t, mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
+def gaussianrise_cooling_envelope_bolometric(time, peak_time, sigma_t, mbh_6, stellar_mass, eta, alpha, beta,
+                                                **kwargs):
     """
-    Full lightcurve, with gaussian rise till fallback time and then the metzger tde model,
+    Full lightcurve, with gaussian rise till xi * fallback time and then the metzger tde model,
     bolometric version for fitting the bolometric lightcurve
 
     :param time: time in source frame in days
@@ -269,28 +320,116 @@ def gaussianrise_cooling_envelope_bolometric(time, peak_time, sigma_t, mbh_6, st
     :param eta: SMBH feedback efficiency (typical range: etamin - 0.1)
     :param alpha: disk viscosity
     :param beta: TDE penetration factor (typical range: 1 - beta_max)
-    :param kwargs: Additional parameters
+    :param kwargs: Additional parameters, check _cooling_envelope for more information
+    :param xi: Optional, default is 1. transition factor - Gaussian transitions to cooling envelope at xi * tfb
     :return luminosity in ergs/s
     """
     output = _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs)
     kwargs['binding_energy_const'] = kwargs.get('binding_energy_const', 0.8)
     tfb_sf = calc_tfb(kwargs['binding_energy_const'], mbh_6, stellar_mass)  # source frame
-    f1 = pm.gaussian_rise(time=tfb_sf, a_1=1, peak_time=peak_time * cc.day_to_s, sigma_t=sigma_t * cc.day_to_s)
+
+    # Transition time
+    xi = kwargs.get('xi', 1.)
+    transition_time = xi * tfb_sf
+
+    # Find the luminosity value at the transition time by interpolating the cooling envelope model
+    # Create interpolation function for the cooling envelope model
+    cooling_envelope_func = interp1d(output.time_temp, output.bolometric_luminosity,
+                                     bounds_error=False, fill_value='extrapolate')
+
+    # Get luminosity at transition time
+    f1 = pm.gaussian_rise(time=transition_time, a_1=1,
+                          peak_time=peak_time * cc.day_to_s,
+                          sigma_t=sigma_t * cc.day_to_s)
 
     # get normalisation
-    f2 = output.bolometric_luminosity[0]
-    norm = f2/f1
+    f2 = cooling_envelope_func(transition_time)
+    norm = f2 / f1
 
-    #evaluate giant array of bolometric luminosities
-    tt_pre_fb = np.linspace(0, tfb_sf, 100)
-    tt_post_fb = output.time_temp
-    full_time = np.concatenate([tt_pre_fb, tt_post_fb])
-    f1 = pm.gaussian_rise(time=tt_pre_fb, a_1=norm,
-                          peak_time=peak_time * cc.day_to_s, sigma_t=sigma_t * cc.day_to_s)
-    f2 = output.bolometric_luminosity
-    full_lbol = np.concatenate([f1, f2])
+    # evaluate giant array of bolometric luminosities
+    tt_pre_transition = np.linspace(0, transition_time, 100)
+    # Only use cooling envelope times after the transition
+    tt_post_transition = output.time_temp[output.time_temp >= transition_time]
+
+    full_time = np.concatenate([tt_pre_transition, tt_post_transition])
+
+    # Gaussian part before transition
+    f1_array = pm.gaussian_rise(time=tt_pre_transition, a_1=norm,
+                                peak_time=peak_time * cc.day_to_s,
+                                sigma_t=sigma_t * cc.day_to_s)
+
+    # Cooling envelope part after transition
+    f2_array = output.bolometric_luminosity[output.time_temp >= transition_time]
+
+    full_lbol = np.concatenate([f1_array, f2_array])
     lbol_func = interp1d(full_time, y=full_lbol, fill_value='extrapolate')
-    return lbol_func(time*cc.day_to_s)
+
+    return lbol_func(time * cc.day_to_s)
+
+
+@citation_wrapper('https://arxiv.org/abs/2307.15121,https://ui.adsabs.harvard.edu/abs/2022arXiv220707136M/abstract')
+def smooth_exponential_powerlaw_cooling_envelope_bolometric(time, peak_time, alpha_1, alpha_2, smoothing_factor,
+                                                               mbh_6, stellar_mass, eta, alpha, beta, **kwargs):
+    """
+    Full lightcurve, with smoothed exponential power law rise till xi * fallback time and then the metzger tde model,
+    bolometric version for fitting the bolometric lightcurve
+
+    :param time: time in source frame in days
+    :param peak_time: peak time in days
+    :param alpha_1: power law index before peak
+    :param alpha_2: power law index after peak
+    :param smoothing_factor: controls transition smoothness at peak (higher = smoother)
+    :param mbh_6: mass of supermassive black hole in units of 10^6 solar mass
+    :param stellar_mass: stellar mass in units of solar masses
+    :param eta: SMBH feedback efficiency (typical range: etamin - 0.1)
+    :param alpha: disk viscosity
+    :param beta: TDE penetration factor (typical range: 1 - beta_max)
+    :param xi: Optional transition factor - smooth exponential power law transitions to cooling envelope at xi * tfb
+    :param kwargs: Additional parameters, check _cooling_envelope for more information
+    :return luminosity in ergs/s
+    """
+    # Get cooling envelope output
+    output = _cooling_envelope(mbh_6, stellar_mass, eta, alpha, beta, **kwargs)
+    kwargs['binding_energy_const'] = kwargs.get('binding_energy_const', 0.8)
+    tfb_sf = calc_tfb(kwargs['binding_energy_const'], mbh_6, stellar_mass)  # source frame
+
+    # Transition time
+    xi = kwargs.get('xi', 1.)
+    transition_time = xi * tfb_sf
+
+    # Find the luminosity value at the transition time by interpolating the cooling envelope model
+    # Create interpolation function for the cooling envelope model
+    cooling_envelope_func = interp1d(output.time_temp, output.bolometric_luminosity,
+                                     bounds_error=False, fill_value='extrapolate')
+
+    # Get luminosity at transition time using smooth exponential power law
+    f1 = pm.smooth_exponential_powerlaw(np.array([transition_time]), 1.0,
+                                     peak_time * cc.day_to_s,
+                                     alpha_1, alpha_2, smoothing_factor)[0]
+
+    # get normalisation
+    f2 = cooling_envelope_func(transition_time)
+    norm = f2 / f1
+
+    # evaluate giant array of bolometric luminosities
+    tt_pre_transition = np.linspace(0, transition_time, 100)
+    # Only use cooling envelope times after the transition
+    tt_post_transition = output.time_temp[output.time_temp >= transition_time]
+
+    full_time = np.concatenate([tt_pre_transition, tt_post_transition])
+
+    # Smooth exponential power law part before transition
+    f1_array = pm.smooth_exponential_powerlaw(tt_pre_transition, norm,
+                                           peak_time * cc.day_to_s,
+                                           alpha_1, alpha_2, smoothing_factor)
+
+    # Cooling envelope part after transition
+    f2_array = output.bolometric_luminosity[output.time_temp >= transition_time]
+
+    full_lbol = np.concatenate([f1_array, f2_array])
+    lbol_func = interp1d(full_time, y=full_lbol, fill_value='extrapolate')
+
+    return lbol_func(time * cc.day_to_s)
 
 
 @citation_wrapper('https://arxiv.org/abs/2307.15121,https://ui.adsabs.harvard.edu/abs/2022arXiv220707136M/abstract')
@@ -308,7 +447,7 @@ def gaussianrise_cooling_envelope(time, redshift, peak_time, sigma_t, mbh_6, ste
     :param eta: SMBH feedback efficiency (typical range: etamin - 0.1)
     :param alpha: disk viscosity
     :param beta: TDE penetration factor (typical range: 1 - beta_max)
-    :param kwargs: Additional parameters
+    :param kwargs: Additional parameters, check _cooling_envelope for more information
     :param xi: Optional argument (default set to one) to change the point where lightcurve switches from Gaussian rise to cooling envelope.
         stitching_point = xi * tfb (where tfb is fallback time). So a xi=1 means the stitching point is at fallback time.
     :param frequency: Required if output_format is 'flux_density'.
@@ -428,7 +567,7 @@ def bpl_cooling_envelope(time, redshift, peak_time, alpha_1, alpha_2, mbh_6, ste
     :param eta: SMBH feedback efficiency (typical range: etamin - 0.1)
     :param alpha: disk viscosity
     :param beta: TDE penetration factor (typical range: 1 - beta_max)
-    :param kwargs: Additional parameters
+    :param kwargs: Additional parameters, check _cooling_envelope for more information
     :param xi: Optional argument (default set to one) to change the point where lightcurve switches from Gaussian rise to cooling envelope.
         stitching_point = xi * tfb (where tfb is fallback time). So a xi=1 means the stitching point is at fallback time.
     :param frequency: Required if output_format is 'flux_density'.
@@ -1134,7 +1273,7 @@ def fitted(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl, **kwargs
                                                               **kwargs)
                                                               
 @citation_wrapper('https://ui.adsabs.harvard.edu/abs/2024arXiv240815048M/abstract')   
-def fitted_pl_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl, log_L, t_decay, p, log_T, sigma, t_peak, **kwargs):
+def fitted_pl_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl, log_L, t_decay, p, log_T, sigma_t, t_peak, **kwargs):
     """
     An import of FitTeD to model the plateau phase, with a gaussian rise and power-law decay
     
@@ -1151,7 +1290,7 @@ def fitted_pl_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl,
     :param t_decay: fallback timescale (days)
     :param p: power-law decay index
     :param log_T: single temperature blackbody temperature for decay model (log_10 Kelvin)
-    :param sigma: gaussian rise timescale (days)
+    :param sigma_t: gaussian rise timescale (days)
     :param t_peak: time of light curve peak (days)
     :param kwargs: Must be all the kwargs required by the specific output_format 
     :param output_format: 'flux_density', 'magnitude', 'spectra', 'flux', 'sncosmo_source'  
@@ -1180,13 +1319,13 @@ def fitted_pl_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl,
         if len(freqs_un) == 1:
             nulnus_plateau = m.model_UV(time, log_mh, a_bh, m_disc, r0, tvi, t_form, ang, v=freqs_un[0])
             nulnus_decay = m.decay_model(time, log_L, t_decay, p, t_peak, log_T, v=freqs_un[0])
-            nulnus_rise = m.rise_model(time, log_L, sigma, t_peak, log_T, v=freqs_un[0])
+            nulnus_rise = m.rise_model(time, log_L, sigma_t, t_peak, log_T, v=freqs_un[0])
         else:
             for i in range(0,len(freqs_un)):
                 inds = np.where(frequency == freqs_un[i])[0]
                 nulnus[inds] = m.model_UV([time[j] for j in inds], log_mh, a_bh, m_disc, r0, tvi, t_form, ang, freqs_un[i])
                 nulnus_decay[inds] = m.decay_model([time[j] for j in inds], log_L, t_decay, p, t_peak, log_T, v=freqs_un[i]) 
-                nulnus_rise[inds] = m.rise_model([time[j] for j in inds], log_L, sigma, t_peak, log_T, v=freqs_un[i])                                             
+                nulnus_rise[inds] = m.rise_model([time[j] for j in inds], log_L, sigma_t, t_peak, log_T, v=freqs_un[i])                                             
         nulnus = nulnus_plateau + nulnus_rise + nulnus_decay    
         flux_density = nulnus/(4.0 * np.pi * dl**2 * frequency)   
         return flux_density/1.0e-26   
@@ -1201,7 +1340,7 @@ def fitted_pl_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl,
         nulnus_plateau = m.model_SEDs(time, log_mh, a_bh, m_disc, r0, tvi, t_form, ang, frequency)
 
         freq_0 = 6e14
-        l_e_amp = (model.decay_model(time, log_L, t_decay, t_peak, log_T, freq_0) + model.rise_model(time, log_L, sigma, t_peak, log_T, freq_0))
+        l_e_amp = (model.decay_model(time, log_L, t_decay, t_peak, log_T, freq_0) + model.rise_model(time, log_L, sigma_t, t_peak, log_T, freq_0))
         nulnus_risedecay = ((l_e_amp[:, None] * (frequency/freq_0)**4 * 
                         (np.exp(cc.planck * freq_0/(cc.boltzmann_constant * 10**log_T)) - 1)/(np.exp(cc.planck * frequency/(cc.boltzmann_constant * 10**log_T)) - 1)).T)  
         flux_density = ((nulnus_risedecay + nulnus_plateau)/(4.0 * np.pi * dl**2 * frequency[:,np.newaxis] * 1.0e-26))  
@@ -1218,7 +1357,7 @@ def fitted_pl_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl,
                                                               **kwargs)  
                                                               
 @citation_wrapper('https://ui.adsabs.harvard.edu/abs/2024arXiv240815048M/abstract')   
-def fitted_exp_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl, log_L, t_decay, log_T, sigma, t_peak, **kwargs):
+def fitted_exp_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl, log_L, t_decay, log_T, sigma_t, t_peak, **kwargs):
     """
     An import of FitTeD to model the plateau phase, with a gaussian rise and exponential decay
     
@@ -1234,7 +1373,7 @@ def fitted_exp_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl
     :param log_L: single temperature blackbody amplitude for decay model (log_10 erg/s)
     :param t_decay: fallback timescale (days)
     :param log_T: single temperature blackbody temperature for decay model (log_10 Kelvin)
-    :param sigma: gaussian rise timescale (days)
+    :param sigma_t: gaussian rise timescale (days)
     :param t_peak: time of light curve peak (days)
     :param kwargs: Must be all the kwargs required by the specific output_format 
     :param output_format: 'flux_density', 'magnitude', 'spectra', 'flux', 'sncosmo_source'  
@@ -1263,13 +1402,13 @@ def fitted_exp_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl
         if len(freqs_un) == 1:
             nulnus_plateau = m.model_UV(time, log_mh, a_bh, m_disc, r0, tvi, t_form, ang, v=freqs_un[0])
             nulnus_decay = m.decay_model(time, log_L, t_decay, t_peak, log_T, v=freqs_un[0])
-            nulnus_rise = m.rise_model(time, log_L, sigma, t_peak, log_T, v=freqs_un[0])
+            nulnus_rise = m.rise_model(time, log_L, sigma_t, t_peak, log_T, v=freqs_un[0])
         else:
             for i in range(0,len(freqs_un)):
                 inds = np.where(frequency == freqs_un[i])[0]
                 nulnus[inds] = m.model_UV([time[j] for j in inds], log_mh, a_bh, m_disc, r0, tvi, t_form, ang, freqs_un[i])
                 nulnus_decay[inds] = m.decay_model([time[j] for j in inds], log_L, t_decay, t_peak, log_T, v=freqs_un[i]) 
-                nulnus_rise[inds] = m.rise_model([time[j] for j in inds], log_L, sigma, t_peak, log_T, v=freqs_un[i]) 
+                nulnus_rise[inds] = m.rise_model([time[j] for j in inds], log_L, sigma_t, t_peak, log_T, v=freqs_un[i]) 
         nulnus = nulnus_plateau + nulnus_rise + nulnus_decay        
         flux_density = nulnus/(4.0 * np.pi * dl**2 * frequency)   
         return flux_density/1.0e-26   
@@ -1284,7 +1423,7 @@ def fitted_exp_decay(time, redshift, log_mh, a_bh, m_disc, r0, tvi, t_form, incl
         nulnus_plateau = m.model_SEDs(time, log_mh, a_bh, m_disc, r0, tvi, t_form, ang, frequency)
 
         freq_0 = 6e14
-        l_e_amp = (m.decay_model(time, log_L, t_decay, t_peak, log_T, freq_0) + m.rise_model(time, log_L, sigma, t_peak, log_T, freq_0))
+        l_e_amp = (m.decay_model(time, log_L, t_decay, t_peak, log_T, freq_0) + m.rise_model(time, log_L, sigma_t, t_peak, log_T, freq_0))
         nulnus_risedecay = ((l_e_amp[:, None] * (frequency/freq_0)**4 * 
                         (np.exp(cc.planck * freq_0/(cc.boltzmann_constant * 10**log_T)) - 1)/(np.exp(cc.planck * frequency/(cc.boltzmann_constant * 10**log_T)) - 1)).T) 
         flux_density = ((nulnus_risedecay + nulnus_plateau)/(4.0 * np.pi * dl**2 * frequency[:,np.newaxis] * 1.0e-26))  

redback/utils.py

@@ -125,12 +125,24 @@ def citation_wrapper(r):
 
     return wrapper
 
+def calc_effective_width_hz_from_angstrom(effective_width, effective_wavelength):
+    """
+    Calculate the effective width in Hz from the effective wavelength in Angstrom
+
+    :param effective_width: effective_width in Angstrom
+    :param effective_wavelength: effective wavelength in Angstrom
+    :return: effective width in Hz
+    """
+    wavelength_m = effective_wavelength * 1.0e-10
+    effective_width_m = effective_width * 1.0e-10
+    effective_width = (3.0e8 / (wavelength_m**2)) * effective_width_m
+    return effective_width
 
 def calc_tfb(binding_energy_const, mbh_6, stellar_mass):
     """
     Calculate the fall back timescale for a SMBH disrupting a stellar mass object
     :param binding_energy_const:
-    :param mbh_6: SMBH mass in solar masses
+    :param mbh_6: SMBH mass in 10^6 solar masses
     :param stellar_mass: stellar mass in solar masses
     :return: fall back time in seconds
     """
@@ -1260,20 +1272,35 @@ def get_heating_terms(ye, vel, **kwargs):
     return heating_terms
 
 
+# Global cache to avoid recreating interpolator every time
+_qdot_interpolator_cache = None
+
 def _calculate_rosswogkorobkin24_qdot(time_array, ejecta_velocity, electron_fraction):
-    import pickle
+    import numpy as np
+    from scipy.interpolate import RegularGridInterpolator
     import os
-    dirname = os.path.dirname(__file__)
-    with open(f"{dirname}/tables/qdot_rosswogkorobkin24.pck", 'rb') as file_handle:
-        qdot_object = pickle.load(file_handle)
+
+    global _qdot_interpolator_cache
+
+    if _qdot_interpolator_cache is None:
+        dirname = os.path.dirname(__file__)
+
+        with np.load(f"{dirname}/tables/qdot_rosswogkorobkin24.npz") as data:
+            qedt = data['qedt']
+            v_grid = data['v_grid']
+            ye_grid = data['ye_grid']
+            time_grid = data['time_array']
+
+        _qdot_interpolator_cache = RegularGridInterpolator((v_grid, ye_grid, time_grid), qedt,
+                                                           bounds_error=False, fill_value=None)
+
     steps = len(time_array)
     _ej_velocity = np.repeat(ejecta_velocity, steps)
     _ye = np.repeat(electron_fraction, steps)
     full_array = np.array([_ej_velocity, _ye, time_array]).T
-    lum_in = qdot_object(full_array)
+    lum_in = _qdot_interpolator_cache(full_array)
     return lum_in
 
-
 def electron_fraction_from_kappa(kappa):
     """
     Uses interpolation from Tanaka+19 to calculate

{redback-1.1.dist-info → redback-1.12.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: redback
-Version: 1.1
+Version: 1.12.1
 Summary: A Bayesian inference and modelling pipeline for electromagnetic transients
 Home-page: https://github.com/nikhil-sarin/redback
 Author: Nikhil Sarin, Moritz Huebner
@@ -12,10 +12,10 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENCE.md
-Requires-Dist: numpy==1.26.0
+Requires-Dist: numpy
 Requires-Dist: setuptools
 Requires-Dist: pandas
-Requires-Dist: scipy<1.14.0
+Requires-Dist: scipy
 Requires-Dist: selenium
 Requires-Dist: matplotlib
 Requires-Dist: astropy
@@ -37,8 +37,11 @@ Requires-Dist: PyQt5; extra == "all"
 Requires-Dist: lalsuite; extra == "all"
 Requires-Dist: kilonova-heating-rate; extra == "all"
 Requires-Dist: redback-surrogates; extra == "all"
+Requires-Dist: tensorflow; extra == "all"
+Requires-Dist: keras; extra == "all"
 Requires-Dist: kilonovanet; extra == "all"
 Requires-Dist: astroquery; extra == "all"
+Requires-Dist: pyphot==1.6.0; extra == "all"
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier
@@ -85,7 +88,7 @@ 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-2503mmkaq-EMEAgz7i3mY0pg1o~VUdqw)
-and email [Nikhil Sarin](mailto:nikhil.sarin@su.se?subject=Contributing%20to%20redback).
+and email [Nikhil Sarin](mailto:nsarin.astro@gmail.com?subject=Contributing%20to%20redback).
 
 To make changes to redback, we require users to use a merge request system.