search

aws-deadline / deadline-cloud-for-blender

AWS Deadline Cloud for Blender
Apache License 2.0
12 stars 8 forks source link

readme

AWS Deadline Cloud for Blender

pypi python license

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

Compatibility

This library requires:

  1. Blender 3.6 or greater,
  2. Python 3.10 or higher; and
  3. Linux, Windows, or a macOS operating system.
    • Adaptor only supports Linux and macOS

Submitter

This package provides a Blender plugin 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.

Getting Started

If you have installed the submitter using the Deadline Cloud submitter installer you can follow the guide to Setup Deadline Cloud submitters for the manual steps needed after installation.

If you are setting up the submitter for a developer workflow or manual installation you can follow the instructions in the DEVELOPMENT file.

Adaptor

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

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-blender

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

$ blender-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.