Welcome to Stone Soup’s documentation!

Stone Soup Logo

Stone Soup is a software project to provide the target tracking and state estimation community with a framework for the development and testing of tracking and state estimation algorithms.

As Stone Soup is focused on development and testing of algorithms, and such components may not be the most optimised implementations, instead focusing on being flexible. Its also intended to aid choice of component/algorithms to tackle real world problems.

Stone Soup is currently in beta and under continuing development, where feedback and contributions are welcomed to improve the component interface design and grow the number components available.

Please see the Stone Soup Tutorials for learning about tracking and using Stone Soup, Examples for examples of Stone Soup features, and Demonstrations for demonstrations of using Stone Soup.

For community support, head over to the Stone Soup room on Gitter.

Installation

To install Stone Soup from PyPI execute:

python -m pip install stonesoup

However, Stone Soup is currently in active development under beta, so it’s strongly encouraged to install the latest version from our GitHub repository:

python -m pip install https://github.com/dstl/Stone-Soup/archive/master.zip

Developing

If you are looking to carry out development with Stone Soup, you should first clone from GitHub and install with development dependencies by doing the following:

git clone "https://github.com/dstl/Stone-Soup.git"
cd Stone-Soup
python -m pip install -e .[dev]

Please also see our Contributing page.

Contents:

Indices and tables