Installation Guide (Mac)

1. Install Dependencies

FireMix requires Python 3 and a number of third party libraries.

We recommend using pyenv to allow easy management of multiple Python versions on your system. You can use it to install the latest Python 3 release and set that as your default Python if desired:

brew install pyenv
pyenv install 3.6.2
pyenv global 3.6.2

PyQt5 needs to be installed using Homebrew:

brew install pyqt5

Use pip to install the dependencies:

pip 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 UI compiler. There is a script you can run to automatically compile all of the resources:

./compile-ui.sh

4. Startup

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

python firemix.py demo