PycWB 0.31.0__tar.gz → 1.0.0a2__tar.gz

pycwb-1.0.0a2/.gitattributes

@@ -0,0 +1 @@
+prototypes/config/DQ/**/*.txt filter=lfs diff=lfs merge=lfs -text

{pycwb-0.31.0 → pycwb-1.0.0a2}/.gitignore

@@ -10,7 +10,7 @@ messenger_test/data
 docs/source/pycwb*.rst
 docs/source/modules.rst
 
-tests/*
+*.log
 .pytest_cache
 *.iml
 cwb-core/install
@@ -24,4 +24,17 @@ messenger-web-interface/dist
 cwb_wrapper/_version.py
 pycwb/_version.py
 
-benchmark/*/*.pkl
+benchmark/*/*.pkl
+examples/*/catalog
+examples/*/public
+examples/*/trigger
+examples/*/job_status
+examples/*/output
+examples/*/log
+examples/*/wdmXTalk
+examples/**/*.hdf5
+examples/**/*.gwf
+
+*.bin
+*.xbin
+*.pkl

{pycwb-0.31.0 → pycwb-1.0.0a2}/.gitlab-ci.yml

@@ -9,13 +9,13 @@ stages:          # List of stages for jobs, and their order of execution
 include:
   - component: git.ligo.org/computing/gitlab/components/docker/build@2.3.1
     inputs:
-      dockerfile: envs/Dockerfile.ci
+      dockerfile: envs/Dockerfile.ci-native
       job_name: build
       image_tag: ${CI_COMMIT_TAG:-$CI_COMMIT_REF_SLUG}
 
   - component: git.ligo.org/computing/gitlab/components/docker/build@2.3.1
     inputs:
-      dockerfile: envs/Dockerfile.ci
+      dockerfile: envs/Dockerfile.ci-native
       job_name: build-latest
       image_tag: latest
 

{pycwb-0.31.0 → pycwb-1.0.0a2}/PKG-INFO

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: PycWB
-Version: 0.31.0
+Version: 1.0.0a2
 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>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://git.ligo.org/yumeng.xu/pycwb
+Project-URL: Documentation, https://pycwb.readthedocs.io
 Keywords: ligo,physics,gravity,signal processing,gravitational waves,cwb,coherent wave burst
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: matplotlib
@@ -13,50 +15,52 @@ Requires-Dist: astropy
 Requires-Dist: pyyaml
 Requires-Dist: jsonschema
 Requires-Dist: watchfiles
-Requires-Dist: numpy
 Requires-Dist: numba
+Requires-Dist: jax
 Requires-Dist: gwpy
 Requires-Dist: ligo-segments
 Requires-Dist: ligo-gracedb
 Requires-Dist: aiohttp
-Requires-Dist: pycbc
 Requires-Dist: filelock
-Requires-Dist: scipy<1.14
+Requires-Dist: numpy>=2
+Requires-Dist: scipy>=1.13
+Requires-Dist: h5py>=3.11
+Requires-Dist: lalsuite>=7.23
+Requires-Dist: healpy>=1.17
+Requires-Dist: scikit-learn>=1.4.2
+Requires-Dist: pyarrow>=17
 Requires-Dist: pillow>=9.0.0
 Requires-Dist: click
 Requires-Dist: orjson
 Requires-Dist: dacite
-Requires-Dist: lalsuite>=7.0.0
-Requires-Dist: prefect
-Requires-Dist: prefect-dask
-Requires-Dist: dask
-Requires-Dist: dask_jobqueue
+Requires-Dist: cartopy
 Requires-Dist: htcondor
 Requires-Dist: psutil
 Requires-Dist: memspectrum
 Requires-Dist: exceptiongroup>=1.0.0; python_version < "3.11"
 Requires-Dist: python-ligo-lw<2.0.0
-Requires-Dist: scikit-learn
 Requires-Dist: jinja2
 Requires-Dist: plotly
-Requires-Dist: healpy
 Requires-Dist: wdm-wavelet
 Requires-Dist: burst-waveform
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Requires-Dist: pandas
+Requires-Dist: duckdb
+Requires-Dist: tqdm
+Provides-Extra: pycbc
+Requires-Dist: pycbc; extra == "pycbc"
+Provides-Extra: nds2
+Requires-Dist: python-nds2-client; extra == "nds2"
 Dynamic: license-file
-Dynamic: requires-dist
 
 # PycWB
 
-[![Documentations](https://readthedocs.org/projects/pycwb/badge/?version=latest)](https://pycwb.readthedocs.io)
+[![Documentation](https://readthedocs.org/projects/pycwb/badge/?version=latest)](https://pycwb.readthedocs.io)
 [![Build Status](https://git.ligo.org/yumeng.xu/pycwb/badges/main/pipeline.svg)](https://git.ligo.org/yumeng.xu/pycwb/-/pipelines)
 [![Releases](https://git.ligo.org/yumeng.xu/pycwb/-/badges/release.svg)](https://git.ligo.org/yumeng.xu/pycwb/-/releases)
 [![PyPI version](https://badge.fury.io/py/pycWB.svg)](https://badge.fury.io/py/pycWB)
 [![License](https://img.shields.io/badge/license-GPLv3-blue)](https://git.ligo.org/yumeng.xu/pycwb/-/blob/main/LICENSE)
 
-PycWB is a modularized Python package for gravitational wave burst search based on the core function of cWB.
+PycWB is a modularized Python package for gravitational wave burst search based on the core functions of cWB.
 The documentation can be found at [pycwb.readthedocs.io](https://pycwb.readthedocs.io).
 
 ## Installation
@@ -64,40 +68,53 @@ The documentation can be found at [pycwb.readthedocs.io](https://pycwb.readthedo
 ### Install PycWB with pip
 
 PycWB is available on [PyPI](https://pypi.org/project/pycWB/). You can install it with pip.
-Some dependencies are required to be installed before installing pycWB with pip. 
+Some dependencies are required before installing `pycwb` with pip.
 The easiest way is to install them with conda.
 
+> Python requirement: `>=3.10`
+
+```bash
+conda create -n pycwb python=3.13
+conda activate pycwb
+conda install -c conda-forge root=6 healpix_cxx=3 nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config
+python3 -m pip install pycwb
+```
+
+Currently, the ROOT-enabled `pycwb` build is only available for `x86_64` architecture. You can install the pure Python version of `pycwb` without installing ROOT:
+
 ```bash
-conda create -n pycwb "python>=3.9,<3.11"
+conda create -n pycwb python=3.13
 conda activate pycwb
-conda install -c conda-forge root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config
+conda install -c conda-forge nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config
 python3 -m pip install pycwb
 ```
 
-Currently, pycWB is only available for x64 architecture.
-For Apple Silicon users, you can install the dependencies with the following commands:
+For Apple Silicon users, if you need the ROOT version, install dependencies with the following commands:
 
 ```bash
 # make sure rosetta is installed
 softwareupdate --install-rosetta --agree-to-license
 # Optional: export CONDA_BUILD=1
-conda create -n pycwb
-conda activate pycwb
+conda create -n pycwb_x64
+conda activate pycwb_x64
 conda config --env --set subdir osx-64
-conda install -c conda-forge "python>=3.9,<3.11" root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config ruamel.yaml htcondor
+conda install python==3.11 root=6.28 healpix_cxx=3 nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config ruamel.yaml htcondor
+python3 -m pip install pycwb
 ```
 
-### Install pycWB from source
+### Install PycWB from source
 
 ```bash
 conda create -n pycwb python
 conda activate pycwb
-conda install -c conda-forge root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config
+conda install -c conda-forge root=6 healpix_cxx=3 nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config
 git clone git@git.ligo.org:yumeng.xu/pycwb.git
 cd pycwb
-make install
+python -m pip install .
 ```
 
+> Again, for Apple Silicon users, if you don't need the ROOT version, remove `root=6` and `healpix_cxx=3` from the dependencies in the command above. The installation process will automatically install the pure Python version of `pycwb`.
+
 ## Usage
 
 Example project can be found in [examples](https://git.ligo.org/yumeng.xu/pycwb/-/tree/main/examples)
@@ -114,6 +131,17 @@ or run with command line
 pycwb run ./user_parameters.yaml
 ```
 
+### Verify installation
+
+```bash
+pycwb --version
+pycwb --help
+```
+
+### Quick start for config setup
+
+For one-command project setup and optional job submission, see [QUICKSTART_CONFIG_SETUP.md](./QUICKSTART_CONFIG_SETUP.md).
+
 ## Interactive tutorial
 
  - Google Colab tutorial: [pycWB_GW150914.ipynb](https://colab.research.google.com/github/PycWB/pycwb/blob/main/examples/colab/pycWB_GW150914.ipynb)

{pycwb-0.31.0 → pycwb-1.0.0a2}/PycWB.egg-info/PKG-INFO

@@ -1,11 +1,13 @@
 Metadata-Version: 2.4
 Name: PycWB
-Version: 0.31.0
+Version: 1.0.0a2
 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>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://git.ligo.org/yumeng.xu/pycwb
+Project-URL: Documentation, https://pycwb.readthedocs.io
 Keywords: ligo,physics,gravity,signal processing,gravitational waves,cwb,coherent wave burst
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: matplotlib
@@ -13,50 +15,52 @@ Requires-Dist: astropy
 Requires-Dist: pyyaml
 Requires-Dist: jsonschema
 Requires-Dist: watchfiles
-Requires-Dist: numpy
 Requires-Dist: numba
+Requires-Dist: jax
 Requires-Dist: gwpy
 Requires-Dist: ligo-segments
 Requires-Dist: ligo-gracedb
 Requires-Dist: aiohttp
-Requires-Dist: pycbc
 Requires-Dist: filelock
-Requires-Dist: scipy<1.14
+Requires-Dist: numpy>=2
+Requires-Dist: scipy>=1.13
+Requires-Dist: h5py>=3.11
+Requires-Dist: lalsuite>=7.23
+Requires-Dist: healpy>=1.17
+Requires-Dist: scikit-learn>=1.4.2
+Requires-Dist: pyarrow>=17
 Requires-Dist: pillow>=9.0.0
 Requires-Dist: click
 Requires-Dist: orjson
 Requires-Dist: dacite
-Requires-Dist: lalsuite>=7.0.0
-Requires-Dist: prefect
-Requires-Dist: prefect-dask
-Requires-Dist: dask
-Requires-Dist: dask_jobqueue
+Requires-Dist: cartopy
 Requires-Dist: htcondor
 Requires-Dist: psutil
 Requires-Dist: memspectrum
 Requires-Dist: exceptiongroup>=1.0.0; python_version < "3.11"
 Requires-Dist: python-ligo-lw<2.0.0
-Requires-Dist: scikit-learn
 Requires-Dist: jinja2
 Requires-Dist: plotly
-Requires-Dist: healpy
 Requires-Dist: wdm-wavelet
 Requires-Dist: burst-waveform
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
+Requires-Dist: pandas
+Requires-Dist: duckdb
+Requires-Dist: tqdm
+Provides-Extra: pycbc
+Requires-Dist: pycbc; extra == "pycbc"
+Provides-Extra: nds2
+Requires-Dist: python-nds2-client; extra == "nds2"
 Dynamic: license-file
-Dynamic: requires-dist
 
 # PycWB
 
-[![Documentations](https://readthedocs.org/projects/pycwb/badge/?version=latest)](https://pycwb.readthedocs.io)
+[![Documentation](https://readthedocs.org/projects/pycwb/badge/?version=latest)](https://pycwb.readthedocs.io)
 [![Build Status](https://git.ligo.org/yumeng.xu/pycwb/badges/main/pipeline.svg)](https://git.ligo.org/yumeng.xu/pycwb/-/pipelines)
 [![Releases](https://git.ligo.org/yumeng.xu/pycwb/-/badges/release.svg)](https://git.ligo.org/yumeng.xu/pycwb/-/releases)
 [![PyPI version](https://badge.fury.io/py/pycWB.svg)](https://badge.fury.io/py/pycWB)
 [![License](https://img.shields.io/badge/license-GPLv3-blue)](https://git.ligo.org/yumeng.xu/pycwb/-/blob/main/LICENSE)
 
-PycWB is a modularized Python package for gravitational wave burst search based on the core function of cWB.
+PycWB is a modularized Python package for gravitational wave burst search based on the core functions of cWB.
 The documentation can be found at [pycwb.readthedocs.io](https://pycwb.readthedocs.io).
 
 ## Installation
@@ -64,40 +68,53 @@ The documentation can be found at [pycwb.readthedocs.io](https://pycwb.readthedo
 ### Install PycWB with pip
 
 PycWB is available on [PyPI](https://pypi.org/project/pycWB/). You can install it with pip.
-Some dependencies are required to be installed before installing pycWB with pip. 
+Some dependencies are required before installing `pycwb` with pip.
 The easiest way is to install them with conda.
 
+> Python requirement: `>=3.10`
+
+```bash
+conda create -n pycwb python=3.13
+conda activate pycwb
+conda install -c conda-forge root=6 healpix_cxx=3 nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config
+python3 -m pip install pycwb
+```
+
+Currently, the ROOT-enabled `pycwb` build is only available for `x86_64` architecture. You can install the pure Python version of `pycwb` without installing ROOT:
+
 ```bash
-conda create -n pycwb "python>=3.9,<3.11"
+conda create -n pycwb python=3.13
 conda activate pycwb
-conda install -c conda-forge root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config
+conda install -c conda-forge nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config
 python3 -m pip install pycwb
 ```
 
-Currently, pycWB is only available for x64 architecture.
-For Apple Silicon users, you can install the dependencies with the following commands:
+For Apple Silicon users, if you need the ROOT version, install dependencies with the following commands:
 
 ```bash
 # make sure rosetta is installed
 softwareupdate --install-rosetta --agree-to-license
 # Optional: export CONDA_BUILD=1
-conda create -n pycwb
-conda activate pycwb
+conda create -n pycwb_x64
+conda activate pycwb_x64
 conda config --env --set subdir osx-64
-conda install -c conda-forge "python>=3.9,<3.11" root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config ruamel.yaml htcondor
+conda install python==3.11 root=6.28 healpix_cxx=3 nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config ruamel.yaml htcondor
+python3 -m pip install pycwb
 ```
 
-### Install pycWB from source
+### Install PycWB from source
 
 ```bash
 conda create -n pycwb python
 conda activate pycwb
-conda install -c conda-forge root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config
+conda install -c conda-forge root=6 healpix_cxx=3 nds2-client python-nds2-client lalsuite python-ligo-lw setuptools_scm cmake pkg-config
 git clone git@git.ligo.org:yumeng.xu/pycwb.git
 cd pycwb
-make install
+python -m pip install .
 ```
 
+> Again, for Apple Silicon users, if you don't need the ROOT version, remove `root=6` and `healpix_cxx=3` from the dependencies in the command above. The installation process will automatically install the pure Python version of `pycwb`.
+
 ## Usage
 
 Example project can be found in [examples](https://git.ligo.org/yumeng.xu/pycwb/-/tree/main/examples)
@@ -114,6 +131,17 @@ or run with command line
 pycwb run ./user_parameters.yaml
 ```
 
+### Verify installation
+
+```bash
+pycwb --version
+pycwb --help
+```
+
+### Quick start for config setup
+
+For one-command project setup and optional job submission, see [QUICKSTART_CONFIG_SETUP.md](./QUICKSTART_CONFIG_SETUP.md).
+
 ## Interactive tutorial
 
  - Google Colab tutorial: [pycWB_GW150914.ipynb](https://colab.research.google.com/github/PycWB/pycwb/blob/main/examples/colab/pycWB_GW150914.ipynb)