xoa
v0.3.0

Getting Started

  • Installation
  • Configuration

User Guide

  • Using the modules
  • Practical examples
  • Commandline interface

Reference

  • API Reference
    • xoa
    • xoa.accessors
    • xoa.cf
      • xoa.cf.are_similar
      • xoa.cf.assign_cf_specs
      • xoa.cf.get_cf_specs
      • xoa.cf.get_cf_specs_encoding
      • xoa.cf.get_cf_specs_from_encoding
      • xoa.cf.get_cf_specs_from_name
      • xoa.cf.get_cf_specs_matching_score
      • xoa.cf.get_default_cf_specs
      • xoa.cf.get_matching_item_specs
      • xoa.cf.get_registered_cf_specs
      • xoa.cf.infer_cf_specs
      • xoa.cf.infer_coords
      • xoa.cf.is_registered_cf_specs
      • xoa.cf.register_cf_specs
      • xoa.cf.reset_cache
      • xoa.cf.search_similar
      • xoa.cf.show_cache
      • xoa.cf.CFCoordSpecs
      • xoa.cf.CFSpecs
        • xoa.cf.CFSpecs.auto_format
        • xoa.cf.CFSpecs.copy
        • xoa.cf.CFSpecs.decode
        • xoa.cf.CFSpecs.encode
        • xoa.cf.CFSpecs.fill_attrs
        • xoa.cf.CFSpecs.format_coord
        • xoa.cf.CFSpecs.format_data_var
        • xoa.cf.CFSpecs.format_dataset
        • xoa.cf.CFSpecs.get
        • xoa.cf.CFSpecs.get_axis
        • xoa.cf.CFSpecs.get_category
        • xoa.cf.CFSpecs.get_dim_type
        • xoa.cf.CFSpecs.get_dim_types
        • xoa.cf.CFSpecs.get_dims
        • xoa.cf.CFSpecs.get_loc
        • xoa.cf.CFSpecs.get_location
        • xoa.cf.CFSpecs.get_name
        • xoa.cf.CFSpecs.infer_coords
        • xoa.cf.CFSpecs.load_cfg
        • xoa.cf.CFSpecs.match
        • xoa.cf.CFSpecs.match_coord
        • xoa.cf.CFSpecs.match_data_var
        • xoa.cf.CFSpecs.parse_dims
        • xoa.cf.CFSpecs.pprint
        • xoa.cf.CFSpecs.search
        • xoa.cf.CFSpecs.search_coord
        • xoa.cf.CFSpecs.search_coord_from_dim
        • xoa.cf.CFSpecs.search_data_var
        • xoa.cf.CFSpecs.search_dim
        • xoa.cf.CFSpecs.set_name
        • xoa.cf.CFSpecs.set_specs
        • xoa.cf.CFSpecs.set_specs_from_cfg
        • xoa.cf.CFSpecs.categories
        • xoa.cf.CFSpecs.cfgspecs
        • xoa.cf.CFSpecs.coords
        • xoa.cf.CFSpecs.data_vars
        • xoa.cf.CFSpecs.dict
        • xoa.cf.CFSpecs.dims
        • xoa.cf.CFSpecs.name
        • xoa.cf.CFSpecs.sglocator
      • xoa.cf.CFVarSpecs
      • xoa.cf.SGLocator
      • xoa.cf.set_cf_specs
      • xoa.cf.XoaCFError
    • xoa.cfgm
    • xoa.cli
    • xoa.color
    • xoa.coords
    • xoa.dyn
    • xoa.filter
    • xoa.geo
    • xoa.grid
    • xoa.interp
    • xoa.misc
    • xoa.plot
    • xoa.regrid
    • xoa.sigma
  • What’s new
  • Development roadmap
  • Appendices
xoa
  • »
  • API Reference »
  • xoa.cf »
  • xoa.cf.CFSpecs »
  • xoa.cf.CFSpecs.search
  • Edit on GitHub

xoa.cf.CFSpecs.search¶

CFSpecs.search(dsa, name=None, loc='any', get='obj', single=True, categories=None, errors='warn')[source]¶

Search for a dataarray with data_vars and/or coords

Parameters
  • dsa (xarray.DataArray, xarray.Dataset) – Array or dataset to scan

  • name (str) – Name to search for.

  • categories (str, list, None) – Explicty categories with “coords” and “data_vars”.

  • errors ({'ignore', 'warn', 'raise'}) –

    In case of errors

    • ignore: silently ignore

    • warn: emit a warning

    • raise: raise an exception

Returns

None, xarray.DataArray, list

Next Previous

© Copyright 2020-2021, Shom. Revision d71b04c8.

Built with Sphinx using a theme provided by Read the Docs.