arrakis.process_spice

Arrakis single-field pipeline

Module Contents

Functions

cli()

Command-line interface

create_dask_runner(→ prefect_dask.DaskTaskRunner)

Create a DaskTaskRunner

main(→ None)

Main script

process_spice(→ None)

Workflow to process the SPIRCE-RACS data

save_args(→ pathlib.Path)

Helper function to create a record of the input configuration arguments that

arrakis.process_spice.cli()[source]

Command-line interface

arrakis.process_spice.create_dask_runner(dask_config: str, overload: bool = False) prefect_dask.DaskTaskRunner[source]

Create a DaskTaskRunner

Parameters:
  • dask_config (str) – Configuraiton file for the DaskTaskRunner

  • overload (bool, optional) – Overload the options for threadded work. Defaults to False.

Returns:

The prefect DaskTaskRunner instance

Return type:

DaskTaskRunner

arrakis.process_spice.main(args: configargparse.Namespace) None[source]

Main script

Parameters:

args (configargparse.Namespace) – Command line arguments.

arrakis.process_spice.process_spice(args, host: str, task_runner: prefect.task_runners.BaseTaskRunner) None[source]

Workflow to process the SPIRCE-RACS data

Parameters:
  • args (configargparse.Namespace) – Configuration parameters for this run

  • host (str) – Host address of the mongoDB.

arrakis.process_spice.save_args(args: configargparse.Namespace) pathlib.Path[source]

Helper function to create a record of the input configuration arguments that govern the pipeline instance

Parameters:

args (configargparse.Namespace) – Supplied arguments for the Arrakis pipeline instance

Returns:

Output path of the saved file

Return type:

Path