v0.4.0

[stefraynaud]

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 xoa.cf.CFSpecs.reloc and xoa.cf.CFSpecs.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 xoa.cf.SGLocator.get_loc_from_da and the xoa.cf.SGLocator.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.

---

This discussion was created from the release v0.4.0.