.. _api_reference:

====================
SARkit API Reference
====================

:Release: |version|
:Date: |today|

API reference for ``sarkit``.

Main namespaces
===============

* :py:mod:`sarkit`
* `sarkit.cphd`
* `sarkit.crsd`
* `sarkit.sicd`

  - `sarkit.sicd.projection`

* `sarkit.sidd`

  - `sarkit.sidd.calculations`

* `sarkit.verification`
* `sarkit.wgs84`

.. toctree::
   :hidden:

    sarkit <sarkit>
    sarkit.cphd <cphd>
    sarkit.crsd <crsd>
    sarkit.sicd <sicd>
    sarkit.sidd <sidd>
    sarkit.verification <verification>
    sarkit.wgs84 <wgs84>


Special-purpose namespaces
==========================

* `sarkit.xmlhelp` - XML helper functions (typically not used directly by end users)

.. toctree::
   :hidden:

    sarkit.xmlhelp <xmlhelp>