arrakis.cleanup
===============

.. py:module:: arrakis.cleanup

.. autoapi-nested-parse::

   DANGER ZONE: Purge directories of un-needed FITS files.

   ..
       !! processed by numpydoc !!


Attributes
----------

.. autoapisummary::

   arrakis.cleanup.TQDM_OUT


Functions
---------

.. autoapisummary::

   arrakis.cleanup.cleanup_parser
   arrakis.cleanup.cli
   arrakis.cleanup.main
   arrakis.cleanup.make_cutout_tarball
   arrakis.cleanup.purge_cubelet_beams


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

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

.. py:function:: cli()

   
   Command-line interface
















   ..
       !! processed by numpydoc !!

.. py:function:: main(datadir: pathlib.Path, overwrite: bool = False) -> None

   
   Clean up beam images flow

   :Parameters: * **datadir** (*Path*) -- Directory with sub dir 'cutouts'
                * **overwrite** (*bool*) -- Overwrite existing tarball















   ..
       !! processed by numpydoc !!

.. py:function:: make_cutout_tarball(cutdir: pathlib.Path, overwrite: bool = False) -> pathlib.Path

   
   Make a tarball of the cutouts directory

   :Parameters: **cutdir** (*Path*) -- Directory containing cutouts

   :returns: Path to the tarball
   :rtype: Path















   ..
       !! processed by numpydoc !!

.. py:function:: purge_cubelet_beams(filepath: pathlib.Path) -> pathlib.Path

   
   Clean up beam images

   :Parameters: * **workdir** (*str*) -- Directory containing images
                * **stoke** (*str*) -- Stokes parameter















   ..
       !! processed by numpydoc !!

.. py:data:: TQDM_OUT