What’s new
0.5.1 (2021-10-13)
New features
Switch the CI workflow to github [PR36].
Bug fixes
Fix
xoa.cf.CFSpecs.to_loc()
that which failing with dataset [PR23].
0.5.0 (2021-10-12)
New features
Add the hlocs argument to
xoa.sigma.get_sigma_terms()
andxoa.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 thexoa.cfgm.cfgargparse()
function.Add the
cfgm_cfg_file
sphinx configuration option to save the default configuration of axoa.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.
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()
andto_loc()
methods toxoa.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 toxoa.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 toget_loc_from_da()
and theget_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 now 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 thexoa.filter.erode_mask()
for horizontal data.Add the
xoa.coords.get_xdim()
,get_ydim()
,get_zdim()
,get_tdim()
andget_fdim()
for quickly finding standard dimensions.
Bug fixes
Fix u and v CF config [PR6]