polaris.tasks.ocean.analysis.analysis_step.AnalysisStep.add_product

AnalysisStep.add_product(plot, group, gallery, title, data=None, **facets)

Describe one product this step has just made, and update the fragment

The range of years the step covers is added to the facets unless the caller gives its own, since every product of an analysis step covers the step’s range and the published name of a product is what keeps two ranges from colliding.

Parameters:

• plot (str) – The name of the plot file, relative to the step’s work directory

• group (str) – The product group this belongs to, which becomes a gallery group

• gallery (str) – The gallery within that group

• title (str) – A one-line description, used as the caption

• data (str, optional) – The name of the netCDF file holding what was plotted

• facets – Any other keys that identify the product

Returns:

product (polaris.analysis.manifest.Product) – The product that was added