| Name | gwtrigfind JSON |
| Version |
0.8.1
JSON |
| download |
| home_page | None |
| Summary | Utility to find files archived by GW event trigger generators |
| upload_time | 2024-07-18 22:16:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | GPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| 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.
[](http://badge.fury.io/py/gwtrigfind)
[](https://gwtrigfind.readthedocs.io/en/stable/?badge=stable)
[](https://git.ligo.org/detchar/tools/gwtrigfind/-/pipelines)
## 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": null,
"name": "gwtrigfind",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Duncan Macleod <duncan.macleod@ligo.org>",
"download_url": "https://files.pythonhosted.org/packages/6d/12/d77dfceaba717b8fa4aac9a357b5bf5e0a5d3ae515e297883fe6c312f366/gwtrigfind-0.8.1.tar.gz",
"platform": null,
"description": "# GWTrigFind\n\nA utility to find GW trigger files produced by event trigger generators and archived on the LIGO Data Grid.\n\n[](http://badge.fury.io/py/gwtrigfind)\n[](https://gwtrigfind.readthedocs.io/en/stable/?badge=stable)\n[](https://git.ligo.org/detchar/tools/gwtrigfind/-/pipelines)\n\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",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Utility to find files archived by GW event trigger generators",
"version": "0.8.1",
"project_urls": {
"Bug Tracker": "https://git.ligo.org/detchar/tools/gwtrigfind/-/issues",
"Documentation": "https://gwtrigfind.readthedocs.io/",
"Source Code": "https://git.ligo.org/detchar/tools/gwtrigfind.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14c5cca1c57daced429105784b636af3a2d0376b40fc3fd14bbb2af4a5fdfc07",
"md5": "36d7cff8aab8e669b8f116a4f2f34024",
"sha256": "f861d6252e6e5f92dd4e3b6e147eeb581c9aae4d9508c0bed1c6842dac7f211d"
},
"downloads": -1,
"filename": "gwtrigfind-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "36d7cff8aab8e669b8f116a4f2f34024",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24107,
"upload_time": "2024-07-18T22:16:53",
"upload_time_iso_8601": "2024-07-18T22:16:53.186416Z",
"url": "https://files.pythonhosted.org/packages/14/c5/cca1c57daced429105784b636af3a2d0376b40fc3fd14bbb2af4a5fdfc07/gwtrigfind-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6d12d77dfceaba717b8fa4aac9a357b5bf5e0a5d3ae515e297883fe6c312f366",
"md5": "b5cce68d9f57043041c3f8134a323a19",
"sha256": "8005a5fa6bb434ac99b1765ca26e44be3ab947229153df75e2998c293a51d0e4"
},
"downloads": -1,
"filename": "gwtrigfind-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "b5cce68d9f57043041c3f8134a323a19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29360,
"upload_time": "2024-07-18T22:16:54",
"upload_time_iso_8601": "2024-07-18T22:16:54.532965Z",
"url": "https://files.pythonhosted.org/packages/6d/12/d77dfceaba717b8fa4aac9a357b5bf5e0a5d3ae515e297883fe6c312f366/gwtrigfind-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-18 22:16:54",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gwtrigfind"
}
