# AWS Deadline Cloud for Houdini
[](https://pypi.python.org/pypi/deadline-cloud-for-houdini)
[](https://pypi.python.org/pypi/deadline-cloud-for-houdini)
[](https://github.com/aws-deadline/deadline-cloud-for-houdini/blob/mainline/LICENSE)
AWS Deadline Cloud for Houdini is a Python package that supports creating and running SideFX Houdini jobs within [AWS Deadline Cloud](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](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][openjd-adaptor-runtime] that improves AWS Deadline Cloud's
ability to run Houdini efficiently on your render farm.
[deadline-cloud]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/what-is-deadline-cloud.html
[deadline-cloud-client]: https://github.com/aws-deadline/deadline-cloud
[openjd]: https://github.com/OpenJobDescription/openjd-specifications/wiki
[openjd-adaptor-runtime]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python
[openjd-adaptor-runtime-lifecycle]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python/blob/release/README.md#adaptor-lifecycle
[service-managed-fleets]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/smf-manage.html
[default-queue-environment]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html#conda-queue-environment
## Compatibility
This library requires:
1. Houdini 19.5, 20.0 or 20.5
1. Python 3.9 or higher; and
1. Linux, Windows, or a macOS operating system.
## Versioning
This package's version follows [Semantic Versioning 2.0](https://semver.org/), 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][deadline-cloud-client]. Based on the loaded scene it determines the files required, allows the user to specify render options, and builds an [OpenJD template][openjd] that defines the workflow.
To install the submitter plug-in, refer to [DEVELOPMENT.md](DEVELOPMENT.md) section `Submitter Development Workflow`. Also refer to Deadline Cloud's [documentation](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html) on how to launch and use the Houdini submitter after installation.
[Houdini Render nodes (ROP)]: https://www.sidefx.com/docs/houdini/nodes/out/index.html
[deadline-cloud-monitor-setup]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html#install-deadline-cloud-monitor
[aws-cli-credentials]: https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-authentication.html
### Houdini Adaptor
The Houdini Adaptor implements the [OpenJD][openjd-adaptor-runtime] 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](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](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:
```sh
$ 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:
```sh
$ houdini-openjd --help
```
For more information on the commands the OpenJD adaptor runtime provides, see [here][openjd-adaptor-runtime-lifecycle].
### 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](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](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/provide-applications.html).
You can find a list of the versions of Houdini that are available by default
[in the user guide](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html#conda-queue-environment)
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](job-bundle), and then uses functionality from the
[Deadline](deadline-cloud-client) 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](deadline-cloud-client) to submit that bundle to your farm.
[job-bundle]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-bundle.html
## 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](http://aws.amazon.com/security/vulnerability-reporting/)
or directly via email to [AWS Security](aws-security@amazon.com). Please do not
create a public GitHub issue in this project.
## Telemetry
See [telemetry](https://github.com/aws-deadline/deadline-cloud-for-houdini/blob/release/docs/telemetry.md) for more information.
## License
This project is licensed under the Apache-2.0 License.
Raw data
{
"_id": null,
"home_page": null,
"name": "deadline-cloud-for-houdini",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e0/a8/d3e3b60443a68f22d7dcee6c57263be058d7f339644eeb32f7c91369953f/deadline_cloud_for_houdini-0.7.4.tar.gz",
"platform": null,
"description": "# AWS Deadline Cloud for Houdini\n\n[](https://pypi.python.org/pypi/deadline-cloud-for-houdini)\n[](https://pypi.python.org/pypi/deadline-cloud-for-houdini)\n[](https://github.com/aws-deadline/deadline-cloud-for-houdini/blob/mainline/LICENSE)\n\nAWS Deadline Cloud for Houdini is a Python package that supports creating and running SideFX Houdini jobs within [AWS Deadline Cloud](deadline-cloud).\nIt provides both the implementation of a Houdini plug-in for your workstation that helps you offload the computation for your rendering workloads\nto [AWS Deadline Cloud](deadline-cloud) to free up your workstation's compute for other tasks, and the implementation of a command-line\nadaptor application based on the [Open Job Description (OpenJD) Adaptor Runtime][openjd-adaptor-runtime] that improves AWS Deadline Cloud's\nability to run Houdini efficiently on your render farm.\n\n[deadline-cloud]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/what-is-deadline-cloud.html\n[deadline-cloud-client]: https://github.com/aws-deadline/deadline-cloud\n[openjd]: https://github.com/OpenJobDescription/openjd-specifications/wiki\n[openjd-adaptor-runtime]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python\n[openjd-adaptor-runtime-lifecycle]: https://github.com/OpenJobDescription/openjd-adaptor-runtime-for-python/blob/release/README.md#adaptor-lifecycle\n[service-managed-fleets]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/smf-manage.html\n[default-queue-environment]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html#conda-queue-environment\n\n## Compatibility\n\nThis library requires:\n\n1. Houdini 19.5, 20.0 or 20.5\n1. Python 3.9 or higher; and\n1. Linux, Windows, or a macOS operating system.\n\n## Versioning\n\nThis package's version follows [Semantic Versioning 2.0](https://semver.org/), but is still considered to be in its \ninitial development, thus backwards incompatible versions are denoted by minor version bumps. To help illustrate how\nversions will increment during this initial development stage, they are described below:\n\n1. The MAJOR version is currently 0, indicating initial development. \n2. The MINOR version is currently incremented when backwards incompatible changes are introduced to the public API. \n3. The PATCH version is currently incremented when bug fixes or backwards compatible changes are introduced to the public API. \n\n## Getting Started\n\nThis Houdini integration for AWS Deadline Cloud has two components that you will need to install:\n\n1. The Houdini submitter plug-in must be installed on the workstation that you will use to submit jobs; and\n2. 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.\n\nBefore submitting any large, complex, or otherwise compute-heavy Houdini render jobs to your farm using the submitter and adaptor that you\nset up, we strongly recommend that you construct a simple test scene that can be rendered quickly and submit renders of that\nscene to your farm to ensure that your setup is correctly functioning.\n\n### Houdini Submitter Plug-in\n\nThis package provides a Houdini ROP node that creates jobs for AWS Deadline Cloud using the [AWS Deadline Cloud client library][deadline-cloud-client]. Based on the loaded scene it determines the files required, allows the user to specify render options, and builds an [OpenJD template][openjd] that defines the workflow.\n\nTo install the submitter plug-in, refer to [DEVELOPMENT.md](DEVELOPMENT.md) section `Submitter Development Workflow`. Also refer to Deadline Cloud's [documentation](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html) on how to launch and use the Houdini submitter after installation.\n\n[Houdini Render nodes (ROP)]: https://www.sidefx.com/docs/houdini/nodes/out/index.html\n[deadline-cloud-monitor-setup]: https://docs.aws.amazon.com/deadline-cloud/latest/userguide/submitter.html#install-deadline-cloud-monitor\n[aws-cli-credentials]: https://docs.aws.amazon.com/cli/v1/userguide/cli-chap-authentication.html\n\n### Houdini Adaptor\n\nThe Houdini Adaptor implements the [OpenJD][openjd-adaptor-runtime] interface that allows render workloads to launch Houdini and feed it commands. This gives the following benefits:\n* a standardized render application interface,\n* sticky rendering, where the application stays open between tasks,\n* path mapping, that enables cross-platform rendering\n\nTo install, test and use a custom Houdini Adaptor, refer to [DEVELOPMENT.md](DEVELOPMENT.md) section `Application Interface Adaptor Development Workflow`\n\nJobs on Deadline Cloud created by the submitter use a released version of this adaptor by default. \n\nIf you are using the [default Queue Environment](default-queue-environment), or an equivalent, to run your jobs, then the released build of this adaptor will be\nautomatically made available to your job. Otherwise, you will need to install the adaptor. \n\nThe release build of the Houdini adaptor can be installed by the standard python packaging mechanisms:\n```sh\n$ pip install deadline-cloud-for-houdini\n```\n\nAfter installation, test that it has been installed properly by running the following as the same user that runs your jobs and\nthat `houdini` can be run as the same user:\n```sh\n$ houdini-openjd --help\n```\n\nFor more information on the commands the OpenJD adaptor runtime provides, see [here][openjd-adaptor-runtime-lifecycle].\n\n### Houdini Software Availability in AWS Deadline Cloud Service Managed Fleets\n\nYou will need to ensure that the version of Houdini that you want to run is available on the worker host when you are using\nAWS Deadline Cloud's [Service Managed Fleets](service-managed-fleets) to run jobs;\nhosts do not have any rendering applications pre-installed. The standard way of accomplishing this is described\n[in the service documentation](https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/provide-applications.html).\nYou can find a list of the versions of Houdini that are available by default \n[in the user guide](https://docs.aws.amazon.com/deadline-cloud/latest/userguide/create-queue-environment.html#conda-queue-environment)\nif you are using the default Conda queue enivonment in your setup.\n\n## Viewing the Job Bundle that will be submitted\n\nTo submit a job, the submitter first generates a [Job Bundle](job-bundle), and then uses functionality from the\n[Deadline](deadline-cloud-client) package to submit the Job Bundle to your render farm to run. If you would like to see\nthe job that will be submitted to your farm, then you can use the \"Export Bundle\" button in the submitter to export the\nJob Bundle to a location of your choice. If you want to submit the job from the export, rather than through the\nsubmitter plug-in then you can use the [Deadline Cloud application](deadline-cloud-client) to submit that bundle to your farm.\n\n[job-bundle]: https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/build-job-bundle.html\n\n## Security\n\nWe take all security reports seriously. When we receive such reports, we will \ninvestigate and subsequently address any potential vulnerabilities as quickly \nas possible. If you discover a potential security issue in this project, please \nnotify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/)\nor directly via email to [AWS Security](aws-security@amazon.com). Please do not \ncreate a public GitHub issue in this project.\n\n## Telemetry\n\nSee [telemetry](https://github.com/aws-deadline/deadline-cloud-for-houdini/blob/release/docs/telemetry.md) for more information.\n\n## License\n\nThis project is licensed under the Apache-2.0 License.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "AWS Deadline Cloud for Houdini",
"version": "0.7.4",
"project_urls": {
"Homepage": "https://github.com/aws-deadline/deadline-cloud-for-houdini",
"Source": "https://github.com/aws-deadline/deadline-cloud-for-houdini"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f0c38541aa0c3bf1a3f14fd7105f2d7a0fc6c04b36d7b1e02972c99876301694",
"md5": "c83efe955be735f8f561bd173ed3b624",
"sha256": "d394e6a219330d2e929a2f5ae111ef19a1bb868f3bc7c3b3226b3936afc49afc"
},
"downloads": -1,
"filename": "deadline_cloud_for_houdini-0.7.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c83efe955be735f8f561bd173ed3b624",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 48841,
"upload_time": "2024-11-21T17:22:09",
"upload_time_iso_8601": "2024-11-21T17:22:09.200945Z",
"url": "https://files.pythonhosted.org/packages/f0/c3/8541aa0c3bf1a3f14fd7105f2d7a0fc6c04b36d7b1e02972c99876301694/deadline_cloud_for_houdini-0.7.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e0a8d3e3b60443a68f22d7dcee6c57263be058d7f339644eeb32f7c91369953f",
"md5": "021e078e9ae4f81aa43098289fec93cc",
"sha256": "74049bd453460d65653fdd638ed3a0e50acb69120a06ac3180c955d6bdbaa8c7"
},
"downloads": -1,
"filename": "deadline_cloud_for_houdini-0.7.4.tar.gz",
"has_sig": false,
"md5_digest": "021e078e9ae4f81aa43098289fec93cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 39187,
"upload_time": "2024-11-21T17:22:11",
"upload_time_iso_8601": "2024-11-21T17:22:11.246637Z",
"url": "https://files.pythonhosted.org/packages/e0/a8/d3e3b60443a68f22d7dcee6c57263be058d7f339644eeb32f7c91369953f/deadline_cloud_for_houdini-0.7.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-21 17:22:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aws-deadline",
"github_project": "deadline-cloud-for-houdini",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "deadline-cloud-for-houdini"
}
JSON
