{"id":19321290,"url":"https://github.com/academysoftwarefoundation/opencolorio-config-aces","last_synced_at":"2025-05-16T07:06:28.724Z","repository":{"id":37260380,"uuid":"264476963","full_name":"AcademySoftwareFoundation/OpenColorIO-Config-ACES","owner":"AcademySoftwareFoundation","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-15T01:41:17.000Z","size":844,"stargazers_count":330,"open_issues_count":17,"forks_count":41,"subscribers_count":29,"default_branch":"main","last_synced_at":"2025-04-12T04:47:36.560Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opencolorio.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AcademySoftwareFoundation.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-16T16:19:17.000Z","updated_at":"2025-04-10T10:55:50.000Z","dependencies_parsed_at":"2023-01-31T04:35:13.254Z","dependency_job_id":"d5294555-0113-401f-aef2-ac36a3b22120","html_url":"https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES","commit_stats":{"total_commits":78,"total_committers":8,"mean_commits":9.75,"dds":"0.23076923076923073","last_synced_commit":"719c8023d126b80d930aad34030ac2ffb7f7e6fc"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2FOpenColorIO-Config-ACES","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2FOpenColorIO-Config-ACES/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2FOpenColorIO-Config-ACES/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AcademySoftwareFoundation%2FOpenColorIO-Config-ACES/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AcademySoftwareFoundation","download_url":"https://codeload.github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485063,"owners_count":22078767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T01:36:28.333Z","updated_at":"2025-05-16T07:06:28.678Z","avatar_url":"https://github.com/AcademySoftwareFoundation.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"..\n  SPDX-License-Identifier: CC-BY-4.0\n  Copyright Contributors to the OpenColorIO Project.\n\nOpenColorIO Configuration for ACES\n==================================\n\n.. start-badges\n\n|actions| |artefacts|\n\n.. |actions| image:: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/continuous-integration-quality-unit-tests.yml/badge.svg\n    :target: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/continuous-integration-quality-unit-tests.yml\n    :alt: Continuous Integration - Quality \u0026 Unit Tests\n\n.. |artefacts| image:: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/configuration-artifacts.yml/badge.svg\n    :target: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/configuration-artifacts.yml\n    :alt: Configuration Artifacts\n\n.. end-badges\n\nThe `OpenColorIO Configuration for ACES \u003chttps://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES\u003e`__\nis an open-source `Python \u003chttps://www.python.org\u003e`__ package implementing\nsupport for the generation of the *OCIO* configurations for the\n`Academy Color Encoding System \u003chttps://www.oscars.org/science-technology/sci-tech-projects/aces\u003e`__\n(ACES).\n\nIt is freely available under the\n`New BSD License \u003chttps://opensource.org/licenses/BSD-3-Clause\u003e`__ terms.\n\n.. contents:: **Table of Contents**\n    :backlinks: none\n    :depth: 2\n\n.. sectnum::\n\nFeatures\n--------\n\nThe following features are available:\n\n-   Automatic *OCIO* **Reference** configuration generation for *aces-dev*\n    *CTL* reference implementation.\n\n    -   Discovery of *aces-dev* *CTL* transforms.\n    -   Generation of the *CTL* transforms graph.\n    -   `Spreadsheet \u003chttps://docs.google.com/spreadsheets/d/1z3xsy3sF0I-8AN_tkMOEjHlAs13ba7VAVhrE8v4WIyo\u003e`__-driven generation.\n\n-   Generators producing the *OCIO* **CG** and **Studio** configurations.\n    -   `Spreadsheet \u003chttps://docs.google.com/spreadsheets/d/1PXjTzBVYonVFIceGkLDaqcEJvKR6OI63DwZX0aajl3A\u003e`__-driven generation.\n\n-   Included *CLF* transforms along with generator and discovery support.\n\nUser Guide\n----------\n\nInstallation\n^^^^^^^^^^^^\n\nCloning the Repository\n~~~~~~~~~~~~~~~~~~~~~~\n\nThe *OpenColorIO Configuration for ACES* repository uses `Git submodules \u003chttps://git-scm.com/book/en/v2/Git-Tools-Submodules\u003e`__\nthus cloning the repository requires initializing them::\n\n    git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git\n\nIf you have already cloned the repository and forgot the ``--recursive``\nargument, it is possible to initialize the submodules as follows::\n\n    git submodule update --init --recursive\n\nuv\n~~\n\nThe *OpenColorIO Configuration for ACES* repository adopts `uv \u003chttps://github.com/astral-sh/uv\u003e`__\nto help managing its dependencies, this is the recommended way to get started\nwith development.\n\nAssuming `python \u003e= 3.10 \u003chttps://www.python.org/download/releases\u003e`__ is\navailable on your system along with `OpenColorIO \u003chttps://opencolorio.org\u003e`__,\nthe development dependencies are installed with `uv \u003chttps://github.com/astral-sh/uv\u003e`__\nas follows::\n\n    git clone --recursive https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES.git\n    cd OpenColorIO-Config-ACES\n    uv sync --all-extras\n\nThe *aces-dev* *CTL* reference graph can be plotted but it requires `Graphviz \u003chttps://graphviz.org\u003e`__\nto be installed on the system.\n\nDocker\n~~~~~~\n\nInstalling the dependencies for the `previous config generator \u003chttps://github.com/imageworks/OpenColorIO-Configs\u003e`__\nwas not a trivial task. For ease of use an `aswf-docker \u003chttps://github.com/AcademySoftwareFoundation/aswf-docker\u003e`__\nbased container is now available.\n\nCreating the container from the `Dockerfile \u003chttps://docs.docker.com/engine/reference/builder\u003e`__\nis done as follows::\n\n    docker build -t aswf/opencolorio-config-aces:latest .\n\nor alternatively, if the dependencies described in the next section are\nsatisfied::\n\n    invoke docker build\n\nThen, to run *bash* in the container::\n\n    docker run -it -v ${PWD}:/home/aswf/OpenColorIO-Config-ACES aswf/opencolorio-config-aces:latest /bin/bash\n\nPypi\n~~~~\n\nThe **OpenColorIO Configuration for ACES** package requires various\ndependencies in order to run and be able to generate the *OCIO* configurations:\n\nPrimary Dependencies\n~~~~~~~~~~~~~~~~~~~~\n\n- `python \u003e= 3.10, \u003c 3.14 \u003chttps://www.python.org/download/releases\u003e`__\n- `opencolorio \u003chttps://pypi.org/project/opencolorio\u003e`__\n- `requests \u003chttps://pypi.org/project/requests\u003e`__\n- `semver \u003chttps://pypi.org/project/semver\u003e`__\n\nOptional Dependencies\n~~~~~~~~~~~~~~~~~~~~~\n\n- `colour-science \u003chttps://pypi.org/project/colour-science\u003e`__\n- `graphviz \u003chttps://www.graphviz.org\u003e`__\n- `jsonpickle \u003chttps://jsonpickle.github.io\u003e`__\n- `networkx \u003chttps://pypi.org/project/networkx\u003e`__\n- `pydot \u003chttps://pypi.org/project/pydot\u003e`__\n\nDocs Dependencies\n~~~~~~~~~~~~~~~~~\n\n- `pydata-sphinx-theme \u003chttps://pypi.org/project/pydata-sphinx-theme\u003e`__\n- `sphinx \u003chttps://pypi.org/project/sphinx\u003e`__\n\nDevelopment Dependencies\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- `coverage \u003chttps://pypi.org/project/coverage\u003e`__\n- `coveralls \u003chttps://pypi.org/project/coveralls\u003e`__\n- `hatch \u003chttps://pypi.org/project/hatch\u003e`__\n- `invoke \u003chttps://pypi.org/project/invoke\u003e`__\n- `pre-commit \u003chttps://pypi.org/project/pre-commit\u003e`__\n- `pyright \u003chttps://pypi.org/project/pyright\u003e`__\n- `pytest \u003chttps://pypi.org/project/pytest\u003e`__\n- `pytest-cov \u003chttps://pypi.org/project/pytest-cov\u003e`__\n- `pytest-xdist \u003chttps://pypi.org/project/pytest-xdist\u003e`__\n\nComponents Status\n^^^^^^^^^^^^^^^^^\n\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Component                     | Status         | Notes                                                                            |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| *aces-dev* Discovery          | Complete       | Minor updates might be required when *aces-dev* is updated.                      |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Common Config Generator       | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| *Reference* Config Generation | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| *CG* Config Generation        | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Custom Config Generation      | In-Progress    | We are designing the components so that one can generate a custom *ACES* config. |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| *Studio* Config Generation    | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| *CLF* Transforms Discovery    | Complete       | Minor updates will be required if classification changes.                        |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| *CLF* Transforms Generation   | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Public API Surfacing          | In-Progress    | What is part of the Public API is not well defined currently.                    |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Unit Tests                    | In-Progress    |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| API Documentation             | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Continuous Integration        | Complete       |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| CLI                           | In-Progress    |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Containerisation              | Complete       | Minor updates will be required as the CLI evolves.                               |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n| Pypi Package                  | Unavailable    |                                                                                  |\n+-------------------------------+----------------+----------------------------------------------------------------------------------+\n\nUsage\n^^^^^\n\nTasks\n~~~~~\n\nVarious tasks are currently exposed via `invoke \u003chttps://pypi.org/project/invoke\u003e`__.\n\nThis is currently the recommended way to build the configuration until a\ndedicated CLI is provided.\n\nListing the tasks is done as follows::\n\n    invoke --list\n\nReference Config\n****************\n\n+-----------------------+----------------------------------------------+\n| Task                  | Command                                      |\n+-----------------------+----------------------------------------------+\n| Build                 | ``invoke build-config-reference``            |\n+-----------------------+----------------------------------------------+\n| Build (Docker)        | ``invoke docker-run-build-config-reference`` |\n+-----------------------+----------------------------------------------+\n| Updating Mapping File | ``invoke update-mapping-file-reference``     |\n+-----------------------+----------------------------------------------+\n\nCG Config\n*********\n\n+-----------------------+---------------------------------------+\n| Task                  | Command                               |\n+-----------------------+---------------------------------------+\n| Build                 | ``invoke build-config-cg``            |\n+-----------------------+---------------------------------------+\n| Build (Docker)        | ``invoke docker-run-build-config-cg`` |\n+-----------------------+---------------------------------------+\n| Updating Mapping File | ``invoke update-mapping-file-cg``     |\n+-----------------------+---------------------------------------+\n\nStudio Config\n*************\n\n+-----------------------+-------------------------------------------+\n| Task                  | Command                                   |\n+-----------------------+-------------------------------------------+\n| Build                 | ``invoke build-config-studio``            |\n+-----------------------+-------------------------------------------+\n| Build (Docker)        | ``invoke docker-run-build-config-studio`` |\n+-----------------------+-------------------------------------------+\n| Updating Mapping File | ``invoke update-mapping-file-studio``     |\n+-----------------------+-------------------------------------------+\n\nAPI Reference\n-------------\n\nThe main technical reference for `OpenColorIO Configuration for ACES \u003chttps://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES\u003e`__\nis the `API Reference \u003chttps://opencolorio-config-aces.readthedocs.io\u003e`__.\n\nAbout\n-----\n\n| **OpenColorIO Configuration for ACES** by OpenColorIO Contributors\n| Copyright Contributors to the OpenColorIO Project – `ocio-dev@lists.aswf.io \u003cocio-dev@lists.aswf.io\u003e`__\n| This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause\n| `https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES \u003chttps://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES\u003e`__\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facademysoftwarefoundation%2Fopencolorio-config-aces","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facademysoftwarefoundation%2Fopencolorio-config-aces","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facademysoftwarefoundation%2Fopencolorio-config-aces/lists"}