.. PyRate documentation master file, created by
   sphinx-quickstart on Fri Mar  3 10:07:59 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyRate documentation
====================

This is the documentation for the **PyRate** software.

**PyRate** is a Python tool for estimating the average rate (velocity) and
cumulative displacement time-series of surface movements for every pixel in
a stack of geocoded unwrapped interferograms generated by Interferometric
Synthetic Aperture Radar (InSAR) processing. **PyRate** currently supports
input data in the GAMMA or ROI_PAC software formats.

The **PyRate** project started in 2012 as a partial Python translation of
"Pirate", a Matlab tool developed by the University of Leeds and the Guangdong
University of Technology.


Contents:
---------

* `Github Repository`_
* `Issue tracking`_

.. toctree::
   :maxdepth: 2

   installation
   usage
   contributing
   authors
   history
   scripts
   modules



.. _Home: https://geoscienceaustralia.github.io/PyRate/
.. _`Github Repository`: https://github.com/GeoscienceAustralia/PyRate
.. _`Issue tracking`: https://github.com/GeoscienceAustralia/PyRate/issues

Feedback
--------

If you have any suggestions or questions about **PyRate** feel free to
email Geoscience Australia InSAR team <insar@ga.gov.au>.

If you encounter any errors or problems with **PyRate**, please let us
know!  Open an Issue_ in the GitHub repository.

.. _Issue: https://github.com/GeoscienceAustralia/PyRate/issues



Indices and tables
==================

* :ref:`modindex`
* :ref:`genindex`