swiftest.Simulation.follow

swiftest.Simulation.follow#

Simulation.follow(codestyle='Swifter', dask=False, **kwargs)[source]#

An implementation of the Swift tool_follow algorithm. Under development. Currently only for Swift simulations.

Parameters:

  • codestyle (str, default “Swifter”) – Name of the desired format (Swift/Swifter/Swiftest)

  • dask (bool, default False) – Use Dask to lazily load data (useful for very large datasets)

  • **kwargs (Any) – A dictionary of additional keyword arguments.

Returns:

xarray dataset – Dataset containing the variables retrieved from the follow algorithm

Contents