src.plot package

Submodules

src.plot.clust_3d module

The purpose of this is the algorithm in 3D.

src.plot.clust_3d.comp_3d(weights, means, covariances, ds)

This will hopefully plot fig2a and fig2b with automatic labelling.

Parameters
  • weights (np.ndarray) – weights numpy array.

  • means (np.ndarray) – means numpy array.

  • covariances (np.ndarray) – covariances numpy array.

  • ds (xr.Dataset) – dataset.

Return type

None

src.plot.i_map module

The purpose of this is to visualise the i_metric on the southern ocean map.

src.plot.i_map.map_imetric(da_i, da)

Plot map i metric clusters.

Returns void (although matplotlib will be storing the figure).

Parameters
  • da_i (xr.DataArray) – xarray.dataarray object.

  • da (xr.DataArray) – xarray.dataarray object.

Return type

None

src.plot.profiles module

Cluster profiles plots.

src.plot.profiles.make_profiles(ds)

Make cluster profiles (mean and std dev).

Parameters

ds (xr.Dataset) – the dataset.

Returns

new_dataset to plot.

Return type

xr.Dataset

src.plot.profiles.plot_profiles(ds)

Plot profiles.

Originally from: https://scitools.org.uk/iris/docs/v1.6/examples/graphics/atlantic_profiles.html A program to plot profiles, originally of the original components etc. https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.pyplot.plot.html There’s a fair deal of duplication in this function. Could probably half its length without changing its functionality.

Parameters

ds (xr.Dataset) – Profile dataset to plot.

Return type

None

Module contents