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

This is the documentation for the `PyRate` software.

`PyRate` is a Python tool for estimating the 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` exploits distributed scatterers
using a "Small Baseline Subset" (SBAS) processing strategy and currently
supports input data in the `GAMMA` or `ROI\_PAC` software formats.
Additionally, the European Space Agency SNAP_ software version 8 has a
"PyRate export" capability that prepares `SNAP` output data in the `GAMMA`
format for use with `PyRate`.

.. _`SNAP`: https://step.esa.int/main/download/snap-download/

.. note::

    - Support and development of `ROI\_PAC` has been discontinued.
    - `ROI\_PAC` support in `PyRate` will be deprecated in a future release.

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.

* Link to `Github Repository`_
* Link to `Issue tracking page`_

.. _`Github Repository`: https://github.com/GeoscienceAustralia/PyRate
.. _`Issue tracking page`: https://github.com/GeoscienceAustralia/PyRate/issues

Feedback
--------

If you have any suggestions or questions about `PyRate` please
email the `Geoscience Australia InSAR team`_.

.. _`Geoscience Australia InSAR team`: mailto: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

Contents:
---------

.. toctree::
   :maxdepth: 3

   installation
   usage
   scripts
   modules
   troubleshooting
   contributing
   authors
   history
   release

.. _Home: https://geoscienceaustralia.github.io/PyRate/


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

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