:py:mod:`nessai.utils.logging`
==============================

.. py:module:: nessai.utils.logging

.. autoapi-nested-parse::

   Utilities related to logging.

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   nessai.utils.logging.setup_logger



.. py:function:: setup_logger(output=None, label='nessai', log_level='WARNING')

   
   Setup the logger.

   Based on the implementation in Bilby:
   https://git.ligo.org/lscsoft/bilby/-/blob/master/bilby/core/utils/log.py

   :Parameters:

       **output** : str, optional
           Path of to output directory.

       **label** : str, optional
           Label for this instance of the logger.

       **log_level** : {'ERROR', 'WARNING', 'INFO', 'DEBUG'}, optional
           Level of logging passed to logger.

   :Returns:

       :obj:`logging.Logger`
           Instance of the Logger class.













   ..
       !! processed by numpydoc !!