nessai.config
=============

.. py:module:: nessai.config

.. autoapi-nested-parse::

   Global configuration for nessai.

   ..
       !! processed by numpydoc !!


Classes
-------

.. autoapisummary::

   nessai.config.LivepointsConfig
   nessai.config.PlottingConfig
   nessai.config.GeneralConfig


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

.. py:class:: LivepointsConfig

   Bases: :py:obj:`_BaseConfig`


   
   Configuration for live points.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: logl_dtype
      :type:  str
      :value: 'f8'


      
      Default log-likelihood dtype
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: it_dtype
      :type:  str
      :value: 'i4'


      
      Default dtype for iteration parameter
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: it_default
      :type:  int
      :value: 0


      
      Default value for the iteration parameter
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: default_float_dtype
      :type:  str
      :value: 'f8'


      
      Default dtype for parameters
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: default_float_value
      :type:  float

      
      Default value for parameters
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: core_parameters
      :type:  List[str]
      :value: ['logP', 'logL', 'it']


      
      List of the core non-sampling parameters included in all live points
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: extra_parameters
      :type:  List[str]
      :value: []


      
      Additional extra parameters included in live points
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: extra_parameters_dtype
      :type:  List[str]
      :value: []


      
      Defaults dtype for extra parameters
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: extra_parameters_defaults
      :type:  Tuple
      :value: ()


      
      Default values for additional extra extra
















      ..
          !! processed by numpydoc !!


   .. py:property:: core_parameters_dtype
      :type: List[str]


      
      List of dtypes for the core non-sampling parameters
















      ..
          !! processed by numpydoc !!


   .. py:property:: core_parameters_defaults
      :type: Tuple


      
      Tuple of default values for core non-sampling parameters.
















      ..
          !! processed by numpydoc !!


   .. py:property:: non_sampling_parameters
      :type: List[str]


      
      List of all the non-sampling parameters
















      ..
          !! processed by numpydoc !!


   .. py:property:: non_sampling_defaults
      :type: Tuple


      
      List of default values for all the non-sampling parameters
















      ..
          !! processed by numpydoc !!


   .. py:property:: non_sampling_dtype
      :type: List[str]


      
      List of the dtype for all the non-sampling parameters
















      ..
          !! processed by numpydoc !!


   .. py:method:: reset() -> None

      
      Reset the extra parameters and properties
















      ..
          !! processed by numpydoc !!


   .. py:method:: reset_properties() -> None

      
      Reset the cached properties
















      ..
          !! processed by numpydoc !!


.. py:class:: PlottingConfig

   Bases: :py:obj:`_BaseConfig`


   
   Configuration for plotting.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: disable_style
      :type:  bool
      :value: False


      
      Disable nessai's custom plotting style globally.

      Useful since all plotting functions use the
      :py:func:`~nessai.plot.nessai_style` decorator by default.















      ..
          !! processed by numpydoc !!


   .. py:attribute:: sns_style
      :type:  str
      :value: None


      
      Default seaborn style.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: base_colour
      :type:  str
      :value: '#02979d'


      
      Base colour for plots.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: highlight_colour
      :type:  str
      :value: '#f5b754'


      
      Highlight colour for plots.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: line_colours
      :type:  List[str]
      :value: ['#4575b4', '#d73027', '#fad117', '#ff8c00']


      
      Default line colours.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: line_styles
      :type:  List[str]
      :value: ['-', '--', ':', '-.']


      
      Default line styles.
















      ..
          !! processed by numpydoc !!


   .. py:attribute:: max_figsize
      :type:  float
      :value: 50


      
      Maximum figure size in either width or height.

      Based on the default DPI in matplotlib of 100, so this will give a maximum
      size of 5000 pixels.















      ..
          !! processed by numpydoc !!


   .. py:attribute:: clip_min
      :type:  float
      :value: -10000000000.0


      
      Minimum value to clip data to for plotting.

      This is used to avoid issues with plots where the dynamic range is too
      large for matplotlib to handle.















      ..
          !! processed by numpydoc !!


.. py:class:: GeneralConfig

   Bases: :py:obj:`_BaseConfig`


   
   General configuration options
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: eps
      :type:  float
      :value: 1e-08


      
      Epsilon value used for numerical stability
















      ..
          !! processed by numpydoc !!