Batch Processing
Rush is an easy to use tool to run Wrap4D computations over a network. It allows running the computation on dozens of machines with just a few clicks. Rush works in combination with Node which is a headless computational node and performs all the heavy computations.
If you are created a project in Wrap4D on our computer and tell Rush that needs to compute this project over a specific frame range. Rush sends the tasks to Nodes and the Nodes perform the computations.
In this scheme, you can see a simple network configuration.
User Machine
A computer where Wrap4D has installed. Used to create projects and start computations.
Computational Machines
Computers where Node has installed. You can use as much computers as licenses of nodes you have.
Server Machine
This is a computer where the Rush application has installed and is running. Rush controls the set of computational nodes: it provides them with tasks, starts, stops, and pauses them.
Tip
This scheme is very flexible. For example, you can have the Rush application running on the same machine as Wrap4D. It’s also possible to use this machine as a computational node as well. So basically, all 3 applications may be running on a single computer if needed.
Installation
Rush
When the wizard is finished, the web interface for Rush appears in your browser:
Here you can find your network address which will connect computational nodes with a server machine.
Node
When the wizard is finished, I will see the tray icon. Lets choose Open web interface inside the context menu of that icon.
Tip
If the tray icon is not displayed, you may run the process inside installation directory of Node using the NodeTray.exe file.
Here is you need to paste your network adress which you copied from Rush web interface inside Rush adress field. After that click Save button and check if the green text Rush connection established appears.
Activation
To activate Node you need to use a command-line interface.
Use this command to activate a node-locked license:
WrapCmd activateNodelocked <pathToLicense>
Use this command to activate a floating license:
WrapCmd activateFloating <hostAddress> <port>
Arguments
pathToLicense
:a path to a license file *.lic. If the file name contains spaces please use double quotes.
Tip
Use command cd to switch to the installation folder.
After the activation Node on each computational machine, we can focus only on the User and Server machines.
Rush activates together with Wrap4D.
User Interface
First Run
To run the Rush interface you need to load any project in Wrap4D and go to the 4D Tools menu and select Run the current project in Rush.
For the first run you need to provide the network address of Rush. You can copy and paste it from the Rush web interface and click the Save button after that.
Tabs
There are 5 main tabs inside Rush. They are displayed as vertical icons on the left side of the application.
Tip
Uncheck Start Immediately to forbid Rush to start selected project immediately.
Projects
Shows the list of projects which have been already added to Rush. Each project of the list has its own filename, frame range, State, Progress and Time params. You can edit project params using Edit Project icon. In this tab you can also run/start/stop, add and delete any project(s).
Nodes
Shows the list of nodes which have been already installed using the Rush network address of the current Server. Each node of the list has its own Connection, Status, Tasks, CPU and Memory params. You can edit node params using Edit Node icon. In this tab you can also run/stop/pause and delete any node(s).
In the window of editing the node parameters you can set the number of tasks that can be executed on it simultaneously. This will allow you to use the resources of the computational unit more efficiently.
You can choose the number of tasks for each Computational Machine. It means, that if you will choose 2 tasks on 1 node inside the Edit Node icon, then two frames will compute on this machine in parallel.
You can also use the option Dynamically adjust to free operating memory size. In this case, the maximum number of tasks on the node will be determined as follows:
When you add a new project, each node in the network with dynamic task number adjustment enabled will receive 1 task to determine the amount of memory the task consumes at peak. Nodes with a static task count set will also participate in determining the amount of resources needed but will receive a fixed number of tasks at once. During the computation process, the information about the required resources is continuously updated.
After any node computes at least 1 task of the project, the Rush Server will have information about the resources required to complete the task.
When deciding “whether to assign another task to a node”, Rush Server will be guided by the free RAM on the node and how much memory the next task in the queue occupies at peak + 25%. For example, if a task requires 10 GB of RAM, then assigning another task requires a minimum of 12.5 GB of free memory.
If Rush Server realizes that a node has free resources to perform a task, another task will be assigned to the node, up to 32 tasks per node.
Thus, the node’s processing power will be utilized more efficiently and will prevent the assignment of an excessive number of tasks, leading to stalled computation due to lack of RAM.
Tip
If the Connection param of the selected node is colored in gray, it means that the current node has not started yet. To start it click Start inside the context of the Node icon in the tray menu.
Errors
Shows the info about errors which have appeared during the computation. For each project you can check the Frame, Message, Node and Time of frames which didn’t succeeded.
Directories
Here you can choose the Gallery directory using a network adress.
Tip
Generally, Wrap4D gallery is generally very large. It normally contains several gigabytes of data, so it’s not convenient to have a copy of the gallery on each machine. Instead, you can put the gallery into a shared folder and provide the Node with its address.
Licenses
Here you can choose the License Server adress to run floating licenses for our products.