:py:mod:`start_pipeline`
========================

.. py:module:: start_pipeline


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


Functions
~~~~~~~~~

.. autoapisummary::

   start_pipeline.arg_init
   start_pipeline.check_runfiles_dir
   start_pipeline.check_sb_path
   start_pipeline.find_ms_dir
   start_pipeline.check_queue
   start_pipeline.wait_for_space
   start_pipeline.get_final_jobid
   start_pipeline.p_grep
   start_pipeline.parset_to_config_file
   start_pipeline.save_config
   start_pipeline.main
   start_pipeline.inner_loop



Attributes
~~~~~~~~~~

.. autoapisummary::

   start_pipeline.NOFORMAT
   start_pipeline.queue_max
   start_pipeline.queue_per_field
   start_pipeline.queue_extra
   start_pipeline.queue_sleep
   start_pipeline.explanation
   start_pipeline.archives
   start_pipeline.version


.. py:data:: NOFORMAT
   :value: '{noformat}\n'

   

.. py:data:: queue_max
   :value: 7000

   

.. py:data:: queue_per_field
   :value: 60

   

.. py:data:: queue_extra
   :value: 50

   

.. py:data:: queue_sleep
   :value: 200

   

.. py:data:: explanation
   :value: Multiline-String

    .. raw:: html

        <details><summary>Show Value</summary>

    .. code-block:: python

        """
        This launches the processASKAP pipeline
        --------------------------------------------------------------
        There are two possibilities:
        i) Determine the bandpass calibration tables - use '-b CAL_SBID' without '-i' or '-n' switches.
            start_pipeline.py -b 20148
            start_pipeline.py -b 20148 20435 20892
        
        ii) Image one or more fields specified either as '-i SBID' or '-n ROW_NUM' where the survey
            database row number is given. If the '-i' switch is used, also provide the bandpass SBID with '-b'.
            start_pipeline.py -i 20908 -b 20892
            start_pipeline.py -e 1 -n 412
        
            Inputs for processASKAP.sh are provided by a sequence of sources:
             i) All input variables have default values defined in
                  https://www.atnf.csiro.au/computing/software/askapsoft/sdp/docs/current/pipelines/ControlParameters.html
            ii) These can be over-ridden with values passed to processAKSAP in a config file. This script compiles the config
                file from three sources:
                1. One of two parsets held in the aces repository: bandpass_default.parset and image_default.parset.
                2. The chosen defaults parset (depending on the requested operation) can be over-ridden or augmented by values
                   in a local parset specified with the '-p' switch (default is pipeline.parset in working directory).
                3. Final additions are made by the script itself; these reflect other command-line arguments.
        
        """

    .. raw:: html

        </details>

   

.. py:data:: archives
   :value: ['/askapbuffer/payne/askap-scheduling-blocks/', '/askapbuffer/scott/askap-scheduling-blocks/']

   

.. py:data:: version
   :value: '20210222'

   

.. py:function:: arg_init()


.. py:function:: check_runfiles_dir(workdir)


.. py:function:: check_sb_path(sb, work_path)


.. py:function:: find_ms_dir(sb)


.. py:function:: check_queue()


.. py:function:: wait_for_space(n_fields=12)


.. py:function:: get_final_jobid(joblist)


.. py:function:: p_grep(things, files)


.. py:function:: parset_to_config_file(ps, filename)


.. py:function:: save_config(parset, rundir, sb)


.. py:function:: main()


.. py:function:: inner_loop(sb_path, config_name, run_date, module_loader)

   :type module_loader: object