gwtrigfind


Namegwtrigfind JSON
Version 0.8.0 PyPI version JSON
download
home_pagehttps://github.com/gwpy/gwtrigfind
SummaryUtility to find files archived by GW event trigger generators
upload_time2019-03-04 15:57:13
maintainer
docs_urlNone
authorDuncan Macleod
requires_python>=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*
license
keywords
VCS
bugtrack_url
requirements astropy ligo-segments
Travis-CI
coveralls test coverage No coveralls.
            # GWTrigFind

A utility to find GW trigger files produced by event trigger generators and archived on the LIGO Data Grid.

[![PyPI version](https://badge.fury.io/py/gwtrigfind.svg)](http://badge.fury.io/py/gwtrigfind)
[![Documentation Status](https://readthedocs.org/projects/gwtrigfind/badge/?version=stable)](https://gwtrigfind.readthedocs.io/en/stable/?badge=stable)
[![Build Status](https://travis-ci.com/gwpy/gwtrigfind.svg?branch=master)](https://travis-ci.org/gwpy/gwtrigfind)
[![Coverage Status](https://coveralls.io/repos/github/gwpy/gwtrigfind/badge.svg?branch=master)](https://coveralls.io/github/gwpy/gwtrigfind?branch=master)

## Quickstart for python

To discover trigger files for a given channel:

```python
>>> from gwtrigfind import find_trigger_files
>>> cache = find_trigger_files(channel, etg, gpsstart, gpsend)
```

The resulting cache can then be read easily into a table using [`gwpy`](//gwpy.github.io/):

```python
>>> from gwpy.table import EventTable
>>> t = EventTable.read(cache, format='ligolw', tablename='sngl_burst')
```

The format argument depends on the etg you use, but is likely to be one of `'hdf5'`, `'ligolw'`, or `'root'`.

## Quickstart for command-line

The same query can be performed from the command line by passing each of the functional arguments above as arguments to the `gwtrigfind` executable script:

```bash
gwtrigfind <channel> <etg> <gpsstart> <gpsend>
```


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gwpy/gwtrigfind",
    "name": "gwtrigfind",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
    "maintainer_email": "",
    "keywords": "",
    "author": "Duncan Macleod",
    "author_email": "duncan.macleod@ligo.org",
    "download_url": "https://files.pythonhosted.org/packages/ee/c6/505aab4442292bd6b6938ec01754d7c4b24de32124503c43d1f2b771e31c/gwtrigfind-0.8.0.tar.gz",
    "platform": "",
    "description": "# GWTrigFind\n\nA utility to find GW trigger files produced by event trigger generators and archived on the LIGO Data Grid.\n\n[![PyPI version](https://badge.fury.io/py/gwtrigfind.svg)](http://badge.fury.io/py/gwtrigfind)\n[![Documentation Status](https://readthedocs.org/projects/gwtrigfind/badge/?version=stable)](https://gwtrigfind.readthedocs.io/en/stable/?badge=stable)\n[![Build Status](https://travis-ci.com/gwpy/gwtrigfind.svg?branch=master)](https://travis-ci.org/gwpy/gwtrigfind)\n[![Coverage Status](https://coveralls.io/repos/github/gwpy/gwtrigfind/badge.svg?branch=master)](https://coveralls.io/github/gwpy/gwtrigfind?branch=master)\n\n## Quickstart for python\n\nTo discover trigger files for a given channel:\n\n```python\n>>> from gwtrigfind import find_trigger_files\n>>> cache = find_trigger_files(channel, etg, gpsstart, gpsend)\n```\n\nThe resulting cache can then be read easily into a table using [`gwpy`](//gwpy.github.io/):\n\n```python\n>>> from gwpy.table import EventTable\n>>> t = EventTable.read(cache, format='ligolw', tablename='sngl_burst')\n```\n\nThe format argument depends on the etg you use, but is likely to be one of `'hdf5'`, `'ligolw'`, or `'root'`.\n\n## Quickstart for command-line\n\nThe same query can be performed from the command line by passing each of the functional arguments above as arguments to the `gwtrigfind` executable script:\n\n```bash\ngwtrigfind <channel> <etg> <gpsstart> <gpsend>\n```\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Utility to find files archived by GW event trigger generators",
    "version": "0.8.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "cf2f922f40362b18ba5374762852ac53",
                "sha256": "f0a1488eed81def80297c6f1fe15011a969ae08bbbbc8567c12d0aa98faa4a6c"
            },
            "downloads": -1,
            "filename": "gwtrigfind-0.8.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cf2f922f40362b18ba5374762852ac53",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
            "size": 24230,
            "upload_time": "2019-03-04T15:57:11",
            "upload_time_iso_8601": "2019-03-04T15:57:11.553122Z",
            "url": "https://files.pythonhosted.org/packages/e6/7a/304c2c6f1690215a52589eeaa3f0ae19f9d96af1c8dee75488af8b21e03b/gwtrigfind-0.8.0-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "6a622133d978ccdbe2f1b33b7d46b008",
                "sha256": "6caf0d66135e90977e2d8529fef5da0ecff4e00830e1b2ebbe9fcd5f229b3e8d"
            },
            "downloads": -1,
            "filename": "gwtrigfind-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "6a622133d978ccdbe2f1b33b7d46b008",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*",
            "size": 39088,
            "upload_time": "2019-03-04T15:57:13",
            "upload_time_iso_8601": "2019-03-04T15:57:13.317674Z",
            "url": "https://files.pythonhosted.org/packages/ee/c6/505aab4442292bd6b6938ec01754d7c4b24de32124503c43d1f2b771e31c/gwtrigfind-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2019-03-04 15:57:13",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "gwpy",
    "github_project": "gwtrigfind",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "astropy",
            "specs": []
        },
        {
            "name": "ligo-segments",
            "specs": [
                [
                    ">=",
                    "1.0.0"
                ]
            ]
        }
    ],
    "lcname": "gwtrigfind"
}
        
Elapsed time: 0.01419s