README

Orbital
-------

|Build Status| |PyPI Version| |Python Version| |MIT License|

Orbital is a high level orbital mechanics package for Python.

Installation
~~~~~~~~~~~~

.. code:: bash

    $ pip install orbitalpy

Example
~~~~~~~

.. code:: python

    from orbital import earth, KeplerianElements, Maneuver, plot

    from scipy.constants import kilo
    import matplotlib.pyplot as plt

    orbit = KeplerianElements.with_altitude(1000 * kilo, body=earth)
    man = Maneuver.hohmann_transfer_to_altitude(10000 * kilo)
    plot(orbit, title='Maneuver 1', maneuver=man)
    plt.show()

.. figure:: http://i.fraz.eu/5b84e.png
   :alt: Example plot

   Example plot

Documentation
~~~~~~~~~~~~~

For more information, view the `documentation
online <http://pythonhosted.org/OrbitalPy/>`__.

.. |Build Status| image:: http://img.shields.io/travis/RazerM/orbital.svg?style=flat-square
   :target: https://travis-ci.org/RazerM/orbital
.. |PyPI Version| image:: http://img.shields.io/pypi/v/orbitalpy.svg?style=flat-square
   :target: https://pypi.python.org/pypi/orbitalpy/
.. |Python Version| image:: https://img.shields.io/badge/python-2.7%2C%203-brightgreen.svg?style=flat-square
   :target: https://www.python.org/downloads/
.. |MIT License| image:: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
   :target: https://raw.githubusercontent.com/RazerM/orbital/master/LICENSE