
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``, ``C4``, ``C3``, ``T4``, ``T3``, ``C2``, ``T2``.

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

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


🤝 Community & Contributions
------------------------------

Your support means the world to us and helps drive continuous improvement in **PolSARtools**. Whether you're reporting bugs, suggesting features, or submitting pull requests - every contribution helps us advance open SAR.

Ways to get involved
~~~~~~~~~~~~~~~~~~~~

🐛 **Report issues**  
Found a bug or have a question? Open an issue and let us know.

✨ **Suggest features**  
We welcome ideas that make PolSARtools more powerful and user-friendly.

🔧 **Submit pull requests**  
Help us improve the codebase - big or small, every PR counts.

📣 **Spread the word**  
Share PolSARtools with fellow researchers, developers, and geospatial enthusiasts.


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

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



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

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



Disclaimer
-----------
PolSARtools is released under the `GNU General Public License v3.0 <https://www.gnu.org/licenses/gpl-3.0.html>`_ (GPL-3.0).  
You are free to use, modify, and share the software under the terms of this license.

This software is provided *as is*, without any warranties. Use at your own risk.


.. Disclaimer
.. ----------

.. PolSARtools 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.