PycWB 0.26.0__tar.gz → 0.27.1__tar.gz

{pycwb-0.26.0 → pycwb-0.27.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: PycWB
-Version: 0.26.0
+Version: 0.27.1
 Summary: A Python package for coherent gravitational wave burst analysis
 Home-page: https://git.ligo.org/yumeng.xu/pycwb
 Author-email: The PycWB team <yumeng.xu@ligo.org>
@@ -32,6 +32,10 @@ Requires-Dist: dask
 Requires-Dist: dask_jobqueue
 Requires-Dist: htcondor
 Requires-Dist: psutil
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
 
 # PycWB
 

{pycwb-0.26.0 → pycwb-0.27.1}/PycWB.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: PycWB
-Version: 0.26.0
+Version: 0.27.1
 Summary: A Python package for coherent gravitational wave burst analysis
 Home-page: https://git.ligo.org/yumeng.xu/pycwb
 Author-email: The PycWB team <yumeng.xu@ligo.org>
@@ -32,6 +32,10 @@ Requires-Dist: dask
 Requires-Dist: dask_jobqueue
 Requires-Dist: htcondor
 Requires-Dist: psutil
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
 
 # PycWB
 

{pycwb-0.26.0 → pycwb-0.27.1}/PycWB.egg-info/SOURCES.txt

@@ -175,6 +175,7 @@ examples/benchmark/input/OPBM.period
 examples/benchmark/input/OPBM_H1.frames
 examples/benchmark/input/OPBM_L1.frames
 examples/colab/pycWB_GW150914.ipynb
+examples/gwosc/user_parameters.yaml
 examples/injection/pycwb_injection.ipynb
 examples/injection/user_parameters_injection.yaml
 examples/injection/wdmXTalk/OverlapCatalog16-1024.bin
@@ -240,6 +241,7 @@ pycwb/cli/__init__.py
 pycwb/cli/batch_runner.py
 pycwb/cli/batch_setup.py
 pycwb/cli/flow.py
+pycwb/cli/gwosc.py
 pycwb/cli/merge_catalog.py
 pycwb/cli/post_process.py
 pycwb/cli/run.py
@@ -248,6 +250,8 @@ pycwb/cli/xtalk.py
 pycwb/config/__init__.py
 pycwb/config/config.py
 pycwb/constants/__init__.py
+pycwb/constants/detectors.py
+pycwb/constants/physics_constants.py
 pycwb/constants/project_constants.py
 pycwb/constants/user_parameters_schema.py
 pycwb/modules/__init__.py
@@ -282,6 +286,8 @@ pycwb/modules/gracedb/__init__.py
 pycwb/modules/gracedb/gracedb.py
 pycwb/modules/gracedb/module.yaml
 pycwb/modules/gracedb/test_gracedb.py
+pycwb/modules/gwosc/__init__.py
+pycwb/modules/gwosc/gwosc.py
 pycwb/modules/job_segment/__init__.py
 pycwb/modules/job_segment/dq_segment.py
 pycwb/modules/job_segment/frame.py
@@ -327,6 +333,7 @@ pycwb/modules/reconstruction/__init__.py
 pycwb/modules/reconstruction/getMRAwaveform.py
 pycwb/modules/reconstruction/module.yaml
 pycwb/modules/report/__init__.py
+pycwb/modules/report/continues_poisson.py
 pycwb/modules/report/far_rho.py
 pycwb/modules/report/read_results.py
 pycwb/modules/report/report.py
@@ -395,6 +402,7 @@ pycwb/vendor/example.yaml
 pycwb/vendor/autoencoder/__init__.py
 pycwb/vendor/autoencoder/cwb_autoencoder.h5
 pycwb/vendor/lib/__init__.py
+pycwb/vendor/template/gwosc/user_parameters.yaml
 pycwb/vendor/web_viewer/event_dump.html
 pycwb/vendor/web_viewer/styles.css
 pycwb/vendor/web_viewer/viewer.html

{pycwb-0.26.0 → pycwb-0.27.1}/bin/pycwb

@@ -12,6 +12,7 @@ import pycwb.cli.batch_runner as batch_runner
 import pycwb.cli.xtalk as xtalk
 import pycwb.cli.merge_catalog as merge_catalog
 import pycwb.cli.post_process as post_process
+import pycwb.cli.gwosc as gwosc
 
 def main():
     parser = argparse.ArgumentParser(prog='pycwb')
@@ -51,6 +52,11 @@ def main():
     post_process.init_parser(post_process_parser)
     post_process_parser.set_defaults(func=post_process.command)
 
+    #gwosc subcommand
+    gwosc_parser = subparsers.add_parser('gwosc', help='Download files to run a pycwb analysis of a GW event of your choice')
+    gwosc.init_parser(gwosc_parser)
+    gwosc_parser.set_defaults(func=gwosc.command)
+        
     args = parser.parse_args()
     if hasattr(args, 'func'):
         args.func(args)

{pycwb-0.26.0 → pycwb-0.27.1}/docs/source/index.rst

@@ -124,6 +124,10 @@ You can get help by running the command with the ``-h`` option. Here are the cur
      - Setup batch run
    * - ``pycwb batch-runner``
      - Runner for batch run, used for the job submission
+   * - ``pycwb post-process``
+     - Run the post process workflow
+   * - ``pycwb gwosc``
+     - Download data from GWOSC and setup the search
    * - ``pycwb flow``
      - Run search with prefect flow
    * - ``pycwb xtalk``

pycwb-0.27.1/examples/gwosc/user_parameters.yaml

@@ -0,0 +1,89 @@
+
+outputDir: "output"
+nproc: 6
+plot_trigger: True
+plot_waveform: True
+plot_injection: True
+plot_sky_map: True
+save_sky_map: True
+save_injection: True
+save_waveform: True
+
+analysis: "2G"
+cfg_search: "r"
+
+optim: False
+
+###### network configuration ######
+ifo: ["L1","H1"]
+refIFO: "L1"
+
+inRate: 16384
+# lags
+lagSize: 1
+lagStep: 1.
+lagOff: 0
+lagMax: 0
+
+# superlags
+slagSize: 0 # number of super lags (simulation=1) - if slagSize=0 -> Standard Segments
+slagMin: 0
+slagMax: 0
+slagOff: 0
+
+# job
+segLen: 1200
+segMLS: 600
+segTHR: 200
+segEdge: 10
+
+# frequency
+fLow: 16.
+fHigh: 1024.
+
+
+levelR: 3
+l_low: 4 # low frequency resolution level		// std (sthr = 2)
+l_high: 10 # high frequency resolution level	// std (sthr = 8)
+
+wdmXTalk: "wdmXTalk/OverlapCatalog16-1024.bin"
+
+healpix: 7
+
+###### cWB production thresholds & regulators ######
+
+bpp: 0.001
+subnet: 0.5
+subcut: 0.0
+netRHO: 5.5
+netCC: 0.5
+Acore: 1.7
+Tgap: 0.2
+Fgap: 128.0
+delta: 0.5
+cfg_gamma: -1.0
+LOUD: 300
+
+pattern: 5
+
+iwindow: 30
+
+nSky: 196608
+
+# simulation
+simulation: None  #PREVIOUSLY COMMENTED
+nfactor: 1
+
+channelNamesRaw: ["L1:GWOSC-4KHZ_R1_STRAIN","H1:GWOSC-4KHZ_R1_STRAIN"]
+frFiles: ["./GW170104/input/L1_frames.in", "./GW170104/input/H1_frames.in"]
+
+DQF: [
+  [ "L1" ,"./GW170104/input/L1_cat0.txt", CWB_CAT0, 0., False, False ],
+  [ "H1" ,"./GW170104/input/H1_cat0.txt", CWB_CAT0, 0., False, False ],
+  [ "L1" ,"./GW170104/input/L1_cat1.txt", CWB_CAT1, 0., False, False ],
+  [ "H1" ,"./GW170104/input/H1_cat1.txt", CWB_CAT1, 0., False, False ],
+  [ "L1" ,"./GW170104/input/L1_cat2.txt", CWB_CAT2, 0., False, False ],
+  [ "H1" ,"./GW170104/input/H1_cat2.txt", CWB_CAT2, 0., False, False ],
+  [ "L1" ,"./GW170104/input/cwb_period.txt", CWB_CAT0, 0., False, False ],
+  [ "H1" ,"./GW170104/input/cwb_period.txt", CWB_CAT0, 0., False, False ],
+]

{pycwb-0.26.0 → pycwb-0.27.1}/prototypes/pp_workflow/simple_module.yaml

@@ -4,14 +4,14 @@ steps:
   - action: report.read_results.read_triggers
     args:
       run_dir: background
-      filters:
-        - "lag[0]>0"
+      prefilters:
+        - "shift[0] != 0 or shift[1] != 0 or lag != 0"
     output_alias: 'background'
   - action: report.read_results.read_live_time
     args:
       run_dir: background
       filters:
-        - "lag[0]>0"
+        - "shift[0] != 0 or shift[1] != 0 or lag != 0"
     output_alias: 'livetime'
   - action: report.far_rho.far_rho # this module will calculate the far_rho and pass the output to the downstream modules
     args:
@@ -24,14 +24,18 @@ steps:
   - action: report.read_results.read_triggers
     args:
       run_dir: background
-      filters:
-        - "lag[0]==0"
+      prefilters:
+        - "lag==0"
+        - "slag[0]==0"
+        - "slag[1]==0"
     output_alias: 'zero_lag'
   - action: report.read_results.read_live_time
     args:
       run_dir: background
       filters:
-        - "lag[0]==0"
+        - "lag==0"
+        - "shift[0]==0"
+        - "shift[1]==0"
     output_alias: 'livetime_zerolag'
   - action: report.report.report_zero_lag
     args:

{pycwb-0.26.0 → pycwb-0.27.1}/pycwb/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.26.0'
-__version_tuple__ = version_tuple = (0, 26, 0)
+__version__ = version = '0.27.1'
+__version_tuple__ = version_tuple = (0, 27, 1)

pycwb-0.27.1/pycwb/cli/gwosc.py

@@ -0,0 +1,84 @@
+import os
+import shutil
+import pycwb
+from pycwb.modules.gwosc.gwosc import download_frames_files
+from pycwb.modules.gwosc.gwosc import get_cat_files
+from pycwb.modules.gwosc.gwosc import analysis_period
+
+def init_parser(parser):
+
+    # Select the GW event
+    parser.add_argument('event_name',
+                        metavar='event_name',  # Corrected metavar
+                        type=str,
+                        help='The name of the GW event you want (e.g., "GW150914").')
+
+    # Time left for cWB analysis
+    parser.add_argument('--time_left',
+                        metavar='time_left',
+                        type=float,
+                        default=610, 
+                        help='The pycWB analysis interval is '
+                             '[event_gps_time - time_left; event_gps_time + time_right]. Default: 610 seconds.')
+
+    # Time right for cWB analysis
+    parser.add_argument('--time_right',
+                        metavar='time_right',
+                        type=float,
+                        default=610, 
+                        help='The pycWB analysis interval is: '
+                             '[event_gps_time - time_left; event_gps_time + time_right]. Default: 610 seconds.')
+
+    # List of detectors
+    parser.add_argument('--ifos',
+                        metavar='ifos',
+                        type=str,
+                        nargs='+', 
+                        default=['H1', 'L1'], 
+                        help='List of the detectors you want data from. For example: --ifos H1 L1. The default is H1 L1.')
+    
+    parser.add_argument('--user_parameters_path',
+                        metavar='user_parameters_path',
+                        type=str,
+                        default=None, 
+                        help='Path of the user_parameters file, default pycwb/vendor/template/gwosc/')
+    
+
+def copy_user_parameters(user_parameters_path):
+
+    
+    file_to_copy = os.path.join(user_parameters_path, 'user_parameters.yaml')  
+
+    # Check if the file exists
+    if not os.path.exists(file_to_copy):
+        raise FileNotFoundError(f"The file {file_to_copy} does not exist. The default file is {file_to_copy}")
+    
+    # Define the destination directory for the event
+    destination_dir = os.path.join(".")
+    os.makedirs(destination_dir, exist_ok=True)  # Ensure the directory exists
+
+    # Define the destination file path
+    destination_file = os.path.join(destination_dir, os.path.basename(file_to_copy))
+    
+    # Copy the file
+    shutil.copy(file_to_copy, destination_file)
+    print(f"Copied {file_to_copy} to {destination_file}")
+
+
+def command(args):
+
+    if not all(ifo in ["H1", "L1"] for ifo in args.ifos) and not args.user_parameters_path:
+        raise ValueError("Only H1 and L1 are supported in ifos with the default user_parameters file, "
+                         "please provide a custom user_parameters file")
+
+    output = './input'
+    
+    if args.user_parameters_path is None:
+        package_abs_path = os.path.dirname(os.path.abspath(pycwb.__file__))
+        args.user_parameters_path = os.path.join(package_abs_path, 'vendor/template/gwosc')
+        print(f'{args.user_parameters_path}')
+
+    download_frames_files(args.event_name, output, args.ifos)
+    get_cat_files(args.event_name, output, args.ifos)
+    analysis_period(args.event_name, output, args.time_left, args.time_right, args.ifos)
+    copy_user_parameters(args.user_parameters_path)

pycwb-0.27.1/pycwb/constants/detectors.py

@@ -0,0 +1,119 @@
+DETECTORS = {
+    "H1": {
+        "name": "LHO_4k",
+        "lat": 0.81079526383,
+        "lon": -2.08405676917,
+        "x": {
+            "alt": -0.00061950000,
+            "az": 5.65487724844
+        },
+        "y": {
+            "alt": 0.00001250000,
+            "az": 4.08408092164
+        }
+    },
+    "L1": {
+        "name": "LLO_4k",
+        "lat": 0.53342313506,
+        "lon": -1.58430937078,
+        "x": {
+            "alt": -0.00031210000,
+            "az": 4.40317772346
+        },
+        "y": {
+            "alt": -0.00061070000,
+            "az": 2.83238139666
+        }
+    },
+    "V1": {
+        "name": "VIRGO",
+        "lat": 0.76151183984,
+        "lon": 0.18333805213,
+        "x": {
+            "alt": 0.00000000000,
+            "az": 0.33916285222
+        },
+        "y": {
+            "alt": 0.00000000000,
+            "az": 5.05155183261
+        }
+    },
+    "G1": {
+        "name": "GEO_600",
+        "lat": 0.91184982752,
+        "lon": 0.17116780435,
+        "x": {
+            "alt": 0.00000000000,
+            "az": 1.19360100484
+        },
+        "y": {
+            "alt": 0.00000000000,
+            "az": 5.83039279401
+        }
+    },
+    "E1": {
+        "name": "ET1_T1400308",
+        "lat": 0.76151183984,
+        "lon": 0.18333805213,
+        "x": {
+            "alt": 0.00000000000,
+            "az": 0.33916285222
+        },
+        "y": {
+            "alt": 0.00000000000,
+            "az": 5.57515060820
+        }
+    },
+    "E2": {
+        "name": "ET2_T1400308",
+        "lat": 0.76299307990,
+        "lon": 0.18405858870,
+        "x": {
+            "alt": 0.00000000000,
+            "az": 4.52795305701
+        },
+        "y": {
+            "alt": 0.00000000000,
+            "az": 3.48075550581
+        }
+    },
+    "E3": {
+        "name": "ET3_T1400308",
+        "lat": 0.76270463257,
+        "lon": 0.18192996730,
+        "x": {
+            "alt": 0.00000000000,
+            "az": 2.43355795462
+        },
+        "y": {
+            "alt": 0.00000000000,
+            "az": 1.38636040342
+        }
+    },
+    "E0": {
+        "name": "ET0_T1400308",
+        "lat": 0.76270463257,
+        "lon": 0.18192996730,
+        "x": {
+            "alt": 0.00000000000,
+            "az": 0.00000000000
+        },
+        "y": {
+            "alt": 0.00000000000,
+            "az": 0.00000000000
+        }
+    },
+    "K1": {
+        "name": "KAGRA",
+        "lat": 0.6355068497,
+        "lon": 2.396441015,
+        "x": {
+            "alt": 0.0031414,
+            "az": 1.054113
+        },
+        "y": {
+            "alt": -0.0036270,
+            "az": -0.5166798
+        }
+    }
+}

pycwb-0.27.1/pycwb/constants/physics_constants.py

@@ -0,0 +1,2 @@
+LAL_EARTHFLAT = 0.00335281 # Earth flattening factor (WGS84)
+LAL_REARTH_SI = 6378136.6  # Earth's radius in meters (WGS84)

{pycwb-0.26.0 → pycwb-0.27.1}/pycwb/modules/cwb_conversions/series.py

@@ -98,7 +98,10 @@ def convert_timeseries_to_wavearray(data: TimeSeries):
     # if not hasattr(ROOT, "_copy_to_wavearray"):
     #     declare_function()
 
-    ROOT.pycwb_copy_to_wavearray(data.value.ctypes.data_as(c_double_p), h, len(data.value))
+    # convert it to contiguous array to prevent segmentation fault
+    new_data = np.ascontiguousarray(data.value, dtype=np.float64)
+
+    ROOT.pycwb_copy_to_wavearray(new_data.ctypes.data_as(c_double_p), h, len(data.value))
 
     h.start(np.asarray(data.t0, dtype=np.double))
     h.rate(int(1. / np.asarray(data.dt, dtype=np.double)))
@@ -122,7 +125,10 @@ def convert_pycbc_timeseries_to_wavearray(data: pycbcTimeSeries):
     # if not hasattr(ROOT, "_copy_to_wavearray"):
     #     declare_function()
 
-    ROOT.pycwb_copy_to_wavearray(data.data.ctypes.data_as(c_double_p), h, len(data.data))
+    # convert it to contiguous array to prevent segmentation fault
+    new_data = np.ascontiguousarray(data.data, dtype=np.float64)
+
+    ROOT.pycwb_copy_to_wavearray(new_data.ctypes.data_as(c_double_p), h, len(data.data))
 
     h.start(np.asarray(data.start_time, dtype=np.double))
     h.rate(int(1. / np.asarray(data.delta_t, dtype=np.double)))

pycwb-0.27.1/pycwb/modules/gwosc/gwosc.py

@@ -0,0 +1,142 @@
+from gwosc.datasets import event_gps, event_detectors, event_segment
+from gwosc.locate import get_urls
+from gwosc.timeline import get_segments
+import os
+import requests
+
+def event_info(event_name, ifos):
+    """
+    Retrieve key information about the specified gravitational wave event.
+
+    Parameters:
+    -----------
+    event_name : str
+        The name of the gravitational wave event (e.g., "GW150914").
+
+    Returns:
+    --------
+    tuple :
+        - A list of detectors that observed the event, filtered to include only allowed detectors.
+        - The GPS time of the event.
+        - The start and end GPS time of the event segment.
+    """
+    allowed_cWB_detectors = ifos
+    detectors = event_detectors(event_name)  
+    detectors = [detector for detector in detectors if detector in allowed_cWB_detectors]
+    event_gps_time = event_gps(event_name)
+    start_time, end_time = event_segment(event_name)
+
+    return detectors, event_gps_time, start_time, end_time
+
+def download_frames_files(event_name, output_dir, ifos):
+    """
+    Download frame files for the given gravitational wave event and save a list of their paths.
+
+    Parameters:
+    -----------
+    event_name : str
+        The name of the gravitational wave event (e.g., "GW150914").
+    output_dir : str
+        The directory where frame files and associated lists will be saved.
+
+    Returns:
+    --------
+    None
+    """
+    os.makedirs(output_dir, exist_ok=True)
+
+    detectors, event_gps_time, start_time, end_time = event_info(event_name, ifos)
+
+    for detector in detectors:
+        urls = get_urls(detector=detector, start=start_time, end=end_time, dataset=event_name, format='gwf', sample_rate=4096)
+        
+        # Exclude files with '-32.gwf'
+        urls = [url for url in urls if "-32.gwf" not in url] 
+        
+        frame_dir = os.path.join(f"{output_dir}/frames/", f"{detector}_frames")
+        os.makedirs(frame_dir, exist_ok=True)
+
+        local_paths = []
+
+        # Download files
+        for url in urls:
+            frame_file_path = os.path.join(frame_dir, os.path.basename(url))
+            print(f"Downloading {frame_file_path} from {url}...")
+            response = requests.get(url)
+            with open(frame_file_path, 'wb') as frame_file:
+                frame_file.write(response.content)
+            local_paths.append(frame_file_path)
+
+        # Save *_frames.in file
+        frame_list_file = os.path.join(output_dir, f"{detector}_frames.in")
+        with open(frame_list_file, 'w') as f:
+            for path in local_paths:
+                f.write(path + "\n")
+
+        print(f"Frame list saved to {frame_list_file}")
+
+def get_cat_files(event_name, output_dir, ifos):
+    """
+    Generate files containing Data Quality (DQ) segments for the given gravitational wave event.
+
+    Parameters:
+    -----------
+    event_name : str
+        The name of the gravitational wave event (e.g., "GW150914").
+    output_dir : str
+        The directory where DQ segment files will be saved.
+
+    Returns:
+    --------
+    None
+    """
+    os.makedirs(output_dir, exist_ok=True)
+
+    detectors, event_gps_time, start_time, end_time = event_info(event_name, ifos)
+
+    for detector in detectors:
+        for category, cat_name in [
+            (f'{detector}_DATA', f'{detector}_cat0.txt'),
+            (f'{detector}_BURST_CAT1', f'{detector}_cat1.txt'),
+            (f'{detector}_BURST_CAT2', f'{detector}_cat2.txt'),
+        ]:
+            segments = get_segments(category, start_time, end_time)
+            cat_file_path = os.path.join(output_dir, cat_name)
+
+            with open(cat_file_path, 'w') as cat_file:
+                for segment in segments:
+                    cat_file.write(f"{segment[0]} {segment[1]}\n")
+
+            print(f"Segments saved in {cat_file_path}")
+
+def analysis_period(event_name, output_dir, time_left, time_right, ifos):
+    """
+    Calculate the analysis period for cWB based on the event GPS time and save it to a file.
+
+    This function calculates the start and end times for the cWB analysis period by subtracting
+    and adding the specified offsets (`time_left` and `time_right`) to the GPS time of the 
+    gravitational wave event. The resulting period is saved in a file named `cwb_period.txt`.
+
+    Parameters:
+    -----------
+    event_name : str
+        The name of the gravitational wave event (e.g., "GW150914").
+    time_left : int, optional
+        Time in seconds to subtract from the event GPS time to determine the start of the analysis period
+        (default is 610 seconds).
+    time_right : int, optional
+        Time in seconds to add to the event GPS time to determine the end of the analysis period
+        (default is 610 seconds).
+
+    Returns:
+    --------
+    None
+    """
+    _, event_gps_time, _, _ = event_info(event_name, ifos)
+    print(f"Event gps time: {event_gps_time}")
+    analysis_period = [event_gps_time - time_left, event_gps_time + time_right]
+
+    cwb_period_file_path = os.path.join(output_dir, "cwb_period.txt")
+    with open(cwb_period_file_path, 'w') as cwb_period_file:
+        cwb_period_file.write(f"{analysis_period[0]} {analysis_period[1]}\n")
+    print(f"cWB analysis period saved in {cwb_period_file_path}")

{pycwb-0.26.0 → pycwb-0.27.1}/pycwb/modules/job_segment/job_segment.py

@@ -148,7 +148,7 @@ def job_segment_from_dq(dq_file_list, ifos, seg_len, seg_mls, seg_edge, seg_over
     seg_lists = []
     for ifo in ifos:
         dq_files = [dq_file for dq_file in dq_file_list if dq_file.ifo == ifo]
-        cat1_list = read_seg_list(dq_files, 'CWB_CAT1')
+        cat1_list = read_seg_list(dq_files, 'CWB_CAT1', periods)
         seg_lists.append(cat1_list)
 
     # for zero super lag, merge the segments, and get the standard job segments