Functions for inspecting data =============================================================================== summary : describe files associated with a dataset --------------------------------------------------- .. autofunction:: climaf.functions.summary ncdump : dump file header ------------------------------ - :doc:`scripts/ncdump` cshow : dump an object ------------------------------------------------ .. autofunction:: climaf.driver.cshow :noindex: Functions to create images, and to display datasets and images ================================================================================ Warning ------------ **SEE ALSO** :ref:`the graphic operators ` and especially :doc:`scripts/plot` ncview: display a dataset ----------------------------- - :doc:`scripts/ncview` iplot : Interactive version of cshow() for display in IPython Notebooks ------------------------------------------------------------------------------------------------ .. autofunction:: climaf.functions.iplot implot : Interactive version of plot() for display in IPython Notebooks ------------------------------------------------------------------------------------------------ .. autofunction:: climaf.functions.implot ts_plot : Shortcut for ensemble_ts_plot ------------------------------------------------------------------------------------- .. autofunction:: climaf.functions.ts_plot plot_params : get plot parameters for a variable and a context ---------------------------------------------------------------- .. autofunction:: climaf.plot.plot_params.plot_params hovm_params : provide some SST/climate boxes for plotting Hovmoller diagrams ----------------------------------------------------------------------------- .. autofunction:: climaf.plot.plot_params.hovm_params cshow : display a figure using 'display' --------------------------------------------- .. autofunction:: climaf.driver.cshow :noindex: Functions for assembling figures in pages ============================================================== For choosing between next two fuctnions, see the :ref:`Note on figure pages ` cpage : create an array of figures (output: 'png' or 'pdf' figure) ------------------------------------------------------------------- .. autoclass:: climaf.classes.cpage :noindex: cpage_pdf : create an array of figures (output: 'pdf' figure) ------------------------------------------------------------- .. autoclass:: climaf.classes.cpage_pdf :noindex: html : package for creating an html index, with tables of links to figures -------------------------------------------------------------------------- .. automodule:: climaf.chtml .. autofunction:: climaf.chtml.header .. autofunction:: climaf.chtml.trailer .. autofunction:: climaf.chtml.section .. autofunction:: climaf.chtml.open_table .. autofunction:: climaf.chtml.close_table .. autofunction:: climaf.chtml.open_line .. autofunction:: climaf.chtml.close_line .. autofunction:: climaf.chtml.line .. autofunction:: climaf.chtml.link .. autofunction:: climaf.chtml.link_on_its_own_line .. autofunction:: climaf.chtml.cell .. autofunction:: climaf.chtml.fline .. autofunction:: climaf.chtml.flines .. autofunction:: climaf.chtml.vspace