qub-sherlock 1.6.5

夏洛克

一个python包，带有命令行工具，用于对变量/瞬时天文源进行上下文分类。sherlock挖掘了一个历史和正在进行的天文测量数据库，试图识别瞬变事件的来源，并根据相关的交叉匹配数据预测它们的分类。

命令行用法

# 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

文档

夏洛克的文档由Read the Docs（最后一个stable version和latest version）托管。

安装

尽管可以通过简单的pip安装获得sherlock，但最好将其安装在conda环境下的anaconda下。如果你不熟悉水蟒，你会找到一个good tutorial here让你起来跑步。

安装了Anaconda后，继续创建一个新的Conda环境来托管Sherlock:

conda create -n sherlock python=2.7 pip

现在激活环境并安装夏洛克：

source activate sherlock
pip install qub-sherlock

在将来的任何时候，您都可以使用以下命令升级到sherlock的最新版本：

pip install qub-sherlock --upgrade

如果您想克隆github repo并从本地版本的代码安装：

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

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

许可证

版权所有（c）2018 David Young

特此免费向任何获得 本软件和相关文档文件的副本 “软件”），无限制地处理软件，包括 但不限于使用、复制、修改、合并、发布， 分发、再授权和/或出售软件副本，以及 允许向其提供软件的人员这样做，但须遵守 以下条件：

上述版权公告及本许可公告须包括在内 在软件的所有副本或大部分中。

软件按“原样”提供，不作任何形式的保证 或默示的，包括但不限于 适销性、适合特定目的和不侵权。 在任何情况下，作者或版权持有人均不对任何 索赔、损害赔偿或其他责任，无论是在合同诉讼中， 侵权行为或其他，由 软件或软件中的使用或其他交易。