arrakis.process_spice
=====================

.. py:module:: arrakis.process_spice

.. autoapi-nested-parse::

   Arrakis single-field pipeline

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   arrakis.process_spice.cli
   arrakis.process_spice.create_dask_runner
   arrakis.process_spice.main
   arrakis.process_spice.pipeline_parser
   arrakis.process_spice.process_spice
   arrakis.process_spice.save_args


Module Contents
---------------

.. py:function:: cli() -> None

   
   Command-line interface
















   ..
       !! processed by numpydoc !!

.. py:function:: create_dask_runner(dask_config: str, overload: bool = False) -> prefect_dask.DaskTaskRunner

   
   Create a DaskTaskRunner

   :Parameters: * **dask_config** (*str*) -- Configuration file for the DaskTaskRunner
                * **overload** (*bool, optional*) -- Overload the options for threadded work. Defaults to False.

   :returns: The prefect DaskTaskRunner instance
   :rtype: DaskTaskRunner















   ..
       !! processed by numpydoc !!

.. py:function:: main(args: configargparse.Namespace) -> None

   
   Main script

   :Parameters: **args** (*configargparse.Namespace*) -- Command line arguments.















   ..
       !! processed by numpydoc !!

.. py:function:: pipeline_parser(parent_parser: bool = False) -> argparse.ArgumentParser

.. py:function:: process_spice(args, host: str, task_runner: prefect.task_runners.BaseTaskRunner) -> None

   
   Workflow to process the SPICE-RACS data

   :Parameters: * **args** (*configargparse.Namespace*) -- Configuration parameters for this run
                * **host** (*str*) -- Host address of the mongoDB.















   ..
       !! processed by numpydoc !!

.. py:function:: save_args(args: configargparse.Namespace) -> pathlib.Path

   
   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
   :rtype: Path















   ..
       !! processed by numpydoc !!