Replaced misnamed 'ST 2048' references to 'ST 2084'.
[OpenColorIO-Configs.git] / aces_1.0.1 / README.md
index e9d7bc5..5da0bad 100644 (file)
@@ -1,4 +1,4 @@
-ACES 1.0.0 OpenColorIO configuration
+ACES 1.0.1 OpenColorIO configuration
 =
 
 Informations about ACES
@@ -23,74 +23,100 @@ For ease of use across a broader number of applications, the family name of each
 
 ### ACES
 
-- Colorspaces
-       - ACES2065-1
-       - ACEScc
-       - ACESproxy
-       - ACEScg
+##### Colorspaces
 
-- Description: Colorspaces and transforms representing the core ACES working and interchange color spaces.
+- ACES2065-1
+- ACEScc
+- ACESproxy
+- ACEScg
 
-- Technical information: Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
+##### Description
+
+Colorspaces and transforms representing the core ACES working and interchange colorspaces.
+
+##### Technical information
+
+Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
 
 ### ADX
 
-- Colorspaces
-       - ADX10
-       - ADX16
+##### Colorspaces
+
+- ADX10
+- ADX16
 
-- Description: Colorspaces and transforms representing the ACES ADX spaces used for film scanning and printing.
+##### Description
 
-- Technical information: Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
-       - [Alex Fry's ACES 0.7.1 OCIO config](https://github.com/imageworks/OpenColorIO-Configs/tree/master/aces_0.7.1) was also a valuable resource.
+Colorspaces and transforms representing the ACES ADX spaces used for film scanning and printing.
+
+##### Technical information
+
+- Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
+- [Alex Fry's ACES 0.7.1 OCIO config](https://github.com/imageworks/OpenColorIO-Configs/tree/master/aces_0.7.1) was also a valuable resource.
 
 ### Look
 
-- Colorspaces
-       - ACES 1.0 to 0.1 emulation
-       - ACES 1.0 to 0.2 emulation
-       - ACES 1.0 to 0.7 emulation
+##### Colorspaces
+
+- ACES 1.0 to 0.1 emulation
+- ACES 1.0 to 0.2 emulation
+- ACES 1.0 to 0.7 emulation
 
-- Description: Colorspaces and transforms emulating the look of the ACES 0.1, 0.2 and 0.7 release.
-       - Should be applied to data in the ACES2065-1 colorspace.
-       - Should be used before an ACES Output Transform
+##### Description
 
-- Technical information: Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
+Colorspaces and transforms emulating the look of the ACES 0.1, 0.2 and 0.7 release.
+
+- Should be applied to data in the ACES2065-1 colorspace.
+- Should be used before an ACES Output Transform.
+
+##### Technical information
+
+Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
 
 ### Output
 
-- Colorspaces
-       - sRGB (D60 sim.)
-       - Rec.709
-       - Rec.709 (D60 sim.)
-       - Rec.2020
-       - Rec.2020 ST2048 (1000 nits)
-       - DCDM (P3 gamut clip)
-       - DCDM
-       - P3-D60 ST2048 (1000 nits)
-       - P3-D60 ST2048 (2000 nits)
-       - P3-D60 ST2048 (4000 nits)
-       - P3-D60
-       - P3-DCI
-
-- Description: Colorspaces and transforms implementing the ACES Output Transforms. These colorspaces produce code values ready for display on hardware devices calibrated to the standard used to name the colorspace.
-
-- Technical information
-       - Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
-       - All transforms produce full-range output. Host applications should be used to apply an full-to-legal scaling needed.
+##### Colorspaces
+
+- sRGB (D60 sim.)
+- Rec.709
+- Rec.709 (D60 sim.)
+- Rec.2020
+- Rec.2020 ST2048 (1000 nits)
+- DCDM (P3 gamut clip)
+- DCDM
+- P3-D60 ST2048 (1000 nits)
+- P3-D60 ST2048 (2000 nits)
+- P3-D60 ST2048 (4000 nits)
+- P3-D60
+- P3-DCI
+
+##### Description
+
+Colorspaces and transforms implementing the ACES Output Transforms. These colorspaces produce code values ready for display on hardware devices calibrated to the standard used to name the colorspace.
+
+##### Technical information
+- Transforms generated based on the [ACES CTL Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl)
+- All transforms produce full-range output. Host applications should be used to apply an full-to-legal scaling needed.
 
 ### Input
 
-- Description: Colorspaces and transforms that implement the ACES Input Transforms. These colorspaces are used to convert from camera-specific formats and encodings to ACES.
-- Colorspaces: There are a variety of Input Transforms covering different cameras manufacturers, gamuts, transfer functions and camera settings. See below for specifics.
+##### Colorspaces
 
-- Technical information: References and descriptions are provided for each group of Input Transforms below.
-       - The colorspaces whose names include a transfer function and a gamut name are full implementations of ACES Input Transforms.
-               - Ex. The ARRI 'V3 LogC (EI160) - Wide Gamut' colorspace
-               - Ex. The RED 'REDlogFilm - DRAGONcolor2' colorspace
-               - Ex. The Canon 'Canon-Log - DCI-P3 Daylight' colorspace
-       - The colorspaces that start with "Linear - " will convert to or from a specific gamut but not apply a transfer function.
-       - The colorspaces that start with "Curve - " will apply a transfer function but not convert between gamuts.
+There are a variety of Input Transforms covering different cameras manufacturers, gamuts, transfer functions and camera settings. See below for specifics.
+
+##### Description
+
+Colorspaces and transforms that implement the ACES Input Transforms. These colorspaces are used to convert from camera-specific formats and encodings to ACES.
+
+##### Technical information
+
+References and descriptions are provided for each group of Input Transforms below.
+- The colorspaces whose names include a transfer function and a gamut name are full implementations of ACES Input Transforms.
+       - Ex. The ARRI 'V3 LogC (EI160) - Wide Gamut' colorspace
+       - Ex. The RED 'REDlogFilm - DRAGONcolor2' colorspace
+       - Ex. The Canon 'Canon-Log - DCI-P3 Daylight' colorspace
+- The colorspaces that start with 'Linear - ' will convert to or from a specific gamut but not apply a transfer function.
+- The colorspaces that start with 'Curve - ' will apply a transfer function but not convert between gamuts.
 
 #### ARRI
 - [ARRI Input Transforms](https://github.com/ampas/aces-dev/tree/v1.0/transforms/ctl/idt/vendorSupplied/arri/alexa)
@@ -123,46 +149,56 @@ For ease of use across a broader number of applications, the family name of each
 
 ### Utility
 
-- Description: A collection of colorspaces that are used to facilitate the creation of LUTs and other basic functionality.
+##### Description
 
-- Technical information:
-       - The 'Log2 xx nits Shaper' and 'Dolby PQ xx nits Shaper' spaces cover the linear range centered around 18% grey. The 48 nits spaces cover -6.5 stops (0.0028125) to +6.5 stops(16.291740). The 1000 nits spaces cover -12 stops to +10 stops. The 2000 nits spaces cover -12 stops to +11 stops. The 4000 nits spaces cover -12 stops to +12 stops.
-       - The LMT shaper spaces cover the linear range going from 10 stops below 18% grey (0.00017578125) to 6.5 stops above 18% grey (16.291740)
-       - The colorspaces that start with "Linear - " will convert to or from a specific gamut but not apply a transfer function.
-       - The colorspaces that start with "Curve - " will apply a transfer function but not convert between gamuts.
+A collection of colorspaces that are used to facilitate the creation of LUTs and other basic functionality.
+
+##### Technical information
+
+- The 'Log2 xx nits Shaper' and 'Dolby PQ xx nits Shaper' spaces cover the linear range centered around 18% grey. The 48 nits spaces cover -6.5 stops (0.0028125) to +6.5 stops(16.291740). The 1000 nits spaces cover -12 stops to +10 stops. The 2000 nits spaces cover -12 stops to +11 stops. The 4000 nits spaces cover -12 stops to +12 stops.
+- The LMT shaper spaces cover the linear range going from 10 stops below 18% grey (0.00017578125) to 6.5 stops above 18% grey (16.291740)
+- The colorspaces starting with 'Linear - ' will convert to or from a specific gamut but not apply a transfer function.
+- The colorspaces starting with 'Curve - ' will apply a transfer function but not convert between gamuts.
 
 ### Roles
 
-- Description: The role colorspaces are aliases to the colorspaces used for the OCIO 'roles' functionality.
+##### Description
+
+The role colorspaces are aliases to the colorspaces used for the *OCIO* 'roles' functionality.
 
 ### Aliases
 
-- Description: The alias colorspaces are named with all lower-case letters and no spaces, dashes, parentheses or other characters that would not work well in a filename. They are only references, aliases for the base colorspaces with more user-friendly names. These spaces were added to enable OCIO's token-based colorspace / filename matching.
-       - These colorspaces should not generally be used by most artists.
+##### Description
+
+The alias colorspaces are named with all lower-case letters and no spaces, dashes, parentheses or other characters that would not work well in a filename. They are only references, aliases for the base colorspaces with more user-friendly names. These spaces were added to enable OCIO's token-based colorspace / filename matching.
+
+- These colorspaces should not generally be used by most artists.
 
 
 Roles
 -
-The standard OCIO roles are defined. They role assignments are:
-
-- color_picking: Output - Rec.709
-- color_timing: ACEScc
-- compositing_log: ACEScc
-- data: Raw
-- default: ACES2065-1
-- matte_paint: ACEScc
-- reference: Raw
-- scene_linear: ACEScg
-- texture_paint: Raw
+
+The standard *OCIO* roles are defined. They role assignments are:
+
+- **color_picking**: Output - Rec.709
+- **color_timing**: ACEScc
+- **compositing_log**: ACEScc
+- **data**: Raw
+- **default**: ACES2065-1
+- **matte_paint**: ACEScc
+- **reference**: Raw
+- **scene_linear**: ACEScg
+- **texture_paint**: Raw
 
 Additionally, a number of colorspaces that are gaining wider adoption have been added to the config. Their names and assignment are:
 
-- compositing_linear: ACEScg
-- rendering: ACEScg
+- **compositing_linear**: ACEScg
+- **rendering**: ACEScg
 
 
 Displays and Views
 -
+
 The default config has one Display named **ACES**, which contains the following Views / colorspaces:
 
 - sRGB D60 sim., colorspace: sRGB (D60 sim.)
@@ -180,7 +216,7 @@ The default config has one Display named **ACES**, which contains the following
 - Raw, colorspace: Raw
 - Log, colorspace: ACEScc
 
-Considerations for custom config generation
+Considerations for custom config generation:
 
 - The choice of a single Display and many Views may not align well with the implementation of OCIO in an application. 
        - If you would like to generate a config that contains multiple Displays, with a small number of Views for each, review the config generation script's '--createMultipleDisplays' option.
@@ -194,10 +230,10 @@ LUTs
 The default resolution is 33x33x33 for the 3D LUTs and 1024 for the 1D LUTs. 
 
 ### OCIO LUTs
-The LUTs used internally by OCIO can be can be retrieved [from the repository here.](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.0/luts) 
+The LUTs used internally by OCIO can be can be retrieved [from the repository here.](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.1/luts) 
 
 ### Baked LUTs
-LUTs that can be used outside of OCIO are included in the ['baked' directory here.](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.0/baked)
+LUTs that can be used outside of OCIO are included in the ['baked' directory here.](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.1/baked)
 
 - The LUTs encode the ACES Output Transform for a specific colorspace input and are generally named:
        - 'Ouput Transform name' for 'Input colorspace name'.extension
@@ -216,9 +252,9 @@ Generating Configurations
 -
 
 ### Python
-Configurations can be generated by the following *Python* package: [aces_1.0.0/python](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.0/python)
+Configurations can be generated by the following *Python* package: [aces_1.0.1/python](https://github.com/hpd/OpenColorIO-Configs/tree/master/aces_1.0.1/python)
 
-Usage is described on the command line and in the package root [\_\_init__.py](https://github.com/hpd/OpenColorIO-Configs/blob/master/aces_1.0.0/python/aces_ocio/__init__.py) file.
+Usage is described on the command line and in the package root [\_\_init__.py](https://github.com/hpd/OpenColorIO-Configs/blob/master/aces_1.0.1/python/aces_ocio/__init__.py) file.
 
 Features exposed for customization by the user include: 
 
@@ -228,13 +264,15 @@ Features exposed for customization by the user include:
 - Selection of shaper function: Log2 or Dolby PQ
 
 ### CTL Source
-The configuration depends on the **1.0.1 ACES CTL**. The release contains a number of minor bug fixes and small additions in the utilities folder but is otherwise the same as the master ACES 1.0 release. 
+The configuration depends on the **ACES 1.0.1 + Hotfixes CTL**. The release contains a number of minor bug fixes and small additions in the utilities folder but is otherwise the same as the master **ACES 1.0.1** release. 
+
+The CTL is available here:
+
+- https://github.com/ampas/aces-dev/tree/hotfixes/transforms/ctl
 
-The release is available here:
+Clone this repo using the following command:
 
-- https://github.com/ampas/aces-dev/tree/v1.0.1/transforms/ctl
-- Clone this repo using the following command
-       - git clone --branch v1.0.1 https://github.com/ampas/aces-dev.git
+- git clone --branch hotfixes https://github.com/ampas/aces-dev.git
 
 
 Dependencies