Included plugins

The following sections list the plugins included with the simulator. The plugin name they can be loaded with is shown. The API documentation of the plugin code is linked to for more details about the parameters for each plugin. As this documentation is extended, further details and examples of the plugins will be added.

Configuration loader

• toml: read configuration from a TOML file (API documentation)

Dask cluster

• local: use an ad-hoc cluster on the local machine (API documentation)

• mpi: use an HPC cluster communicating over MPI (API documentation)

Distortion

• anslie_mccolm_attenuation: acoustic attenuation using the model of Anslie and McColm (API documentation)

• doppler: model the distortion of the spectrum due to the Doppler effect (API documentation)

• geometric_spreading: energy loss due to geometric spreadding (API documentation)

• rectangular_beampattern: beampattern of an ideal rectangular transducer (API documentation)

Environment

• invariant: spatially and temporally invariant operating environment (API documentation)

Ping times

• constant_distance: travel a fixed distance between pings (API documentation)

• constant_interval: emit pings at a constant rate (API documentation)

Point targets

• random_point_rectangle: points randomly distributed inside a rectangular area (API documentation)

• random_point_triangle: points randomly distributed inside a triangle (API documentation)

• single_point: single point target at a specified location (API documentation)

Result converters

• matlab: save results to a MATLAB data file (API documentation)

• numpy: save results to a NumPy .npz file (API documentation)

Signals

• lfm_chirp: transmit a linear frequency modulated chirp (API documentation)

Simulation controllers

• simple_points: simulate using idealised point targets (API documentation)

Signal windows

• blackman (API documentation)

• blackman_harris (API documentation)

• generalised_cosine (API documentation)

• hamming (API documentation)

• hann (API documentation)

• nuttall (API documentation)

• tukey (API documentation)

System description

• generic: basic collection of transducers and the transmitted signal (API documentation)

Trajectory

• linear: idealised linear trajectory (API documentation)

Transducers

• generic (API documentation)

Travel time calculators

• iterative: use a iterative procedure to account for intra-ping motion (API documentation)

• stop_and_hop: apply the stop-and-hop assumption when calculating travel time (API documentation)