Skip to main content

A Stone Soup plugin for underwater acoustic sensing.

Project description

Blue Pebble

PyPI version Python versions

License: MIT

Blue Pebble is a research-oriented simulation framework for underwater acoustic sensing, currently focused on passive sonar signal processing, acoustic propagation modelling, beamforming, detection, and multi-target tracking.

Designed as a plugin for Stone Soup, Blue Pebble supports research in:

  • Underwater acoustics
  • Passive sonar signal processing
  • Towed array modelling
  • Acoustic propagation modelling
  • Beamforming and detection theory
  • Target tracking and data association

Blue Pebble provides modular acoustic propagation backends, ranging from analytical spreading laws to external ray-tracing solvers (e.g., rtrs), enabling trade-offs between physical fidelity and computational efficiency.

Naming conventions: The project is referred to as Blue Pebble throughout documentation. The repository and PyPI package use the hyphenated form blue-pebble (e.g., pip install blue-pebble). Within Python code, the package is imported as bluepebble (e.g., import bluepebble).

Research Applications

Blue Pebble is intended for controlled, simulation-based studies, including:

  • Evaluation of tracking and data association algorithms
  • End-to-end sonar performance analysis
  • Synthetic dataset generation for validation
  • Sensitivity analysis of propagation effects on detection and estimation

Although current functionality centres on passive sonar, the architecture supports extension to additional modalities (e.g., active or multistatic configurations).

Architecture

Blue Pebble follows a modular design that separates physical modelling from signal processing and tracking logic. Core components include:

  • Platform dynamics - Kinematic modelling of ownship, targets, and arrays
  • Acoustic propagation - Pluggable propagation backends (analytical or external solvers)
  • Signal generation - Source modelling and noise synthesis
  • Beamforming - Array processing algorithms
  • Detection - Measurement formation and statistical thresholding
  • Tracking - Integration with Stone Soup estimators and data association

This separation enables systematic experimentation across modelling assumptions and algorithmic choices without tightly coupling components.

Features

Implemented capabilities include:

  • Multi-body kinematic modelling for flexible towed arrays
  • Analytical spreading models and external ray-tracing integration (e.g., rtrs)
  • Configurable source signature synthesis
  • Ambient, biological, and ownship noise modelling
  • Multiple beamforming algorithms
  • Detection algorithms with performance metrics
  • Passive sonar simulation pipelines
  • Integration of real environmental datasets (bathymetry, range-dependent sound speed profiles)
  • Incorporation of measured source signatures
  • Native integration with Stone Soup tracking workflows
  • Plotting utilities for bearings and Cartesian tracks
  • Notebook-based tutorials and worked examples

Installation

pip install blue-pebble

Development

Recommended: Dev Container (Easiest Setup)

For a fully configured development environment, use the included Dev Container.

Requirements

  • Docker Engine (Docker Desktop on Windows/macOS, or Docker on Linux)

Optional:

  • Visual Studio Code
  • VS Code Dev Containers extension

Clone the repository:

git clone https://github.com/UoL-SignalProcessingGroup/blue-pebble.git

Using the Dev Container (VS Code Workflow)

If using Visual Studio Code with the Dev Containers extension:

cd blue-pebble
code .

When prompted, select "Reopen in Container."

VS Code will:

  • Build the Docker image
  • Start the container
  • Mount the repository
  • Configure the Python interpreter automatically

This provides a fully configured development environment including:

  • Python
  • All required build dependencies including rtrs

Using the Container Without VS Code (CLI Workflow)

You can build and run the container manually:

docker build -t blue-pebble-dev .
docker run -it --rm -v $(pwd):/workspace blue-pebble-dev

On Windows PowerShell:

docker run -it --rm -v ${PWD}:/workspace blue-pebble-dev

This starts an interactive shell inside the container.

Citation

If you use Blue Pebble in academic work, please cite the associated conference paper and the software release (via DOI when available).

@inproceedings{wakefield2026sonar,
  title={A Sonar Signal Processing Plugin for Stone Soup},
  author={Wakefield, Joshua J and Boulton, Finley and Colquitt, Daniel J. and Ralph, Jason F. and Williams, Duncan P.},
  booktitle={2026 29th International Conference on Information Fusion (FUSION)},
  pages={1--8},
  year={2026},
  organization={IEEE}
}

License

Blue Pebble is licensed under the MIT license.

See LICENSE and NOTICE.md for details.

Third-Party Components

Software: Blue Pebble depends on rtrs, which is licensed under the MIT licence and installed automatically as a dependency.

Data: Blue Pebble does not distribute external data in its PyPI package. Users are responsible for complying with the licences of any external data they utilise.

Future Enhancements

Planned and potential extensions include:

Environmental Modelling

  • Coherent ambient noise modelling (wind, rain, wave-induced noise)
  • Systematic environmental uncertainty modelling (sound speed and sensor position errors)

Signal and Source Modelling

  • Expanded source directivity modelling

Detection and Performance Analysis

  • Alternative SNR and beam power outputs (e.g., angle-dependent CFAR variants)
  • Bearing × time × frequency output volume to support multi-band downstream processing
  • Multi-band detector operating across frequency bands simultaneously
  • 2D CFAR with training cells spanning both bearing and time, giving the detector access to a limited time history

Sensing Modalities

  • Active sonar modelling
  • Multistatic and bistatic configurations
  • Additional sensing geometries (hull-mounted arrays, sonobuoys, distributed arrays)
  • Explicit hydrophone modelling

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

blue_pebble-0.1.1.tar.gz (214.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

blue_pebble-0.1.1-py3-none-any.whl (108.6 kB view details)

Uploaded Python 3

File details

Details for the file blue_pebble-0.1.1.tar.gz.

File metadata

  • Download URL: blue_pebble-0.1.1.tar.gz
  • Upload date:
  • Size: 214.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for blue_pebble-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c618baca9ff57ed73e99040f956cbdb33465423bc81b56728aef3048d7ab7648
MD5 32ba56bd3bed811e3aabe13a6059cb92
BLAKE2b-256 a9ef0d5e54dd4ee2262f9bfea0de89876a8c2bb04daa6f930f39b95e0fd5352b

See more details on using hashes here.

Provenance

The following attestation bundles were made for blue_pebble-0.1.1.tar.gz:

Publisher: publish.yml on UoL-SignalProcessingGroup/blue-pebble

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file blue_pebble-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: blue_pebble-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 108.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for blue_pebble-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0429fb1e27994d473dede1bdf82c135267dcf3c2ebaf81da82bf56a719d09ee6
MD5 ea93776658661a3df6af5173efc8fe8e
BLAKE2b-256 537424ab749cd8d44f9228e5c4ee5b48db194b93472dc4da6f1edd701b9f050e

See more details on using hashes here.

Provenance

The following attestation bundles were made for blue_pebble-0.1.1-py3-none-any.whl:

Publisher: publish.yml on UoL-SignalProcessingGroup/blue-pebble

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page