Installation from wheel

To install Sympathy for Data from a wheel file:

  1. Check the required Python version

  2. Install Python

  3. Create a virtual environment

  4. Install Sympathy from wheel

  5. Run Sympathy

1. Check the required Python version

The wheel filename tells you which Python version is needed. Look for the cpXY part of the filename. For example:

  • sympathy-6.0.0-cp311-cp311-win_amd64.whl requires Python 3.11

  • sympathy-6.0.0-cp312-cp312-manylinux_2_39_x86_64.whl requires Python 3.12

2. Install Python

Install the Python version that matches the wheel file.

Windows / macOS

Download and install the appropriate version from python.org.

Linux (Ubuntu 24.04)

Ubuntu 24.04 ships with Python 3.12. If you need a different version, you can install it from the deadsnakes PPA:

sudo apt install python3.11 python3.11-venv

Using uv (all platforms)

If you have uv installed, it can manage Python versions for you:

uv python install 3.12

3. Create virtual environment

Navigate to a directory where you want to create the virtual environment.

Windows

py -3.12 -m venv sympathy-env
sympathy-env\Scripts\activate.bat

macOS / Linux

python3.12 -m venv sympathy-env
source sympathy-env/bin/activate

Using uv (all platforms)

uv venv --python 3.12 sympathy-env
source sympathy-env/bin/activate    # macOS/Linux
sympathy-env\Scripts\activate.bat   # Windows

4. Install Sympathy from wheel

With the virtual environment active, install the wheel file (replace the filename with your actual wheel file):

pip install sympathy-6.0.0-cp312-cp312-win_amd64.whl
python -m sympathy install

5. Run Sympathy for Data

Start Sympathy for Data with the GUI:

sympathy gui

Or run a workflow in headless mode:

sympathy cli my-workflow.syx

For a more comprehensive list of commands and options, see Top-level commands.

Optional features

Some nodes require extra third-party python packages to be installed to be able to run. This will be done automatically when such a node is executed for the first time. If you prefer to install such extra python packages ahead of time, you can do so by running:

python -m pip install <sympathy-filename>.whl[all]

See also Graphviz.