deadline-cloud-for-houdini 0.7.4

AWS Deadline Cloud for Houdini

AWS Deadline Cloud for Houdini

AWS Deadline Cloud for Houdini is a Python package that supports creating and running SideFX Houdini jobs within AWS Deadline Cloud. It provides both the implementation of a Houdini plug-in for your workstation that helps you offload the computation for your rendering workloads to AWS Deadline Cloud to free up your workstation's compute for other tasks, and the implementation of a command-line adaptor application based on the Open Job Description (OpenJD) Adaptor Runtime that improves AWS Deadline Cloud's ability to run Houdini efficiently on your render farm.

Compatibility

This library requires:

1. Houdini 19.5, 20.0 or 20.5
2. Python 3.9 or higher; and
3. Linux, Windows, or a macOS operating system.

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.

Getting Started

This Houdini integration for AWS Deadline Cloud has two components that you will need to install:

1. The Houdini submitter plug-in must be installed on the workstation that you will use to submit jobs; and
2. The Houdini adaptor must be installed on all of your AWS Deadline Cloud worker hosts that will be running the Houdini jobs that you submit.

Before submitting any large, complex, or otherwise compute-heavy Houdini render jobs to your farm using the submitter and adaptor that you set up, we strongly recommend that you construct a simple test scene that can be rendered quickly and submit renders of that scene to your farm to ensure that your setup is correctly functioning.

Houdini Submitter Plug-in

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

To install the submitter plug-in, refer to DEVELOPMENT.md section Submitter Development Workflow. Also refer to Deadline Cloud's documentation on how to launch and use the Houdini submitter after installation.

Houdini Adaptor

The Houdini Adaptor implements the OpenJD interface that allows render workloads to launch Houdini 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

To install, test and use a custom Houdini Adaptor, refer to DEVELOPMENT.md section Application Interface Adaptor Development Workflow

Jobs on Deadline Cloud created by the submitter use a released version of this adaptor by default.

If you are using the default Queue Environment, or an equivalent, to run your jobs, then the released build of this adaptor will be automatically made available to your job. Otherwise, you will need to install the adaptor.

The release build of the Houdini adaptor can be installed by the standard python packaging mechanisms:

$ pip install deadline-cloud-for-houdini

After installation, test that it has been installed properly by running the following as the same user that runs your jobs and that houdini can be run as the same user:

$ houdini-openjd --help

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

Houdini Software Availability in AWS Deadline Cloud Service Managed Fleets

You will need to ensure that the version of Houdini that you want to run is available on the worker host when you are using AWS Deadline Cloud's Service Managed Fleets to run jobs; hosts do not have any rendering applications pre-installed. The standard way of accomplishing this is described in the service documentation. You can find a list of the versions of Houdini that are available by default in the user guide if you are using the default Conda queue enivonment in your setup.

Viewing the Job Bundle that will be submitted

To submit a job, the submitter first generates a Job Bundle, and then uses functionality from the Deadline package to submit the Job Bundle to your render farm to run. If you would like to see the job that will be submitted to your farm, then you can use the "Export Bundle" button in the submitter to export the Job Bundle to a location of your choice. If you want to submit the job from the export, rather than through the submitter plug-in then you can use the Deadline Cloud application to submit that bundle to your farm.

Security

We take all security reports seriously. When we receive such reports, we will investigate and subsequently address any potential vulnerabilities as quickly as possible. If you discover a potential security issue in this project, please notify AWS/Amazon Security via our vulnerability reporting page or directly via email to AWS Security. Please do not create a public GitHub issue in this project.

Telemetry

See telemetry for more information.

License

This project is licensed under the Apache-2.0 License.