TubeTK/Dashboard Scripts

From KitwarePublic
Jump to navigationJump to search


TubeTK uses a novel configuration-file based method for installing dashboard machines. In general, you will perform an initial download of TubeTK, copy an example configuration file to the level above the TubeTK source, edit that file as appropriate, and then setup cron jobs to call script files that are distributed with TubeTK and that are controlled by your configuration file.

TubeTK's current dashboard is available at:



1. The top-level dashboard directory is at "~/src/dashboards". This tutorial will help you create directory structure with the following hierarchy


where ${BUILD_TYPE} is one of Release, Debug, RelWithDebInfo, ...

2. The machine being configured is called "MyMachine"


  • You must have CMake 2.8.8 or greater installed to run a TubeTK dashboard system.
  • You must have Qt 4.7 or greater installed to compile TubeTK
  • This tutorial assumes you have some knowledge of CMake and CTest


Go to the top level of your dashboard clients

cd ~/src/dashboards

Get a copy of all dashboard scripts, include some example scripts:

git clone

The following script will be used to update and launch your dashboard client every night. WINDOWS: Use the corresponding .bat file if you are doing this on Windows:

cp TubeTK_Dashboards/

Setup your machine's parameters as described in the file:


Create a specific set of parameters for your dashboard machine:

cd TubeTK_Dashboards
cp EXAMPLE_Linux.cmake MyMachine_TubeTK_Nightly.cmake

On Windows, copy the corresponding EXAMPLE_Windows.cmake file

Setup the parameters as specified in that file:

vi MyMachine_TubeTK_Nightly.cmake

By adding your script to the repo, your dashboard machine can be updated without having to log into it:

git add MyMachine_TubeTK_Nightly.cmake
git commit -m "ENH: Initial setup for MyMachine"

Make sure you have the latest copy of the TubeTK_Dashboard directory and then submit your changes to the git repo:

git pull
git push

Setup a recurrent nightly job

  • On Linux:
crontab -e

Add the following line to the crontab, but please change the start minute (20) and the start hour (0) to different values to avoid simultaneous downloads from multiple machines:

20 0 * * * /home/me/src/dashboards/
  • On Windows, use the task scheduler to run your TubeTK_Nightly.bat script.