shoot.profiles.profiles.Profiles

shoot.profiles.profiles.Profiles#

class shoot.profiles.profiles.Profiles(time, root_path, brut_prf)[source]#

Collection of in-situ profiles with temperature and salinity data

Manages a collection of Profile objects, providing methods to load from datasets, convert to xarray format, save to NetCDF, and associate with eddies.

Parameters:

  • time (xarray.DataArray) – Time coordinate for the profiles.

  • root_path (str) – Root directory path for data storage.

  • brut_prf (xarray.Dataset) – Raw profile dataset.

profiles#

List of valid Profile objects.

Type:

list of Profile

years#

Array of years covered by the profiles.

Type:

ndarray

ds#

Profiles converted to xarray Dataset format (cached property).

Type:

xarray.Dataset

__init__(time, root_path, brut_prf)[source]#

Initialize Profiles collection

Parameters:

  • time (xarray.DataArray) – Time coordinate for the profiles.

  • root_path (str) – Root directory path for data storage.

  • brut_prf (xarray.Dataset) – Raw profile dataset.

Methods

associate(eddies[, nlag])

Associate profiles with eddies

background(eddies, nlag, dlag)

Define background profile for each eddies profiles are considered when they are in a window of nlag around the detection date and at a maximum of dlag.

from_ds(ds, root_path[, max_depth])

Create Profiles from an xarray Dataset

to_netcdf([name, path])

Save profiles to NetCDF format

Attributes

ds

create profile array