|build-status| |docs|

Pyplis -  Python Plume Imaging Software
---------------------------------------

Pyplis is a Python toolbox originally developed for the analysis of UV SO2 camera data. The software includes a comprehensive and flexible collection of algorithms for the analysis of atmospheric imaging data and is tested for all major operating systems and most recent python versions.

Useful links
============

- **Installation**: `Installation instructions <https://pyplis.readthedocs.io/en/latest/intro.html#installation>`_
- **Getting Started**: `Getting Started guide <https://pyplis.readthedocs.io/en/latest/intro.html#getting-started>`_
- **Main Features**: `Feature overview <https://pyplis.readthedocs.io/en/latest/intro.html#main-features>`_
- **Contributing**: `Contributing guide <https://pyplis.readthedocs.io/en/latest/contributing.html>`_
- **Scientific background**: `Peer reviewed pyplis publication <http://www.mdpi.com/2076-3263/7/4/134>`_

Features
========

- Comprehensive algorithms for all aspects of UV SO2 camera data analysis.
- Flexible tools for atmospheric imaging data processing.
- Cross-platform compatibility (Windows, Linux).
- Tested with recent Python versions.

For more details on the features, please refer to the `documentation <https://pyplis.readthedocs.io/en/latest/intro.html#main-features>`__.

Installation
============

To install Pyplis, simply run:

.. code-block:: bash

   pip install pyplis

If you use conda, you can also install pyplis using conda-forge:

.. code-block:: bash

   conda install -c conda-forge pyplis

For detailed installation instructions, please refer to the `documentation <https://pyplis.readthedocs.io/en/latest/intro.html>`__.

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

The pyplis documentation is hosted `here <https://pyplis.readthedocs.io/>`_. It contains all relevant
information about the software, including installation instructions, a detailed API reference, and a gallery of examples. 
The documentation is continuously updated and improved.

Contributions are welcome!
==========================

The pyplis software is maintained during the author's free time, and the author is no longer actively engaged in the field of volcano remote sensing. Contributions from users or developers with expertise in UV SO2 cameras are highly valued. Interested individuals are encouraged to reach out via email at jonasgliss@gmail.com, submit pull requests through a fork, or create issues on the repository (tagging @jgliss in issues and pull requests is recommended).

.. |build-status| image:: https://github.com/jgliss/pyplis/workflows/CI/badge.svg
   :target: https://github.com/jgliss/pyplis/actions

.. |docs| image:: https://readthedocs.org/projects/pyplis/badge/?version=latest
    :target: https://pyplis.readthedocs.io/en/latest/?badge=latest