generate

jwst.associations.generate(pool, rules, version_id=None)[source]

Generate associations in the pool according to the rules.

Parameters:
  • pool (AssociationPool) – The pool to generate from.
  • rules (Associations) – The associaton rule set.
  • version_id (None, True, or str) – The string to use to tag associations and products. If None, no tagging occurs. If True, use a timestamp If a string, the string.
Returns:

A 2-tuple consisting of:

  • List of associations
  • Table of items from the pool that do not belong to any association.

Return type:

([association,..], orphans)

Notes

Refer to the Association Generator documentation for a full description.