.. KALMUS documentation master file, created by
   sphinx-quickstart on Wed Feb 24 16:47:39 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to KALMUS's documentation!
==================================

.. toctree::
   :hidden:

   Home <self>
   Installation Guide <install>
   API Documentation <kalmus>
   KALMUS Update Log <update_log>
   Acknowledgement <acknowledge>

KALMUS Color Toolkit
======================
Filmmakers, cinematographers, production designers, and then colorists (the person who fine tunes or grades the color in post production) spend enormous sums and labor deciding a film’s color palette. Why? Because color has an almost subliminal impact on how we perceive a film. Interpreting a film’s use of color, however, remains an elusive and understudied area.

KALMUS is a Python package for the computational analysis of colors in films. It provides quantitative tools to study and compare the use of film color. This package serves two purposes: (1) various ways to measure, calculate and compare a film's colors and (2) various ways to visualize a film's color. We have named the software KALMUS in homage to Natalie Kalmus (1882 - 1965), a Technicolor Director who oversaw the color palettes of nearly 300 Hollywood feature films.

KALMUS utilizes the movie barcode as a visualization of the film's color. It has a modularized pipeline for the generation of barcodes using different measures of color and region of interest in each film frame. KALMUS provides a low-level API, high-level command line, and Graphic user interface for audience from all backgrounds to take advantage of its functionality.

* What is a Movie Barcode: `KALMUS: tools for color analysis of films <https://joss.theoj.org/papers/10.21105/joss.03156>`_. *Journal of Open Source Software*, 6(61), 3156. `https://doi.org/10.21105/joss.03156 <https://doi.org/10.21105/joss.03156>`_
* KALMUS's project repository: `GitHub Repository for KALMUS project <https://github.com/KALMUS-Color-Toolkit/KALMUS>`_
* KALMUS's latest release on PyPI: `KALMUS's PyPI Homepage <https://pypi.org/project/kalmus/>`_
* Get started on KALMUS: `Notebook Tutorials for KALMUS'S API, GUI, and CLI <https://github.com/KALMUS-Color-Toolkit/KALMUS/tree/master/notebooks>`_
* How do I contribute to the KALMUS: `KALMUS Contribution Guidelines <https://github.com/KALMUS-Color-Toolkit/KALMUS/blob/master/CONTRIBUTING.md>`_


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

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