Installation Guide (Linux)

1. Install Dependencies

FireMix requires Python 3 and a number of third party libraries. It is known to run well on recent versions of Ubuntu, and should run well on any Linux system where the dependencies are available.

First, use your package manager to install Python and PyQt5. Note that in Ubuntu, PyQt5 is split into a number of packages, so there are multiple ones needed to get all the required parts of the library for FireMix.

These instructions are for installing to your system-wide Python, but if you want, you can also use a tool like pyenv to create a local python instance to use with FireMix.

sudo apt-get install python3 python3-pip python3-pyqt5 python3-pyqt5.qtquick python3-pyqt5.qtopengl pyqt5-dev-tools

Next, use pip to install the dependencies:

pip3 install -r requirements.txt

2. Create default files

The repository ships with example settings and playlist files to get you started (the program can not yet create them automatically). You will need to create local copies (do not include these copies in pull requests!). In the Linux console:

cp data/settings.json.example data/settings.json
cp data/playlists/default.json.example data/playlists/default.json

3. Compile Qt resources

The GUI forms need to be run through Qt's compiler. Since we use PyQt5, the program is called pyuic5. There are scripts you can run to automatically compile all of the resources.

run ./compile-ui.sh

4. Startup

At this point, you should be able to run FireMix and see output on FireSim. Use the command:

./firemix.py demo