Metadata-Version: 1.1
Name: HMpTy
Version: 1.3.2
Summary: Tools for working with Hierarchical Triangular Meshes (HTMs). Generate HTM-ids, crossmatch sets of sky-coordinates and more
Home-page: https://github.com/thespacedoctor/HMpTy
Author: David Young
Author-email: davidrobertyoung@gmail.com
License: MIT
Download-URL: https://github.com/thespacedoctor/HMpTy/archive/v1.3.2.zip
Description: HMpTy 
        =========================
        
        *A python package and command-line tools for working with Hierarchical Triangular Meshes (HTMs). Generate HTM-ids, crossmatch sets of sky-coordinates and more*.
        
        .. image:: http://i.imgur.com/5GG4979.png
            :width: 600 px
        
        Here's a summary of what's included in the python package:
        
        .. include:: /classes_and_functions.rst
        
        Command-Line Usage
        ======
        
        .. code-block:: bash 
           
            
            Documentation for HMpTy can be found here: http://HMpTy.readthedocs.org/en/stable
            
            
            Usage:
                hmpty index <tableName> <primaryIdCol> <raCol> <decCol> (-s <pathToSettingsFile>|--host <host> --user <user> --passwd <passwd> --dbName <dbName>)
                hmpty search <tableName> <raCol> <decCol> <ra> <dec> <radius> (-s <pathToSettingsFile>|--host <host> --user <user> --passwd <passwd> --dbName <dbName>) [(-r <format>|-r mysql <resultsTable>)]
            
            Options:
                index                 add HTMids to database table
                search                perform a conesearch on a database table
            
                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
                dec                                                             the declination of the centre of the conesearch circle
                radius                                                          the radius of the conesearch circle (arcsec)
                -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
            
            
        
        Documentation
        =============
        
        Documentation for HMpTy is hosted by `Read the Docs <http://HMpTy.readthedocs.org/en/stable/>`__ (last `stable version <http://HMpTy.readthedocs.org/en/stable/>`__ and `latest version <http://HMpTy.readthedocs.org/en/latest/>`__).
        
        Installation
        ============
        
        The easiest way to install HMpTy is to use ``pip``:
        
        .. code:: bash
        
            pip install HMpTy
        
        Or you can clone the `github repo <https://github.com/thespacedoctor/HMpTy>`__ and install from a local version of the code:
        
        .. code:: bash
        
            git clone git@github.com:thespacedoctor/HMpTy.git
            cd HMpTy
            python setup.py install
        
        To upgrade to the latest version of HMpTy use the command:
        
        .. code:: bash
        
            pip install HMpTy --upgrade
        
        
        Development
        -----------
        
        If you want to tinker with the code, then install in development mode.
        This means you can modify the code from your cloned repo:
        
        .. code:: bash
        
            git clone git@github.com:thespacedoctor/HMpTy.git
            cd HMpTy
            python setup.py develop
        
        `Pull requests <https://github.com/thespacedoctor/HMpTy/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 HMpTy, you might find `my Sublime Snippets <https://github.com/thespacedoctor/HMpTy-Sublime-Snippets>`_ useful. 
        
        
        Issues
        ------
        
        Please report any issues
        `here <https://github.com/thespacedoctor/HMpTy/issues>`__.
        
        License
        =======
        
        Copyright (c) 2016 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.
        
        
Keywords: astronomy, coordinates, tools
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Utilities
