1 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.

Table of Contents

• 1 OpenColorIO Configuration for ACES

  • 1.1 Features

  • 1.2 Installation

    • 1.2.1 Docker

    • 1.2.2 Pypi

  • 1.3 Usage

    • 1.3.1 Tasks

    • 1.3.2 API

  • 1.4 About

1.1 Features

The following features are available:

• Automatic OCIO Reference configuration generation for aces-dev CTL reference implementation.

• Configurable generator producing the OCIO Studio configuration.

1.2 Installation

1.2.1 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

1.2.2 Pypi

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

1.2.2.1 Primary Dependencies

• python>=3.7

• networkx

• OpenColorIO

1.2.2.2 Plotting Dependencies

• graphviz

• pygraphviz

1.2.2.3 Development Dependencies

• coverage

• coveralls

• flake8

• invoke

• nose

• pre-commit

• pytest

• restructuredtext-lint

• sphinx

• sphinx-rtd-theme

• twine

• yapf==0.23.0

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

1.3 Usage

1.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-reference-config

Alternatively, with the docker container built:

invoke docker-run-build-reference-config

1.3.2 API

The main reference for OpenColorIO Configuration for ACES is the manual.

OpenColorIO Configuration for ACES - Manual

Reference

OpenColorIO Configuration for ACES

Generation

Config Generation Common Objects

opencolorio_config_aces

colorspace_factory(name[, family, encoding, …])	OpenColorIO colorspace factory.
view_transform_factory(name[, family, …])	OpenColorIO view transform factory.
ConfigData(profile_version, description, …)	Defines the data container for an OpenColorIO config.
validate_config(config)	Validates given OpenColorIO config.
generate_config(data[, config_name, validate])	Generates the OpenColorIO config from given data.

Reference Configuration

aces-dev Discovery

opencolorio_config_aces

discover_aces_ctl_transforms([root_directory])	Discovers the ACES CTL transform paths in given root directory: The given directory is traversed and *.ctl files are collected.
classify_aces_ctl_transforms(…)	Classifies given ACES CTL transforms.
unclassify_ctl_transforms(…)	Unclassifies given ACES CTL transforms.
filter_ctl_transforms(ctl_transforms[, …])	Filters given ACES CTL transforms with given filterers.
print_aces_taxonomy()	Prints aces-dev taxonomy:

aces-dev Conversion Graph

opencolorio_config_aces

build_aces_conversion_graph(ctl_transforms)	Builds the aces-dev conversion graph from given ACES CTL transforms.
node_to_ctl_transform(graph, node)	Returns the ACES CTL transform from given node name.
ctl_transform_to_node(graph, ctl_transform)	Returns the node name from given ACES CTL transform.
filter_nodes(graph[, filterers])	Filters given aces-dev conversion graph nodes with given filterers.
conversion_path(graph, source, target)	Returns the conversion path from the source node to the target node in the aces-dev conversion graph.
plot_aces_conversion_graph(graph, filename)	Plots given aces-dev conversion graph using Graphviz and pyraphviz.

aces-dev Reference Config Generator

opencolorio_config_aces

generate_config_aces([config_name, …])

Generates the aces-dev reference implementation OpenColorIO Config using the Mapping method.

Utilities

Common

opencolorio_config_aces.utilities

DocstringDict	A dict sub-class that allows settings a docstring to dict instances.
first_item(iterable[, default])	Returns the first item of given iterable.
common_ancestor(*args)	Returns the common ancestor of given iterables.
paths_common_ancestor(*args)	Returns the common ancestor path from given paths.
vivification()	Implements supports for vivification of the underlying dict like data-structure, magical!
vivified_to_dict(vivified)	Converts given vivified data-structure to dictionary.
message_box(message[, width, padding, …])	Prints a message inside a box.
is_opencolorio_installed([raise_exception])	Returns if OpenColorIO is installed and available.
REQUIREMENTS_TO_CALLABLE	Mapping of requirements to their respective callables.
required(*requirements)	A decorator checking if various requirements are satisfied.
is_string(a)	Returns if given \(a\) variable is a string like variable.
is_iterable(a)	Returns if given \(a\) variable is iterable.
git_describe()	Describes the current OpenColorIO Configuration for ACES git version.

Indices and tables

• Index

• Search Page

1.4 About

OpenColorIO Configuration for ACES by OpenColorIO Contributors

Copyright Contributors to the OpenColorIO Project – ocio-dev@lists.aswf.io

This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause

https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES