diff options
Diffstat (limited to 'python-gwosc.spec')
| -rw-r--r-- | python-gwosc.spec | 454 |
1 files changed, 454 insertions, 0 deletions
diff --git a/python-gwosc.spec b/python-gwosc.spec new file mode 100644 index 0000000..76293c2 --- /dev/null +++ b/python-gwosc.spec @@ -0,0 +1,454 @@ +%global _empty_manifest_terminate_build 0 +Name: python-gwosc +Version: 0.7.0 +Release: 1 +Summary: A python interface to the GW Open Science data archive +License: MIT +URL: https://git.ligo.org/gwosc/client/ +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/b6/b4/aa80325300c3ea99c0362630e8a252d208feb61f8894a3bb2a21cbcbd661/gwosc-0.7.0.tar.gz +BuildArch: noarch + +Requires: python3-requests +Requires: python3-sphinx +Requires: python3-sphinx-automodapi +Requires: python3-sphinx-rtd-theme +Requires: python3-flake8 +Requires: python3-flake8-bandit +Requires: python3-pytest +Requires: python3-pytest-cov +Requires: python3-pytest-socket +Requires: python3-requests-mock + +%description +# `gwosc` client API + +The `gwosc` package provides an interface to querying the open data +releases hosted on <https://gw-openscience.org> from the GEO, LIGO, +and Virgo gravitational-wave observatories. + +## Release status + +[](http://badge.fury.io/py/gwosc) +[](https://anaconda.org/conda-forge/gwosc/) +[](https://doi.org/10.5281/zenodo.1196306) +[](https://choosealicense.com/licenses/mit/) + + +## Development status + +[](https://git.ligo.org/gwosc/client/-/pipelines) + +[](https://gwosc.readthedocs.io/en/latest/?badge=latest) + +## Installation + +To install: + + conda install -c conda-forge gwosc + +or + + pip install gwosc + +## Searching for datasets + +To search for available datasets (correct as of March 14 2018): + +```python +>>> from gwosc import datasets +>>> datasets.find_datasets() +['GW150914', 'GW151226', 'GW170104', 'GW170608', 'GW170814', 'GW170817', 'LVT151012', 'O1', 'S5', 'S6'] +>>> datasets.find_datasets(detector='V1') +['GW170814', 'GW170817'] +>>> datasets.find_datasets(type='run') +['O1', 'S5', 'S6'] +``` + +To query for the GPS time of an event dataset (or vice-versa): + +```python +>>> datasets.event_gps('GW170817') +1187008882.43 +>>> datasets.event_at_gps(1187008882) +'GW170817' +``` + +Similar queries are available for observing run datasets: + +```python +>>> datasets.run_segment('O1') +(1126051217, 1137254417) +>>> datasets.run_at_gps(1135136350) # event_gps('GW151226') +'O1' +``` + +## Locating data URLs by event name + +You can search for remote data URLS based on the event name: + +```python +>>> from gwosc.locate import get_event_urls +>>> get_event_urls('GW150914') +['https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_4KHZ_R1-1126259447-32.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_4KHZ_R1-1126257415-4096.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126259447-32.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126257415-4096.hdf5'] +``` + +You can down-select the URLs using keyword arguments: + +```python +>>> get_event_urls('GW150914', detector='L1', duration=32) +['https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126259447-32.hdf5'] +``` + +## Locating data URLs by GPS interval + +You can search for remote data URLs based on the GPS time interval as +follows: + +```python +>>> from gwosc.locate import get_urls +>>> get_urls('L1', 968650000, 968660000) +['https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968646656-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968650752-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968654848-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968658944-4096.hdf5'] +``` + +This arguments for this function are as follows + +- `detector` : the prefix of the relevant gravitational-wave + interferometer, either `'H1'` for LIGO-Hanford, or `'L1'` for LIGO + Livingston, +- `start`: the GPS start time of the interval of interest +- `end`: the GPS end time of the interval of interest + +By default, this method will return the paths to HDF5 files for the 4 +kHz sample-rate data, these can be specified as keyword arguments. For +full information, run + +```python +>>> help(get_urls) +``` + +## Query for Timeline segments + +You can also search for Timeline segments, based on a flag name, and a +GPS time interval as follows: + +```python +>>> from gwosc.timeline import get_segments +>>> get_segments('H1_DATA', 1126051217, 1126151217) +[(1126073529, 1126114861), (1126121462, 1126123267), (1126123553, 1126126832), (1126139205, 1126139266), (1126149058, 1126151217)] +``` + +The output is a `list` of `(start, end)` 2-tuples which each represent a +semi-open time interval. + +For documentation on what flags are available, for example for the O1 +science run, see [the O1 data release page](https://gw-openscience.org/O1/) +(*Data Quality*). + + + +%package -n python3-gwosc +Summary: A python interface to the GW Open Science data archive +Provides: python-gwosc +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-gwosc +# `gwosc` client API + +The `gwosc` package provides an interface to querying the open data +releases hosted on <https://gw-openscience.org> from the GEO, LIGO, +and Virgo gravitational-wave observatories. + +## Release status + +[](http://badge.fury.io/py/gwosc) +[](https://anaconda.org/conda-forge/gwosc/) +[](https://doi.org/10.5281/zenodo.1196306) +[](https://choosealicense.com/licenses/mit/) + + +## Development status + +[](https://git.ligo.org/gwosc/client/-/pipelines) + +[](https://gwosc.readthedocs.io/en/latest/?badge=latest) + +## Installation + +To install: + + conda install -c conda-forge gwosc + +or + + pip install gwosc + +## Searching for datasets + +To search for available datasets (correct as of March 14 2018): + +```python +>>> from gwosc import datasets +>>> datasets.find_datasets() +['GW150914', 'GW151226', 'GW170104', 'GW170608', 'GW170814', 'GW170817', 'LVT151012', 'O1', 'S5', 'S6'] +>>> datasets.find_datasets(detector='V1') +['GW170814', 'GW170817'] +>>> datasets.find_datasets(type='run') +['O1', 'S5', 'S6'] +``` + +To query for the GPS time of an event dataset (or vice-versa): + +```python +>>> datasets.event_gps('GW170817') +1187008882.43 +>>> datasets.event_at_gps(1187008882) +'GW170817' +``` + +Similar queries are available for observing run datasets: + +```python +>>> datasets.run_segment('O1') +(1126051217, 1137254417) +>>> datasets.run_at_gps(1135136350) # event_gps('GW151226') +'O1' +``` + +## Locating data URLs by event name + +You can search for remote data URLS based on the event name: + +```python +>>> from gwosc.locate import get_event_urls +>>> get_event_urls('GW150914') +['https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_4KHZ_R1-1126259447-32.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_4KHZ_R1-1126257415-4096.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126259447-32.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126257415-4096.hdf5'] +``` + +You can down-select the URLs using keyword arguments: + +```python +>>> get_event_urls('GW150914', detector='L1', duration=32) +['https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126259447-32.hdf5'] +``` + +## Locating data URLs by GPS interval + +You can search for remote data URLs based on the GPS time interval as +follows: + +```python +>>> from gwosc.locate import get_urls +>>> get_urls('L1', 968650000, 968660000) +['https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968646656-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968650752-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968654848-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968658944-4096.hdf5'] +``` + +This arguments for this function are as follows + +- `detector` : the prefix of the relevant gravitational-wave + interferometer, either `'H1'` for LIGO-Hanford, or `'L1'` for LIGO + Livingston, +- `start`: the GPS start time of the interval of interest +- `end`: the GPS end time of the interval of interest + +By default, this method will return the paths to HDF5 files for the 4 +kHz sample-rate data, these can be specified as keyword arguments. For +full information, run + +```python +>>> help(get_urls) +``` + +## Query for Timeline segments + +You can also search for Timeline segments, based on a flag name, and a +GPS time interval as follows: + +```python +>>> from gwosc.timeline import get_segments +>>> get_segments('H1_DATA', 1126051217, 1126151217) +[(1126073529, 1126114861), (1126121462, 1126123267), (1126123553, 1126126832), (1126139205, 1126139266), (1126149058, 1126151217)] +``` + +The output is a `list` of `(start, end)` 2-tuples which each represent a +semi-open time interval. + +For documentation on what flags are available, for example for the O1 +science run, see [the O1 data release page](https://gw-openscience.org/O1/) +(*Data Quality*). + + + +%package help +Summary: Development documents and examples for gwosc +Provides: python3-gwosc-doc +%description help +# `gwosc` client API + +The `gwosc` package provides an interface to querying the open data +releases hosted on <https://gw-openscience.org> from the GEO, LIGO, +and Virgo gravitational-wave observatories. + +## Release status + +[](http://badge.fury.io/py/gwosc) +[](https://anaconda.org/conda-forge/gwosc/) +[](https://doi.org/10.5281/zenodo.1196306) +[](https://choosealicense.com/licenses/mit/) + + +## Development status + +[](https://git.ligo.org/gwosc/client/-/pipelines) + +[](https://gwosc.readthedocs.io/en/latest/?badge=latest) + +## Installation + +To install: + + conda install -c conda-forge gwosc + +or + + pip install gwosc + +## Searching for datasets + +To search for available datasets (correct as of March 14 2018): + +```python +>>> from gwosc import datasets +>>> datasets.find_datasets() +['GW150914', 'GW151226', 'GW170104', 'GW170608', 'GW170814', 'GW170817', 'LVT151012', 'O1', 'S5', 'S6'] +>>> datasets.find_datasets(detector='V1') +['GW170814', 'GW170817'] +>>> datasets.find_datasets(type='run') +['O1', 'S5', 'S6'] +``` + +To query for the GPS time of an event dataset (or vice-versa): + +```python +>>> datasets.event_gps('GW170817') +1187008882.43 +>>> datasets.event_at_gps(1187008882) +'GW170817' +``` + +Similar queries are available for observing run datasets: + +```python +>>> datasets.run_segment('O1') +(1126051217, 1137254417) +>>> datasets.run_at_gps(1135136350) # event_gps('GW151226') +'O1' +``` + +## Locating data URLs by event name + +You can search for remote data URLS based on the event name: + +```python +>>> from gwosc.locate import get_event_urls +>>> get_event_urls('GW150914') +['https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_4KHZ_R1-1126259447-32.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/H-H1_GWOSC_4KHZ_R1-1126257415-4096.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126259447-32.hdf5', 'https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126257415-4096.hdf5'] +``` + +You can down-select the URLs using keyword arguments: + +```python +>>> get_event_urls('GW150914', detector='L1', duration=32) +['https://www.gw-openscience.org/eventapi/json/GWTC-1-confident/GW150914/v3/L-L1_GWOSC_4KHZ_R1-1126259447-32.hdf5'] +``` + +## Locating data URLs by GPS interval + +You can search for remote data URLs based on the GPS time interval as +follows: + +```python +>>> from gwosc.locate import get_urls +>>> get_urls('L1', 968650000, 968660000) +['https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968646656-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968650752-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968654848-4096.hdf5', 'https://www.gw-openscience.org/archive/data/S6/967835648/L-L1_LOSC_4_V1-968658944-4096.hdf5'] +``` + +This arguments for this function are as follows + +- `detector` : the prefix of the relevant gravitational-wave + interferometer, either `'H1'` for LIGO-Hanford, or `'L1'` for LIGO + Livingston, +- `start`: the GPS start time of the interval of interest +- `end`: the GPS end time of the interval of interest + +By default, this method will return the paths to HDF5 files for the 4 +kHz sample-rate data, these can be specified as keyword arguments. For +full information, run + +```python +>>> help(get_urls) +``` + +## Query for Timeline segments + +You can also search for Timeline segments, based on a flag name, and a +GPS time interval as follows: + +```python +>>> from gwosc.timeline import get_segments +>>> get_segments('H1_DATA', 1126051217, 1126151217) +[(1126073529, 1126114861), (1126121462, 1126123267), (1126123553, 1126126832), (1126139205, 1126139266), (1126149058, 1126151217)] +``` + +The output is a `list` of `(start, end)` 2-tuples which each represent a +semi-open time interval. + +For documentation on what flags are available, for example for the O1 +science run, see [the O1 data release page](https://gw-openscience.org/O1/) +(*Data Quality*). + + + +%prep +%autosetup -n gwosc-0.7.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-gwosc -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.0-1 +- Package Spec generated |