rockAtlas 0.2.3

A python package and command-line tools to A suite of tools to pull known solar-system small-body detections out of ATLAS data

rockAtlas

A python package and command-line tools for A suite of tools to pull known solar-system small-body detections out of ATLAS data.

Command-Line Usage

Documentation for rockAtlas can be found here: http://rockAtlas.readthedocs.org/en/stable

Usage:
    rockAtlas init
    rockAtlas bookkeeping [-f] [-s <pathToSettingsFile>]
    rockAtlas astorb
    rockAtlas pyephem [-o]

Commands:
    bookkeeping           update and clean database tables, perform essential bookkeeping tasks
    astorb                download astorb.dat orbital elements file and update the orbital elements database table
    pyephem               generate the pyephem positions overlapping the ATLAS exposures in the moving objects database

Options:
    init                  setup the rockAtlas settings file for the first time
    -h, --help            show this help message
    -v, --version         show version
    -s, --settings        the settings file
    -f, --full            a full update (not just recently changed exposures and sources)
    -o, --one             only generate positions for a single pyephem snapshot (few 10s of exposures - useful for testing)

Documentation

Documentation for rockAtlas is hosted by Read the Docs (last stable version and latest version).

Installation

The easiest way to install rockAtlas is to use pip:

pip install rockAtlas

Or you can clone the github repo and install from a local version of the code:

git clone [e-mail]:thespacedoctor/rockAtlas.git
cd rockAtlas
python setup.py install

To upgrade to the latest version of rockAtlas use the command:

pip install rockAtlas --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:

git clone [e-mail]:thespacedoctor/rockAtlas.git
cd rockAtlas
python setup.py develop

Pull requests are welcomed!

Sublime Snippets

If you use Sublime Text as your code editor, and you’re planning to develop your own python code with rockAtlas, you might find my Sublime Snippets useful.

Issues

Please report any issues here.

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.