diff --git a/README.md b/README.md new file mode 100644 index 0000000..2f84cc5 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# qarnot-render-deadline + +The Qarnot integration for [Deadline](https://www.awsthinkbox.com/deadline), based on a python module + a Deadline Monitor UI script. + +The python module `qarnot_render_deadline` can be used this way: + +```python +import qarnot_render_deadline + +q_render_deadline = qarnot_render_deadline.QarnotRenderDeadline( + client_token="YOUR_API_TOKEN", cluster_url="https://api.qarnot.com" +) +q_render_deadline.create_instances("deadline-client-10.1-blender-2.91", 2) +# Deadline workers will appear in Deadline Monitor once the pool and task is +# fully dispatched. You can then launch Deadline jobs against those machines +# and, once you're done, shut the workers down with: +q_render_deadline.stop_instances() +``` + +The Deadline Monitor UI script `QarnotRender` can be found in the `Scripts` menu. + +## Installation + + * python module and dependencies + + The file [qarnot_render_deadline.py](qarnot_render_deadline.py) must be manually copied on the machine running the Deadline Monitor to: + + ``` + /opt/Thinkbox/Deadline10/lib/python2.7/site-packages/qarnot_render_deadline.py + ``` + + The `qarnot` module also has to be installed with: + + ```bash + pip install --target /opt/Thinkbox/Deadline10/lib/python2.7/site-packages qarnot + ``` + + * Deadline Monitor UI script + + The file [custom/scripts/General/QarnotRender.py](custom/scripts/General/QarnotRender.py) must be copied in the Deadline repository's `custom` directory: + + ``` + /custom/scripts/General/QarnotRender.py + ```