What’s new¶

0.4.0 (2021-09-02)¶

New features¶

xoa.cf.CFSpecs.decode() better supports staggered grids.
xoa.cf.CFSpecs.search_dim() supports generic names in addition to dimension types as second argument.
Add the xoa.cf.CFSpecs.match_dim() method to check if a given dimension name is known.
Add the reloc() and to_loc() methods to xoa.cf.CFSpecs for quickly changing the staggered grid indicators in names.
Add the xoa.cf.SGLocator.add_loc() method to quickly change the location markers in a data array.

Breaking changes¶

xoa.coords.get_dims() is renamed to xoa.coords.get_cf_dims().
The name argument of xoa.cf.CFSpecs methods is renamed to cf_name, and the dim_type(s) argument is renamed to cf_arg(s).
xoa.cf.SGLocator.get_location() is renamed to get_loc_from_da() and the get_loc() is added.

Bug fixes¶

Fix the output formatting of xoa.grid.dz2depth().

Documentation¶

The Naming conventions with xoa.cf section and Compare Hycom3d with a GDP drifter example are adapted to reflect changes.

v0.3.1 (2021-05-21)¶

New features¶

Add an autolim keyword to xoa.plot.plot_flow() to speedup the processing with cartopy maps.

Breaking changes¶

Rename the cf and sigma keyword of xoa.register_accessors() respectively to xcf and decode_sigma to match the default name of accessors.
Rename the sigma accessor to decode_sigma.

Bug fixes¶

Fix the access to the xoa executable on windows.
Fix the minimal version for xarray [PR23].

Documentation¶

Add a “How to start” section.
Accessors are not documented separately with sphinx-autosummary-accessors [PR20].
The Hycom-GDP example now uses xoa.plot.plot_flow().

v0.3.0 (2021-05-12)¶

New features¶

Add the xoa.plot.plot_flow() function [PR9].
Improve xoa.coords.get_depth() so that it can compute depth from sigma coordinates or layer thinknesses [PR8].
Add the xoa.dyn.flow2d() function [PR7].
Add the xoa.regrid.extrap1d() function.
Add the xoa.filter.erode_coast() function which is specialized version of the xoa.filter.erode_mask() for horizontal data.
Add the xoa.coords.get_xdim(), get_ydim(), get_zdim(), get_tdim() and get_fdim() for quickly finding standard dimensions.

Bug fixes¶

Fix u and v CF config [PR6]

0.2.0¶

New features¶

Breaking changes¶

Deprecations¶

Bug fixes¶

Documentation¶