Installation instructions#

This guide will help you set up Tumult Analytics on your local machine.


Tumult Analytics is built in Python, so a Python installation is required to use it. It is compatible with Python 3.7 through 3.11. Because Tumult Analytics uses PySpark for computation, it also requires Java 8 or 11.

Only the x86_64 processor architecture is officially supported at present. Apple silicon is supported through binary translation with Rosetta 2.

Below are instructions for installing these prerequisites on several common platforms. If none of these apply to you, install Python 3 and Java from your OS package manager or manually, then proceed with the pip installation. If you encounter any issues during the installation process, please let us know!

Python and pip, Python’s package manager, are likely already installed. If they are not, install them with:

apt install python3 python3-pip

Java may already be installed as well. If it is not, install the Java Runtime Environment with:

apt install default-jre-headless

Python and pip, Python’s package manager, may already be installed. On some releases, Python 2 may be installed by default, but not Python 3. To install Python 3, run:

yum install python3 python3-pip

To install Java, run:

yum install java-1.8.0-openjdk-headless

Note that despite the package name, this will install Java 8.

The below instructions assume the use of Homebrew for managing packages. If you do not already have Homebrew, it can be installed with:

/bin/bash -c "$(curl -fsSL"

Python may be installed with:

brew install python@3.7

And Java may be installed with:

brew install openjdk@8

You may need to explicitly add this OpenJDK installation to your PATH for it to be detected and usable by Spark. This can be done by, for example, adding export PATH="/usr/local/opt/openjdk/bin:$PATH" to .bashrc and then restarting your shell.

Since Python 3.7 is not supported on the Apple silicon processor architecture, you will need to first install Rosetta 2 and the x86_64 version of Homebrew. If you do not already have Rosetta 2, it can be installed with:

softwareupdate --install-rosetta

The x86_64 version of Homebrew can be installed with:

arch -x86_64 /bin/bash -c "$(curl -fsSL"

Now, you can install Python 3.7 with:

arch -x86_64 /usr/local/bin/brew install python@3.7

And Java may be installed with:

arch -x86_64 /usr/local/bin/brew install openjdk@8

The only supported way to install Tumult Analytics on Windows is using the Windows Subsystem for Linux (WSL). Once you have installed your preferred Linux distribution with WSL, follow the corresponding Linux installation instructions to get Tumult Analytics set up.


Once the above prerequisites are installed, Tumult Analytics can be installed using pip3 with:

pip3 install

This will automatically install all of its Python dependencies as well.

It is recommended, though not required, to install Tumult Analytics in a virtual environment to minimize interactions with your system Python environment.

Optional: checking your installation#

Once you’ve installed Tumult Analytics, you can run this command to check that basic functionality works:

python3 -c "from import check_installation; check_installation()"

If Analytics has been installed correctly, this command should finish successfully.