Welcome to gmic-py’s documentation!

gmic-py is a Python 3 binding for the G’MIC Image Processing Framework written in C++.

gmic is the package name of gmic-py on pypi.org, so you should pip install gmic (see 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.

This documentation showcases various uses of gmic-py:

• gmic-py alone in pure Python,

• with Numpy,

• with the Python Imaging Library (PIL),

• with scikit-image,

• (soon) with pygame and Tkinter,

• (soon) with p5 processing for Python.

Head over to the Quickstart section for examples.

• Installing
  • For Linux / Unix
  • For Mac OS
  • For Windows (future)
• Quickstart
  • 1. Install gmic-py
  • 2. Run a simple G’MIC effect and view it
  • 3. Save your result to a file
  • 4. Dealing with GmicImage and GmicImage lists
  • 5. Working with the Numpy support
• Tutorials
  • Tutorial 1 - G’MIC commands syntax
    • Little theory on G’MIC commands
    • The help <some command> command
    • The sample or sp command
    • The display command
    • The print command
    • The output <file> command
    • The input <somefile> command (simple and short form)
    • Applying a one or more filter(s)
  • Tutorial 2 - Optimization, GmicImage, lists, stylize
    • The G’MIC module - for debugging’s sake mostly
    • Gmic - The G’MIC interpreter class
    • GmicImage - The G’MIC Image class
    • The G’MIC images list (and image names)
    • Image names
    • Wrapping up - stylized fruits example
  • Tutorial 3 - filtering a GIF into a flipbook
    • Goal: Making a moon phases flip book
    • Loading a GIF into a list of GmicImages
    • Filtering individual animation frames
    • Making a montage of the frames
    • Saving to PNG and printing
    • Cutting and assembling paper frames
    • Time to flip
• Numpy support
  • Must-know
  • How-to
• PIL support
  • Must-know
  • How-to
• Scikit-Image support
  • Must-know
  • How-to
• Jupyter/IPython/GColab support
  • How-to
    • Installing
    • Using
  • Implementation details
• Developing, compiling, testing, releasing
  • TL;DR building gmic-py on Linux
  • gmic-py development to release lifecycle (overview)
  • Github Actions Continuous integration workflows
  • build_tools.bash - a developer’s Swiss army knife
    • Centralized version for development and continuous-integration-based releasing
    • Calling build_tools.bash
    • Rapid sub-commands overview and explanations
  • Recommended compilers
  • Library requirements
  • Optimized vs. debugging
  • On the fly compiling with pip
  • Compiling from a git clone
  • gmic-py development to release lifecycle (detailed)
• API Reference

Indices and tables

• Index

• Module Index

• Search Page