Skip to main content
Ctrl+K
xoa 2026.2.1.dev3+g6123990a4.d20260505 documentation - Home xoa 2026.2.1.dev3+g6123990a4.d20260505 documentation - Home

Getting Started

  • How to install
  • Configuration
  • Quick start guide

User Guide

  • Examples
    • Interpolate a meridional section of CROCO outputs to regular depths
    • Compare Hycom3d with a GDP drifter
    • Compare Mercator to ARGO
  • In-depth guides
    • Metadata, CF and naming conventions
    • Config management with xoa.cfgm
    • Grid operations, regridding and sigma coordinates
    • Filtering and data processing
  • Commandline interface

Reference

  • Package API
    • xoa
    • xoa.cfgm
      • xoa.cfgm.cfg2rst
      • xoa.cfgm.cfgargparse
      • xoa.cfgm.filter_section
      • xoa.cfgm.gen_cfgm_cfg
      • xoa.cfgm.gen_cfgm_rst
      • xoa.cfgm.get_cfg_path
      • xoa.cfgm.get_sec_names
      • xoa.cfgm.get_spec
      • xoa.cfgm.get_validator
      • xoa.cfgm.is_bbox
      • xoa.cfgm.is_boolstr
      • xoa.cfgm.is_cdtime
      • xoa.cfgm.is_cmap
      • xoa.cfgm.is_color
      • xoa.cfgm.is_daterange
      • xoa.cfgm.is_daterange64
      • xoa.cfgm.is_datetime
      • xoa.cfgm.is_datetime64
      • xoa.cfgm.is_dict
      • xoa.cfgm.is_eval
      • xoa.cfgm.is_figsize
      • xoa.cfgm.is_interval
      • xoa.cfgm.is_minmax
      • xoa.cfgm.is_numerics
      • xoa.cfgm.is_path
      • xoa.cfgm.is_pydatetime
      • xoa.cfgm.is_timedelta
      • xoa.cfgm.is_timedelta64
      • xoa.cfgm.is_timestamp
      • xoa.cfgm.opt2rst
      • xoa.cfgm.parse_node
      • xoa.cfgm.print_short_help
      • xoa.cfgm.print_validation_functions
      • xoa.cfgm.register_validation_functions
      • xoa.cfgm.remove_defaults
      • xoa.cfgm.setup
      • xoa.cfgm.ConfigManager
        • xoa.cfgm.ConfigManager.arg_long_help
        • xoa.cfgm.ConfigManager.arg_parse
        • xoa.cfgm.ConfigManager.arg_patch
        • xoa.cfgm.ConfigManager.get_defaults
        • xoa.cfgm.ConfigManager.get_rst
        • xoa.cfgm.ConfigManager.get_spec
        • xoa.cfgm.ConfigManager.load
        • xoa.cfgm.ConfigManager.patch
        • xoa.cfgm.ConfigManager.reset
        • xoa.cfgm.ConfigManager.to_rst
        • xoa.cfgm.ConfigManager.cfgspecs
        • xoa.cfgm.ConfigManager.configspecs
        • xoa.cfgm.ConfigManager.defaults
        • xoa.cfgm.ConfigManager.specs
        • xoa.cfgm.ConfigManager.validator
      • xoa.cfgm.VdtDateTimeError
      • xoa.cfgm.VdtSizeError
      • xoa.cfgm.VdtWarning
      • xoa.cfgm.XoaValidateError
    • xoa.cli
      • xoa.cli.get_parser
      • xoa.cli.main
      • xoa.cli.main_info
    • xoa.color
      • xoa.color.crop_cmap
      • xoa.color.CmapAdapter
        • xoa.color.CmapAdapter.get_cmap
        • xoa.color.CmapAdapter.get_dict
        • xoa.color.CmapAdapter.set_vlim
    • xoa.coords
      • xoa.coords.change_index
      • xoa.coords.drop_dim_coords
      • xoa.coords.ensure_ns_datetime
      • xoa.coords.geo_stack
      • xoa.coords.get_altitude
      • xoa.coords.get_binding_data_vars
      • xoa.coords.get_cf_coords
      • xoa.coords.get_cf_dims
      • xoa.coords.get_coords_compat_with_dims
      • xoa.coords.get_depth
      • xoa.coords.get_dim_types
      • xoa.coords.get_fdim
      • xoa.coords.get_lat
      • xoa.coords.get_level
      • xoa.coords.get_lon
      • xoa.coords.get_meta_coords
      • xoa.coords.get_meta_dims
      • xoa.coords.get_order
      • xoa.coords.get_positive_attr
      • xoa.coords.get_tdim
      • xoa.coords.get_time
      • xoa.coords.get_vertical
      • xoa.coords.get_xdim
      • xoa.coords.get_ydim
      • xoa.coords.get_zdim
      • xoa.coords.is_altitude
      • xoa.coords.is_depth
      • xoa.coords.is_lat
      • xoa.coords.is_level
      • xoa.coords.is_lon
      • xoa.coords.is_time
      • xoa.coords.reorder
      • xoa.coords.transpose
      • xoa.coords.positive_attr
        • xoa.coords.positive_attr.conjugate
        • xoa.coords.positive_attr.bit_length
        • xoa.coords.positive_attr.bit_count
        • xoa.coords.positive_attr.to_bytes
        • xoa.coords.positive_attr.from_bytes
        • xoa.coords.positive_attr.as_integer_ratio
        • xoa.coords.positive_attr.is_integer
        • xoa.coords.positive_attr.real
        • xoa.coords.positive_attr.imag
        • xoa.coords.positive_attr.numerator
        • xoa.coords.positive_attr.denominator
        • xoa.coords.positive_attr.infer
        • xoa.coords.positive_attr.guess
        • xoa.coords.positive_attr.up
        • xoa.coords.positive_attr.down
      • xoa.coords.transpose_modes
        • xoa.coords.transpose_modes.conjugate
        • xoa.coords.transpose_modes.bit_length
        • xoa.coords.transpose_modes.bit_count
        • xoa.coords.transpose_modes.to_bytes
        • xoa.coords.transpose_modes.from_bytes
        • xoa.coords.transpose_modes.as_integer_ratio
        • xoa.coords.transpose_modes.is_integer
        • xoa.coords.transpose_modes.real
        • xoa.coords.transpose_modes.imag
        • xoa.coords.transpose_modes.numerator
        • xoa.coords.transpose_modes.denominator
        • xoa.coords.transpose_modes.classic
        • xoa.coords.transpose_modes.basic
        • xoa.coords.transpose_modes.xarray
        • xoa.coords.transpose_modes.compat
        • xoa.coords.transpose_modes.insert
        • xoa.coords.transpose_modes.resize
    • xoa.core
    • xoa.core.geo
    • xoa.core.interp
      • xoa.core.interp.cell2relloc
      • xoa.core.interp.closest2d
      • xoa.core.interp.grid2locs
      • xoa.core.interp.grid2relloc
      • xoa.core.interp.grid2rellocs
    • xoa.core.num
      • xoa.core.num.as_float_array
      • xoa.core.num.get_iminmax
      • xoa.core.num.ravel_index
      • xoa.core.num.unravel_index
    • xoa.core.regrid
      • xoa.core.regrid.cellave1d
      • xoa.core.regrid.cubic1d
      • xoa.core.regrid.extrap1d
      • xoa.core.regrid.hermit1d
      • xoa.core.regrid.linear1d
      • xoa.core.regrid.nearest1d
    • xoa.core.sigma
    • xoa.data_samples
      • xoa.data_samples.get_data_sample
      • xoa.data_samples.open_data_sample
      • xoa.data_samples.show_data_samples
    • xoa.dyn
      • xoa.dyn.flow2d
      • xoa.dyn.get_sea_level
    • xoa.filter
      • xoa.filter.convolve
      • xoa.filter.decimate
      • xoa.filter.demerliac
      • xoa.filter.erode_coast
      • xoa.filter.erode_mask
      • xoa.filter.generate_isotropic_kernel
      • xoa.filter.generate_kernel
      • xoa.filter.generate_orthogonal_kernel
      • xoa.filter.get_window_func
      • xoa.filter.shapiro_kernel
      • xoa.filter.smooth
      • xoa.filter.tidal_filter
      • xoa.filter.decimation_methods
        • xoa.filter.decimation_methods.conjugate
        • xoa.filter.decimation_methods.bit_length
        • xoa.filter.decimation_methods.bit_count
        • xoa.filter.decimation_methods.to_bytes
        • xoa.filter.decimation_methods.from_bytes
        • xoa.filter.decimation_methods.as_integer_ratio
        • xoa.filter.decimation_methods.is_integer
        • xoa.filter.decimation_methods.real
        • xoa.filter.decimation_methods.imag
        • xoa.filter.decimation_methods.numerator
        • xoa.filter.decimation_methods.denominator
        • xoa.filter.decimation_methods.average
        • xoa.filter.decimation_methods.pick
        • xoa.filter.decimation_methods.kill
    • xoa.geo
      • xoa.geo.bearing
      • xoa.geo.cdist
      • xoa.geo.clusterize
      • xoa.geo.deg2m
      • xoa.geo.get_distances
      • xoa.geo.get_extent
      • xoa.geo.haversine
      • xoa.geo.m2deg
      • xoa.geo.pdist
      • xoa.geo.ScipyDistContext
      • xoa.geo.distance_units
        • xoa.geo.distance_units.conjugate
        • xoa.geo.distance_units.bit_length
        • xoa.geo.distance_units.bit_count
        • xoa.geo.distance_units.to_bytes
        • xoa.geo.distance_units.from_bytes
        • xoa.geo.distance_units.as_integer_ratio
        • xoa.geo.distance_units.is_integer
        • xoa.geo.distance_units.real
        • xoa.geo.distance_units.imag
        • xoa.geo.distance_units.numerator
        • xoa.geo.distance_units.denominator
        • xoa.geo.distance_units.m
        • xoa.geo.distance_units.meters
        • xoa.geo.distance_units.meter
        • xoa.geo.distance_units.km
        • xoa.geo.distance_units.kilometers
        • xoa.geo.distance_units.kilometer
    • xoa.grid
      • xoa.grid.apply_along_dim
      • xoa.grid.decode_cf_dz2depth
      • xoa.grid.decode_dz2depth
      • xoa.grid.diff
      • xoa.grid.dz2depth
      • xoa.grid.get_centers
      • xoa.grid.get_edges
      • xoa.grid.pad
      • xoa.grid.shift
      • xoa.grid.to_rect
      • xoa.grid.dz2depth_ref_types
        • xoa.grid.dz2depth_ref_types.conjugate
        • xoa.grid.dz2depth_ref_types.bit_length
        • xoa.grid.dz2depth_ref_types.bit_count
        • xoa.grid.dz2depth_ref_types.to_bytes
        • xoa.grid.dz2depth_ref_types.from_bytes
        • xoa.grid.dz2depth_ref_types.as_integer_ratio
        • xoa.grid.dz2depth_ref_types.is_integer
        • xoa.grid.dz2depth_ref_types.real
        • xoa.grid.dz2depth_ref_types.imag
        • xoa.grid.dz2depth_ref_types.numerator
        • xoa.grid.dz2depth_ref_types.denominator
        • xoa.grid.dz2depth_ref_types.infer
        • xoa.grid.dz2depth_ref_types.top
        • xoa.grid.dz2depth_ref_types.ssh
        • xoa.grid.dz2depth_ref_types.bottom
        • xoa.grid.dz2depth_ref_types.bathy
      • xoa.grid.shift_directions
        • xoa.grid.shift_directions.conjugate
        • xoa.grid.shift_directions.bit_length
        • xoa.grid.shift_directions.bit_count
        • xoa.grid.shift_directions.to_bytes
        • xoa.grid.shift_directions.from_bytes
        • xoa.grid.shift_directions.as_integer_ratio
        • xoa.grid.shift_directions.is_integer
        • xoa.grid.shift_directions.real
        • xoa.grid.shift_directions.imag
        • xoa.grid.shift_directions.numerator
        • xoa.grid.shift_directions.denominator
        • xoa.grid.shift_directions.left
        • xoa.grid.shift_directions.bottom
        • xoa.grid.shift_directions.south
        • xoa.grid.shift_directions.low
        • xoa.grid.shift_directions.west
        • xoa.grid.shift_directions.right
        • xoa.grid.shift_directions.top
        • xoa.grid.shift_directions.north
        • xoa.grid.shift_directions.high
        • xoa.grid.shift_directions.east
    • xoa.krig
      • xoa.krig.empirical_variogram
      • xoa.krig.get_variogram_model_func
      • xoa.krig.get_xyz
      • xoa.krig.krig
      • xoa.krig.Kriger
        • xoa.krig.Kriger.interp
        • xoa.krig.Kriger.Ainv
        • xoa.krig.Kriger.clusters
        • xoa.krig.Kriger.dist_units
        • xoa.krig.Kriger.nclust
        • xoa.krig.Kriger.npmax
        • xoa.krig.Kriger.variogram_func
      • xoa.krig.VariogramModel
        • xoa.krig.VariogramModel.apply
        • xoa.krig.VariogramModel.fit
        • xoa.krig.VariogramModel.get_estimated_params
        • xoa.krig.VariogramModel.get_func
        • xoa.krig.VariogramModel.get_param
        • xoa.krig.VariogramModel.get_params
        • xoa.krig.VariogramModel.get_params_array
        • xoa.krig.VariogramModel.plot
        • xoa.krig.VariogramModel.set_estimated_params
        • xoa.krig.VariogramModel.set_params
        • xoa.krig.VariogramModel.set_params_array
        • xoa.krig.VariogramModel.dist_units
        • xoa.krig.VariogramModel.estimated_params
        • xoa.krig.VariogramModel.frozen_params
        • xoa.krig.VariogramModel.param_names
        • xoa.krig.VariogramModel.params
      • xoa.krig.kriging_types
        • xoa.krig.kriging_types.conjugate
        • xoa.krig.kriging_types.bit_length
        • xoa.krig.kriging_types.bit_count
        • xoa.krig.kriging_types.to_bytes
        • xoa.krig.kriging_types.from_bytes
        • xoa.krig.kriging_types.as_integer_ratio
        • xoa.krig.kriging_types.is_integer
        • xoa.krig.kriging_types.real
        • xoa.krig.kriging_types.imag
        • xoa.krig.kriging_types.numerator
        • xoa.krig.kriging_types.denominator
        • xoa.krig.kriging_types.ordinary
        • xoa.krig.kriging_types.simple
      • xoa.krig.variogram_model_types
        • xoa.krig.variogram_model_types.conjugate
        • xoa.krig.variogram_model_types.bit_length
        • xoa.krig.variogram_model_types.bit_count
        • xoa.krig.variogram_model_types.to_bytes
        • xoa.krig.variogram_model_types.from_bytes
        • xoa.krig.variogram_model_types.as_integer_ratio
        • xoa.krig.variogram_model_types.is_integer
        • xoa.krig.variogram_model_types.real
        • xoa.krig.variogram_model_types.imag
        • xoa.krig.variogram_model_types.numerator
        • xoa.krig.variogram_model_types.denominator
        • xoa.krig.variogram_model_types.exponential
        • xoa.krig.variogram_model_types.linear
        • xoa.krig.variogram_model_types.gaussian
        • xoa.krig.variogram_model_types.spherical
    • xoa.meta
      • xoa.meta.are_similar
      • xoa.meta.assign_meta_specs
      • xoa.meta.get_cache
      • xoa.meta.get_default_meta_specs
      • xoa.meta.get_matching_item_specs
      • xoa.meta.get_meta_config_file
      • xoa.meta.get_meta_specs
      • xoa.meta.get_meta_specs_encoding
      • xoa.meta.get_meta_specs_from_encoding
      • xoa.meta.get_meta_specs_from_name
      • xoa.meta.get_meta_specs_matching_score
      • xoa.meta.get_registered_meta_specs
      • xoa.meta.get_variant
      • xoa.meta.infer_coords
      • xoa.meta.infer_meta_specs
      • xoa.meta.is_registered_meta_specs
      • xoa.meta.register_meta_specs
      • xoa.meta.reset_cache
      • xoa.meta.search_similar
      • xoa.meta.show_cache
      • xoa.meta.set_meta_specs
    • xoa.misc
      • xoa.misc.dict_check_defaults
      • xoa.misc.dict_filter
      • xoa.misc.dict_merge
      • xoa.misc.get_axis_slices
      • xoa.misc.gunique
      • xoa.misc.is_empty
      • xoa.misc.is_iterable
      • xoa.misc.list_xr_names
      • xoa.misc.match_attrs
      • xoa.misc.match_string
      • xoa.misc.ArgList
        • xoa.misc.ArgList.get
        • xoa.misc.ArgList.put
      • xoa.misc.ArgTuple
        • xoa.misc.ArgTuple.get
        • xoa.misc.ArgTuple.put
      • xoa.misc.Choices
        • xoa.misc.Choices.format_function_docstring
        • xoa.misc.Choices.format_method_docstring
        • xoa.misc.Choices.to_docstring
        • xoa.misc.Choices.choices
      • xoa.misc.DefaultEnumMeta
        • xoa.misc.DefaultEnumMeta.get_rst
        • xoa.misc.DefaultEnumMeta.mro
        • xoa.misc.DefaultEnumMeta.default
        • xoa.misc.DefaultEnumMeta.rst
        • xoa.misc.DefaultEnumMeta.rst_with_links
      • xoa.misc.IntEnumChoices
        • xoa.misc.IntEnumChoices.conjugate
        • xoa.misc.IntEnumChoices.bit_length
        • xoa.misc.IntEnumChoices.bit_count
        • xoa.misc.IntEnumChoices.to_bytes
        • xoa.misc.IntEnumChoices.from_bytes
        • xoa.misc.IntEnumChoices.as_integer_ratio
        • xoa.misc.IntEnumChoices.is_integer
        • xoa.misc.IntEnumChoices.real
        • xoa.misc.IntEnumChoices.imag
        • xoa.misc.IntEnumChoices.numerator
        • xoa.misc.IntEnumChoices.denominator
      • xoa.misc.XEnumMeta
        • xoa.misc.XEnumMeta.get_rst
        • xoa.misc.XEnumMeta.mro
        • xoa.misc.XEnumMeta.default
        • xoa.misc.XEnumMeta.rst
        • xoa.misc.XEnumMeta.rst_with_links
    • xoa.plot
      • xoa.plot.add_agg_filter
      • xoa.plot.add_glow
      • xoa.plot.add_lightshading
      • xoa.plot.add_shadow
      • xoa.plot.plot_double_minimap
      • xoa.plot.plot_flow
      • xoa.plot.plot_minimap
      • xoa.plot.plot_ts
      • xoa.plot.DropShadowFilter
        • xoa.plot.DropShadowFilter.get_pad
        • xoa.plot.DropShadowFilter.prepare_image
        • xoa.plot.DropShadowFilter.process_image
      • xoa.plot.FilteredArtistList
        • xoa.plot.FilteredArtistList.add_callback
        • xoa.plot.FilteredArtistList.contains
        • xoa.plot.FilteredArtistList.convert_xunits
        • xoa.plot.FilteredArtistList.convert_yunits
        • xoa.plot.FilteredArtistList.draw
        • xoa.plot.FilteredArtistList.findobj
        • xoa.plot.FilteredArtistList.format_cursor_data
        • xoa.plot.FilteredArtistList.get_agg_filter
        • xoa.plot.FilteredArtistList.get_alpha
        • xoa.plot.FilteredArtistList.get_animated
        • xoa.plot.FilteredArtistList.get_children
        • xoa.plot.FilteredArtistList.get_clip_box
        • xoa.plot.FilteredArtistList.get_clip_on
        • xoa.plot.FilteredArtistList.get_clip_path
        • xoa.plot.FilteredArtistList.get_cursor_data
        • xoa.plot.FilteredArtistList.get_figure
        • xoa.plot.FilteredArtistList.get_gid
        • xoa.plot.FilteredArtistList.get_in_layout
        • xoa.plot.FilteredArtistList.get_label
        • xoa.plot.FilteredArtistList.get_mouseover
        • xoa.plot.FilteredArtistList.get_path_effects
        • xoa.plot.FilteredArtistList.get_picker
        • xoa.plot.FilteredArtistList.get_rasterized
        • xoa.plot.FilteredArtistList.get_sketch_params
        • xoa.plot.FilteredArtistList.get_snap
        • xoa.plot.FilteredArtistList.get_tightbbox
        • xoa.plot.FilteredArtistList.get_transform
        • xoa.plot.FilteredArtistList.get_transformed_clip_path_and_affine
        • xoa.plot.FilteredArtistList.get_url
        • xoa.plot.FilteredArtistList.get_visible
        • xoa.plot.FilteredArtistList.get_window_extent
        • xoa.plot.FilteredArtistList.get_zorder
        • xoa.plot.FilteredArtistList.have_units
        • xoa.plot.FilteredArtistList.is_transform_set
        • xoa.plot.FilteredArtistList.pchanged
        • xoa.plot.FilteredArtistList.pick
        • xoa.plot.FilteredArtistList.pickable
        • xoa.plot.FilteredArtistList.properties
        • xoa.plot.FilteredArtistList.remove
        • xoa.plot.FilteredArtistList.remove_callback
        • xoa.plot.FilteredArtistList.set
        • xoa.plot.FilteredArtistList.set_agg_filter
        • xoa.plot.FilteredArtistList.set_alpha
        • xoa.plot.FilteredArtistList.set_animated
        • xoa.plot.FilteredArtistList.set_clip_box
        • xoa.plot.FilteredArtistList.set_clip_on
        • xoa.plot.FilteredArtistList.set_clip_path
        • xoa.plot.FilteredArtistList.set_figure
        • xoa.plot.FilteredArtistList.set_gid
        • xoa.plot.FilteredArtistList.set_in_layout
        • xoa.plot.FilteredArtistList.set_label
        • xoa.plot.FilteredArtistList.set_mouseover
        • xoa.plot.FilteredArtistList.set_path_effects
        • xoa.plot.FilteredArtistList.set_picker
        • xoa.plot.FilteredArtistList.set_rasterized
        • xoa.plot.FilteredArtistList.set_sketch_params
        • xoa.plot.FilteredArtistList.set_snap
        • xoa.plot.FilteredArtistList.set_transform
        • xoa.plot.FilteredArtistList.set_url
        • xoa.plot.FilteredArtistList.set_visible
        • xoa.plot.FilteredArtistList.set_zorder
        • xoa.plot.FilteredArtistList.update
        • xoa.plot.FilteredArtistList.update_from
        • xoa.plot.FilteredArtistList.axes
        • xoa.plot.FilteredArtistList.figure
        • xoa.plot.FilteredArtistList.mouseover
        • xoa.plot.FilteredArtistList.stale
        • xoa.plot.FilteredArtistList.sticky_edges
        • xoa.plot.FilteredArtistList.zorder
      • xoa.plot.GaussianFilter
        • xoa.plot.GaussianFilter.get_pad
        • xoa.plot.GaussianFilter.prepare_image
        • xoa.plot.GaussianFilter.process_image
      • xoa.plot.GrowFilter
        • xoa.plot.GrowFilter.get_pad
        • xoa.plot.GrowFilter.prepare_image
      • xoa.plot.LightFilter
        • xoa.plot.LightFilter.get_pad
        • xoa.plot.LightFilter.prepare_image
        • xoa.plot.LightFilter.process_image
      • xoa.plot.OffsetFilter
        • xoa.plot.OffsetFilter.get_pad
        • xoa.plot.OffsetFilter.prepare_image
        • xoa.plot.OffsetFilter.process_image
    • xoa.regrid
      • xoa.regrid.extrap1d
      • xoa.regrid.regrid1d
      • xoa.regrid.extrap_modes
        • xoa.regrid.extrap_modes.conjugate
        • xoa.regrid.extrap_modes.bit_length
        • xoa.regrid.extrap_modes.bit_count
        • xoa.regrid.extrap_modes.to_bytes
        • xoa.regrid.extrap_modes.from_bytes
        • xoa.regrid.extrap_modes.as_integer_ratio
        • xoa.regrid.extrap_modes.is_integer
        • xoa.regrid.extrap_modes.real
        • xoa.regrid.extrap_modes.imag
        • xoa.regrid.extrap_modes.numerator
        • xoa.regrid.extrap_modes.denominator
        • xoa.regrid.extrap_modes.no
        • xoa.regrid.extrap_modes.none
        • xoa.regrid.extrap_modes.false
        • xoa.regrid.extrap_modes.top
        • xoa.regrid.extrap_modes.above
        • xoa.regrid.extrap_modes.after
        • xoa.regrid.extrap_modes.bottom
        • xoa.regrid.extrap_modes.below
        • xoa.regrid.extrap_modes.both
        • xoa.regrid.extrap_modes.all
        • xoa.regrid.extrap_modes.yes
        • xoa.regrid.extrap_modes.true
      • xoa.regrid.regrid1d_methods
        • xoa.regrid.regrid1d_methods.conjugate
        • xoa.regrid.regrid1d_methods.bit_length
        • xoa.regrid.regrid1d_methods.bit_count
        • xoa.regrid.regrid1d_methods.to_bytes
        • xoa.regrid.regrid1d_methods.from_bytes
        • xoa.regrid.regrid1d_methods.as_integer_ratio
        • xoa.regrid.regrid1d_methods.is_integer
        • xoa.regrid.regrid1d_methods.real
        • xoa.regrid.regrid1d_methods.imag
        • xoa.regrid.regrid1d_methods.numerator
        • xoa.regrid.regrid1d_methods.denominator
        • xoa.regrid.regrid1d_methods.linear
        • xoa.regrid.regrid1d_methods.interp
        • xoa.regrid.regrid1d_methods.nearest
        • xoa.regrid.regrid1d_methods.cubic
        • xoa.regrid.regrid1d_methods.hermit
        • xoa.regrid.regrid1d_methods.hermitian
        • xoa.regrid.regrid1d_methods.cellave
        • xoa.regrid.regrid1d_methods.cellerr
    • xoa.thermdyn
      • xoa.thermdyn.get_dens
      • xoa.thermdyn.get_sal
      • xoa.thermdyn.get_temp
      • xoa.thermdyn.is_dens
      • xoa.thermdyn.is_sal
      • xoa.thermdyn.is_temp
      • xoa.thermdyn.mixed_layer_depth
    • xoa.sigma
      • xoa.sigma.atmosphere_sigma_coordinate
      • xoa.sigma.decode_cf_sigma
      • xoa.sigma.decode_formula_terms
      • xoa.sigma.decode_sigma
      • xoa.sigma.get_cs
      • xoa.sigma.get_sigma_terms
      • xoa.sigma.ocean_s_coordinate
      • xoa.sigma.ocean_s_coordinate_g1
      • xoa.sigma.ocean_s_coordinate_g2
      • xoa.sigma.ocean_sigma_coordinate
    • xoa.cf
  • Accessors API
    • xarray.DataArray.xoa.xdim
    • xarray.DataArray.xoa.ydim
    • xarray.DataArray.xoa.zdim
    • xarray.DataArray.xoa.tdim
    • xarray.DataArray.xoa.name
    • xarray.DataArray.xoa.attrs
    • xarray.DataArray.xoa.coords
    • xarray.DataArray.xoa.data_vars
    • xarray.DataArray.xoa.meta
    • xarray.DataArray.xoa.set_meta_specs
    • xarray.DataArray.xoa.get_meta_specs
    • xarray.DataArray.xoa.decode
    • xarray.DataArray.xoa.encode
    • xarray.DataArray.xoa.auto_format
    • xarray.DataArray.xoa.fill_attrs
    • xarray.DataArray.xoa.infer_coords
    • xarray.DataArray.xoa.get
    • xarray.DataArray.xoa.get_coord
    • xarray.DataArray.xoa.get_depth
    • xarray.Dataset.xoa.coords
    • xarray.Dataset.xoa.data_vars
    • xarray.Dataset.xoa.meta
    • xarray.Dataset.xoa.decode_sigma
    • xarray.Dataset.xoa.set_meta_specs
    • xarray.Dataset.xoa.get_meta_specs
    • xarray.Dataset.xoa.decode
    • xarray.Dataset.xoa.encode
    • xarray.Dataset.xoa.auto_format
    • xarray.Dataset.xoa.fill_attrs
    • xarray.Dataset.xoa.infer_coords
    • xarray.Dataset.xoa.get
    • xarray.Dataset.xoa.get_coord
    • xarray.Dataset.xoa.get_depth
    • xarray.Dataset.decode_sigma.decode
    • xarray.Dataset.decode_sigma.get_sigma_terms
    • xarray.Dataset.decode_sigma
  • What’s new
  • Development roadmap
  • Appendices
    • xoa options
    • Default and specialized meta specs
      • Meta specifications for mercator datasets
      • Meta specifications for argo datasets
      • Meta specifications for gdp datasets
      • Meta specifications for hycom datasets
      • Meta specifications for croco datasets
      • Meta specifications for default datasets
      • data_vars ["ptemp"]
      • data_vars ["ctemp"]
      • data_vars ["temp"]
      • data_vars ["asal"]
      • data_vars ["pfsal"]
      • data_vars ["psal"]
      • data_vars ["sal"]
      • data_vars ["sst"]
      • data_vars ["sss"]
      • data_vars ["sigmat"]
      • data_vars ["ndens"]
      • data_vars ["sigmatheta"]
      • data_vars ["pdens"]
      • data_vars ["sigma0"]
      • data_vars ["sigma1"]
      • data_vars ["sigma2"]
      • data_vars ["sigma3"]
      • data_vars ["sigma4"]
      • data_vars ["dens"]
      • data_vars ["pres"]
      • data_vars ["ssd"]
      • data_vars ["conduct"]
      • data_vars ["sndspd"]
      • data_vars ["mld"]
      • data_vars ["ped"]
      • data_vars ["ohc"]
      • data_vars ["osc"]
      • data_vars ["cp"]
      • data_vars ["adt"]
      • data_vars ["sla"]
      • data_vars ["mdt"]
      • data_vars ["ssh"]
      • data_vars ["u"]
      • data_vars ["v"]
      • data_vars ["w"]
      • data_vars ["ubt"]
      • data_vars ["vbt"]
      • data_vars ["ubc"]
      • data_vars ["vbc"]
      • data_vars ["usurf"]
      • data_vars ["vsurf"]
      • data_vars ["ugbt"]
      • data_vars ["vgbt"]
      • data_vars ["cspd"]
      • data_vars ["speed"]
      • data_vars ["cdir"]
      • data_vars ["ke"]
      • data_vars ["eke"]
      • data_vars ["tke"]
      • data_vars ["mke"]
      • data_vars ["kz"]
      • data_vars ["akt"]
      • data_vars ["vaisa"]
      • data_vars ["bathy"]
      • data_vars ["meanlev"]
      • data_vars ["dx"]
      • data_vars ["dy"]
      • data_vars ["ex"]
      • data_vars ["ey"]
      • data_vars ["dz"]
      • data_vars ["dlon"]
      • data_vars ["dlat"]
      • data_vars ["angle"]
      • data_vars ["mask"]
      • data_vars ["cvol"]
      • data_vars ["vol"]
      • data_vars ["corio"]
      • data_vars ["beta"]
      • data_vars ["oro"]
      • data_vars ["orosm"]
      • data_vars ["nethf"]
      • data_vars ["lwnhf"]
      • data_vars ["swnhf"]
      • data_vars ["ghf"]
      • data_vars ["lwuhf"]
      • data_vars ["swuhf"]
      • data_vars ["lwdhf"]
      • data_vars ["swdhf"]
      • data_vars ["lathf"]
      • data_vars ["hflat"]
      • data_vars ["senhf"]
      • data_vars ["hfsen"]
      • data_vars ["evap"]
      • data_vars ["rain"]
      • data_vars ["t2m"]
      • data_vars ["q2m"]
      • data_vars ["hu2m"]
      • data_vars ["z0a"]
      • data_vars ["cda"]
      • data_vars ["cha"]
      • data_vars ["cea"]
      • data_vars ["wspd"]
      • data_vars ["wdir"]
      • data_vars ["wfdir"]
      • data_vars ["wtdir"]
      • data_vars ["uair"]
      • data_vars ["vair"]
      • data_vars ["wair"]
      • data_vars ["tair"]
      • data_vars ["pa"]
      • data_vars ["ps"]
      • data_vars ["plev"]
      • data_vars ["ptop"]
      • data_vars ["tkea"]
      • data_vars ["u10m"]
      • data_vars ["v10m"]
      • data_vars ["w10m"]
      • data_vars ["ux10m"]
      • data_vars ["vy10m"]
      • data_vars ["tauu"]
      • data_vars ["tauv"]
      • data_vars ["taux"]
      • data_vars ["tauy"]
      • data_vars ["topheight"]
      • data_vars ["hbl"]
      • data_vars ["hs"]
      • data_vars ["mssx"]
      • data_vars ["mssy"]
      • data_vars ["mss"]
      • data_vars ["mlw"]
      • data_vars ["t0m1"]
      • data_vars ["dp"]
      • data_vars ["tp"]
      • data_vars ["fp"]
      • data_vars ["th1p"]
      • data_vars ["char"]
      • data_vars ["ubr"]
      • data_vars ["uubr"]
      • data_vars ["vubr"]
      • data_vars ["bhd"]
      • data_vars ["foc"]
      • data_vars ["utwo"]
      • data_vars ["vtwo"]
      • data_vars ["utaw"]
      • data_vars ["vtaw"]
      • data_vars ["fbb"]
      • data_vars ["utbb"]
      • data_vars ["vtbb"]
      • data_vars ["uuss"]
      • data_vars ["vuss"]
      • data_vars ["utus"]
      • data_vars ["vtus"]
      • data_vars ["mapsta"]
      • data_vars ["wlv"]
      • data_vars ["sig"]
      • data_vars ["cs"]
      • data_vars ["hc"]
      • data_vars ["thetas"]
      • data_vars ["thetab"]
      • data_vars ["depth"]
      • data_vars ["altitude"]
      • data_vars ["station"]
      • data_vars ["calday"]
      • data_vars ["echoint"]
      • coords ["x"]
      • coords ["y"]
      • coords ["level"]
      • coords ["lon"]
      • coords ["lat"]
      • coords ["depth"]
      • coords ["altitude"]
      • coords ["sig"]
      • coords ["time"]
      • coords ["forecast"]
      • coords ["freq"]
      • coords ["station"]
      • coords ["member"]
      • MetaSpecs ["register"]
      • MetaSpecs ["sglocator"]
      • MetaSpecs ["vertical"]
      • MetaSpecs ["accessors"]
  • Github repository
  • Repository
  • Show source
  • Open issue
  • .rst

xoa.cfgm.gen_cfgm_rst

Contents

  • gen_cfgm_rst()

xoa.cfgm.gen_cfgm_rst#

xoa.cfgm.gen_cfgm_rst(app)[source]#

previous

xoa.cfgm.gen_cfgm_cfg

next

xoa.cfgm.get_cfg_path

Contents
  • gen_cfgm_rst()

By Shom

© Copyright 2020-2026, Shom.