aces_1.0.1/python/aces_ocio/__init__.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 """
   5 ACES OCIO
   6 =========
   7
   8 Usage
   9 -----
  10
  11 Python
  12 ******
  13
  14 >>> from aces_ocio.generate_config import generate_config
  15 >>> aces_ctl_directory = '/path/to/github/checkout/releases/v1.0.1/transforms/ctl'
  16 >>> config_directory = '/path/to/configuration/dir'
  17 >>> generate_config(aces_ctl_directory, config_directory, 4096, 65, True)
  18
  19 Command Line
  20 ************
  21
  22 Using the *create_aces_config* binary:
  23
  24 $ create_aces_config -a '/path/to/github/checkout/releases/v1.0.1/transforms/ctl' -c '/path/to/config/dir' --lutResolution1d 4096 --lutResolution3d 65 --keepTempImages
  25
  26 It is possible to set the following environment variables to avoid passing
  27 the paths to the binary:
  28
  29 - *ACES_OCIO_CTL_DIRECTORY*
  30 - *ACES_OCIO_CONFIGURATION_DIRECTORY*
  31
  32 The above command line call would be done as follows:
  33
  34 $ create_aces_config --lutResolution1d 4096 --lutResolution3d 65 --keepTempImages
  35
  36 Testing the generated configuration is needs the
  37 *ACES_OCIO_CTL_DIRECTORY* environment variable to be set and is done as
  38 follows:
  39
  40 $ tests_aces_config
  41
  42 Build
  43 -----
  44
  45 Mac OS X - Required packages
  46 ****************************
  47
  48 OpenColorIO
  49 ___________
  50
  51 $ brew install -vd opencolorio --with-python
  52
  53 OpenImageIO
  54 ___________
  55
  56 $ brew tap homebrew/science
  57
  58 Optional Dependencies
  59 _____________________
  60
  61 $ brew install -vd libRaw
  62 $ brew install -vd OpenCV
  63 $ brew install -vd openimageio --with-python
  64
  65 CTL
  66 ___
  67
  68 $ brew install -vd CTL
  69
  70 OpenColorIO
  71 ___________
  72
  73 *ociolutimage* will build with *openimageio* installed.
  74
  75 $ brew uninstall -vd opencolorio
  76 $ brew install -vd opencolorio --with-python
  77 """
  78
  79 __author__ = 'ACES Developers'
  80 __copyright__ = 'Copyright (C) 2014 - 2015 - ACES Developers'
  81 __license__ = ''
  82 __maintainer__ = 'ACES Developers'
  83 __email__ = 'aces@oscars.org'
  84 __status__ = 'Production'
  85
  86 __major_version__ = '1'
  87 __minor_version__ = '0'
  88 __change_version__ = '1'
  89 __version__ = '.'.join((__major_version__,
  90                         __minor_version__,
  91                         __change_version__))