src package

Subpackages

Submodules

src.animate module

Animate da.

src.animate.animate_imetric(video_path='output.gif', k_clusters=5)

Animate an xr.DataArray.

Parameters

video_path (str, optional) – Video path. Defaults to “output.mp4”.
k_clusters (int, opitonal) – k clusters. Defaults to cst.K_CLUSTERS.

Return type

None

src.constants module

Constants.py program for storing paths and variables names.

src.make_figures module

Make figures: run through all the paper figures and make them.

Takes roughly 5 minutes the first time it is run.

src.make_figures.make_all_figures()

Make all the figures in the paper in a sequence.

Takes roughly 15 minutes on jasmin.

Return type: None

src.move_figures module

Move figures.

src.move_figures.move(copy_command='cp')

Move the files to the project.

Parameters: copy_command (str, optional) – which command is needed to move files in operating system. Defaults to “cp”.
Return type: None

src.time_wrapper module

Times utilities.

src.time_wrapper.timeit(method)

This timeit function is a wrapper for performance analysis.

Should return the time taken for a function to run, :type method: Callable :param method: the function that it takes as an input :rtype: Callable :return: timed

Example

Usage example::: import src.time_wrapper as twr @twr.timeit