Skip to main content

A python package and command-line tools to A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient dections are in fact known asteroids

Project description

rockfinder

Documentation Status Coverage Status

A python package and command-line suite to generate solar-system body ephemerides and to determine if specific transient dections are in fact known asteroids.

https://farm5.staticflickr.com/4383/36370391855_f8c698563e_o.png

Command-Line Usage

Usage:
    rockfinder where [-e] [csv|md|rst|json|yaml] <objectId> <mjd>...

    csv                   output results in csv format
    md                    output results as a markdown table
    rst                   output results as a restructured text table
    json                  output results in json format
    yaml                  output results in yaml format
    -e, --extra           return extra ephemeris info (verbose)
    -h, --help            show this help message

Documentation

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

Installation

The easiest way to install rockfinder is to use pip:

pip install rockfinder

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

git clone git@github.com:thespacedoctor/rockfinder.git
cd rockfinder
python setup.py install

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

pip install rockfinder --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 git@github.com:thespacedoctor/rockfinder.git
cd rockfinder
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 rockfinder, you might find my Sublime Snippets useful.

Issues

Please report any issues here.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

rockfinder-0.6.1-py3-none-any.whl (339.1 kB view hashes)

Uploaded Python 3

rockfinder-0.6.1-py2-none-any.whl (343.1 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page