nessai.utils.settings
=====================

.. py:module:: nessai.utils.settings

.. autoapi-nested-parse::

   Utilities for determining the settings available in nessai.

   Used for bilby and pycbc-inference.

   ..
       !! processed by numpydoc !!


Functions
---------

.. autoapisummary::

   nessai.utils.settings.get_all_kwargs
   nessai.utils.settings.get_run_kwargs_list


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

.. py:function:: get_all_kwargs(importance_nested_sampler: bool = False, split_kwargs: bool = False) -> dict

   
   Get a dictionary of all possible kwargs and their default values.


   :Parameters:

       **importance_nested_sampler**
           Indicates whether the importance nested sampler will be used or not.
           Defaults to :code:`False` for backwards compatibility.

       **split_kwargs**
           If True, the kwards are split into kwargs passed to :code:`FlowSampler`
           and those passes to :code:`FlowSampler.run`. If False, all kwargs are
           return in a single dictionary.



   :Returns:

       Dictionary of kwargs and their default values.
           ..











   ..
       !! processed by numpydoc !!

.. py:function:: get_run_kwargs_list(importance_nested_sampler: bool = False) -> List[str]

   
   Get a list of kwargs used in the run method


   :Parameters:

       **importance_nested_sampler**
           Indicates whether the importance nested sampler will be used or not.
           Defaults to :code:`False` for backwards compatibility.



   :Returns:

       List of kwargs.
           ..











   ..
       !! processed by numpydoc !!