Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added simple usage to README file #15

Merged
merged 1 commit into from
Sep 1, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,32 @@
GW trigfind
===========
# GW trigfind

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

[![Build Status](https://travis-ci.org/ligovirgo/trigfind.svg?branch=master)](https://travis-ci.org/ligovirgo/trigfind)
[![Coverage Status](https://coveralls.io/repos/github/ligovirgo/trigfind/badge.svg?branch=master)](https://coveralls.io/github/ligovirgo/trigfind?branch=master)

## Quickstart for python

To discover trigger files for a given channel:

```python
>>> from trigfind 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.sngl_burst')
```

The format argument depends on the etg you use, but is likely to be one of `'ligolw.sngl_burst'`, `'ligolw.sngl_inspiral'`, 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 `trigfind` executable script:

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