ler 0.4.1__tar.gz → 0.4.2__tar.gz

{ler-0.4.1 → ler-0.4.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: ler
-Version: 0.4.1
-Summary: Gravitational waves Lensing Rates
+Version: 0.4.2
+Summary: LVK (LIGO-Virgo-KAGRA collaboration) Event (compact-binary mergers) Rate calculator and simulator
 Home-page: https://github.com/hemantaph/ler
 Author: Hemantakumar
 Author-email: hemantaphurailatpam@gmail.com

{ler-0.4.1 → ler-0.4.2}/ler/__init__.py

@@ -51,7 +51,7 @@ set_multiprocessing_start_method()
 __author__ = 'hemanta_ph <hemantaphurailatpam@gmail.com>'
 
 # The version as used in the setup.py
-__version__ = "0.4.1"
+__version__ = "0.4.2"
 
 # add __file__
 import os

{ler-0.4.1 → ler-0.4.2}/ler/gw_source_population/cbc_source_parameter_distribution.py

@@ -46,7 +46,7 @@ class CBCSourceParameterDistribution(CBCSourceRedshiftDistribution):
         Dictionary of prior sampler functions and its input parameters.
         Check for available priors and corresponding input parameters by running,
         >>> from ler.gw_source_population import CBCSourceParameterDistribution
-        >>> cbc = CompactBinaryPopulation()
+        >>> cbc = CBCSourceParameterDistribution()
         >>> cbc.available_gw_prior_list_and_its_params()
         # To check the current chosen priors and its parameters, run,
         >>> print("default priors=",cbc.gw_param_samplers)
@@ -77,7 +77,7 @@ class CBCSourceParameterDistribution(CBCSourceRedshiftDistribution):
 
     Instance Attributes
     ----------
-    CompactBinaryPopulation has the following instance attributes:\n
+    CBCSourceParameterDistribution has the following instance attributes:\n
     +-------------------------------------+----------------------------------+
     | Atrributes                          | Type                             |
     +=====================================+==================================+
@@ -114,7 +114,7 @@ class CBCSourceParameterDistribution(CBCSourceRedshiftDistribution):
 
     Instance Methods
     ----------
-    CompactBinaryPopulation has the following instance methods:\n
+    CBCSourceParameterDistribution has the following instance methods:\n
     +-------------------------------------+----------------------------------+
     | Methods                             | Type                             |
     +=====================================+==================================+
@@ -1136,7 +1136,7 @@ class CBCSourceParameterDistribution(CBCSourceRedshiftDistribution):
         Examples
         ----------
         >>> from ler.gw_source_population import CBCSourceParameterDistribution
-        >>> cbc = CompactBinaryPopulation()
+        >>> cbc = CBCSourceParameterDistribution()
         >>> priors = cbc.available_gw_prior_list_and_its_params
         >>> priors.keys()  # type of priors
         dict_keys(['merger_rate_density', 'source_frame_masses', 'spin', 'geocent_time', 'ra', 'phase', 'psi', 'theta_jn'])

{ler-0.4.1 → ler-0.4.2}/ler/gw_source_population/cbc_source_redshift_distribution.py

@@ -25,7 +25,7 @@ from .jit_functions import merger_rate_density_bbh_popI_II_oguri2018, star_forma
 
 class CBCSourceRedshiftDistribution(object):
     """Class to generate a population of source galaxies.
-    This class is inherited by :class:`~ler.ler.CompactBinaryPopulation` and :class:`~ler.ler.LensGalaxyParameterDistribution` class.
+    This class is inherited by :class:`~ler.ler.CBCSourceParameterDistribution` and :class:`~ler.ler.LensGalaxyParameterDistribution` class.
 
     Parameters
     ----------

{ler-0.4.1 → ler-0.4.2}/ler/image_properties/image_properties.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 """
 This module contains the LensGalaxyPopulation class, which is used to sample lens galaxy parameters, source parameters conditioned on the source being strongly lensed, image properties, and lensed SNRs. \n
-The class inherits from the CompactBinaryPopulation class, which is used to sample source parameters. \n
+The class inherits from the CBCSourceParameterDistribution class, which is used to sample source parameters. \n
 """
 
 import warnings
@@ -341,6 +341,8 @@ class ImageProperties():
         ####################################
         lens_parameters.update(image_parameters)
         lens_parameters["n_images"] = n_images
+        lens_parameters["x_source"] = x_source
+        lens_parameters["y_source"] = y_source
 
         return lens_parameters
 

{ler-0.4.1 → ler-0.4.2}/ler/lens_galaxy_population/lens_galaxy_parameter_distribution.py

@@ -2,7 +2,7 @@
 """
 This module contains the LensGalaxyPopulation class, which is used to sample lens galaxy parameters, source parameters conditioned on the source being strongly lensed. \n
 The class inherits from the ImageProperties class, which is used calculate image properties (magnification, timedelays, source position, image position, morse phase). \n
-Either the class takes in initialized CompactBinaryPopulation class as input or inherits the CompactBinaryPopulation class with default params (if no input) \n
+Either the class takes in initialized CBCSourceParameterDistribution class as input or inherits the CBCSourceParameterDistribution class with default params (if no input) \n
 """
 
 import warnings
@@ -181,8 +181,8 @@ class LensGalaxyParameterDistribution(CBCSourceParameterDistribution, ImagePrope
 
     # Attributes
     cbc_pop = None
-    """:class:`~CompactBinaryPopulation` class\n
-    This is an already initialized class that contains a function (CompactBinaryPopulation.sample_gw_parameters) that actually samples the source parameters. 
+    """:class:`~CBCSourceParameterDistribution` class\n
+    This is an already initialized class that contains a function (CBCSourceParameterDistribution.sample_gw_parameters) that actually samples the source parameters. 
     """
 
     z_min = None
@@ -313,7 +313,7 @@ class LensGalaxyParameterDistribution(CBCSourceParameterDistribution, ImagePrope
             dictionary of parameters to initialize the parent classes
         """
 
-        # initialization of CompactBinaryPopulation class
+        # initialization of CBCSourceParameterDistribution class
         # it also initializes the CBCSourceRedshiftDistribution class
         # list of relevant initialized instances,
         # 1. self.sample_source_redshift
@@ -639,7 +639,7 @@ class LensGalaxyParameterDistribution(CBCSourceParameterDistribution, ImagePrope
         def zs_function(zs_sl):
             # get zs
             # self.sample_source_redshifts from CBCSourceRedshiftDistribution class
-            zs = self.sample_zs(size)  # this function is from CompactBinaryPopulation class
+            zs = self.sample_zs(size)  # this function is from CBCSourceParameterDistribution class
             # put strong lensing condition with optical depth
             tau = self.strong_lensing_optical_depth(zs)
             tau_max = self.strong_lensing_optical_depth(np.array([z_max]))[0] # tau increases with z

{ler-0.4.1 → ler-0.4.2}/ler/rates/gwrates.py

@@ -84,7 +84,7 @@ class GWRATES(CBCSourceParameterDistribution):
         
     Instance Attributes
     ----------
-    LeR class has the following attributes, \n
+    LeR class has the following attributes:\n
     +-------------------------------------+----------------------------------+
     | Atrributes                          | Type                             |
     +=====================================+==================================+
@@ -121,7 +121,7 @@ class GWRATES(CBCSourceParameterDistribution):
 
     Instance Methods
     ----------
-    LeR class has the following methods, \n
+    LeR class has the following methods:\n
     +-------------------------------------+----------------------------------+
     | Methods                             | Description                      |
     +=====================================+==================================+
@@ -506,7 +506,7 @@ class GWRATES(CBCSourceParameterDistribution):
             dictionary of parameters to initialize the parent classes
         """
 
-        # initialization of CompactBinaryPopulation class
+        # initialization of CBCSourceParameterDistribution class
         # it also initializes the CBCSourceRedshiftDistribution class
         input_params = dict(
             z_min=self.z_min,

{ler-0.4.1 → ler-0.4.2}/ler/rates/ler.py

@@ -76,6 +76,23 @@ class LeR(LensGalaxyParameterDistribution):
     interpolator_directory : `str`
         directory to store the interpolators.
         default interpolator_directory = './interpolator_pickle'. This is used for storing the various interpolators related to `ler` and `gwsnr` package.
+    create_new_interpolator : `bool` or `dict`
+        default create_new_interpolator = False.
+        if True, the all interpolators (including `gwsnr`'s)will be created again.
+        if False, the interpolators will be loaded from the interpolator_directory if they exist.
+        if dict, you can specify which interpolators to create new. Complete example (change any of them to True), create_new_interpolator = create_new_interpolator = dict(
+            redshift_distribution=dict(create_new=False, resolution=1000),
+            z_to_luminosity_distance=dict(create_new=False, resolution=1000),
+            velocity_dispersion=dict(create_new=False, resolution=1000),
+            axis_ratio=dict(create_new=False, resolution=1000),
+            optical_depth=dict(create_new=False, resolution=200),
+            z_to_Dc=dict(create_new=False, resolution=1000),
+            Dc_to_z=dict(create_new=False, resolution=1000),
+            angular_diameter_distance=dict(create_new=False, resolution=1000),
+            differential_comoving_volume=dict(create_new=False, resolution=1000),
+            Dl_to_z=dict(create_new=False, resolution=1000),
+            gwsnr=False,
+        )
     ler_directory : `str`
         directory to store the parameters.
         default ler_directory = './ler_data'. This is used for storing the parameters of the simulated events.
@@ -98,7 +115,7 @@ class LeR(LensGalaxyParameterDistribution):
         
     Instance Attributes
     ----------
-    LeR class has the following attributes, \n
+    LeR class has the following attributes: \n
     +-------------------------------------+----------------------------------+
     | Atrributes                          | Type                             |
     +=====================================+==================================+
@@ -141,7 +158,7 @@ class LeR(LensGalaxyParameterDistribution):
 
     Instance Methods
     ----------
-    LeR class has the following methods, \n
+    LeR class has the following methods:\n
     +-------------------------------------+----------------------------------+
     | Methods                             | Description                      |
     +=====================================+==================================+
@@ -194,7 +211,7 @@ class LeR(LensGalaxyParameterDistribution):
     |                                     | ratio between lensed and         |
     |                                     | unlensed events.                 |
     +-------------------------------------+----------------------------------+
-    |:meth:`~rate_comparision_with_rate_calculation                          |
+    |:meth:`~rate_comparison_with_rate_calculation`                          |
     +-------------------------------------+----------------------------------+
     |                                     | Function to calculate rates for  |
     |                                     | unleesed and lensed events and   |
@@ -437,6 +454,7 @@ class LeR(LensGalaxyParameterDistribution):
         list_of_detectors=None,
         json_file_names=None,
         interpolator_directory="./interpolator_pickle",
+        create_new_interpolator=False,
         ler_directory="./ler_data",
         verbose=True,
         **kwargs,
@@ -453,6 +471,7 @@ class LeR(LensGalaxyParameterDistribution):
         if json_file_names:
             self.json_file_names.update(json_file_names)
         self.interpolator_directory = interpolator_directory
+        kwargs["create_new_interpolator"] = create_new_interpolator
         self.ler_directory = ler_directory
         # create directory if not exists
         if not os.path.exists(ler_directory):
@@ -820,6 +839,21 @@ class LeR(LensGalaxyParameterDistribution):
                 if key in input_params:
                     input_params[key] = value
         self.snr_calculator_dict = input_params
+
+        # dealing with create_new_interpolator param
+        if isinstance(input_params["create_new_interpolator"], bool):
+            pass
+        elif isinstance(input_params["create_new_interpolator"], dict):
+            # check input_params["gwsnr"] exists
+            if "gwsnr" in input_params["create_new_interpolator"]:
+                if isinstance(input_params["create_new_interpolator"]["gwsnr"], bool):
+                    input_params["create_new_interpolator"] = input_params["create_new_interpolator"]["gwsnr"]
+                else:
+                    raise ValueError("create_new_interpolator['gwsnr'] should be a boolean.")
+            else:
+                raise ValueError("create_new_interpolator should be a boolean or a dictionary with 'gwsnr' key.")
+
+        # initialization of GWSNR class
         gwsnr = GWSNR(
                     npool=input_params["npool"],
                     mtot_min=input_params["mtot_min"],
@@ -835,7 +869,7 @@ class LeR(LensGalaxyParameterDistribution):
                     psds=input_params["psds"],
                     ifos=input_params["ifos"],
                     interpolator_dir=input_params["interpolator_dir"],
-                    # create_new_interpolator=input_params["create_new_interpolator"],
+                    create_new_interpolator=input_params["create_new_interpolator"],
                     gwsnr_verbose=input_params["gwsnr_verbose"],
                     multiprocessing_verbose=input_params["multiprocessing_verbose"],
                     mtot_cut=input_params["mtot_cut"],
@@ -910,7 +944,7 @@ class LeR(LensGalaxyParameterDistribution):
             resume = False (default) or True.
             if True, the function will resume from the last batch.
         save_batch : `bool`
-            if True, the function will save the parameters in batches. if False, the function will save all the parameters at the end of sampling. save_batch=False is faster.
+            if True, the function will save the parameters in batches. if False (default), the function will save all the parameters at the end of sampling. save_batch=False is faster.
         output_jsonfile : `str`
             json file name for storing the parameters.
             default output_jsonfile = 'unlensed_params.json'. Note that this file will be stored in the self.ler_directory.
@@ -1670,7 +1704,7 @@ class LeR(LensGalaxyParameterDistribution):
 
         return snr_hit
 
-    def rate_comparision_with_rate_calculation(
+    def rate_comparison_with_rate_calculation(
         self,
         unlensed_param=None,
         snr_threshold_unlensed=8.0,
@@ -1733,7 +1767,7 @@ class LeR(LensGalaxyParameterDistribution):
         >>> ler = LeR()
         >>> ler.unlensed_cbc_statistics();
         >>> ler.lensed_cbc_statistics();
-        >>> rate_ratio, unlensed_param, lensed_param = ler.rate_comparision_with_rate_calculation()
+        >>> rate_ratio, unlensed_param, lensed_param = ler.rate_comparison_with_rate_calculation()
         """
 
         # call json_file_ler_param and add the results

{ler-0.4.1 → ler-0.4.2}/ler/utils/utils.py

@@ -5,6 +5,7 @@ This module contains helper routines for other modules in the ler package.
 
 import os
 import pickle
+import h5py
 import numpy as np
 import json
 from scipy.interpolate import interp1d
@@ -52,6 +53,66 @@ class NumpyEncoder(json.JSONEncoder):
             return obj.tolist()
         return json.JSONEncoder.default(self, obj)
 
+def load_pickle(file_name):
+    """Load a pickle file.
+
+    Parameters
+    ----------
+    file_name : `str`
+        pickle file name for storing the parameters.
+
+    Returns
+    ----------
+    param : `dict`
+    """
+    with open(file_name, "rb") as handle:
+        param = pickle.load(handle)
+
+    return param
+
+def save_pickle(file_name, param):
+    """Save a dictionary as a pickle file.
+
+    Parameters
+    ----------
+    file_name : `str`
+        pickle file name for storing the parameters.
+    param : `dict`
+        dictionary to be saved as a pickle file.
+    """
+    with open(file_name, "wb") as handle:
+        pickle.dump(param, handle, protocol=pickle.HIGHEST_PROTOCOL)
+
+# hdf5
+def load_hdf5(file_name):
+    """Load a hdf5 file.
+
+    Parameters
+    ----------
+    file_name : `str`
+        hdf5 file name for storing the parameters.
+
+    Returns
+    ----------
+    param : `dict`
+    """
+
+    return h5py.File(file_name, 'r')
+
+def save_hdf5(file_name, param):
+    """Save a dictionary as a hdf5 file.
+
+    Parameters
+    ----------
+    file_name : `str`
+        hdf5 file name for storing the parameters.
+    param : `dict`
+        dictionary to be saved as a hdf5 file.
+    """
+    with h5py.File(file_name, 'w') as f:
+        for key, value in param.items():
+            f.create_dataset(key, data=value)
+
 def load_json(file_name):
     """Load a json file.
 

{ler-0.4.1 → ler-0.4.2}/ler.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: ler
-Version: 0.4.1
-Summary: Gravitational waves Lensing Rates
+Version: 0.4.2
+Summary: LVK (LIGO-Virgo-KAGRA collaboration) Event (compact-binary mergers) Rate calculator and simulator
 Home-page: https://github.com/hemantaph/ler
 Author: Hemantakumar
 Author-email: hemantaphurailatpam@gmail.com

{ler-0.4.1 → ler-0.4.2}/setup.py

@@ -13,8 +13,8 @@ if python_version < (3, 10):
 
 setup(
     name="ler",
-    version="0.4.1",
-    description="Gravitational waves Lensing Rates",
+    version="0.4.2",
+    description="LVK (LIGO-Virgo-KAGRA collaboration) Event (compact-binary mergers) Rate calculator and simulator",
     long_description=long_description,
     long_description_content_type='text/markdown',
     author="Hemantakumar",