dstl/Stone-Soup: v1.2

<p><!-- Release notes generated using configuration in .github/release.yml at main --></p> <h2>What's Changed</h2> <h3>Breaking changes</h3> <ul> <li><p>Change how sensor parameters are passed to action generators by @nperree-dstl in https://github.com/dstl/Stone-Soup/pull/901</p> <ul> <li><em>ActionableProperty</em> has a <code>generator_kwargs_mapping</code> dictionary to map properties of the <em>ActionGenerator</em> to properties of the <em>Sensor</em>, allowing them to be set via the sensor. This means the previous method for setting resolutions has been modified to use this.<ul> <li>Fix: for <em>RadarRotatingBearingRange</em>, set <code>resolution=resolution_value</code> instead of <code>resolutions=dict()</code></li> <li>When creating a new sensor with an <em>ActionableProperty</em>, use the <code>generator_kwargs_mapping</code> to map sensor properties to <em>ActionGenerator</em> properties where required.</li> </ul> </li> </ul> </li> <li><p>Sensor management with actionable movables by @akenyon in https://github.com/dstl/Stone-Soup/pull/943</p> <ul> <li>Sensor managers now take a set of sensors and a set of platforms so positional arguments order has changed<ul> <li>Fix: set <code>reward_function</code> using kwargs (e.g. <code>reward_function=…</code>)</li> </ul> </li> <li>Import locations have changed for the base classes <em>Action</em>, <em>ActionGenerator</em>, <em>Actionable</em> and <em>ActionableProperty</em>.<ul> <li>Fix: import all from new location, <code>stonesoup.sensormanager.action</code></li> </ul> </li> </ul> </li> </ul> <h3>Implemented enhancements</h3> <ul> <li>Add metric MultiManager and MetricPlotter by @rcgorman-dstl in https://github.com/dstl/Stone-Soup/pull/811</li> <li>Introduce ability to constrain particle states in ParticleUpdater and MCMCRegulariser by @timothy-glover in https://github.com/dstl/Stone-Soup/pull/855</li> <li>Bool to return reward for BruteForce and Optimise sensor managers by @asaunders-dstl in https://github.com/dstl/Stone-Soup/pull/851</li> <li>Resampling dependant regularisation in ParticleUpdater by @timothy-glover in https://github.com/dstl/Stone-Soup/pull/869</li> <li>Minor Addition and Changes to MultiMeasurementInitiator by @gawebb-dstl in https://github.com/dstl/Stone-Soup/pull/835</li> <li>Adding greedy sensor manager by @akenyon in https://github.com/dstl/Stone-Soup/pull/874</li> <li>Add GaussianMixtureInitiator, ASDGaussianInitiator and EnsembleInitiator by @csherman-dstl in https://github.com/dstl/Stone-Soup/pull/873</li> <li>Function to linearly interpolate state mutable sequences by @gawebb-dstl in https://github.com/dstl/Stone-Soup/pull/872</li> <li>Update Animated Plotter Example by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/857</li> <li>Introduce Kullback-Leibler Divegence measure and reward function by @timothy-glover in https://github.com/dstl/Stone-Soup/pull/868</li> <li>New Recursive updaters added by @spike-dstl in https://github.com/dstl/Stone-Soup/pull/859</li> <li>Polar Plotting by @gawebb-dstl in https://github.com/dstl/Stone-Soup/pull/796</li> <li>One to One Track Association by @gawebb-dstl in https://github.com/dstl/Stone-Soup/pull/624</li> <li>Azimuth elevation range model by @Carlson-J in https://github.com/dstl/Stone-Soup/pull/880</li> <li>Introduce grid based action generators and actionable movable classes by @timothy-glover in https://github.com/dstl/Stone-Soup/pull/892</li> <li>Create IsotropicPlume model and gas sensor by @timothy-glover in https://github.com/dstl/Stone-Soup/pull/850</li> <li>Adapted the square root components by @jmbarr in https://github.com/dstl/Stone-Soup/pull/916</li> <li>Shorten sensor management tutorials' simulation length by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/918</li> <li>Adding setting title functionality to AnimationPlotter by @jswright-dstl in https://github.com/dstl/Stone-Soup/pull/919</li> <li>Add convert measurement parameter to TwoDPlotter by @jswright-dstl in https://github.com/dstl/Stone-Soup/pull/909</li> <li>Added the switching term to GOSPA. by @Carlson-J in https://github.com/dstl/Stone-Soup/pull/898</li> <li>Add support for Python 3.12 by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/925</li> <li>Simplify (or at least make more standard) control models by @jmbarr in https://github.com/dstl/Stone-Soup/pull/927</li> <li>Tidy plotter initialisation and remove rectangle zoom restriction. by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/934</li> <li>Dynamically Iterated EKF by @spike-dstl in https://github.com/dstl/Stone-Soup/pull/891</li> <li>Add 3D plotting option to Plotterly by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/932</li> <li>Error-Controller BRUF and Variable-Step BRUF by @spike-dstl in https://github.com/dstl/Stone-Soup/pull/914</li> </ul> <h3>Fixed bugs</h3> <ul> <li>Corrected update equation in Kalman tutorial by @jmbarr in https://github.com/dstl/Stone-Soup/pull/866</li> <li>Add conv measurements option to AnimatedPlotterly by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/856</li> <li>Fix track to track associations type by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/870</li> <li>Change return type and add track ID metadata to Track2GaussianDetectionFeeder by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/871</li> <li>Fix to RecursiveEnsembleUpdater by @spike-dstl in https://github.com/dstl/Stone-Soup/pull/885</li> <li>Correct UKF kappa default to match documentation by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/905</li> <li>Modify Ensemble state generation and initiator test thresholds by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/902</li> <li>Change StatePrediction and StateUpdate by @jswright-dstl in https://github.com/dstl/Stone-Soup/pull/906</li> <li>Fix bug in GridActionGenerator by @nperree-dstl in https://github.com/dstl/Stone-Soup/pull/917</li> <li>Fix error handling for 3d in Plotterly and add tests by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/931</li> <li>Fix plugins for latest versions of Python by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/956</li> <li>Fix incorrect transition model being used in Kalman Smoothers by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/945</li> <li>Fix calculation of cross-covariance in unscented_transform @sglvladi in https://github.com/dstl/Stone-Soup/pull/963</li> <li>Fixing bug which causes multiplication by Probability to return a Probability @jmbarr in https://github.com/dstl/Stone-Soup/pull/912</li> </ul> <h3>Documentation updates</h3> <ul> <li>Remove plot style in GMPHD tutorial to fix docs build by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/867</li> <li>Improve example documentation by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/840</li> <li>Example of Bearing-only tracking by @A-acuto in https://github.com/dstl/Stone-Soup/pull/823</li> <li>Modify track fusion example to use tee and plot longest track by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/882</li> <li>Update copyright year by @jswright-dstl in https://github.com/dstl/Stone-Soup/pull/920</li> <li>Make sensor management tutorials flake-8 compliant by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/926</li> <li>Make Metrics Example Flake8 Compliant by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/928</li> <li>Reinforcement Learning Sensor Manager Example by @sgboakes in https://github.com/dstl/Stone-Soup/pull/886</li> <li>change reference to correct one by @avcuenes in https://github.com/dstl/Stone-Soup/pull/938</li> <li>Correct deleter property documentation by @jswright-dstl in https://github.com/dstl/Stone-Soup/pull/950</li> <li>Add an example showing performance differences between JPDA and EHM by @A-acuto in https://github.com/dstl/Stone-Soup/pull/861</li> <li>Fix unused variable in Comparing Multiple Trackers example by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/959</li> </ul> <h3>Other changes</h3> <ul> <li>change unequal timesteps in animated plotter from error to warning by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/904</li> <li>Move sphinx gallery line in tutorial 10 by @mharris-dstl in https://github.com/dstl/Stone-Soup/pull/924</li> <li>NumPy 2 compatibility by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/929</li> <li>Ignore Sphinx Gallery execution times file by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/947</li> <li>Avoid test collection failure with optional dependency astropy by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/955</li> <li>Add pyehm plugin as optional tests by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/957</li> <li>Added Version Requirement for Plotly by @gawebb-dstl in https://github.com/dstl/Stone-Soup/pull/958</li> <li>Add GitHub release notes config by @sdhiscocks in https://github.com/dstl/Stone-Soup/pull/960</li> </ul> <h2>New Contributors</h2> <ul> <li>@asaunders-dstl made their first contribution in https://github.com/dstl/Stone-Soup/pull/851</li> <li>@akenyon made their first contribution in https://github.com/dstl/Stone-Soup/pull/874</li> <li>@csherman-dstl made their first contribution in https://github.com/dstl/Stone-Soup/pull/873</li> <li>@Carlson-J made their first contribution in https://github.com/dstl/Stone-Soup/pull/880</li> <li>@avcuenes made their first contribution in https://github.com/dstl/Stone-Soup/pull/938</li> </ul> <p><strong>Full Changelog</strong>: https://github.com/dstl/Stone-Soup/compare/v1.1...v1.2</p&gt