.. image:: images/logo_w.png
   :align: center
   :alt: clEsperanto logo

***************************
pyclesperanto documentation
***************************

pyclesperanto is the python package of clEsperanto - a multi-language framework for GPU-accelerated image processing.
You will find here the documentation for the python bindings of clEsperanto, pyclesperanto. The documentation covers the installation, the usage and the API of pyclesperanto.
As well as documentation on how to migrate from the `prototype <https://github.com/clEsperanto/pyclesperanto_prototype>`_ to `pyclesperanto <https://github.com/clEsperanto/pyclesperanto>`_.

.. note::

   This project is still under active development, as well as its documentation. If you find any issues, please raise an `issue <https://github.com/clEsperanto/pyclesperanto/issues>`_.

.. toctree::
   :caption: 📘 Documentation
   :maxdepth: 1

   documentation/install
   documentation/usage
   documentation/faq
   documentation/api
   genindex

.. toctree::
   :caption: 🚀 Prototype Migration
   :maxdepth: 1

   prototype/prototype
   prototype/api_differences

.. toctree::
   :caption: 🛠️ Developper Guide
   :maxdepth: 1

   developpers/contribute


📖 Citation
-----------

There is no publication for pyclesperanto yet. If you use pyclesperanto in your research, please use the zenodo DOI to cite it.

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.13853800.svg
   :target: https://doi.org/10.5281/zenodo.13853800
   :alt: DOI 10.5281/zenodo.13853800
   :align: center