Contents¶
- License and acknowledgements
- Requirements and acknowledgements
- Installing, configuring, using
- Examples
- Operators : using external scripts, binaries and python functions
- Standard operators and functions
- CdfTools
- cLinearRegression : performs a linear regression between X and Y
- ccdfheatc : computes the heat content in the specified area (multi-variable input file)
- ccdfheatcm : computes the heat content in the specified area (mono-variable input file)
- ccdfmean : computes the mean value of the field (on full space domain, weighted)
- ccdfmean_profile : computes the vertical profile of horizontal means for 3D fields
- ccdfmean_profile_box : computes the vertical profile of horizontal means for 3D fields on a given geographical domain
- ccdfmxlheatc : computes the heat content in the mixed layer (multi-variable input file)
- ccdfmxlheatcm : computes the heat content in the mixed layer (mono-variable input file)
- ccdfsaltc : computes the salt content in the specified area
- ccdfsections : computes some variables (Uorth, Utang,…) along a section made of Nsec linear segments (multi-variable input file)
- ccdfsectionsm : computes some variables (Uorth, Utang,…) along a section made of Nsec linear segments (mono-variable input file)
- ccdfstd : computes the standard deviation of any variable
- ccdfstdmoy : computes the standard deviation and mean value of any variable
- ccdftransport : computes the transports accross a section
- ccdfvT : computes the time average values for V.T, V.S, U.T and U.S
- ccdfvar : computes the spatial variance of field (2D or 3D)
- ccdfvar_profile : computes the vertical profile of spatial variance for 3D fields
- ccdfzonalmean : compute the global zonal mean of the given variable
- ccdfzonalmean_bas : compute the zonal mean of the given variable in a specified sub-basin
- ccdo : invoke CDO with a unary operator
- ccdo2 : invoke CDO with a bianry operator (i.e. on two datasets)
- ccdo_ens : invoke CDO with a unary operator on an ensemble of datasets
- cepscrop : crop eps figures to their minimal size
- cpdfcrop : crop pdf figures to their minimal size
- curl_tau_atm : computes wind stress curl on regular grid (usually atmosphere)
- curves : plot multiple profiles (along p, lat, lon, time, …)
- divide : division between two CliMAF objects
- ensemble_ts_plot : plot time series
- hovm: plot Hovmöller diagrams on a given or global domain (SST/climate boxes, … )
- llbox : extract a latitude-longitude box
- mask : set a given value as missing value
- mean_and_std : field mean and standard deviation
- minus : difference of two fields using CDO operator sub
- ml2pl : interpolates a field from model levels to pressure levels
- multiply : multiplication between two CliMAF objects
- ncdump : show only the header information of a netCDF file
- ncpdq: netCDF Permute Dimensions Quickly
- ncview : launch ncview on a dataset
- plot: map, cross-section and profile plot of one or two fields, and vectors plot over a map
- plus : Addition of two fields using CDO operator add
- regrid : regrid an object to the grid of another one
- regridll : regrid an object to a lat-lon box of a CDO regular grid
- regridn : regrid an object to a named grid
- slice : extract a slice at a given dimension’s range
- space_average : compute space average
- time_average : compute time average for all time steps
- Available functions
- 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 processing data
- Functions for creating new processing functions, or tuning their behaviour
- Functions for managing numerical results
- 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
- Utility functions and variables
- Internal functions - presented here for their doc
- 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)
- Functions for data definition and access
- Calling ESMValTools diagnostic scripts
- HowTo…
- ..go quick through most CliMAF features
- ..install CliMAF
- ..run CliMAF, run an example
- ..describe where my data is
- ..get on-line help
- ..know which CliMAF operators are available and what they do
- ..tune CliMAF verbosity level
- ..report an issue
- ..declare my favorite script or binary as a CliMAF operator for my own use
- ..contribute a diagnostic module
- ..contribute to improve CliMAF documentation
- ..define a new data organization scheme
- ..record a CliMAF session
- Experts’ corner
- Contributing changes for integration in CliMAF
- What’s new
- Future steps and wish list
- Community & Contact