h_init

h_init(loglevel='info', plotlevel='default', weblog=True, processing_intents=None)[source]

Initialize the pipeline state and context.

h_init must be called before any other pipeline task. The pipeline can be initialized in one of two ways: by creating a new pipeline state (h_init) or be loading a saved pipeline state (h_resume).

h_init creates an empty pipeline context but does not load visibility data into the context. Any of the pipeline h*_importdata tasks can be used to load data.

Parameters:

  • loglevel (str) -- Log level for pipeline messages. Log messages below this threshold will not be displayed.

  • plotlevel (str) -- Toggle generation of detail plots in the web log. A level of 'all' generates all plots; 'summary' omits detail plots; 'default' generates all plots apart from for the hif_applycal task.

  • weblog (bool) -- Generate the web log

  • processing_intents (dict[str, Any] | None) -- Dictionary of processing intents for the current pipeline run.

Return type:

Context

Examples

  1. Create the pipeline context

>>> h_init()