nessai.config#
Global configuration for nessai.
Classes#
Configuration for live points. |
|
Configuration for plotting. |
|
General configuration options |
Module Contents#
- class nessai.config.LivepointsConfig#
Bases:
_BaseConfigConfiguration for live points.
- logl_dtype: str = 'f8'#
Default log-likelihood dtype
- it_dtype: str = 'i4'#
Default dtype for iteration parameter
- it_default: int = 0#
Default value for the iteration parameter
- default_float_dtype: str = 'f8'#
Default dtype for parameters
- default_float_value: float#
Default value for parameters
- core_parameters: List[str] = ['logP', 'logL', 'it']#
List of the core non-sampling parameters included in all live points
- extra_parameters: List[str] = []#
Additional extra parameters included in live points
- extra_parameters_dtype: List[str] = []#
Defaults dtype for extra parameters
- extra_parameters_defaults: Tuple = ()#
Default values for additional extra extra
- property core_parameters_dtype: List[str]#
List of dtypes for the core non-sampling parameters
- property core_parameters_defaults: Tuple#
Tuple of default values for core non-sampling parameters.
- property non_sampling_parameters: List[str]#
List of all the non-sampling parameters
- property non_sampling_defaults: Tuple#
List of default values for all the non-sampling parameters
- property non_sampling_dtype: List[str]#
List of the dtype for all the non-sampling parameters
- reset() None#
Reset the extra parameters and properties
- reset_properties() None#
Reset the cached properties
- class nessai.config.PlottingConfig#
Bases:
_BaseConfigConfiguration for plotting.
- disable_style: bool = False#
Disable nessai’s custom plotting style globally.
Useful since all plotting functions use the
nessai_style()decorator by default.
- sns_style: str = None#
Default seaborn style.
- base_colour: str = '#02979d'#
Base colour for plots.
- highlight_colour: str = '#f5b754'#
Highlight colour for plots.
- line_colours: List[str] = ['#4575b4', '#d73027', '#fad117', '#ff8c00']#
Default line colours.
- line_styles: List[str] = ['-', '--', ':', '-.']#
Default line styles.
- max_figsize: float = 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.
- clip_min: float = -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.