README.md 831 Bytes
Newer Older
Tanner Prestegard's avatar
Tanner Prestegard committed
1
# ligo-gracedb
2 3
The <b>Gra</b>vitational-wave <b>C</b>andidate <b>E</b>vent <b>D</b>ata<b>b</b>ase (GraceDB) is a web service designed for aggregating and communicating information about candidate events from gravitational-wave searches and associated follow-ups.
`ligo-gracedb` provides a Python-based client tool for facilitating interactions with the GraceDB API.
Tanner Prestegard's avatar
Tanner Prestegard committed
4

5 6

## Documentation
7
For more information, see the [full documentation](https://gw.readthedocs.io/ligo-gracedb/).
8

9

Tanner Prestegard's avatar
Tanner Prestegard committed
10 11 12
## Quick install
```python
pip install ligo-gracedb
13 14
```

Tanner Prestegard's avatar
Tanner Prestegard committed
15 16
## Contributing
Please fork this [repository](https://git.ligo.org/lscsoft/gracedb-client) and submit a merge request if you wish to contribute to this package.
17

Tanner Prestegard's avatar
Tanner Prestegard committed
18
See the [contributing documentation](https://gw.readthedocs.io/projects/ligo-gracedb/en/latest/contributing.html) for more details.