Skip to content

Commit ebd5df1

Browse files
KelSolaarKelSolaar
authored
PR: Studio Config Generator (#59)
* Improve "Config" vs "config" usage consistency. Signed-off-by: Thomas Mansencal <[email protected]> * Implement initial support for "Studio" config generator. Signed-off-by: Thomas Mansencal <[email protected]> * Implement support for straightforward update of the config mapping files. Signed-off-by: Thomas Mansencal <[email protected]> * Implement support for "BuiltinTransform" from "CG" and "Studio" config mapping files. Signed-off-by: Thomas Mansencal <[email protected]> * Varnish "CLF" transforms generation code. - Ensure that all the "CLF" transforms are discovered and classified. - Ensure that all the module can be imported from base namespace. - Improve implementation consistency refactor access to common attributes. - Ensure that relevant definitions have a return value. - Improve documentation. - Refactor tasks. Signed-off-by: Thomas Mansencal <[email protected]> * Use more internal "CLF" data to generate colorspace names. Improve overall code and documentation consistency across the board. Improve transform names consistency across the board. Use factories to produce "CLF" transforms to benefit from logging. Signed-off-by: Thomas Mansencal <[email protected]> * Implement initial support for programmatic alias generation. Signed-off-by: Thomas Mansencal <[email protected]> * Update "pyproject.toml" file. Signed-off-by: Thomas Mansencal <[email protected]> * Update "README.rst" and docs. Signed-off-by: Thomas Mansencal <[email protected]> * Raise package version to 0.3.0. Signed-off-by: Thomas Mansencal <[email protected]>
1 parent f8954ee commit ebd5df1

File tree

83 files changed

+2848
-1046
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+2848
-1046
lines changed

‎.github/workflows/configuration-artifacts.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,12 @@ jobs:
8484
name: config-cg
8585
path: |
8686
build/config/aces/cg/
87+
- name: Generation - Config - ACES Studio
88+
run: |
89+
poetry run invoke build-config-studio
90+
shell: bash
91+
- uses: actions/upload-artifact@v2
92+
with:
93+
name: config-studio
94+
path: |
95+
build/config/aces/studio/

‎README.rst‎

Lines changed: 52 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,19 @@
55
OpenColorIO Configuration for ACES
66
==================================
77

8-
.. image:: https://via.placeholder.com/720x320.png?text=WARNING: This+repository+is+under+construction!
8+
.. start-badges
9+
10+
|actions| |artefacts|
11+
12+
.. |actions| image:: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/continuous-integration-quality-unit-tests.yml/badge.svg
13+
:target: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/continuous-integration-quality-unit-tests.yml
14+
:alt: Continuous Integration - Quality & Unit Tests
15+
16+
.. |artefacts| image:: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/configuration-artifacts.yml/badge.svg
17+
:target: https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/actions/workflows/configuration-artifacts.yml
18+
:alt: Configuration Artifacts
19+
20+
.. end-badges
921
1022
The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/>`__
1123
is an open-source `Python <https://www.python.org/>`__ package implementing
@@ -33,8 +45,7 @@ The following features are available:
3345
- Discovery of *aces-dev* *CTL* transforms.
3446
- Generation of the *CTL* transforms graph.
3547

36-
- Configurable generator producing the *OCIO* **CG** and **Studio**
37-
configurations.
48+
- Generators producing the *OCIO* **CG** and **Studio** configurations.
3849
- Included *CLF* transforms along with generator and discovery support.
3950

4051
User Guide
@@ -194,22 +205,44 @@ Listing the tasks is done as follows::
194205

195206
invoke --list
196207

197-
Assuming the dependencies are satisfied, the task to build the **Reference**
198-
configuration is::
199-
200-
invoke build-config-reference
201-
202-
Alternatively, with the docker container built::
203-
204-
invoke docker-run-build-config-reference
205-
206-
Likewise, for the **CG** configuration::
207-
208-
invoke build-config-cg
209-
210-
Or::
211-
212-
invoke docker-run-build-config-cg
208+
Reference Config
209+
****************
210+
211+
+-----------------------+--------------------------------------------+
212+
| Task | Command |
213+
+-----------------------+--------------------------------------------+
214+
| Build | `invoke build-config-reference` |
215+
+-----------------------+--------------------------------------------+
216+
| Build (Docker) | `invoke docker-run-build-config-reference` |
217+
+-----------------------+--------------------------------------------+
218+
| Updating Mapping File | `invoke update-mapping-file-reference` |
219+
+-----------------------+--------------------------------------------+
220+
221+
CG Config
222+
*********
223+
224+
+-----------------------+-------------------------------------+
225+
| Task | Command |
226+
+-----------------------+-------------------------------------+
227+
| Build | `invoke build-config-cg` |
228+
+-----------------------+-------------------------------------+
229+
| Build (Docker) | `invoke docker-run-build-config-cg` |
230+
+-----------------------+-------------------------------------+
231+
| Updating Mapping File | `invoke update-mapping-file-cg` |
232+
+-----------------------+-------------------------------------+
233+
234+
Reference Config
235+
****************
236+
237+
+-----------------------+-----------------------------------------+
238+
| Task | Command |
239+
+-----------------------+-----------------------------------------+
240+
| Build | `invoke build-config-studio` |
241+
+-----------------------+-----------------------------------------+
242+
| Build (Docker) | `invoke docker-run-build-config-studio` |
243+
+-----------------------+-----------------------------------------+
244+
| Updating Mapping File | `invoke update-mapping-file-studio` |
245+
+-----------------------+-----------------------------------------+
213246

214247
API Reference
215248
-------------

‎docs/_static/Logo_Medium_001.png‎

-32.4 KB
Binary file not shown.

‎docs/_static/Logo_Small_001.png‎

-6.65 KB
Binary file not shown.

‎docs/conf.py‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@
6565
},
6666
],
6767
}
68-
html_logo = "_static/Logo_Small_001.png"
6968
html_static_path = ["_static"]
7069
htmlhelp_basename = f"{basename}Doc"
7170

@@ -88,7 +87,6 @@
8887
"manual",
8988
),
9089
]
91-
latex_logo = "_static/Logo_Medium_001.png"
9290

9391
# -- Options for manual page output ---------------------------------------
9492
man_pages = [

‎docs/index.rst‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
OpenColorIO Configuration for ACES
66
==================================
77

8-
.. image:: https://via.placeholder.com/720x320.png?text=WARNING: This+repository+is+under+construction!
9-
108
The `OpenColorIO Configuration for ACES <https://github.com/AcademySoftwareFoundation/OpenColorIO-Config-ACES/>`__
119
is an open-source `Python <https://www.python.org/>`__ package implementing
1210
support for the generation of the *OCIO* configurations for the
@@ -29,8 +27,7 @@ The following features are available:
2927
- Discovery of *aces-dev* *CTL* transforms.
3028
- Generation of the *CTL* transforms graph.
3129

32-
- Configurable generator producing the *OCIO* **CG** and **Studio**
33-
configurations.
30+
- Generators producing the *OCIO* **CG** and **Studio** configurations.
3431
- Included *CLF* transforms along with generator and discovery support.
3532

3633
User Guide

‎docs/opencolorio_config_aces.clf.rst‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,21 @@ Common LUT Format Generation
2828
.. autosummary::
2929
:toctree: generated/
3030

31-
generate_clf
31+
generate_clf_transform
32+
33+
**Ancillary Objects**
34+
35+
``opencolorio_config_aces.clf``
36+
37+
.. currentmodule:: opencolorio_config_aces.clf
38+
39+
.. autosummary::
40+
:toctree: generated/
41+
42+
generate_clf_transforms_bmdfilm
43+
generate_clf_transforms_davinci
44+
generate_clf_transforms_itu
45+
generate_clf_transforms_ocio
46+
generate_clf_transforms_utility
47+
generate_clf_transforms_panasonic
48+
generate_clf_transforms_red

‎docs/opencolorio_config_aces.config.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ Factories
3737
named_transform_factory
3838
produce_transform
3939
transform_factory
40-
transform_factory_clf_transform_to_group_transform
41-
transform_factory_default
4240
view_transform_factory
4341

4442
Reference Configuration
@@ -113,3 +111,5 @@ Reference Configuration
113111

114112
.. autosummary::
115113
:toctree: generated/
114+
115+
generate_config_studio

‎docs/opencolorio_config_aces.utilities.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,6 @@ Common
3333
matrix_3x3_to_4x4
3434
multi_replace
3535
regularise_version
36-
validate_method
36+
validate_method
37+
google_sheet_title
38+
slugify

‎docs/usage.rst‎

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,41 @@ Listing the tasks is done as follows::
1717

1818
invoke --list
1919

20-
Assuming the dependencies are satisfied, the task to build the **Reference**
21-
configuration is::
22-
23-
invoke build-config-reference
24-
25-
Alternatively, with the docker container built::
26-
27-
invoke docker-run-build-config-reference
28-
29-
Likewise, for the **CG** configuration::
30-
31-
invoke build-config-cg
32-
33-
Or::
34-
35-
invoke docker-run-build-config-cg
20+
Reference Config
21+
****************
22+
23+
+-----------------------+--------------------------------------------+
24+
| Task | Command |
25+
+-----------------------+--------------------------------------------+
26+
| Build | `invoke build-config-reference` |
27+
+-----------------------+--------------------------------------------+
28+
| Build (Docker) | `invoke docker-run-build-config-reference` |
29+
+-----------------------+--------------------------------------------+
30+
| Updating Mapping File | `invoke update-mapping-file-reference` |
31+
+-----------------------+--------------------------------------------+
32+
33+
CG Config
34+
*********
35+
36+
+-----------------------+-------------------------------------+
37+
| Task | Command |
38+
+-----------------------+-------------------------------------+
39+
| Build | `invoke build-config-cg` |
40+
+-----------------------+-------------------------------------+
41+
| Build (Docker) | `invoke docker-run-build-config-cg` |
42+
+-----------------------+-------------------------------------+
43+
| Updating Mapping File | `invoke update-mapping-file-cg` |
44+
+-----------------------+-------------------------------------+
45+
46+
Reference Config
47+
****************
48+
49+
+-----------------------+-----------------------------------------+
50+
| Task | Command |
51+
+-----------------------+-----------------------------------------+
52+
| Build | `invoke build-config-studio` |
53+
+-----------------------+-----------------------------------------+
54+
| Build (Docker) | `invoke docker-run-build-config-studio` |
55+
+-----------------------+-----------------------------------------+
56+
| Updating Mapping File | `invoke update-mapping-file-studio` |
57+
+-----------------------+-----------------------------------------+

0 commit comments

Comments
 (0)