Notes on Installing Scenic
This page describes common issues with installing Scenic and suggestions for fixing them.
Missing Python Version
If when running pip you get an error saying that your machine does not have a compatible version, this means that you do not have Python 3.8 or later on your PATH. Install a newer version of Python, either directly from the Python website or using pyenv (e.g. running pyenv install 3.10.4). Then use that version of Python when creating a virtual environment before installing Scenic.
“setup.py” not found
This error indicates that you are using too old a version of
pip: you need at least version 21.3.
Run python -m pip install --upgrade pip to upgrade.
If you install Scenic using
pip, you might see an error message like the following:
ERROR: pip’s dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
This error means that in order to install Scenic,
pip had to break the dependency constraints of some package you had previously installed (the error message will indicate which one).
So while Scenic will work correctly, something else may now be broken.
This won’t happen if you install Scenic into a fresh virtual environment.
Cannot Find Scenic
If when running the scenic command you get a “command not found” error, or when trying to import the
scenic module you get a
ModuleNotFoundError, then Scenic has not been installed where your shell or Python respectively can find it.
The most likely problem is that you installed Scenic for one copy of Python but are now using a different one: for example, if you installed Scenic in a Python virtual environment (which we highly recommend), you may have forgotten to activate that environment, and so are using your system Python instead.
See the virtual environment tutorial for instructions.
Scene Schematics Don’t Appear (2D)
If no window appears when you ask Scenic to generate and display a scene using the
--2d flag (as in the example commands in Getting Started with Scenic), this means that Matplotlib has no interactive backend installed.
On Linux, try installing the
python3-tk package (e.g. sudo apt-get install python3-tk).
If you get an error about SDL being missing, you may need to install it.
On Linux (or Windows with WSL), install the
libsdl2-dev package (e.g. sudo apt-get install libsdl2-dev); on macOS, if you use Homebrew you can run brew install sdl2.
For other platforms, see the SDL website.
Using a Local Scenic Version with VerifAI
If you are using Scenic as part of the VerifAI toolkit, the VerifAI installation process will automatically install Scenic from PyPI. However, if you need to use your own fork of Scenic or some features which have not yet been released on PyPI, you will need to install Scenic manually in VerifAI’s virtual environment. The easiest way to do this is as follows:
Install VerifAI in a virtual environment of your choice.
Activate the virtual environment.
Change directory to your clone of the Scenic repository.
Run pip install -e .
You can test that this process has worked correctly by going back to the VerifAI repo and running the Scenic part of its test suite with pytest tests/test_scenic.py.
Installing Scenic in this way bypasses dependency resolution for VerifAI.
If your local version of Scenic requires different versions of some of VerifAI’s dependencies, you may get errors from pip about dependency conflicts.
Such errors do not actually prevent Scenic from being installed; however you may get unexpected behavior from VerifAI at runtime.
If you are developing forks of Scenic and VerifAI, a more stable approach would be to modify VerifAI’s
pyproject.toml to point to your fork of Scenic instead of the
scenic package on PyPI.
Installing python-fcl on Apple silicon
If on an Apple-silicon machine you get an error related to pip being unable to install
python-fcl, it can be installed manually using the following steps:
Clone the python-fcl repository.
Navigate to the repository.
Install dependencies using Homebrew with the following command: brew install fcl eigen octomap
Activate your virtual environment if you haven’t already.
Install the package using pip with the following command: CPATH=$(brew --prefix)/include:$(brew --prefix)/include/eigen3 LD_LIBRARY_PATH=$(brew --prefix)/lib python -m pip install .
For greatest ease of installation, we recommend using the Windows Subsystem for Linux (WSL, a.k.a. “Bash on Windows”) on Windows 10 and newer.
Some WSL users have reported encountering the error
no display name and no $DISPLAY environmental variable, but have had success applying the techniques outlined here.
It is possible to run Scenic natively on Windows; however, in the past there have been issues with some of Scenic’s dependencies either not providing wheels for Windows or requiring manual installation of additional libraries.
Problems building Shapely
In the past, the
shapely package did not install properly on Windows.
If you encounter this issue, try installing it manually following the instructions here.