Skip to content

Refactoring the Code

thespacedoctor edited this page Sep 8, 2015 · 1 revision

I have refactored the code so that it is now a python package called sherlock.

To install the code:

git clone git@bitbucket.org:thespacedoctor/sherlock.git
cd sherlock
python setup.py install

This will install a command-line tool on your OS called sherlock. Run sherlock -h to get help on the command:

# SHERLOCK #
: INFERING TRANSIENT-SOURCE CLASSIFICATIONS FROM SPATIALLY CROSS-MATCHED CATALOGUED SOURCES :
=============================================================================================

Usage:
    sherlock -s <pathToSettingsFile> (<objectid> <objectid>...| -l <transientListId>) [--update]

    -h, --help            show this help message
    -v, --version         show version
    -s, --settings        the settings file
    -l, --transientlistId          the id of the transient list to classify
    -u, --update          update the transient database with new classifications and crossmatches

The Settings File

The settings file now contains every option required to change the way the code runs, including database settings and the actual search algorithm. The order searches appear in the search algorithm section is the order they shall be run in the actual code:

search algorithm:
    sdss qso:
        angular radius arcsec: 2.0
        transient classification: AGN
        database table: tcs_cat_v_sdss_dr9_spect_qsos
    milliquas:
        angular radius arcsec: 3.0
        transient classification: AGN
        database table: tcs_cat_milliquas
    veron:
        angular radius arcsec: 2.0
        transient classification: AGN
        database table: tcs_veron_cat
    ned qso:
        angular radius arcsec: 2.0
        transient classification: AGN
        database table: tcs_cat_v_ned_qsos
    ned nt:
        angular radius arcsec: 3.0
        physical radius kpc: 0.5
        transient classification: NT
        database table: tcs_cat_v_ned_galaxies
    sdss spec nt:
        angular radius arcsec: 3.0
        physical radius kpc: 0.5
        transient classification: NT
        database table: tcs_cat_v_sdss_dr9_spect_galaxies
    sdss phot nt: 
        angular radius arcsec: 0.5
        transient classification: NT
        database table: tcs_cat_v_sdss_dr9_galaxies_notspec
    ...

Clone this wiki locally