Metadata-Version: 2.0
Name: qub-sherlock
Version: 1.6.5
Summary: A python package with command-line tools for contextually classifying variable/transient astronomical sources. Sherlock mines a library of historical and on-going astronomical survey data in an attempt to identify sources transient/variable events, and predict their classifications based on the associated crossmatched data
Home-page: https://github.com/thespacedoctor/sherlock
Author: David Young
Author-email: davidrobertyoung@gmail.com
License: MIT
Download-URL: https://github.com/thespacedoctor/sherlock/archive/v1.6.5.zip
Description-Content-Type: UNKNOWN
Keywords: transients, astronomy, classifier, catalogues
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
Requires-Dist: HMpTy
Requires-Dist: astrocalc
Requires-Dist: fundamentals
Requires-Dist: neddy
Requires-Dist: numpy
Requires-Dist: psutil
Requires-Dist: pymysql
Requires-Dist: pyyaml
Requires-Dist: qub-sherlock
Requires-Dist: sloancone

sherlock 
=========================

.. image:: https://readthedocs.org/projects/qub-sherlock/badge/
    :target: http://qub-sherlock.readthedocs.io/en/latest/?badge
    :alt: Documentation Status

.. image:: https://cdn.rawgit.com/thespacedoctor/sherlock/master/coverage.svg
    :target: https://cdn.rawgit.com/thespacedoctor/sherlock/master/htmlcov/index.html
    :alt: Coverage Status

*A python package with command-line tools for contextually classifying variable/transient astronomical sources. Sherlock mines a library of historical and on-going astronomical survey data in an attempt to identify sources transient/variable events, and predict their classifications based on the associated crossmatched data*.





Command-Line Usage
==================

.. code-block:: bash 


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

    Documentation for sherlock can be found here: http://qub-sherlock.readthedocs.org/en/stable

    .. todo ::

        - docuument cl_utils module
        - tidy usage text

    Usage:
        sherlock init
        sherlock info [-s <pathToSettingsFile>]
        sherlock [-NA] dbmatch [--update] [-s <pathToSettingsFile>]
        sherlock [-vN] match -- <ra> <dec> [<pathToSettingsFile>] 
        sherlock clean [-s <pathToSettingsFile>]
        sherlock wiki [-s <pathToSettingsFile>]
        sherlock import ned <ra> <dec> <radiusArcsec> [-s <pathToSettingsFile>]
        sherlock import cat <cat_name> <pathToDataFile> <cat_version> [-s <pathToSettingsFile>]
        sherlock import stream <stream_name> [-s <pathToSettingsFile>]

    Options:
        init                    setup the sherlock settings file for the first time
        match                   XXXX
        dbmatch                 database match
        clean                   XXXX
        wiki                    XXXX
        import                  XXXX
        ned                     use the online NED database as the source catalogue
        cat                     import a static catalogue into the sherlock-catalogues database
        stream                  download/stream new data from a give source catalogue into the sherlock sherlock-catalogues database
        info                    print an overview of the current catalogues, views and streams in the sherlock database ready for crossmatching

        ra                      the right-ascension coordinate with which to perform a conesearch (sexegesimal or decimal degrees)
        dec                     the declination coordinate with which to perform a conesearch (sexegesimal or decimal degrees)
        radiusArcsec            radius in arcsec of the footprint to download from the online NED database
        cat_name                name of the catalogue being imported (veron|ned_d)                          
        stream_name             name of the stream to import into the sherlock-catalogues database (ifs)

        -N, --skipNedUpdate     do not update the NED database before classification
        -A, --skipAnnotation    do not update the peak magnitudes and human readable text annotations of objects (can eat up some time)
        -h, --help              show this help message
        -s, --settings          the settings file
        -v, --verbose           print more details to stdout
        -l, --transientlistId   the id of the transient list to classify
        -u, --update            update the transient database with new classifications and crossmatches


Documentation
=============

Documentation for sherlock is hosted by `Read the Docs <http://qub-sherlock.readthedocs.org/en/stable/>`__ (last `stable version <http://qub-sherlock.readthedocs.org/en/stable/>`__ and `latest version <http://qub-sherlock.readthedocs.org/en/latest/>`__).

Installation
============

Although you can get Sherlock from a simple ``pip`` install, it's best to install it within a Conda environment under Anaconda. If you're not familiar with Anaconda, you'll find a `good tutorial here <http://astronotes.co.uk/blog/2017/10/04/An-Astronomer's-Guide-to-dotstar-Conda.html>`_ to get you up and running. 

Once you have Anaconda installed, go ahead and create a new Conda environment to host Sherlock:

.. code:: bash

    conda create -n sherlock python=2.7 pip

Now activate the environment and install sherlock:

.. code:: bash

    source activate sherlock
    pip install qub-sherlock

At any point in the future you can upgrade to the latest version of sherlock with the command:

.. code:: bash

    pip install qub-sherlock --upgrade

If instead you want to clone the `github repo <https://github.com/thespacedoctor/sherlock>`__ and install from a local version of the code:

.. code:: bash

    git clone git@github.com:thespacedoctor/sherlock.git
    cd sherlock
    source activate sherlock
    python setup.py install






Development
-----------

If you want to tinker with the code, then install in development mode.
This means you can modify the installed code from whereever you clone the repo to:

.. code:: bash

    git clone git@github.com:thespacedoctor/sherlock.git
    cd sherlock
    source activate sherlock
    python setup.py develop

`Pull requests <https://github.com/thespacedoctor/sherlock/pulls>`__
are welcomed!

Sublime Snippets
~~~~~~~~~~~~~~~~

If you use `Sublime Text <https://www.sublimetext.com/>`_ as your code editor, and you're planning to develop your own python code with sherlock, you might find `my Sublime Snippets <https://github.com/thespacedoctor/sherlock-Sublime-Snippets>`_ useful. 

Issues
------

Please report any issues
`here <https://github.com/thespacedoctor/sherlock/issues>`__.

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.



