Welcome to gmic-py's documentation!
===================================
``gmic-py`` is a Python 3 binding for the `G'MIC Image Processing Framework <https://gmic.eu/>`_ written in C++.

``gmic`` is the package name of `gmic-py on pypi.org <https://pypi.org/project/gmic/>`_, so you should ``pip install gmic`` (see :doc:`installing`).

G'MIC provides image-processing commands for 1D to 4D images, as well as many graphical filters.
It is thus targetted at both artists and data-scientists.

.. image:: _static/images/292_plan.png

This documentation showcases various uses of ``gmic-py``:

* gmic-py alone in pure Python,
* with `Numpy <https://numpy.org/>`_,
* with the `Python Imaging Library (PIL) <https://python-pillow.org/>`_,
* with `scikit-image <https://scikit-image.org/>`_,
* (soon) with `pygame <https://www.pygame.org/>`_ and `Tkinter <https://wiki.python.org/moin/TkInter>`_,
* (soon) with `p5 processing for Python <https://pypi.org/project/p5/>`_.

Head over to the :doc:`gettingstarted` section for examples.

.. toctree::
   :maxdepth: 3

   installing
   gettingstarted
   tutorials
   numpy
   PIL
   skimage
   jupyter
   compiling
   gmic



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

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