Houdini render monitoring

Follow renders, caches, simulations and TOP cooks from your phone, get a preview of the last frame, and stop or start watched nodes remotely.

  • Houdini 20.5 to 21
  • Plugin 2.0
  • ROPs, File Caches and TOPs
  • Windows

Install the package

  1. Download the Houdini package

    It contains a RenderBuddy folder and a RenderBuddy.json file. The same package works in every supported Houdini version.

    The Houdini download is coming soon.

  2. Copy both into your packages folder

    Use the folder for your Houdini version, for example:

    %USERPROFILE%\Documents\houdini21.0\packages\RenderBuddy\
    %USERPROFILE%\Documents\houdini21.0\packages\RenderBuddy.json

    Create the packages folder if it doesn't exist. The folder and the file must sit next to each other.

  3. Restart Houdini

    The plugin starts by itself and connects to the Agent. The Python shell shows [RenderBuddy] INFO: v2.0.0 ready.

  4. Watch the nodes you want on your phone

    Nothing is reported until you do. See Watch nodes.

Updating from version 1? Remove the old copies first: houdiniX.Y\python3.11libs\renderbuddy and houdiniX.Y\scripts\456.py. Version 2 reports only the nodes you watch.

Watch nodes

RenderBuddy reports only the nodes you watch, so test renders and small caches never reach your phone. Right-click a ROP, File Cache, TOP network or TOP node and choose Watch with RenderBuddy. Or select nodes and click Watch / Unwatch on the RenderBuddy shelf.

A watched node shows a Watched by RenderBuddy comment in the network editor. The watch is saved in the .hip file. To undo it, right-click the node and choose Stop Watching with RenderBuddy.

When a render on a node you don't watch runs for more than 5 minutes, RenderBuddy asks once whether to watch it. You can turn this off in Settings.

What it tracks

JobWatched nodeIn the app
RenderA render ROP: Karma, Mantra, USD Render in Solaris, third-party renderersRendering, with frame, progress, time left and a preview
CacheFile Cache (also with Save to Disk in Background), Geometry, Alembic, FBX and USD ROPsCaching, with frame progress
SimulationA cache of a DOP network, or of anything with a DOP network upstreamSimulating, with frame progress
TOP cookA TOP network or a TOP nodePDG Cooking, with work items instead of frames. See TOP cooks.

Every run is its own job. A job you start in Houdini reaches your phone once it has run for 60 seconds, so quick tests stay quiet (change it in Settings). A job that fails is always reported. A job you start from your phone is reported right away. A simulation is shown simply as "Simulation", whatever the solver.

Tested on Houdini 20.5 and 21: Karma in /out, the Geometry ROP, File Cache (also in the background), simulation caches and TOP networks. Karma in Solaris, Mantra, Redshift, Arnold, V-Ray, RenderMan, Octane, Alembic, FBX and USD ROPs and single TOP nodes are recognized but not tested yet.

How a job ends

  • Finished: every frame of the range was written. A ROP that never reports single frames counts as finished when it ends without an error.
  • Cancelled: it ended early without an error, for example after Esc in Houdini or Stop on your phone. The frame count is the real one. The push says whether it was stopped from your phone or in Houdini.
  • Error: Houdini reported an error, and the app shows the first error message. Or Houdini crashed or was closed during the job: the app then shows Houdini closed unexpectedly.

Houdini shows the result for 10 seconds, then goes back to Idle. The reason for a stop or a failure stays on the card until the next job starts.

From your phone

Open the machine and expand Houdini. While a job runs, the card shows the node and the kind of job, for example karma_beauty · Render 42%.

ButtonWhat it does
InfoOpens the job details. For a TOP cook, it also shows the work items of each node.
PreviewRenders only. Shows the last finished frame. See Previews.
StopInterrupts the job like Esc in Houdini, without a Python error window. A TOP cook is cancelled, and its work item processes still running 15 seconds later are stopped. Only the stopped job's processes are ended: a background TOP cook, an older job's renderers, and a job that another Houdini runs (for example one started with Save to Disk in Background) keep running.
RenderWhen Houdini is idle: start one of your watched nodes.

Start a node from your phone

Tap Render. Start in Houdini lists the watched nodes of the open scene, with their kind and frame range. Pick one. If the node has a Render with Take parameter, you can also pick a Take; As set on the node keeps its own. The free space on its output drive is shown underneath.

The node starts in the open Houdini the way you'd start it yourself: with its own Render or Save to Disk button, or as a cook for TOP nodes. A take you pick is used for that run only and put back afterwards. The job shows up on your phone at once, and Houdini is busy until it finishes.

Remote start needs an interactive Houdini with the scene open. TOP nodes start without a take choice. To turn remote start off, untick Allow starting renders from the phone in Settings; the phone then lists no nodes.

Previews

Houdini doesn't convert anything. Each time a render writes a frame (EXR, JPEG, PNG, TIFF, TGA or HDR), the plugin tells the Agent where the file is, and the Agent makes the preview on the same PC, in the background:

  • EXR, HDR and float TIFF frames get the scene's OCIO display and view. A multi-layer EXR shows its first layer. JPEG, PNG and 8-bit TIFF are used as they are.
  • The preview is a JPEG of at most 1920 pixels on its longer side.
  • The Agent works at the lowest priority and converts at most one frame every 2 seconds, so your render keeps the CPU.

Tap Preview and the newest converted frame goes to your phone right away, end-to-end encrypted. Until the job's first frame is finished, the button reads Preview after the first frame. Caches, simulations and TOP cooks have no preview.

The Agent also checks the frames it converts. When three in a row are black, you get a Black Frames Detected push.

TOP cooks

One cook is one job, named after the TOP node that was cooked. It counts the work items this cook works on: those of that node and of the nodes upstream of it that cook with it. Cooking a Wait for All, for example, also counts the ROP Fetch nodes that feed it. Work items that were already cooked, or loaded from cache, before the cook started don't count.

The card shows Work items: done, cooking and failed, out of the total. Info adds Work items by node, upstream nodes first and the cooked node last. Each node gets one dot per work item, up to 60 (a bar above that):

DotWork item
Dim greenAlready done before this cook
GreenDone in this cook
AmberCooking
RedFailed
GreyWaiting

Under the dots, a line such as 12/20 · 3 cooking · 1 failed · 4 already done. Up to 16 nodes are listed; the others show as +N more nodes. A cook with failed work items ends as an error, for example 3 of 480 work items failed.

Disk space

For jobs that write files, the plugin reports the free space on the output drive. After three frames, it also estimates what the remaining frames need: the largest of the last five frames, times the frames left, plus 10%. The card shows it as Output disk, for example 412 GB free · needs ~38 GB, with a warning sign when it won't fit.

The first time a job needs more than is free, you get a Not enough disk space push with both sizes, once per job. While the job runs, the card also shows the warning in its Problem detected box.

Notifications

Each push names the kind of job:

JobPushes
RenderRender Started, Render Finished, Render Failed
CacheCache Started, Cache Finished, Cache Failed
SimulationSimulation Started, Simulation Finished, Simulation Failed
TOP cookTOP Cook Started, TOP Cook Finished, TOP Cook Failed, counted in work items, for example 480 work items

A stopped job sends Stopped by User (from your phone) or Stopped Locally (in Houdini), with the kind of job and the frame it reached. A job you start in Houdini sends its start push once it has run for the minimum time (60 seconds by default). A render of a single frame sends no start push, and its end push only if Single-frame renders is on in the app's Settings.

You're also told about black frames (see Previews), not enough disk space (see Disk space), and when Houdini stops responding for a minute during a job.

Several Houdinis at once

  • Interactive Houdini: everything on this page.
  • hython, hbatch and farm processes: watched nodes are reported, and you can stop them from your phone. They show up only while they run a job. They can't be started from the phone.
  • PDG work item processes: stay silent. The Houdini that runs the cook reports it.

Up to four Houdini processes can report at the same time, and each job sends its own pushes. The Houdini card on your phone follows one of them: the one that's working (a render comes before a simulation, a cache or a TOP cook; between equals, the job that started first), otherwise your interactive Houdini.

To turn the plugin off in one process, set the environment variable RENDERBUDDY_DISABLE=1.

The RenderBuddy shelf

Add the RenderBuddy shelf for these tools:

ToolUse it to
Watch / UnwatchWatch the selected ROPs, File Caches or TOP networks, or stop watching them.
Watched NodesList the watched nodes in this scene. Pick one to select it in the network.
RB StatusSee the plugin version, the connection, your settings and the current or last job.
Test ConnectionCheck the Agent is receiving data.
SettingsChange the options below.

Settings

Settings opens one window with every option. Click OK to save, Cancel to keep things as they were.

SettingDefaultWhat it does
Allow starting renders from the phoneOnLists your watched nodes on the phone, so you can start them. Off: the phone lists none.
Also stop PDG services when stopping from the phoneOffWhen you stop a TOP cook from the phone, also stop the PDG service processes, not only the work items.
Ask to watch long unwatched rendersOnAsks once when a render on an unwatched node runs for more than 5 minutes.
Only report jobs started in Houdini that run longer than60 sShorter jobs stay off your phone. Jobs started from the phone and failed jobs are always reported.

Troubleshooting

Nothing happens when Houdini starts

Check that RenderBuddy.json sits directly in the packages folder of the Houdini version you're running, next to the RenderBuddy folder. Remove copies of version 1 (python3.11libs\renderbuddy, scripts\456.py).

A job doesn't show up on my phone

Check that the node is watched (it shows Watched by RenderBuddy) and that the job ran longer than the minimum time, 60 seconds by default. RB Status on the shelf shows the connection and the last job.

My node isn't in the phone's Render list

Watch it, and check that Allow starting renders from the phone is on in Settings. Only an interactive Houdini with the scene open lists its nodes.

The phone says Houdini is busy

Houdini is already running a job. Wait for it to finish, or stop it first.

Preview stays on "Preview after the first frame"

The job hasn't finished a frame yet. Previews come from the image files the renderer writes, so a ROP that writes no image files has no preview.

Is the Agent getting anything?

Click Test Connection. If it fails, make sure the Agent is running on this computer.

RB Status says "Agent: not confirmed" or "Agent: update needed"

Not confirmed: the program on the Agent's port didn't prove it's your RenderBuddy Agent, so the plugin sent it nothing. Start the RenderBuddy Agent under your own Windows user account. Update needed: the plugin and the Agent don't speak the same version. The message says which one to update.