Package: 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*TheCLtoolsforbreaker*:Author:DavidYoung:DateCreated:October29,2015Usage:breakerinitbreakerupdate[-naP][-s<pathToSettingsFile>]breakerskymap<gwid><pathToLVMap>[-c<centerDeg>]breakerplot[-a](timeline|history|sources)[-w<gwid>][-t<telescope>][-p<projection>][-s<pathToSettingsFile>]breakerplotcomparison<gwid><pathToMapDirectory>[-s<pathToSettingsFile>]breakerfaker<ps1ExpId>[-s<pathToSettingsFile>]breakerstats<gwid>[<telescope>][-s<pathToSettingsFile>]breakerlisten<far>(<mjdStart><mjdEnd>|<inLastNMins>)[-s<pathToSettingsFile>]breakerlisten-d[<far><sec>][-s<pathToSettingsFile>]breakercontour<gwid><ra><dec>COMMANDS--------initsetupthebreakersettingsfileforthefirsttimeupdateupdatethePS1footprinttableinbreakerdatabaseandassociatewithGW-IDs.OptionallydownloadoverlappingNEDsourceandalsoaddtothedatabaseskymapgenerateanallskyFITS&PDFimagemapgiventhepathtotheLVlikeihoodmap(MeractorandMollweideprojectionsrespectively)plotenterplottingmodetimelineplotfromtheepochofthewavedetectionforwardintimehistoryplotfromnowbackintimeoverthelastdays,weeksandmonthscomparisonproduceamulti-panelplottocomparewavemapsstatsgeneratesomecoveragestatsforagivenwavesurveycampaignsourcesoverplotmapwithNEDsourcesfoundwithinthewavecampaignfootprintfakergenerateacatalogueofsimulatedtransientsourcesinPS1exposureIDfootprintlistenconnecttograceDBanddownloadmapsfoundwithinthegiventimerangecontourdeterminewithinwhichlikelihoodcontouragiventransientlocationlies(nearest10%)ARGUMENTS---------rarightascendsion(sexegesimalordecimaldegrees)decdeclination(sexegesimalordecimaldegrees)farfalsealarmratelimitinHz.Default*1e-5*(~=1perday)-w<gwid>thegravitationalwaveID(graceDBorhuman-readableGWformsallowed)pathToSettingsFilepathtotheyamlsettingsfile-c<centerDeg>thecentrallongitudeline(deg)pathToMapDirectorypathtoadirectorycontaininglocalisationmapsps1ExpIdapanstarrsexposureIDmjdStartstartofanMJDrangemjdEndendoftheMJDrangeinLastNMinsinthelastNnumberofminutespathToLVMappathtotheLVlikelihoodmapsectimeinseconds-t<telescope>selectanindividualtelescope(defaultisalltelescopes)[ps1|atlas]-p<projection>skymapprojection.Default*mercator*.[mercator|gnomonic|mollweide]FLAGS------h,--helpshowthishelpmessage-s,--settingsthesettingsfile-n,--updateNedupdatetheNEDdatabasesteam-d,--daemonlistenindaemonmode-a,--allplotalltimelineplot(includingtheCPUintensive-21-0daysandalltransients/footprintsplots)-P,--no-pointingsdonotupdatepointingsDocumentationDocumentation for breaker is hosted byRead the Docs(laststable versionandlatest version).InstallationThe easiest way to install breaker is via Anaconda. For some instructions for installing Anacondasee here.Once you have Anaconda installed, then create and activate a new conda environment:condacreate-nbreakerpython=2.7pipsourceactivatebreakerNow do a conda install of healpy before installing breaker (the pip install of healpy seems very flaky):condainstall-cconda-forgehealpyFinally install breaker:pipinstallbreakerInstallion a Development VersionOr you can clone thegithub repoand install from a local version of the code:gitclonegit@github.com:thespacedoctor/breaker.gitcdbreakerpythonsetup.pyinstallTo upgrade to the latest version of breaker use the command:pipinstallbreaker--upgradeTroubleshootingIf 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:setenvCCclangor, for bash:exportCC=clangThen try and install breaker again.healpy. If you’re having trouble installing healpy try installing thelatest version from github. Download and extract the tarball.Untar, set yourMACOSX_DEPLOYMENT_TARGETenvironment variable and install:tar-xvfhealpy-1.9.0.tar.gzcdhealpy-1.9.0setenvMACOSX_DEPLOYMENT_TARGET10.11pythonsetup.pyinstallDevelopmentIf you want to tinker with the code, then install in development mode.
This means you can modify the code from your cloned repo:gitclonegit@github.com:thespacedoctor/breaker.gitcdbreakerpythonsetup.pydevelopPull requestsare welcomed!IssuesPlease report any issueshere.LicenseCopyright (c) 2018 David YoungPermission 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.