sherlock

https://img.shields.io/pypi/pyversions/qub-sherlock https://img.shields.io/pypi/v/qub-sherlock https://img.shields.io/github/license/thespacedoctor/sherlock https://img.shields.io/pypi/dm/qub-sherlock

http://157.245.42.153:8080/buildStatus/icon?job=sherlock%2Fmaster&subject=build%20master http://157.245.42.153:8080/buildStatus/icon?job=sherlock%2Fdevelop&subject=build%20dev https://cdn.jsdelivr.net/gh/thespacedoctor/sherlock@master/coverage.svg https://readthedocs.org/projects/qub-sherlock/badge/?version=master https://img.shields.io/github/issues/thespacedoctor/sherlock/type:%20bug?label=bug%20issues

mine a library of historical and on-going astronomical survey data in an attempt to identify the sources of transient/variable events, and predict their classifications based on crossmatched data.

Documentation for sherlock is hosted by Read the Docs ( development version and master version). The code lives on github. Please report any issues you find here.

API Reference

Modules

sherlock.commonutils

common tools used throughout package

sherlock.imports

sherlock.utKit

Unit testing tools

Classes

sherlock.catalogue_conesearch

The worker class for the conesearch module

sherlock.commonutils.update_wiki_pages

Update sherlock’s github wiki pages with some useful info regarding the crossmatch database catalogue tables

sherlock.database

the database object for sherlock, setting up ssh tunnels and various database connections

sherlock.database_cleaner

Clean and maintain the database helper tables used by sherlock

sherlock.imports.ifs

Importer for the Multi Unit Spectroscopic Explorer (MUSE) IFS galaxy catalogue stream

sherlock.imports.ned

Using a list of coordinates, query the online NED database and import sources found within a given search radius of each of the loctions into the sherlock-catalogues database

sherlock.imports.ned_d

Import the * `NED-D <https://ned.ipac.caltech.edu/Library/Distances/>`_ *galaxy catalogue in to the sherlock-catalogues database

sherlock.imports.veron

importer object for the VERON AGN catalogue

sherlock.transient_catalogue_crossmatch

crossmatch a list of transients against a suite of catalogues according to given search algorithm

sherlock.transient_classifier

The Sherlock Transient Classifier

Functions

sherlock.commonutils.get_crossmatch_catalogues_column_map

Query the sherlock-catalogues helper tables to generate a map of the important columns of each catalogue

sherlock.commonutils.getpackagepath

Get the root path for this python package - used in unit testing code

Release Notes

v2.1.8 - April 16, 2021#bugFixFriday

  • REFACTOR: catalogue quality weights now used within the merged source sets to sort the data. This fixed some mis-matched annotation issues.

  • REFACTOR: updating db connection settings to use QUB jumpbox.

  • REFACTOR/FIX Reduced associated source merging radius from 3 arcsec to 1 arcsec (1/9th of the original matching area). This seems to correct many of the cases in which 2 or more distinct catalogued sources were getting merged/blended into one association. This resulted in in-correct classification prediction and wrongly associated distances.

  • FIXED: annotation mismatches. If transient is classified as a SN then the underlying sources is identified as a galaxy in the annotation.

v2.1.7 - September 29, 2020

  • FIXED: lite version introduced a couple of small bugs. Fixed.

v2.1.6 - September 7, 2020

  • ENHANCEMENT: transient human-readable annotations added to the classifications dictionary return of the transient_classifier.classify() method.

  • ENHANCEMENT: a lite parameter has been added to the Sherlock transient_classifier object. When set to True only top-ranked crossmatches are returned with a limited column set.

  • ENHANCEMENT: snapshot annotation is now added into the classification dictionary return. The classification dictionary is now {'MyTransientId01': ['Type', 'Annotation'], 'MyTransientId02': ['Type', 'Annotation'],}

  • REFACTOR: small change to query that writes NED source magnitudes that vastly improves speed

  • FIXED: small issue where a missing error in photoz was causing annotations to not complete

v2.1.5 - June 22, 2020

  • refactor: tunnel changes due to new jump box installation at QUB

  • fixed: some NED galaxies not reported if redshift does not exist but a semi-major axis is given

v2.1.4 - June 18, 2020

  • fixed: an empty crossmatch set could cause a transient database update when not required

v2.1.3 - June 5, 2020

  • refactor: stop sherlock checking for transient database triggers if running in non-update mode

  • fixed: another sdss photoz issue where photoz ranking about specz

v2.1.2 - May 24, 2020

  • fixed: merged result parameters are now merged correctly

v2.1.1 - May 21, 2020

  • fixed: fixes to cl utils

v2.1.0 - May 20, 2020

  • Now compatible with Python 3.*