
Welcome to PolSARtools' Documentation!
=======================================

**PolSARtools** is a Python package available on `PyPI <https://pypi.org/project/polsartools/>`_ 🐍 that generates **derived SAR parameters**, including:

- 🌀 **Polarimetric descriptors**
- 🌿 **Vegetation indices**
- 🧩 **Polarimetric decomposition parameters**

It supports input from various SAR sensors or directly from **polarimetric matrices** such as: ``S2``, ``C3``, ``T3``, ``C2``, ``T2``.

📘 Tutorial Notebooks
----------------------

Get started quickly with hands-on examples! Explore our step-by-step tutorials here:  
👉 `polsartools-notebooks <https://github.com/Narayana-Rao/polsartools-notebooks>`_ 📓✨


📚 Cite Us!
------------

If you use **PolSARtools** in your research or projects, we'd really appreciate a citation! 🛰️✨

Please cite our work as:

    Bhogapurapu, N., Dey, S., Mandal, D., Bhattacharya, A., and Rao, Y.S. (2021). 
    *PolSAR tools: A QGIS plugin for generating SAR descriptors*. 
    Journal of Open Source Software, **6(60)**, p.2970.  
    🔗 https://doi.org/10.21105/joss.02970

BibTeX 📄
~~~~~~~~~

.. code-block:: bibtex

    @article{bhogapurapu2021polsar,
      title={PolSAR tools: A QGIS plugin for generating SAR descriptors},
      author={Bhogapurapu, Narayanarao and Dey, Subhadip and Mandal, Dipankar and Bhattacharya, Avik and Rao, YS},
      journal={Journal of Open Source Software},
      volume={6},
      number={60},
      pages={2970},
      year={2021},
      doi={10.21105/joss.02970}
    }

🙏 Your support means a lot and helps us keep improving PolSARtools!


.. toctree::
   :maxdepth: 3
   :caption: Contents:

   files/00start
   files/01sensors
   files/02functions
   files/03refs



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

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




Disclaimer
----------

PolSARtools v0.6.1 is released under the `GNU General Public License v3.0 <https://www.gnu.org/licenses/gpl-3.0.html>`_ (GPL-3.0). 
This means you are free to use, modify, and distribute the software, provided you adhere to the terms of the license.

No Warranty
~~~~~~~~~~~

This software is provided **"as is"**, **without warranty of any kind**, either express or implied, including but not limited to 
the warranties of **merchantability**, **fitness for a particular purpose**, and **non-infringement**. In no event shall the 
authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, 
or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.

Use this software at your own risk. While efforts have been made to ensure reliability and accuracy, no guarantee is provided 
regarding its suitability for any particular application.