Available functions¶
Function names presented here are those defined by module climaf.api
and can be used ‘as is’ (i.e. without prefixing it by the module name)
after executing:
>>> from climaf.api import *
even if they belong to another module
- Functions for data definition and access
- ds : define a dataset object (actually a front-end for
cdataset
) - cdataset : define a dataset object
- cdef : define some default values for datasets attributes
- eds : define an ensemble of datasets
- cens : define an ensemble of objects
- fds : define a dataset from a data file
- cproject : declare a new project and its non-standard attributes/facets
- derive_cproject : create a new project from an existing one by changing its name and possibly its facets
- cprojects : dictionary of known projects
- dataloc : describe data locations for a series of simulations
- cdefault: set or get a default value for some data attribute/facet
- derive : define a variable as computed from other variables
- calias : define a variable as computed, in a project, from another, single, variable
- cfreqs : declare non-standard frequency names, for a project
- crealms : declare non-standard realm names, for a project
- ds : define a dataset object (actually a front-end for
- Functions for inspecting data
- Functions to create images, and to display datasets and images
- Warning
- ncview: display a dataset
- iplot : Interactive version of cshow() for display in IPython Notebooks
- implot : Interactive version of plot() for display in IPython Notebooks
- ts_plot : Shortcut for ensemble_ts_plot
- plot_params : get plot parameters for a variable and a context
- hovm_params : provide some SST/climate boxes for plotting Hovmoller diagrams
- cshow : display a figure using ‘display’
- Functions for assembling figures in pages
- Functions for handling the cache
- clist : tell what’s in cache, and much more
- cls : tell what’s in cache
- crm : remove some files from cache
- cdu : disk cache usage
- cwc : count some files in cache
- craz : reset cache
- cdrop : erase a result’s file
- cprotect : protect a result’s file against cdrop and craz
- ccost : provide compute cost for an object
- Functions returning CliMAF objects
- cscalar : returns a scalar value (float) in python (using cMA)
- fadd : add two CliMAF objects or a CliMAF object and a constant
- fsub : subtract two CliMAF objects or a CliMAF object and a constant
- fmul : multiply two CliMAF objects or a CliMAF object and a constant
- fdiv : divide two CliMAF objects or a CliMAF object and a constant
- apply_scale_offset : Returns a CliMAF object after applying a scale and offset
- diff_regrid : Regrids dat1 on dat2 and returns the difference between dat1 and dat2
- diff_regridn : Regrids dat1 and dat2 on a chosen cdogrid (default is n90) and returns the difference between dat1 and dat2
- annual_cycle : Computes the annual cycle as the 12 climatological months of dat
- clim_average : Computes climatological averages on the annual cycle of a dataset
- lonlatvert_interpolation : Interpolates a lon/lat/pres field (two possible ways)
- zonmean : Return the zonal mean field of dat
- diff_zonmean : Returns the zonal mean bias of dat1 against dat2 (based on lonlatpres_interpolation)