OpenColorIO Configuration for ACES

The OpenColorIO Configuration for ACES is an open-source Python package implementing support for the generation of the OCIO configurations for the Academy Color Encoding System (ACES).

It is freely available under the New BSD License terms.

1   Features

The following features are available:

• Automatic OCIO Reference configuration generation for aces-dev CTL reference implementation.
  • Discovery of aces-dev CTL transforms.
  • Generation of the CTL transforms graph.
• Configurable generator producing the OCIO CG and Studio configurations.
• Included CLF transforms along with generator and discovery support.

2   User Guide

2.1   Installation

2.1.1   Cloning the Repository

The OpenColorIO Configuration for ACES repository uses Git submodules thus cloning the repository requires initializing them:

git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git

If you have already cloned the repository and forgot the --recursive argument, it is possible to initialize the submodules as follows:

git submodule update --init --recursive

2.1.2   Poetry

The OpenColorIO Configuration for ACES repository adopts Poetry to help managing its dependencies, this is the recommended way to get started with development.

Assuming python >= 3.8 is available on your system along with OpenColorIO, the development dependencies are installed with Poetry as follows:

git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git
cd OpenColorIO-Config-ACES
poetry install --extras "optional"

The aces-dev CTL reference graph can be plotted but it requires Graphviz to be installed on the system and having installed the optional pygraphviz: python package:

poetry install --extras "optional graphviz"

2.1.3   Docker

Installing the dependencies for the previous config generator was not a trivial task. For ease of use an aswf-docker based container is now available.

Creating the container from the Dockerfile is done as follows:

docker build -t aswf/opencolorio-config-aces:latest .

or alternatively, if the dependencies described in the next section are satisfied:

invoke docker build

Then, to run bash in the container:

docker run -it -v ${PWD}:/home/aswf/OpenColorIO-Config-ACES aswf/opencolorio-config-aces:latest /bin/bash

2.1.4   Pypi

The OpenColorIO Configuration for ACES package requires various dependencies in order to run and be able to generate the OCIO configurations:

2.1.4.1   Primary Dependencies

• python >= 3.8, < 3.11
• OpenColorIO

2.1.4.2   Optional Dependencies

• colour
• graphviz
• jsonpickle
• networkx
• pygraphviz

2.1.4.3   Development Dependencies

• black
• coverage
• coveralls
• flake8
• invoke
• mypy
• pre-commit
• pydata-sphinx-theme
• pydocstyle
• pytest
• pyupgrade
• restructuredtext-lint
• sphinx >= 4, < 5
• twine

Once the dependencies are satisfied, the OpenColorIO Configuration for ACES package can be installed from the Python Package Index by issuing this command in a shell:

pip install --user opencolorio-config-aces

2.2   Components Status

2.3   Usage

2.3.1   Tasks

Various tasks are currently exposed via invoke.

This is currently the recommended way to build the configuration until a dedicated CLI is provided.

Listing the tasks is done as follows:

invoke --list

Assuming the dependencies are satisfied, the task to build the Reference configuration is:

invoke build-config-reference

Alternatively, with the docker container built:

invoke docker-run-build-config-reference

Likewise, for the CG configuration:

invoke build-config-cg

Or:

invoke docker-run-build-config-cg

3   API Reference

The main technical reference for OpenColorIO Configuration for ACES is the API Reference.

4   About