bilby_pipe.parser
=================

.. py:module:: bilby_pipe.parser


Attributes
----------

.. autoapisummary::

   bilby_pipe.parser.__version__


Classes
-------

.. autoapisummary::

   bilby_pipe.parser.StoreBoolean


Functions
---------

.. autoapisummary::

   bilby_pipe.parser.create_parser
   bilby_pipe.parser.main


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

.. py:data:: __version__

.. py:class:: StoreBoolean(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

   Bases: :py:obj:`argparse.Action`


   
   argparse class for robust handling of booleans with configargparse

   When using configargparse, if the argument is setup with
   action="store_true", but the default is set to True, then there is no way,
   in the config file to switch the parameter off. To resolve this, this class
   handles the boolean properly.















   ..
       !! processed by numpydoc !!

   .. py:method:: __call__(parser, namespace, value, option_string=None)


.. py:function:: create_parser(top_level=True)

   
   Creates the BilbyArgParser for bilby_pipe


   :Parameters:

       **top_level:**
           If true, parser is to be used at the top-level with requirement
           checking etc, else it is an internal call and will be ignored.



   :Returns:

       parser: BilbyArgParser instance
           Argument parser











   ..
       !! processed by numpydoc !!

.. py:function:: main()