Skip to content

Latest commit

 

History

History
284 lines (170 loc) · 4.69 KB

api.md

File metadata and controls

284 lines (170 loc) · 4.69 KB

nsv

nsv._version

nsv.utils

nsv.standardizer

Standardizer Objects

@dataclass
class Standardizer()

Standardize raw data

kogur

@property
@final_cleanup_before_returning
def kogur() -> Dataset

Standardized Kögur dataset

latrabjarg_climatology

@property
@final_cleanup_before_returning
def latrabjarg_climatology() -> Dataset

Standardized Látrabjarg climatology dataset

latrabjarg_survey

@property
@final_cleanup_before_returning
def latrabjarg_survey() -> Dataset

Standardized Látrabjarg survey dataset

fim

@final_cleanup_before_returning
def fim(resolution: int) -> Dataset

Standardized FIM dataset

Arguments:

  • sec int - resolution {1, 25}

Returns:

  • Dataset - Standardized dataset

osnap

@property
@final_cleanup_before_returning
def osnap() -> Dataset

Standardized OSNAP dataset

ovide

@property
@final_cleanup_before_returning
def ovide() -> Dataset

Standardized OVIDE dataset

ho2000

@property
@final_cleanup_before_returning
def ho2000() -> Dataset

Standardized Hansen & Osterhus 2000 dataset

m82_1

@final_cleanup_before_returning
def m82_1(sec_id) -> Dataset

Standardized Meteor cruise M82/1

Arguments:

  • sec int - Section ID {1, 2, 3, 4, 5, 6, 7, 8, 9}

Returns:

  • Dataset - Standardized dataset

eel

@property
@final_cleanup_before_returning
def eel() -> Dataset

Standardized EEL dataset

kn203_2

@final_cleanup_before_returning
def kn203_2(sec_id: str) -> Dataset

Standardized Knorr cruise KN203-2

Arguments:

  • sec_id str - Section ID {"A", "B", "C", "D", "E"}

Returns:

  • Dataset - Standardized dataset

pos503

@final_cleanup_before_returning
def pos503(sec_id) -> Dataset

Standardized Meteor cruise POS503

Arguments:

  • sec int - Section ID {1, 2, 3, 4, 5}

Returns:

  • Dataset - Standardized dataset

nsv.section_finder

SectionFinder Objects

@dataclass
class SectionFinder()

Arguments:

  • ds_domain Dataset - domain_cfg dataset

grids

@property
def grids() -> dict

Dictionary mapping each grid to a dataset with its coordinates

nearest_neighbor

def nearest_neighbor(lons, lats, grid: str) -> Dataset

Given the coordinates defining a section, find the nearest points on a model grid.

Arguments:

  • lons 1D array-like - Longitudes defining a section
  • lats 1D array-like - Latitudes defining a section
  • grid string - Model grid {"u", "v", "t", "f"}

Returns:

  • Dataset - Dataset with model coordinates and indexes

zigzag_section

def zigzag_section(lons, lats, grid: str) -> Dataset

Given the coordinates defining a section, find the correspoinding zigzag section on a model grid.

Arguments:

  • lons 1D array-like - Longitudes defining a section
  • lats 1D array-like - Latitudes defining a section
  • grid string - Model grid {"u", "v", "t", "f"}

Returns:

  • Dataset - Dataset with model coordinates and indexes

velocity_points_along_zigzag_section

def velocity_points_along_zigzag_section(lons, lats) -> dict

Given the coordinates defining a section, find the corrisponding velocity points along a zigzag section (f-grid). Useful to compute accurate volume fluxes.

Arguments:

  • lons 1D array-like - Longitudes defining a section
  • lats 1D array-like - Latitudes defining a section

Returns:

  • dict - Dictionary mapping u/v grids to their coordinates and indexes.