The Revit Batch Processor RBP

There are so many truly wonderful pieces of software sitting around there that I am unaware of, real works of art, pinnacles of perfection, that I only happen upon by chance.

In this case, @alexandrecafarofr happens to mention a powerful utility in his Revit API discussion forum thread on automatic heating and cooling load analysis:

The Revit Batch Processor (RBP) a project maintained by Daniel Rumery, ex-BVN:

Captain Dan

Here is an excerpt of the GitHub project readme to make your mouth water:

Revit Batch Processor (RBP)

Fully automated batch processing of Revit files with your own Python or Dynamo task scripts!

Latest version

Installer for Revit Batch Processor v1.5.3

See the Releases page for more information.


See the Revit Batch Processor FAQ.

Use Cases

This tool doesn't do any of these things, but it allows you to do them:

Revit batch processor user interface


Unlimited Power

"With great power come great responsibility" -- Spiderman

This tool enables you to do things with Revit files on a very large scale. Because of this ability, Python or Dynamo scripts that make modifications to Revit files (esp. workshared files) should be developed with the utmost care! You will need to be confident in your ability to write Python or Dynamo scripts that won't ruin your files en-masse. The Revit Batch Processor's 'Detach from Central' option should be used both while testing and for scripts that do not explicitly depend on working with a live workshared Central file.

Ever so many thanks to Dan for implementing, sharing, and, above all, so wonderfully documenting and maintaining this very impressive and powerful application!

Addendum – Questions

We have discussed similar batch processing topics here in the past, e.g.:

Based n thoise, I raised issue #51 to ask some important questions on failure handling and recovery:

  1. Are the actions taken automatically logged? – Why? In case of a problem, it might be handy to know how far you got successfully before the problem appeared, so that you know where to pick up again.
  2. Is the Revit.exe health monitored? – Why? Well, Revit is not built for batch processing, so one might expect it to crash and die if it is force fed too many files in a single session.
  3. Is Revit restarted for each new document? That would reduce the risk of the aforementioned point.

Dan very kindly responds:

  1. There is a log file that records the console output seen in the GUI. By default, log files by default are written to the folder %APPDATA%\BatchRvt. It logs stuff like process Revit startup and monitoring, files processed, file actions (open, closing, detach, file type, path, etc.). Any custom actions performed by a script would be left up to the script to record action-specific progress. If using a Python script, there is a utility function Output for logging to RBP's console. Dynamo scripts need their own mechanism for logging.
  2. The Revit process(es) are monitored to detect process exit and process busy events. This info is logged to the console. If a Revit session crashes, RBP starts up a fresh Revit session for any files that remain to be processed (so only the Revit file that lead to the crash will be skipped). Indeed, I found this can happen when processing a large amount of Revit files, hence the recovery mechanism. You'll see in the UI there is an option to process the files in the same Revit session (when possible) or process every file in its own session; as far as crash recovery is concerned, however, the behaviour is the same. Note that Dynamo scripts are always made to run in a separate Revit session per file due to some limitations I encountered when closing an active UI document. Python scripts don't have this limitation and hence will process a lot faster!
  3. See 2) :)

There is also a per-file time-out feature that can be used to terminate processing of a file if the time limit is reached. In that scenario, the Revit process is forcibly terminated and a fresh session started up to process the remaining files.