PageRenderTime 22ms CodeModel.GetById 14ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/index.rst

http://github.com/imageworks/OpenColorIO
ReStructuredText | 98 lines | 70 code | 28 blank | 0 comment | 0 complexity | 46bf1aba8f919becbc29b5640a6f9315 MD5 | raw file
 1..
 2  SPDX-License-Identifier: CC-BY-4.0
 3  Copyright Contributors to the OpenColorIO Project.
 4
 5Home
 6====
 7
 8OpenColorIO (OCIO) is a complete color management solution geared towards motion
 9picture production with an emphasis on visual effects and computer animation.
10OCIO provides a straightforward and consistent user experience across all
11supporting applications while allowing for sophisticated back-end configuration
12options suitable for high-end production usage. OCIO is compatible with the
13Academy Color Encoding Specification (ACES) and is LUT-format agnostic,
14supporting many popular formats.
15
16OpenColorIO is released as version 1.0 and has been in development since 2003.
17OCIO represents the culmination of years of production experience earned on such
18films as SpiderMan 2 (2004), Surf's Up (2007), Cloudy with a Chance of Meatballs
19(2009), Alice in Wonderland (2010), and many more. OpenColorIO is natively
20supported in commercial applications like Katana, Mari, Nuke, Silhouette FX, and
21others.
22
23.. _mailing_lists:
24
25Mailing Lists
26*************
27
28There are two mailing lists associated with OpenColorIO:
29
30`ocio-user <https://lists.aswf.io/g/ocio-user>`__\ ``@lists.aswf.io``
31    For end users (artists, often) interested in OCIO profile design,
32    facility color management, and workflow.
33
34`ocio-dev <https://lists.aswf.io/g/ocio-dev>`__\ ``@lists.aswf.io``
35    For developers interested OCIO APIs, code integration, compilation, etc.
36
37Quick Start
38***********
39
40Most users will likely want to use the OpenColorIO that comes precompiled with
41their applications.  See the :ref:`compatiblesoftware` for further details on
42each application.
43
44Note that OCIO configurations are required to do any 'real' work, and are
45available separately on the :ref:`downloads` section of this site. Example
46images are also available. For assistance customizing .ocio configurations,
47contact `ocio-user <https://lists.aswf.io/g/ocio-user>`__\.
48
49- Step 1:  set the OCIO environment-variable to /path/to/your/profile.ocio
50- Step 2:  Launch supported application.
51
52If you are on a platform that is not envvar friendly, most applications also
53provide a menu option to select a different OCIO configuration after launch.
54
55Please be sure to select a profile that matches your color workflow (VFX work
56typically requires a different profile than animated features). If you need
57assistance picking a profile, email 
58`ocio-user <https://lists.aswf.io/g/ocio-user>`__\.
59
60Downloading and Building the Code
61*********************************
62
63Source code is available on Github at
64http://github.com/AcademySoftwareFoundation/OpenColorIO
65
66Download a `.zip <http://github.com/AcademySoftwareFoundation/OpenColorIO/zipball/master>`_ or
67`.tar.gz <http://github.com/AcademySoftwareFoundation/OpenColorIO/tarball/master>`_ of the
68current state of the repository.
69
70Please see the :ref:`developer-guide` for more info, and contact `ocio-dev
71<https://lists.aswf.io/g/ocio-dev>`__\  with any questions.
72
73.. toctree::
74    :hidden:
75    :maxdepth: 2
76    
77    self
78    introduction
79    
80    configurations/index
81    installation
82    
83    userguide/index
84    
85    developers/index
86    
87    CompatibleSoftware
88    FAQ
89    downloads
90    
91    ChangeLog
92    License
93
94--------------------------------------------------------------------------------
95
96:ref:`search`
97
98:ref:`genindex`