API reference

User-facing API

These functions are intended for user use.

• add_cyclic
  • add_cyclic()
• axes
  • axes()
• axes_plot
  • axes_plot()
• vect
  • calculate_levels()
• cbar
  • cbar()
• cf_var_name
  • cf_var_name()
• con
  • con()
• cscale
  • cscale()
• find_pos_in_array
  • find_pos_in_array()
• fix_floats
  • fix_floats()
• gclose
  • gclose()
• gopen
  • gopen()
• gpos
  • gpos()
• gset
  • gset()
• levs
  • levs()
• lineplot
  • lineplot()
• mapset
  • mapset()
• max_ndecs_data
  • max_ndecs_data()
• ndecs
  • ndecs()
• pcon
  • pcon()
• polar_regular_grid
  • polar_regular_grid()
• reset
  • reset()
• rgaxes
  • rgaxes()
• setvars
  • setvars()
• stipple
  • stipple()
• stipple_points
  • stipple_points()
• stream
  • stream()
• traj
  • traj()
• vect
  • vect()
• vloc
  • vloc()

Internal API

These functions are not intended for user use.

• _bfill
  • _bfill()
• _bfill_ugrid
  • _bfill_ugrid()
• _cf_data_assign
  • _cf_data_assign()
• _check_data
  • _check_data()
• _cscale_get_map
  • _cscale_get_map()
• _dim_titles
  • _dim_titles()
• _gvals
  • _gvals()
• _map_title
  • _map_title()
• _mapaxis
  • _mapaxis()
• _plot_map_axes
  • _plot_map_axes()
• _process_color_scales
  • _process_color_scales()
• _set_map
  • _set_map()
• _supscr
  • _supscr()
• _timeaxis
  • _timeaxis()

Deprecations

These functions are not intended for user use and will be removed in the next version. In most cases these have no use in the codebase as of v3.3.0.

• regrid
  • regrid()

Note the functions compare_arrays and regression_tests (version 3.3.0 and earlier) related to testing only so have been moved out of the functional codebase.