1 file was added to this release more than 14 days after its initial publication. Inspect the release files before installing.
breaker
A python package and command-line tools for the PanSTARRS & ATLAS LIGO-VIRGO (PSAT) group to aid surveys of the likely sky-locations of LIGO-VIRGO discovered Gravitational Waves.
Command-Line Usage
*The CL tools for breaker*
:Author:
David Young
:Date Created:
October 29, 2015
Usage:
breaker init
breaker update [-naP] [-s <pathToSettingsFile>]
breaker skymap <gwid> <pathToLVMap> [-c <centerDeg>]
breaker plot [-a] (timeline|history|sources) [-w <gwid>] [-t <telescope>] [-p <projection>] [-s <pathToSettingsFile>]
breaker plot comparison <gwid> <pathToMapDirectory> [-s <pathToSettingsFile>]
breaker faker <ps1ExpId> [-s <pathToSettingsFile>]
breaker stats <gwid> [<telescope>] [-s <pathToSettingsFile>]
breaker listen <far> (<mjdStart> <mjdEnd> | <inLastNMins>) [-s <pathToSettingsFile>]
breaker listen -d [<far> <sec>] [-s <pathToSettingsFile>]
breaker contour <gwid> <ra> <dec>
COMMANDS
--------
init setup the breaker settings file for the first time
update update the PS1 footprint table in breaker database and associate with GW-IDs. Optionally download overlapping NED source and also add to the database
skymap generate an all sky FITS & PDF image map given the path to the LV likeihood map (Meractor and Mollweide projections respectively)
plot enter plotting mode
timeline plot from the epoch of the wave detection forward in time
history plot from now back in time over the last days, weeks and months
comparison produce a multi-panel plot to compare wave maps
stats generate some coverage stats for a given wave survey campaign
sources overplot map with NED sources found within the wave campaign footprint
faker generate a catalogue of simulated transient sources in PS1 exposure ID footprint
listen connect to grace DB and download maps found within the given time range
contour determine within which likelihood contour a given transient location lies (nearest 10%)
ARGUMENTS
---------
ra right ascendsion (sexegesimal or decimal degrees)
dec declination (sexegesimal or decimal degrees)
far false alarm rate limit in Hz. Default *1e-5* (~= 1 per day)
-w <gwid> the gravitational wave ID (graceDB or human-readable GW forms allowed)
pathToSettingsFile path to the yaml settings file
-c <centerDeg> the central longitude line (deg)
pathToMapDirectory path to a directory containing localisation maps
ps1ExpId a panstarrs exposure ID
mjdStart start of an MJD range
mjdEnd end of the MJD range
inLastNMins in the last N number of minutes
pathToLVMap path to the LV likelihood map
sec time in seconds
-t <telescope> select an individual telescope (default is all telescopes) [ps1|atlas]
-p <projection> skymap projection. Default *mercator*. [mercator|gnomonic|mollweide]
FLAGS
-----
-h, --help show this help message
-s, --settings the settings file
-n, --updateNed update the NED database steam
-d, --daemon listen in daemon mode
-a, --all plot all timeline plot (including the CPU intensive -21-0 days and all transients/footprints plots)
-P, --no-pointings do not update pointingsDocumentation
Documentation for breaker is hosted by Read the Docs (last stable version and latest version).
Installation
The easiest way to install breaker is via Anaconda. For some instructions for installing Anaconda see here.
Once you have Anaconda installed, then create and activate a new conda environment:
conda create -n breaker python=2.7 pip
source activate breakerNow do a conda install of healpy before installing breaker (the pip install of healpy seems very flaky):
conda install -c conda-forge healpyFinally install breaker:
pip install breakerInstallion a Development Version
Or you can clone the github repo and install from a local version of the code:
git clone git@github.com:thespacedoctor/breaker.git
cd breaker
python setup.py installTo upgrade to the latest version of breaker use the command:
pip install breaker --upgradeTroubleshooting
If you’re having trouble with the installation here are a few things to try:
Astropy and Clang. On Mac OS you may have to set your C-compiler to clang before astropy will install. So before the breaker installation, try:
setenv CC clangor, for bash:
export CC=clangThen try and install breaker again.
healpy. If you’re having trouble installing healpy try installing the latest version from github. Download and extract the tarball.
Untar, set your MACOSX_DEPLOYMENT_TARGET environment variable and install:
tar -xvf healpy-1.9.0.tar.gz
cd healpy-1.9.0
setenv MACOSX_DEPLOYMENT_TARGET 10.11
python setup.py installDevelopment
If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:
git clone git@github.com:thespacedoctor/breaker.git
cd breaker
python setup.py developPull requests are welcomed!
Issues
Please report any issues here.
License
Copyright (c) 2018 David Young
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1 maintainer
Metadata
1 maintainer
Release files for breaker 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
File added late
1 file was uploaded more than 14 days after the first file in this release.
While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.
We recommend inspecting the release files before installing.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| breaker-2.0.1.tar.gz | 19.3 MB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| breaker-2.0.1-py3-none-any.whl | Python 3 | none | any | Details |
| breaker-2.0.1-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 58.1 MB
Release files / breaker-2.0.1.tar.gz
| Download URL | breaker-2.0.1.tar.gz |
|---|---|
| Size | 19.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f618e66173c4d0721141c78719f9ad4a194242e5422c3ac78de295d4a38c1a55
|
|
BLAKE2b-256 checksum How to use checksums |
aac19f280d09195a96c7e46a6225fcb5875ba347f984297b167c5ce87fc7c3d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.9.1 pkginfo/1.4.1 requests/2.18.4 setuptools/36.4.0 requests-toolbelt/0.8.0 tqdm/4.14.0 CPython/2.7.13
|
Release files / breaker-2.0.1-py3-none-any.whl
File added late
This file was uploaded more than 14 days after the first file in this release.
While project maintainers occasionally add legitimate files to an existing release, late additions can also indicate a security compromise.
We recommend inspecting the release file before installing.
| Download URL | breaker-2.0.1-py3-none-any.whl |
|---|---|
| Size | 19.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1b4b653d261bad06ce5497aa417f37f3576bad1b80b325192d232169edf484eb
|
|
BLAKE2b-256 checksum How to use checksums |
b77ce317929519f02c6d8a76b1c2f42584c2054075a8b4a7a2228cd6489e44b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.18.4 setuptools/44.0.0 requests-toolbelt/0.8.0 tqdm/4.14.0 CPython/2.7.13
|
Release files / breaker-2.0.1-py2-none-any.whl
| Download URL | breaker-2.0.1-py2-none-any.whl |
|---|---|
| Size | 19.4 MB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
d4a0ca4ba775afb9ac7fb3b06e0e351a7adf5d96f424d3f21c0db9ed8e88f0a2
|
|
BLAKE2b-256 checksum How to use checksums |
f4dd9dd8251fa2dbdcee3021a34b26b7dcdd30a0fb51ce2639ded89d52b6bde6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.9.1 pkginfo/1.4.1 requests/2.18.4 setuptools/36.4.0 requests-toolbelt/0.8.0 tqdm/4.14.0 CPython/2.7.13
|
