=====================
Satpy's Documentation
=====================

Satpy is a python library for reading, manipulating, and writing data from
remote-sensing earth-observing satellite instruments. Satpy
provides users with readers that convert geophysical parameters from various
file formats to the common Xarray :class:`~xarray.DataArray` and
:class:`~xarray.Dataset` classes for easier interoperability with other
scientific python libraries. For a full list of available readers see :ref:`reader_table`.
Satpy also provides interfaces for creating RGB (Red/Green/Blue) images and other
composite types by combining data from multiple instrument bands or products.
Various atmospheric corrections and visual enhancements are provided for
improving the usefulness and quality of output images. Output data can be written to
multiple output file formats such as PNG, GeoTIFF, and CF standard NetCDF
files. Satpy also allows users to resample data to geographic projected grids
(areas). Satpy is maintained by the open source
`Pytroll <http://pytroll.github.io/>`_ group.

The Satpy library acts as a high-level abstraction layer on top of other
libraries maintained by the Pytroll group including:

- `pyresample <http://pyresample.readthedocs.io/en/latest/>`_
- `pyspectral <https://pyspectral.readthedocs.io/en/latest/>`_
- `trollimage <http://trollimage.readthedocs.io/en/latest/>`_
- `pycoast <https://pycoast.readthedocs.io/en/latest/>`_
- `pydecorate <https://pydecorate.readthedocs.io/en/latest/>`_
- `python-geotiepoints <https://python-geotiepoints.readthedocs.io/en/latest/>`_
- `pyninjotiff <https://github.com/pytroll/pyninjotiff>`_

Go to the Satpy project_ page for source code and downloads.

Satpy is designed to be easily extendable to support any earth observation
satellite by the creation of plugins (readers, compositors, writers, etc).
The table at the bottom of this page shows the input formats supported by
the base Satpy installation.

.. note::

    Satpy's interfaces are not guaranteed stable and may change until version
    1.0 when backwards compatibility will be a main focus.

.. _project: http://github.com/pytroll/satpy


Getting Help
============

Having trouble installing or using Satpy? Feel free to ask questions at
any of the contact methods for the PyTroll group
`here <https://pytroll.github.io/#getting-in-touch>`_ or file an issue on
`Satpy's GitHub page <https://github.com/pytroll/satpy/issues>`_.

Documentation
=============

.. toctree::
    :maxdepth: 2

    overview
    install
    config
    data_download
    examples/index
    quickstart
    reading
    remote_reading
    composites
    resample
    enhancements
    writing
    multiscene
    dev_guide/index
    readers_formats

.. toctree::
    :maxdepth: 1

    Satpy API <api/modules>
    faq
    Release Notes <https://github.com/pytroll/satpy/blob/main/CHANGELOG.md>
    Security Policy <https://github.com/pytroll/satpy/blob/main/SECURITY.md>


.. note::

    Please note that the reader table that used to be placed here has moved to the "reading"
    section here:  :ref:`reader_table`.

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

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