deadline-cloud-for-nuke 0.18.5

The submitter and adaptor to enable Nuke support for AWS Deadline Cloud

AWS Deadline Cloud for Nuke

AWS Deadline Cloud for Nuke is a python package that allows users to create AWS Deadline Cloud jobs from within Nuke. Using the Open Job Description (OpenJD) Adaptor Runtime this package also provides a command line application that adapts Nuke's command line interface to support the OpenJD specification.

Compatibility

This library requires:

1. Nuke 15,
2. Python 3.9 or higher; and
3. Linux, Windows, or a macOS operating system.

Submitter

This package provides a Nuke plugin that creates jobs for AWS Deadline Cloud using the AWS Deadline Cloud client library. Based on the loaded comp it determines the files required, allows the user to specify render options, and builds an OpenJD template that defines the workflow.

Getting Started

To install the submitter manually, you can use pip.

For Windows,

pip install deadline-cloud-for-nuke -t %USERPROFILE%/deadline-cloud-for-nuke

For Linux and MacOS:

pip install deadline-cloud-for-nuke -t ~/deadline-cloud-for-nuke

Please note that target directory is ~/deadline-cloud-for-nuke in Mac/Linux or C:\Users\username/deadline-cloud-for-nuke in Windows in the example, but you can choose any other directories that you'd prefer.

For Windows,

set NUKE_PATH=%NUKE_PATH%;%USERPROFILE%/deadline-cloud-for-nuke/deadline/nuke_submitter

For Linux and MacOS:

export NUKE_PATH=${NUKE_PATH}:~/deadline-cloud-for-nuke/deadline/nuke_submitter

After installation and within the same terminal, run Nuke<version> executable. The Nuke submitter should now be available in the AWS Deadline menu.

For Mac, Nuke executable will be somewhere in /Applications/Nuke15.0v4/Nuke15.0v4.app/Contents/MacOS directory.

NOTE: If you want the submitter available outside of this shell, consider using NUKE_PATH as an environment variable rather than a shell variable.

Adaptor

The Nuke Adaptor implements the OpenJD interface that allows render workloads to launch Nuke and feed it commands. This gives the following benefits:

• a standardized render application interface,
• sticky rendering, where the application stays open between tasks,
• path mapping, that enables cross-platform rendering

Jobs created by the submitter use this adaptor by default.

Getting Started

The adaptor can be installed by the standard python packaging mechanisms:

$ pip install deadline-cloud-for-nuke

After installation it can then be used as a command line tool:

$ nuke-openjd --help

For more information on the commands the OpenJD adaptor runtime provides, see here.

Versioning

This package's version follows Semantic Versioning 2.0, but is still considered to be in its initial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how versions will increment during this initial development stage, they are described below:

1. The MAJOR version is currently 0, indicating initial development.
2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API.
3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API.

Security

See CONTRIBUTING for more information.

Telemetry

See telemetry for more information.

License

This project is licensed under the Apache-2.0 License.