Through pip

The easiest way to install Soil is through pip, with Python >= 3.8:

pip install soil

Now test that it worked by running the command line tool

soil --help


python -m soil --help

Or, if you’re using using soil programmatically:

import soil

Web UI

Soil also includes a web server that allows you to upload your simulations, change parameters, and visualize the results, including a timeline of the network. To make it work, you have to install soil like this:

Once installed, the soil web UI can be run in two ways:


The latest version can be downloaded from GitHub and installed manually:

git clone
cd soil
python -m venv .venv
source .venv/bin/activate
pip install --editable .