API Reference

Date:

Dec 04, 2025

This page provides an auto-generated summary of TOAD’s API.

Top-Level Functions

toad.TOAD(data[, time_dim, log_level, engine])	Main object for interacting with TOAD.
toad.compute_shifts(td, var, method[, ...])	Apply an abrupt shift detection algorithm to a dataset along the specified temporal dimension.
toad.compute_clusters(td, var, method[, ...])	Apply clustering to a dataset's temporal shifts using a sklearn-compatible clustering algorithm.
toad.Plotter(td)	Plotting utilities for TOAD objects.

Core Modules

toad.clustering	Clustering module for TOAD (Temporal Offset Analysis and Detection).
toad.shifts	Shifts module for TOAD.
toad.regridding	Regridding methods available in TOAD.
toad.plotting
toad.utils	Utility functions and constants for TOAD.
toad.postprocessing