v0.7.1

New features

• Add support for not creating multi-indexes in xoa.coords.geo_stack.

Bug fixes

• Fix xoa.geo.get_distances that was not able to handle multi-indexes from xoa.coords.geo_stack.
• Fix doc generation [#83].
• Fix xoa.sigma.get_cs to keep it compatible with pure numpy arrays.

Documentation

• Add a link to the github repository.

v0.7.0

New features

• Add issue and pull request templates.
• Add the xoa.filter.smooth function [#76].
• Improved the default sig and std parameter values for filter windows that accept them [#76].
• Add the xoa.plot.plot_minimap and xoa.plot.plot_double_minimap functions to display the geographic situation of a set of coordinates [#73].
• Add support for the min_extent keyword to xoa.geo.get_extent [#73`]
• Add dask support to xoa.sigma sigma to depth converters [#72].
• Add the xoa.num module that contains low level numeric utilities.
• Add the xoa.thermdyn.mixed_layer_depth function to compute
  the mixed layer depth with three different methods [#67, #75].
• Add the xoa.thermdyn.is_temp, xoa.thermdyn.is_sal and xoa.thermdyn.is_dens functions to infer if an array of temperature, salinity or density type, and added the related xoa.thermdyn.get_temp, xoa.thermdyn.get_sal and xoa.thermdyn.get_dens function to search in datasets[#67, #79].
• Add kernel_kwargs keyword to xoa.filter.convolve to better control the kernel generation by xoa.filter.generate_kernel [#64].
• Add inference of parameters for some window functions, like the gaussian shape, in xoa.filter.get_window_func [#64].
• Add xoa.regrid.isoslice based on xoa.interp.isoslice core function [#63].

Breaking changes

• xoa.filter.get_window_func accepts now only one positional argument and all other arguments must be named.

Bug fixes

• Fix xoa.cfgm.is_boolstr which now supports the new configobj.
• Fix broadcasting xoa.interp 1d interpolation routines [#69].
• Fix xoa.sigma.get_sigma_terms so that it works in case of multiple levels coordinates [#60].
• Fix xoa.grid.to_rect that now infers coordinates and can emit a warning or raise an error.

Documentation

• Add an example of xoa.plot.plot_double_minimap to sphx_glr_examples_plot_mercator_argo.py and sphx_glr_examples_plot_hycom_gdp.py examples [#73].
• Add an example of xoa.thermdyn.mixed_layer_depth to sphx_glr_examples_plot_croco_section.py example [#67].

v0.6.1

New features

• Add a warning to xoa.open_data_sample that is emitted when the request edfile
  is not an internal data sample [#47].
• Add the xoa.plot.add_shadow, xoa.plot.add_glow and
  xoa.plot.add_lightshading function to add path effects to plots [#44].
• Add the xoa.plot.plot_ts function to make T-S diagrams [#43].
• Add the xoa.filter.demerliac function to apply a Dermerliac filter
  to time serie [#41].
• Add support for fine tuning masking in xoa.filter.convolve through the na_thres
  parameter [#41].
• Add the xoa.geo.cdist and xoa.geo.pdist functions to compute
  haversine distances respectively between two dataset and with a dataset [#40].
• Add the xoa.coords.geo_stack function to stack longitudes and latitudes
  into another dimension, in a dataset or data array [#40].
• Add the xoa.filter.decimate function to crudely undersample a geographic
  dataset or data array with a radius of proximity [#40].
• Add the xoa.geo.get_distances to compute the Haversine distances between
  locations inside a single dataset or between txo datasets [#40].
• Add the xoa.krig.empirical_variogram function to estimate variogram parameters.
• Add the xoa.krig.VariogramModel to manage a variogram model [#40].
• Add the xoa.krig.Kriger and xoa.krig.krig to perform kriging [#40].
• Add the exclude option to data var and coordinate specifications of
  xoa.cf.CFSpecs instances [#38].

Breaking changes

• A single Nan now contaminates the data over the kernel emprise in xoa.filter.convolve
  since na_thres is set to zero by default [#40].
• xoa now requires the gsw package.

Bug fixes

• Fix xoa.regrid.regrid1d so that it works now with time coordinates [#48].
• Fix xoa.regrid.grid2loc so that it works with scalar output coordinates.
• Fix xoa.regrid.regrid1d to prevent conflict in the presence of MultiIndexes.
• Fix search for coordinates that are hidden due to xarray.DataArray.stack.

Documentation

• Add the "Compare Mercator to ARGO" example.

v0.5.1

New features

• Switch the CI workflow to github [#36].

Bug fixes

• Fix xoa.cf.CFSpecs.to_loc that which failing with dataset [#36].

v0.5.0

New features

• Add the hlocs argument to xoa.sigma.get_sigma_terms and xoa.sigma.decode_cf_sigma to decode at several horizontal staggered grid locations.
• Add the edges argument to xoa.regrid.regrid1d to manually specify the edges that are used by the "cellave" regridding method.
• Add back the loc argument to the formatting methods of xoa.cf.
• Add dimension checking and support for dask arrays in xoa.sigma.
• Expose a few options of xoa.cfgm.ConfigManager to the xoa.cfgm.cfgargparse function.
• Add the cfgm_cfg_file sphinx configuration option to save the default configuration of a xoa.cfgm.ConfigManager.

Bug fixes

• Fix xoa.regrid.regrid1d with "cellave" method.
• Fix xoa.cf.CFSpecs.get_location_mapping for coordinates that have no axis attribute specifications.
• Fix xoa.grid.dz2depth that was not working properly with 4D+ arrays.

Breaking changes

• The loc argument of xoa.sigma.get_sigma_terms is renamed vloc.

v0.4.0

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.

v0.3.1

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 [#23].

Documentation

• Add a "How to start" section.
• Accessors are not documented separately with sphinx-autosummary-accessors [#20].
• The Hycom-GDP example now uses xoa.plot.plot_flow.

v0.3.0

New features

• Add the xoa.plot.plot_flow() function [#9].
• Improve xoa.coords.get_depth() so that it can compute depth from sigma coordinates or layer thinknesses [#8].
• Add the xoa.dyn.flow2d() function [#7].
• 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 [#6]