# GWDataFind
The GWDataFind data discovery client.
The GWDataFind service allows users to query for the location of
Gravitational-Wave Frame (GWF) files containing data from the current
gravitational-wave detectors.
[![PyPI version](https://badge.fury.io/py/gwdatafind.svg)](http://badge.fury.io/py/gwdatafind)
[![Linux status](https://git.ligo.org/lscsoft/gwdatafind/badges/main/pipeline.svg)](https://git.ligo.org/lscsoft/gwdatafind/commits/main)
[![Windows status](https://ci.appveyor.com/api/projects/status/js6gql8960qa9pkl?svg=true)](https://ci.appveyor.com/project/duncanmmacleod/gwdatafind)
[![License](https://img.shields.io/pypi/l/gwdatafind.svg)](https://choosealicense.com/licenses/gpl-3.0/)
[![Documentation status](https://readthedocs.org/projects/gwdatafind/badge/?version=latest)](https://gwdatafind.readthedocs.io/en/latest/?badge=latest)
## Installation
The simplest installation is via `pip`:
```bash
python -m pip install gwdatafind
```
This package is also available as a Conda package:
```bash
conda install -c conda-forge gwdatafind
```
## Basic Usage
To find the URLs of all `H1_R` files for the LIGO-Hanford observatory in
a given GPS interval:
```python
>>> from gwdatafind import find_urls
>>> find_urls('H', 'H1_R', 1198800018, 1198800618)
```
To utillise connection pooling, create a `Session`:
```python
>>> from gwdatafind import (find_urls, Session)
>>> with Session() as sess:
... for ifo in ("H", "L"):
... urls[ifo] = find_urls(
... ifo,
... f"{ifo}1_R",
... 1198800018,
... 1198800618,
... session=sess,
... )
## On the command-line
GWDataFind can also be executed via the command-line client, for full details
run
```bash
$ python -m gwdatafind --help
```
For more documentation, see <https://gwdatafind.readthedocs.io/>.
Raw data
{
"_id": null,
"home_page": "https://gwdatafind.readthedocs.io",
"name": "gwdatafind",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Duncan Macleod",
"author_email": "duncan.macleod@ligo.org",
"download_url": "https://files.pythonhosted.org/packages/2b/10/9f1b9100f59e2ca4a85dad8a21942d0702d756f4b80a433c728be4a871d2/gwdatafind-1.2.0.tar.gz",
"platform": null,
"description": "# GWDataFind\n\nThe GWDataFind data discovery client.\n\nThe GWDataFind service allows users to query for the location of\nGravitational-Wave Frame (GWF) files containing data from the current\ngravitational-wave detectors.\n\n[![PyPI version](https://badge.fury.io/py/gwdatafind.svg)](http://badge.fury.io/py/gwdatafind)\n[![Linux status](https://git.ligo.org/lscsoft/gwdatafind/badges/main/pipeline.svg)](https://git.ligo.org/lscsoft/gwdatafind/commits/main)\n[![Windows status](https://ci.appveyor.com/api/projects/status/js6gql8960qa9pkl?svg=true)](https://ci.appveyor.com/project/duncanmmacleod/gwdatafind)\n[![License](https://img.shields.io/pypi/l/gwdatafind.svg)](https://choosealicense.com/licenses/gpl-3.0/)\n[![Documentation status](https://readthedocs.org/projects/gwdatafind/badge/?version=latest)](https://gwdatafind.readthedocs.io/en/latest/?badge=latest)\n\n## Installation\n\nThe simplest installation is via `pip`:\n\n```bash\npython -m pip install gwdatafind\n```\n\nThis package is also available as a Conda package:\n\n```bash\nconda install -c conda-forge gwdatafind\n```\n\n## Basic Usage\n\nTo find the URLs of all `H1_R` files for the LIGO-Hanford observatory in\na given GPS interval:\n\n```python\n>>> from gwdatafind import find_urls\n>>> find_urls('H', 'H1_R', 1198800018, 1198800618)\n```\n\nTo utillise connection pooling, create a `Session`:\n\n```python\n>>> from gwdatafind import (find_urls, Session)\n>>> with Session() as sess:\n... for ifo in (\"H\", \"L\"):\n... urls[ifo] = find_urls(\n... ifo,\n... f\"{ifo}1_R\",\n... 1198800018,\n... 1198800618,\n... session=sess,\n... )\n\n## On the command-line\n\nGWDataFind can also be executed via the command-line client, for full details\nrun\n\n```bash\n$ python -m gwdatafind --help\n```\n\nFor more documentation, see <https://gwdatafind.readthedocs.io/>.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "The GWDataFind data discovery client",
"version": "1.2.0",
"project_urls": {
"Bug Tracker": "https://git.ligo.org/gwdatafind/gwdatafind/-/issues/",
"Documentation": "https://gwdatfind.readthedocs.io",
"Download": "https://pypi.org/project/gwdatafind",
"Homepage": "https://gwdatafind.readthedocs.io",
"Source Code": "https://git.ligo.org/gwdatafind/gwdatafind.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "89615020eff070e04b1e07c7cf8bed63705aa705011e057cbb839e9a31367bdd",
"md5": "8418d43484e5ef64694829274c945824",
"sha256": "58c505ee188c1186ff81b3de5f946f289179a4f8c334f7eb45d07dd70a71bd2c"
},
"downloads": -1,
"filename": "gwdatafind-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8418d43484e5ef64694829274c945824",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 45529,
"upload_time": "2023-12-18T09:19:41",
"upload_time_iso_8601": "2023-12-18T09:19:41.129435Z",
"url": "https://files.pythonhosted.org/packages/89/61/5020eff070e04b1e07c7cf8bed63705aa705011e057cbb839e9a31367bdd/gwdatafind-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b109f1b9100f59e2ca4a85dad8a21942d0702d756f4b80a433c728be4a871d2",
"md5": "6e844d5c75f70cfacc0bd9212be061ce",
"sha256": "8f74942e66cdb9a53030da29069110b3cb30afc2a034790957786028fb09f451"
},
"downloads": -1,
"filename": "gwdatafind-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "6e844d5c75f70cfacc0bd9212be061ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 40381,
"upload_time": "2023-12-18T09:19:43",
"upload_time_iso_8601": "2023-12-18T09:19:43.234684Z",
"url": "https://files.pythonhosted.org/packages/2b/10/9f1b9100f59e2ca4a85dad8a21942d0702d756f4b80a433c728be4a871d2/gwdatafind-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-18 09:19:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "gwdatafind"
}