Getting Started¶
This guide walks you through installing and configuring a Balthazar Runner, allowing you to execute experiments from your local machine and connect them to your Balthazar workspace.
What is a Runner?¶
A Runner is a lightweight application that runs on your laptop or desktop. It executes experiment workflows locally while securely communicating with the Balthazar backend.
Python installation¶
Balthazar requires Python 3.8 or newer.
If Python is not yet installed on your system, please download and install it first. We recommend performing a fresh installation using the official installers available at:
Installing a Runner¶
Follow the steps below to create and install a Runner for your environment.
1. Open the Balthazar web app¶
Navigate to:
Log in to your workspace.
2. Open runner settings¶
- Click the gear icon in the left-hand sidebar
- Select Runners
- Click Add Runner
3. Create the Runner¶
- Enter a name for your Runner (for example,
MyLab) - Click Save
4. Download and install the Runner¶
After saving, download options will appear:
- Choose the installer for your operating system (Windows or Linux/macOS)
- Download and run the installer on the machine where the Runner will operate
5. Launch the Runner¶
Open the Balthazar Runner application on your laptop or desktop.
6. Connect the Runner to your workspace¶
- From the Balthazar web app, copy the Runner ID and paste it into the corresponding field in the Runner application
- Repeat the same process for the Token
- Click Save. The Runner should automatically connect to the Balthazar servers
7. Test the connection¶
- Click Test in the Balthazar web app. The connection should be successful
- After confirming, the Runner should appear in the list with a status of Online
Once connected, your Runner is ready to execute experiments from Balthazar.