pycWB


NamepycWB JSON
Version 0.17.2 PyPI version JSON
download
home_pagehttps://git.ligo.org/yumeng.xu/pycwb
SummaryA Python package for coherent gravitational wave burst analysis
upload_time2023-08-30 19:20:52
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords ligo physics gravity signal processing gravitational waves cwb coherent wave burst
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # pycWB

[![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.

## Installation

### 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. 
The easiest way is to install them with conda.

```bash
conda create -n pycwb "python>=3.9,<3.11"
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
python3 -m pip install pycwb
```

### 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
git clone git@git.ligo.org:yumeng.xu/pycwb.git
cd pycwb
make install
```

## Usage

Example project can be found in [examples](./examples)

```python
from pycwb.search import search

search('./user_parameters.yaml')
```

Raw data

            {
    "_id": null,
    "home_page": "https://git.ligo.org/yumeng.xu/pycwb",
    "name": "pycWB",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "ligo,physics,gravity,signal processing,gravitational waves,cwb,coherent wave burst",
    "author": "",
    "author_email": "The pycWB team <xusmailbox@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/39/73/1e36bac73d5e7d9e15e062dea31efbd8e57b2bb5f6b68ed24d1683a45501/pycWB-0.17.2.tar.gz",
    "platform": null,
    "description": "# pycWB\n\n[![Build Status](https://git.ligo.org/yumeng.xu/pycwb/badges/main/pipeline.svg)](https://git.ligo.org/yumeng.xu/pycwb/-/pipelines)\n[![Releases](https://git.ligo.org/yumeng.xu/pycwb/-/badges/release.svg)](https://git.ligo.org/yumeng.xu/pycwb/-/releases)\n[![PyPI version](https://badge.fury.io/py/pycWB.svg)](https://badge.fury.io/py/pycWB)\n[![License](https://img.shields.io/badge/license-GPLv3-blue)](https://git.ligo.org/yumeng.xu/pycwb/-/blob/main/LICENSE)\n\npycWB is a modularized Python package for gravitational wave burst search based on the core function of cWB.\n\n## Installation\n\n### Install pycWB with pip\n\npycWB is available on [PyPI](https://pypi.org/project/pycWB/). You can install it with pip.\nSome dependencies are required to be installed before installing pycWB with pip. \nThe easiest way is to install them with conda.\n\n```bash\nconda create -n pycwb \"python>=3.9,<3.11\"\nconda activate pycwb\nconda install -c conda-forge root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config\npython3 -m pip install pycwb\n```\n\n### Install pycWB from source\n\n```bash\nconda create -n pycwb python\nconda activate pycwb\nconda install -c conda-forge root=6.26.10 healpix_cxx=3.81 nds2-client python-nds2-client lalsuite setuptools_scm cmake pkg-config\ngit clone git@git.ligo.org:yumeng.xu/pycwb.git\ncd pycwb\nmake install\n```\n\n## Usage\n\nExample project can be found in [examples](./examples)\n\n```python\nfrom pycwb.search import search\n\nsearch('./user_parameters.yaml')\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Python package for coherent gravitational wave burst analysis",
    "version": "0.17.2",
    "project_urls": {
        "Homepage": "https://git.ligo.org/yumeng.xu/pycwb"
    },
    "split_keywords": [
        "ligo",
        "physics",
        "gravity",
        "signal processing",
        "gravitational waves",
        "cwb",
        "coherent wave burst"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "39731e36bac73d5e7d9e15e062dea31efbd8e57b2bb5f6b68ed24d1683a45501",
                "md5": "c9dae7f62e48304607f6943357e7802b",
                "sha256": "22e59b8fc72c1cd1f22046ef19f9af27978560bb4a924e30006ab00d2029c5b2"
            },
            "downloads": -1,
            "filename": "pycWB-0.17.2.tar.gz",
            "has_sig": false,
            "md5_digest": "c9dae7f62e48304607f6943357e7802b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 39625534,
            "upload_time": "2023-08-30T19:20:52",
            "upload_time_iso_8601": "2023-08-30T19:20:52.210065Z",
            "url": "https://files.pythonhosted.org/packages/39/73/1e36bac73d5e7d9e15e062dea31efbd8e57b2bb5f6b68ed24d1683a45501/pycWB-0.17.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-30 19:20:52",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "pycwb"
}
Elapsed time: 0.10980s