This repository provides the specification for Open Job Description, a flexible open specification for portable render jobs, both as a point of reference and to drive updates from the community.
Jump to:
The fastest way to understand the bones of Open Job Description is to understand both How Jobs Are Constructed and How Jobs Are Run. You may also find it beneficial to look through the provided sample templates in this GitHub repository.
Open Job Description is a flexible open specification for defining render jobs which are portable between studios and render solutions.
We created Open Job Description after hearing frequently from studios that they found the choice of render farm management tools to be daunting due to the effort required to update or replace their tooling around the render farm. We also heard from software developers that they were unable to realistically release render farm plugins for their own applications despite being the most qualified to do so, as the render farm landscape was fractured and releasing multiple plugins for different render farm solutions would quickly siphon all their development capacity away from improving their software. A standard way of defining render jobs, or really any type of work suited for completion on a render farm, makes tools and plugins portable and increases interoperability.
For deeper insight into our thought process and goals, we recommend this Academy Software Foundation talk by Pauline Koh, Senior Product Manager - Technical at Amazon Web Services, titled Portable and Open Render Job Specifications.
If you have an Open Job Description project that you would like to advertise here then please submit a pull request.
- openjd-cli - Provides a command-line interface for working with Open Job Description templates.
- openjd-model - A Python implementation of the data model for Open Job Description's template schemas.
- openjd-sessions - A Python library that can be used to build a runtime that is able to run Jobs in a Session as defined by Open Job Description.
- openjd-adaptor-runtime - A Python library for creating a command-line Adaptor to assist with integrating an existing application, such as a rendering application, into batch computing systems that run Jobs in a way that is compatible with Open Job Description Sessions.
Open Job Description is under active development. We're releasing this because we'd like your feedback and participation as we move forward, together, in defining and implementing a specification that solves the problems in the space. We know that, as currently specified, Open Job Description is not a cure-all for any and all workflows.
Please see CONTRIBUTING.md for a more detailed description of how to contribute, and the RFC Readme for how to contribute an RFC.
We look forward to your input.
- Discussions: We encourage you to post about what you would like to see in future revisions of the specification, share, and brag about how you are using Open Job Description, and engage with us and the community.
- Request for Comment: This repository exists because we want your comments on the specification. Please consider submitting an RFC if you have thoughts on how the specification could be improved.
- Issues: We encourage you to use the GitHub issue tracker to report bugs.
- Pull Requests: We welcome pull requests to improve this wiki documentation. Simply make your changes in our GitHub Repository and post a pull request.
- Discussions: Seek help via our GitHub Discussions forum.
See CONTRIBUTING for more information.
See the LICENSE file for our project's licensing. We will also ask you to confirm the licensing of your contribution.