PycWB 0.22.1__tar.gz → 0.22.2__tar.gz

{pycwb-0.22.1 → pycwb-0.22.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PycWB
-Version: 0.22.1
+Version: 0.22.2
 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>

{pycwb-0.22.1 → pycwb-0.22.2}/PycWB.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PycWB
-Version: 0.22.1
+Version: 0.22.2
 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>

{pycwb-0.22.1 → pycwb-0.22.2}/PycWB.egg-info/SOURCES.txt

@@ -336,6 +336,7 @@ pycwb/modules/workflow_utils/job_setup.py
 pycwb/modules/xtalk/__init__.py
 pycwb/modules/xtalk/monster.py
 pycwb/modules/xtalk/monster_old.py
+pycwb/modules/xtalk/xtalk_data.py
 pycwb/prefect_flow/__init__.py
 pycwb/prefect_flow/pycwb_flow.py
 pycwb/prefect_flow/tasks/__init__.py

{pycwb-0.22.1 → pycwb-0.22.2}/pycwb/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.22.1'
-__version_tuple__ = version_tuple = (0, 22, 1)
+__version__ = version = '0.22.2'
+__version_tuple__ = version_tuple = (0, 22, 2)

{pycwb-0.22.1 → pycwb-0.22.2}/pycwb/cli/xtalk.py

@@ -14,6 +14,7 @@ def init_parser(parser):
                         '-o',
                         metavar='output_dir',
                         type=str,
+                        default='.',
                         help='the output directory')
 
 

{pycwb-0.22.1 → pycwb-0.22.2}/pycwb/config/config.py

@@ -5,7 +5,9 @@ pycwb.constants.user_parameters_schema.
 """
 import os.path
 import logging
+import pathlib
 
+from ..modules.xtalk.xtalk_data import check_and_download_xtalk_data
 from ..types.wdm_xtalk import WDMXTalkCatalog
 from ..types.data_quality_file import DQFile
 from ..utils.network import max_delay
@@ -67,9 +69,8 @@ class Config:
             setattr(self, key, params[key])
 
         self.add_derived_key()
-        self.check_file(self.MRAcatalog)
-        if self.MRAcatalog:
-            self.check_MRA_catalog()
+        self.check_xtalk_file(self.MRAcatalog)
+        self.check_MRA_catalog()
         self.check_lagStep()
 
     def add_derived_key(self):
@@ -90,7 +91,10 @@ class Config:
 
         # load WAT filter directory and set MRAcatalog
         if not self.filter_dir:
-            self.filter_dir = os.environ['HOME_WAT_FILTERS']
+            if os.environ.get('HOME_WAT_FILTERS') is None:
+                self.filter_dir = os.path.abspath(".")
+            else:
+                self.filter_dir = os.environ['HOME_WAT_FILTERS']
 
         self.MRAcatalog = f"{self.filter_dir}/{self.wdmXTalk}"
 
@@ -142,6 +146,33 @@ class Config:
         if not os.path.isfile(file_name):
             raise FileNotFoundError(f"File {file_name} does not exist")
 
+    @staticmethod
+    def check_xtalk_file(file_name: str) -> bool:
+        """
+        Helper function to check if xtalk file exists and download it if it does not exist
+
+        Parameters
+        ----------
+        file_name : str
+            Path to the xtalk file
+
+        Returns
+        -------
+        bool
+            True if the file exists or has been downloaded successfully, False otherwise
+
+        Raises
+        ------
+        FileNotFoundError
+            If the file does not exist and cannot be downloaded
+        """
+        if not os.path.isfile(file_name):
+            if check_and_download_xtalk_data(str(pathlib.Path(file_name).name), str(pathlib.Path(file_name).parent)):
+                return True
+            else:
+                raise FileNotFoundError(f"File {file_name} does not exist")
+        return True
+
     def check_lagStep(self):
         """
         Check if lagStep compatible with WDM parity

pycwb-0.22.2/pycwb/constants/project_constants.py

@@ -0,0 +1,3 @@
+ROUNDED_DIGITS = 50
+XTALK_FILE_LIST_URL = "https://raw.githubusercontent.com/PycWB/xtalk-data/main/file_list.txt"
+XTALK_DATA_URL = "https://github.com/PycWB/xtalk-data/raw/main"

{pycwb-0.22.1 → pycwb-0.22.2}/pycwb/modules/xtalk/monster.py

@@ -12,7 +12,7 @@ def load_catalog(fn, dump=True):
 
     Parameters
     ----------
-    fn : str
+    fn : str or Path
         The file name of the crosstalk catalog file
     dump : bool
         If True, save the parsed data into a .npz file with the same name as the input file in current working directory
@@ -38,17 +38,18 @@ def load_catalog(fn, dump=True):
     # Check if there is converted file
     # if ext of fn is .bin, search if there is a .npz file with the same name
     # under the same directory and working directory
-    if pathlib.Path(fn).suffix == ".bin":
+    if pathlib.Path(fn).suffix == ".bin" or pathlib.Path(fn).suffix == ".xbin":
         print(f"A .bin file is detected, searching for .npz file with the same name.")
-        npz_fn = fn.replace(".bin", ".npz")
+        # npz_fn = fn.replace(".bin", ".npz")
+        npz_fn = pathlib.Path(fn).with_suffix(".npz")
         if pathlib.Path(npz_fn).exists():
             print(f".npz file found: {npz_fn}, loading the catalog from the .npz file.")
             return load_catalog(npz_fn)
 
-        npz_fn = pathlib.Path(fn).name.replace(".bin", ".npz")
-        if pathlib.Path(npz_fn).exists():
-            print(f".npz file found: {npz_fn}, loading the catalog from the .npz file.")
-            return load_catalog(npz_fn)
+        # npz_fn = pathlib.Path(fn).name.replace(".bin", ".npz")
+        # if pathlib.Path(npz_fn).exists():
+        #     print(f".npz file found: {npz_fn}, loading the catalog from the .npz file.")
+        #     return load_catalog(npz_fn)
 
     with open(fn, "rb") as f:
         data = f.read()  # Read the entire file into memory
@@ -91,7 +92,8 @@ def load_catalog(fn, dump=True):
 
     if dump:
         # dump to current working directory
-        filename = pathlib.Path(fn).name.replace(".bin", ".npz")
+        # filename = pathlib.Path(fn).name.replace(".bin", ".npz")
+        filename = pathlib.Path(fn).with_suffix(".npz")
         np.savez(filename, xtalk_coeff=xtalk_coeff, xtalk_lookup_table=lookup_table, layers=layers,
                  nRes=nRes)
     return np.array(xtalk_coeff), lookup_table, np.array(layers), nRes

pycwb-0.22.2/pycwb/modules/xtalk/xtalk_data.py

@@ -0,0 +1,49 @@
+import requests
+import pathlib
+from pycwb.constants.project_constants import XTALK_DATA_URL, XTALK_FILE_LIST_URL
+
+
+def fetch_txt(url):
+    try:
+        response = requests.get(url)
+        response.raise_for_status()  # Raises an exception for 4XX or 5XX errors
+        return response.text.splitlines()  # Returns the list of file names
+    except requests.RequestException as e:
+        return f"An error occurred: {e}"
+
+
+def download_file(url, file_name):
+    try:
+        response = requests.get(url)
+        response.raise_for_status()  # Raises an exception for 4XX or 5XX errors
+        with open(file_name, "wb") as f:
+            f.write(response.content)
+        return f"File {file_name} has been downloaded successfully."
+    except requests.RequestException as e:
+        return f"An error occurred: {e}"
+
+
+def check_and_download_xtalk_data(file_name: str, output_dir: str = ".")\
+        -> bool:
+    # Fetch and print the file list
+    file_list = fetch_txt(XTALK_FILE_LIST_URL)
+
+    # replace any file extension (.bin, .xbin) with .npz
+    # new_file_name = pathlib.Path(file_name).with_suffix(".npz").name
+    file_name = pathlib.Path(file_name).name
+
+    # Check if the file is in the list
+    if file_name in file_list:
+        # make output_dir if it does not exist
+        pathlib.Path(output_dir).mkdir(parents=True, exist_ok=True)
+
+        # Download the file
+        print(f"File {file_name} is available on {XTALK_DATA_URL}.")
+        download_url = f"{XTALK_DATA_URL}/{file_name}"
+        print(f"Downloading {download_url}...")
+        download_file(download_url, f"{output_dir}/{file_name}")
+        print(f"File saved as {output_dir}/{file_name}")
+        return True
+    else:
+        print(f"File {file_name} is not available on {XTALK_DATA_URL}.")
+        return False

{pycwb-0.22.1 → pycwb-0.22.2}/pycwb/workflow/subflow/prepare_job_runs.py

@@ -44,7 +44,7 @@ def prepare_job_runs(working_dir: str, config_file: str, n_proc: int = 1,
     os.chdir(working_dir)
 
     # check environment
-    check_MRACatalog_setting()
+    # check_MRACatalog_setting()
 
     # read user parameters
     config = Config(file_name)
@@ -78,7 +78,7 @@ def load_batch_run(working_dir: str, config_file: str, job_file: str, job_start:
 
     os.chdir(working_dir)
 
-    check_MRACatalog_setting()
+    # check_MRACatalog_setting()
 
     config = Config(file_name)
 

pycwb-0.22.1/pycwb/constants/project_constants.py

@@ -1 +0,0 @@
-ROUNDED_DIGITS = 50