astrohack.utils.pipeline_support
================================

.. py:module:: astrohack.utils.pipeline_support


Classes
-------

.. autoapisummary::

   astrohack.utils.pipeline_support.MessageBoard


Functions
---------

.. autoapisummary::

   astrohack.utils.pipeline_support.yesno
   astrohack.utils.pipeline_support.file_is_asdm
   astrohack.utils.pipeline_support.run_casatask
   astrohack.utils.pipeline_support.parse_list_or_all
   astrohack.utils.pipeline_support.make_dict_str_simple
   astrohack.utils.pipeline_support.initialization_check
   astrohack.utils.pipeline_support.proceed_check
   astrohack.utils.pipeline_support.list_input_tooltip
   astrohack.utils.pipeline_support.created_filtered_kwargs_dict
   astrohack.utils.pipeline_support.run_astrohack_function
   astrohack.utils.pipeline_support.base_name_determination
   astrohack.utils.pipeline_support.asdm_test_and_import
   astrohack.utils.pipeline_support.get_time_string_from_dict
   astrohack.utils.pipeline_support.get_lst_string_from_time_str
   astrohack.utils.pipeline_support.add_basic_info_and_parameters_to_report


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

.. py:function:: yesno(prompt)

.. py:function:: file_is_asdm(filename)

.. py:class:: MessageBoard(width=None, block_char='#', spacing=1, blocking=3)

   .. py:attribute:: block_char
      :value: '#'



   .. py:attribute:: spacing


   .. py:attribute:: blocking
      :value: 3



   .. py:attribute:: capo
      :value: '### '



   .. py:attribute:: coda
      :value: Multiline-String

      .. raw:: html

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

      .. code-block:: python

         """ ###
         """

      .. raw:: html

         </details>




   .. py:attribute:: usable_width


   .. py:attribute:: block_line


   .. py:attribute:: block_len


   .. py:method:: heading(user_msg)


   .. py:method:: one_liner(msg)


   .. py:method:: done()


.. py:function:: run_casatask(task_name: str, kwargs_dict: dict, msger: MessageBoard = None, intended_output: str | None = None, overwrite: bool = False, verbose: bool = True) -> bool

   Run a casatask and returns True if it has been run, False if it was skipped
   :param task_name: Casatask name
   :param kwargs_dict: Dict containing arguments for casatask
   :param msger: MessageBoard object
   :param intended_output: Possible intended output
   :param overwrite: Overwrite flag (only used when there is an intended output)
   :param verbose: Verbose flag (print messages regarding execution and execution time)
   :return: True when casatask was run, False otherwise


.. py:function:: parse_list_or_all(parameter_value: str)

.. py:function:: make_dict_str_simple(the_dict, ident=4)

.. py:function:: initialization_check(param_dict: dict, title: str)

.. py:function:: proceed_check(param_dict: dict, prompt: str = 'Proceed?')

.. py:function:: list_input_tooltip(example)

.. py:function:: created_filtered_kwargs_dict(param_dict: dict, function)

.. py:function:: run_astrohack_function(param_dict: dict, function, msger: MessageBoard, verbose: bool = True)

.. py:function:: base_name_determination(param_dict: dict)

.. py:function:: asdm_test_and_import(param_dict: dict, base_name, msger: MessageBoard)

.. py:function:: get_time_string_from_dict(time_dict, qa)

.. py:function:: get_lst_string_from_time_str(time_str)

.. py:function:: add_basic_info_and_parameters_to_report(param_dict: dict)