deadline-cloud-for-keyshot 0.2.0

AWS Deadline Cloud for KeyShot

AWS Deadline Cloud for KeyShot

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

Compatibility

This library requires:

1. KeyShot 2023 or 2024
2. Python 3.9 or higher; and
3. Windows or macOS operating system.

Submitter

This package provides a KeyShot plugin script 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 with KeyShot's render interface, and builds an OpenJD template that defines the workflow.

Installing and using the KeyShot Submitter

1. Run pip install deadline[gui]
2. Copy the file deadline-cloud-for-keyshot/src/deadline/keyshot_submitter/Submit to AWS Deadline Cloud.py to the KeyShot scripts folder for your OS:
   • Windows (choose one):
     • User scripts folder e.g. %USERPROFILE%/Documents/KeyShot/Scripts
     • System-wide scripts folder e.g. %PROGRAMFILES%/KeyShot/Scripts
   • Mac: /Library/Application Support/KeyShot12/ or /Library/Application Support/KeyShot/ depending on your version of Keyshot.
     • You can navigate to the folder by going to Finder, clicking the menu for Go -> Go to Folder, and typing in the folder path.
3. Launch KeyShot. The submitter can be launched within KeyShot from Window > Scripting Console > Scripts > Submit to AWS Deadline Cloud > Run

Submission Modes

There are two submission modes for the KeyShot submitter which a dialog will ask you to select from before opening the submitter UI.

1. Attach The scene BIP file and all external files references
   • The open scene file and all external files referenced within will be included as job attachments. The submitter will export the open scene to a KSP(KeyShot Package) which turns all file paths in the scene into relative paths and creates a flattened directory with all of the external files directly beside the scene file. The KSP is then unzipped, and the new scene file with the relative paths and all external files will be submitted with the job. The temporary directory used to save the KSP will be deleted after each submission.
2. Attach Only the scene BIP file
   • Only the open scene file will be attached to the submission. The expectation is that any external files referenced within the scene will be available to the workers through network storage or some other method.

Adaptor

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

• a standardized render application interface,
• sticky rendering, where the application stays open between tasks

Jobs created by the submitter use this adaptor by default.

Using the KeyShot Adaptor

1. Build and install deadline-cloud-for-keyshot on your workers

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

     $ pip install deadline-cloud-for-keyshot
     

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

     $ keyshot-openjd --help
     

2. KeyShot doesn't use PYTHONPATH and has a limited standard library so we explicitly load modules from the paths specified in the environment variable DEADLINE_CLOUD_PYTHONPATH. On your workers set the environment variable DEADLINE_CLOUD_PYTHONPATH to include paths to the following modules:

   • openjd
   • deadline
   • pywin32_system32
   • win32
   • Pythonwin

   e.g. On Windows running the worker in a virtual environment it might look something like:

   set DEADLINE_CLOUD_PYTHONPATH=C:/Users/<USER>/workervenv/Lib/site-packages/openjd;C:/Users/<USER>/workervenv/Lib/site-packages/deadline;C:/Users/<USER>/workervenv/Lib/site-packages/pywin32_system32;C:/Users/<USER>/workervenv/Lib/site-packages/win32;C:/Users/<USER>/workervenv/Lib/site-packages/win32/lib;C:/Users/<USER>/workervenv/Lib/site-packages/pythonwin
   

3. Configure licensing for KeyShot by setting the environment variable LUXION_LICENSE_FILE=<PORT>:<ADDRESS> to point towards the license server to use

   • e.g. setx LUXION_LICENSE_FILE "2703@127.0.0.1"

4. The adaptor expects the keyshot_headless executable is available through the PATH environment variable.

   • e.g. Local install: setx PATH "%LOCALAPPDATA%\KeyShot\bin;%PATH%"
   • e.g. System install: setx PATH "%PROGRAMFILES%\KeyShot\bin;%PATH%"
   • Verify by running keyshot_headless -h

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.