HMpTy.cl_utils module

Documentation for HMpTy can be found here: http://HMpTy.readthedocs.org

Usage:

hmpty init hmpty htmid hmpty [-f] index (-s |–host –user –passwd –dbName ) hmpty search (-s |–host –user –passwd –dbName ) [(-r |-r mysql )]

Options:

init setup the sherlock settings file for the first time index add HTMids to database table search perform a conesearch on a database table htmid generate the htmID at the given coordinates for the give HTM level

tableName                                                       name of the table to add the HTMids to
primaryIdCol                                                    the name of the unique primary ID column of the database table
raCol                                                           name of the table column containing the right ascension
decCol                                                          name of the table column containing the declination
ra                                                              the right ascension of the centre of the conesearch circle or coordinate set
dec                                                             the declination of the centre of the conesearch circle or coordinate set
radius                                                          the radius of the conesearch circle (arcsec)
level                                                           the HTM level required

-f, --force                                                     force a regeneration of all HTMIDs
-h, --help                                                      show this help message
-v, --version                                                   show version
-s <pathToSettingsFile>, --settings <pathToSettingsFile>        path to a settings file containing the database credentials
--host <host>                                                   database host address
--user <user>                                                   database username
--passwd <passwd>                                               database password
--dbName <dbName>                                               database name
-r <format>, --render <format>                                  select a format to render your results in
tab_complete(text, state)[source]
main(arguments=None)[source]

The main function used when ``cl_utils.py`` is run as a single script from the cl, or when installed as a cl command