polaris.analysis.manifest.Product

class polaris.analysis.manifest.Product(plot, group, gallery, title, data=None, **facets)[source]

One published product: a plot, the data behind it, and the facets that identify it

Variables:

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

  • data (str or None) – The name of the netCDF file holding what was plotted, relative to the step’s work directory, or None for a product with no data file

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

  • gallery (str) – The gallery within that group

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

  • facets (dict) – Everything else that identifies the product — field, season, vertical reduction, date range, and later region and observational reference. These are caption and filter material; only group and gallery shape the index.

__init__(plot, group, gallery, title, data=None, **facets)[source]

Describe one product

Parameters:

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

  • group (str) – The product group this belongs to

  • 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

Methods

__init__(plot, group, gallery, title[, data])

Describe one product

from_dict(entry)

Build a product from a dictionary read back from JSON

to_dict()

Get the product as a dictionary ready to be written to JSON