polaris.provenance.get_summary

polaris.provenance.get_summary(config=None)

Get a short provenance of the Polaris that is running

This is the provenance in the form something presented to a reader can carry — a generated page, a report — rather than the file polaris.provenance.write() writes, which is exhaustive.

Parameters:

config (polaris.config.PolarisConfigParser, optional) – The config options, used to record the version of the component that was built, if there is one

Returns:

summary (dict) – Labels and the values they had, in the order they are worth reading