evo

Python package for the evaluation of odometry and SLAM

Linux / macOS / Windows / ROS / ROS2

This package provides executables and a small library for handling, evaluating and comparing the trajectory output of odometry and SLAM algorithms.

Supported trajectory formats:

'TUM' trajectory files
'KITTI' pose files
'EuRoC MAV' (.csv groundtruth and TUM trajectory file)
ROS and ROS2 bagfile with geometry_msgs/PoseStamped, geometry_msgs/TransformStamped, geometry_msgs/PoseWithCovarianceStamped, geometry_msgs/PointStamped or nav_msgs/Odometry topics or TF messages

See here for more infos about the formats.

Why?

evo has several advantages over other public benchmarking tools:

common tools for different formats
algorithmic options for association, alignment, scale adjustment for monocular SLAM etc.
flexible options for output, plotting, visualization or export (e.g. LaTeX plots or Excel tables)
a powerful, configurable CLI that can cover many use cases
modular core and tools libraries for custom extensions
faster than other established Python-based tools (see here)

What it's not: a 1-to-1 re-implementation of a particular evaluation protocol tailored to a specific dataset.

Installation / Upgrade

Installation is easy-peasy if you're familiar with this: https://xkcd.com/1987/#

The latest version of evo supports Python 3.10+.

Please use pip only in a proper environment (e.g. uv/uvx, pipx, venv, Pixi or a classic virtual environment).

⚠️ ☠️☠️☠️ ⚠️

Whatever you do, don't use: pip install --user / anything with --break-system-packages / or worst: sudo pip install

From PyPi

If you just want to use the executables of the latest release version, the easiest way is to run:

pip install evo

This will download the package and its dependencies from PyPI and install or upgrade them. If you want, you can subscribe to new releases via https://libraries.io/pypi/evo.

To upgrade to a newer version: pip install --upgrade evo

From Source

Run this in the repository's base folder:

pip install --editable .

Pixi

Pixi is an easy-to-use alternative if you want to have an isolated development environment. Run pixi add evo if you have an existing environment, or clone this repository and run pixi shell to open a dev shell.

Tab completion

Tab completion is supported via the argcomplete package. Run activate-global-python-argcomplete after the installation to use it.

Dependencies

Python packages

evo has some required dependencies that are automatically resolved during installation with pip. See the pyproject.toml file for all details.

PyQt6 (optional)

PyQt6 will give you the enhanced GUI for plot figures from the "qtagg" matplotlib backend (otherwise: "TkAgg"). If PyQt6 is already installed when installing this package, it will be used as a default (see evo_config show). To change the plot backend afterwards, run evo_config set plot_backend qtagg.

If you run into issues with installing tkinter, trying PyQt6 is a good idea.

ROS (optional)

Some ROS-related features require a ROS installation, see here. We are testing this package with ROS Lyrical.

Reading ROS bag files works also without a ROS installation thanks to the great rosbags package that is installed together with evo. This allows you also to read ROS 1 & 2 bags even if you don't have one of those ROS distros installed. (except for reading /tf topics, because there we need the buffer implementation from ROS)

contextily (optional)

contextily is required for adding map tiles to plots of geo-referenced data.

Rerun (optional)

You can send data also to the rerun viewer. Just pip install rerun-sdk and add --rerun to your command. See the related Wiki page for more details.

Command Line Interface

After installation with pip, the following executables can be called globally from your command-line:

Metrics:

evo_ape - absolute pose error
evo_rpe - relative pose error

Tools:

evo_traj - tool for analyzing, plotting or exporting one or more trajectories
evo_res - tool for comparing one or multiple result files from evo_ape or evo_rpe
evo_config - tool for global settings and config file manipulation

Call the commands with --help to see the options, e.g. evo_ape --help. Tab-completion of command line parameters is available on UNIX-like systems.

More documentation Check out the Wiki on GitHub.

Example Workflow

There are some example trajectories in the source folder in test/data.

1.) Plot multiple trajectories

Here, we plot two KITTI pose files and the ground truth using evo_traj:

cd test/data
evo_traj kitti KITTI_00_ORB.txt KITTI_00_SPTAM.txt --ref=KITTI_00_gt.txt -p --plot_mode=xz

2.) Run a metric on trajectories

For example, here we calculate the absolute pose error for two trajectories from ORB-SLAM and S-PTAM using evo_ape (KITTI_00_gt.txt is the reference (ground truth)) and plot and save the individual results to .zip files for evo_res:

First trajectory (ORB Stereo):

mkdir results
evo_ape kitti KITTI_00_gt.txt KITTI_00_ORB.txt -va --plot --plot_mode xz --save_results results/ORB.zip

Second trajectory (S-PTAM):

evo_ape kitti KITTI_00_gt.txt KITTI_00_SPTAM.txt -va --plot --plot_mode xz --save_results results/SPTAM.zip

3.) Process multiple results from a metric

evo_res can be used to compare multiple result files from the metrics, i.e.:

print infos and statistics (default)
plot the results
save the statistics in a table

Here, we use the results from above to generate a plot and a table:

evo_res results/*.zip -p --save_table results/table.csv

IPython / Jupyter Resources

For an interactive source code documentation, open the Jupyter notebook metrics_tutorial.ipynb in the notebooks folder of the repository. More infos on Jupyter notebooks: see here

If you have IPython installed, you can launch an IPython shell with a custom evo profile with the command evo_ipython.

Contributing Utilities

A few "inoffical" scripts for special use-cases are collected in the contrib/ directory of the repository. They are inofficial in the sense that they don't ship with the package distribution and thus aren't regularly tested in continuous integration.

Trouble

"😱, this piece of 💩 software doesn't do what I want!!1!1!!"

First aid:

append -h/ --help to your command
check the Wiki
check the previous issues
open a new issue

Contributing

Patches are welcome, preferably as pull requests.

License

GPL-3.0 or later

If you use this package for your research, a footnote with the link to this repository is appreciated: github.com/MichaelGrupp/evo.

...or, for citation with BibTeX:

@misc{grupp2017evo,
  title={evo: Python package for the evaluation of odometry and SLAM.},
  author={Grupp, Michael},
  howpublished={\url{https://github.com/MichaelGrupp/evo}},
  year={2017}
}

Release files for evo 1.37.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for evo 1.37.1
File	Size	Uploaded
evo-1.37.1.tar.gz	10.3 MB	Aug 31, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for evo 1.37.1
File	Interpreter	ABI	Platform	Reset
evo-1.37.1-py3-none-any.whl 162.4 kB Aug 31, 2026	Python 3	none	any	Details

Total release size: 10.4 MB

Release files / evo-1.37.1.tar.gz

Download URL	evo-1.37.1.tar.gz
Size	10.3 MB
Tags	Source
SHA-256 checksum How to use checksums	`310362579fc9a7c68b2a7e6ff2b947fd2698846aef90fd8e8f68bc0b44f31343`
BLAKE2b-256 checksum How to use checksums	`cd83fec8463022608439579c969d24e1e06177e493948d582f08040deffb8571`
Upload date	Aug 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Hatch/1.17.0 {"ci":null,"cpu":"arm64","distro":{"name":"macOS","version":"26.6.2"},"implementation":{"name":"CPython","version":"3.10.20"},"installer":{"name":"hatch","version":"1.17.0"},"openssl_version":"OpenSSL 3.6.3 9 Jun 2026","python":"3.10.20","system":{"name":"Darwin","release":"25.6.0"}} HTTPX2/2.4.0`

Release files / evo-1.37.1-py3-none-any.whl

Download URL	evo-1.37.1-py3-none-any.whl
Size	162.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`ac8f73572eca89eff4d9d3762909703e7e61c70a0d93d9884978d91a68ddbf63`
BLAKE2b-256 checksum How to use checksums	`60c0f88532d6d911d7133aecbe36b299f8d30989fd1dd9339d6671ca79cdb39b`
Upload date	Aug 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`Hatch/1.17.0 {"ci":null,"cpu":"arm64","distro":{"name":"macOS","version":"26.6.2"},"implementation":{"name":"CPython","version":"3.10.20"},"installer":{"name":"hatch","version":"1.17.0"},"openssl_version":"OpenSSL 3.6.3 9 Jun 2026","python":"3.10.20","system":{"name":"Darwin","release":"25.6.0"}} HTTPX2/2.4.0`