settings

Modules:

Name	Description
convolution_settings
detailed_balance_settings

Classes:

Name	Description
ConvolutionSettings	Settings for numerical convolutions.
DetailedBalanceSettings	Class to manage detailed balance settings for a SampleModel or Analysis.

Classes

ConvolutionSettings(upsample_factor=5, extension_factor=0.2, suppress_warnings=False, display_name='MyConvolutionSettings', unique_name=None)

Settings for numerical convolutions.

Parameters:

Name	Type	Description	Default
upsample_factor	Numeric | None	The factor by which to upsample the input data before convolution.	5
extension_factor	Numeric | None	The factor by which to extend the input data range before convolution.	0.2
suppress_warnings	bool	Whether to suppress warnings about wide or narrow peaks in the models.	False
display_name	str | None	Display name of the model.	'MyConvolutionSettings'
unique_name	str | None	Unique name of the model. If None, a unique name will be generated.	None

Raises:

Type	Description
TypeError	If upsample_factor is not a number or None. If extension_factor is not a number or None. If suppress_warnings is not a boolean.
ValueError	If upsample_factor is not greater than 1. If extension_factor is negative.

Methods:

Name	Description
to_dict	Convert an EasyScience object into a full dictionary using
from_dict	Re-create an EasyScience object from a full encoded
__dir__	This creates auto-completion and helps out in iPython
__copy__	Return a copy of the object.
__repr__	Return a string representation of the ConvolutionSettings.

Attributes:

Name	Type	Description
unique_name	str	Get the unique name of the object.
display_name	str	Get a pretty display name.
name	str	Get the name of the model.
upsample_factor	Numeric | None	Get the upsample factor.
extension_factor	float	Get the extension factor.
convolution_plan_is_valid	bool	Get whether the convolution plan is valid.
suppress_warnings	bool	Get whether to suppress warnings.

Attributes

unique_name property writable

Get the unique name of the object.

display_name property writable

Get a pretty display name.

:return: The pretty display name.

name property writable

Get the name of the model.

Returns:

Type	Description
str	The name of the model.

upsample_factor property writable

Get the upsample factor.

Returns:

Type	Description
Numeric | None	The upsample factor.

extension_factor property writable

Get the extension factor.

The extension factor determines how much the energy range is extended on both sides before convolution. 0.2 means extending by 20% of the original energy span on each side

Returns:

Type	Description
float	The extension factor.

convolution_plan_is_valid property writable

Get whether the convolution plan is valid.

Returns:

Type	Description
bool	Whether the convolution plan is valid.

suppress_warnings property writable

Get whether to suppress warnings.

Returns:

Type	Description
bool	Whether to suppress warnings.

Functions

to_dict(skip=None)

Convert an EasyScience object into a full dictionary using SerializerBases generic convert_to_dict method.

:param skip: List of field names as strings to skip when forming the dictionary :return: encoded object containing all information to reform an EasyScience object.

from_dict(obj_dict) classmethod

Re-create an EasyScience object from a full encoded dictionary.

:param obj_dict: dictionary containing the serialized contents (from SerializerDict) of an EasyScience object :return: Reformed EasyScience object

__dir__()

This creates auto-completion and helps out in iPython notebooks.

:return: list of function and parameter names for auto- completion

__copy__()

Return a copy of the object.

__repr__()

Return a string representation of the ConvolutionSettings.

Returns:

Type	Description
str	A string representation of the ConvolutionSettings.

DetailedBalanceSettings(use_detailed_balance=True, normalize_detailed_balance=True, display_name='DetailedBalanceSettings', unique_name=None)

Class to manage detailed balance settings for a SampleModel or Analysis.

Parameters:

Name	Type	Description	Default
use_detailed_balance	bool	Whether to apply detailed balance to the model. If False, no detailed balance is applied.	True
normalize_detailed_balance	bool	Whether to normalize the detailed balance factor by dividing with temperature.	True
display_name	str	Display name of the model.	'DetailedBalanceSettings'
unique_name	str | None	Unique name of the model. If None, a unique name will be generated.	None

Raises:

Type	Description
TypeError	If use_detailed_balance or normalize_detailed_balance is not a bool.

Methods:

Name	Description
to_dict	Convert an EasyScience object into a full dictionary using
from_dict	Re-create an EasyScience object from a full encoded
__dir__	This creates auto-completion and helps out in iPython
__copy__	Return a copy of the object.
__repr__	Return a string representation of the DetailedBalanceSettings.

Attributes:

Name	Type	Description
unique_name	str	Get the unique name of the object.
display_name	str	Get a pretty display name.
name	str	Get the name of the model.
use_detailed_balance	bool	Get whether to apply detailed balance to the model.
normalize_detailed_balance	bool	Get whether to divide the detailed balance factor by temperature.

Attributes

unique_name property writable

Get the unique name of the object.

display_name property writable

Get a pretty display name.

:return: The pretty display name.

name property writable

Get the name of the model.

Returns:

Type	Description
str	The name of the model.

use_detailed_balance property writable

Get whether to apply detailed balance to the model.

Returns:

Type	Description
bool	True if detailed balance is applied, False otherwise.

normalize_detailed_balance property writable

Get whether to divide the detailed balance factor by temperature.

Returns:

Type	Description
bool	True if the detailed balance factor should be normalized by dividing with temperature, False otherwise.

Functions

to_dict(skip=None)

Convert an EasyScience object into a full dictionary using SerializerBases generic convert_to_dict method.

:param skip: List of field names as strings to skip when forming the dictionary :return: encoded object containing all information to reform an EasyScience object.

from_dict(obj_dict) classmethod

Re-create an EasyScience object from a full encoded dictionary.

:param obj_dict: dictionary containing the serialized contents (from SerializerDict) of an EasyScience object :return: Reformed EasyScience object

__dir__()

This creates auto-completion and helps out in iPython notebooks.

:return: list of function and parameter names for auto- completion

__copy__()

Return a copy of the object.

__repr__()

Return a string representation of the DetailedBalanceSettings.

Returns:

Type	Description
str	A string representation of the DetailedBalanceSettings.

Modules

convolution_settings

Classes:

Name	Description
ConvolutionSettings	Settings for numerical convolutions.

Classes

ConvolutionSettings(upsample_factor=5, extension_factor=0.2, suppress_warnings=False, display_name='MyConvolutionSettings', unique_name=None)

Settings for numerical convolutions.

Parameters:

Name	Type	Description	Default
upsample_factor	Numeric | None	The factor by which to upsample the input data before convolution.	5
extension_factor	Numeric | None	The factor by which to extend the input data range before convolution.	0.2
suppress_warnings	bool	Whether to suppress warnings about wide or narrow peaks in the models.	False
display_name	str | None	Display name of the model.	'MyConvolutionSettings'
unique_name	str | None	Unique name of the model. If None, a unique name will be generated.	None

Raises:

Type	Description
TypeError	If upsample_factor is not a number or None. If extension_factor is not a number or None. If suppress_warnings is not a boolean.
ValueError	If upsample_factor is not greater than 1. If extension_factor is negative.

Methods:

Name	Description
__repr__	Return a string representation of the ConvolutionSettings.
to_dict	Convert an EasyScience object into a full dictionary using
from_dict	Re-create an EasyScience object from a full encoded
__dir__	This creates auto-completion and helps out in iPython
__copy__	Return a copy of the object.

Attributes:

Name	Type	Description
upsample_factor	Numeric | None	Get the upsample factor.
extension_factor	float	Get the extension factor.
convolution_plan_is_valid	bool	Get whether the convolution plan is valid.
suppress_warnings	bool	Get whether to suppress warnings.
unique_name	str	Get the unique name of the object.
display_name	str	Get a pretty display name.
name	str	Get the name of the model.

Attributes

upsample_factor property writable

Get the upsample factor.

Returns:

Type	Description
Numeric | None	The upsample factor.

extension_factor property writable

Get the extension factor.

The extension factor determines how much the energy range is extended on both sides before convolution. 0.2 means extending by 20% of the original energy span on each side

Returns:

Type	Description
float	The extension factor.

convolution_plan_is_valid property writable

Get whether the convolution plan is valid.

Returns:

Type	Description
bool	Whether the convolution plan is valid.

suppress_warnings property writable

Get whether to suppress warnings.

Returns:

Type	Description
bool	Whether to suppress warnings.

unique_name property writable

Get the unique name of the object.

display_name property writable

Get a pretty display name.

:return: The pretty display name.

name property writable

Get the name of the model.

Returns:

Type	Description
str	The name of the model.

Functions

__repr__()

Return a string representation of the ConvolutionSettings.

Returns:

Type	Description
str	A string representation of the ConvolutionSettings.

to_dict(skip=None)

Convert an EasyScience object into a full dictionary using SerializerBases generic convert_to_dict method.

:param skip: List of field names as strings to skip when forming the dictionary :return: encoded object containing all information to reform an EasyScience object.

from_dict(obj_dict) classmethod

Re-create an EasyScience object from a full encoded dictionary.

:param obj_dict: dictionary containing the serialized contents (from SerializerDict) of an EasyScience object :return: Reformed EasyScience object

__dir__()

This creates auto-completion and helps out in iPython notebooks.

:return: list of function and parameter names for auto- completion

__copy__()

Return a copy of the object.

detailed_balance_settings

Classes:

Name	Description
DetailedBalanceSettings	Class to manage detailed balance settings for a SampleModel or Analysis.

Classes

DetailedBalanceSettings(use_detailed_balance=True, normalize_detailed_balance=True, display_name='DetailedBalanceSettings', unique_name=None)

Class to manage detailed balance settings for a SampleModel or Analysis.

Parameters:

Name	Type	Description	Default
use_detailed_balance	bool	Whether to apply detailed balance to the model. If False, no detailed balance is applied.	True
normalize_detailed_balance	bool	Whether to normalize the detailed balance factor by dividing with temperature.	True
display_name	str	Display name of the model.	'DetailedBalanceSettings'
unique_name	str | None	Unique name of the model. If None, a unique name will be generated.	None

Raises:

Type	Description
TypeError	If use_detailed_balance or normalize_detailed_balance is not a bool.

Methods:

Name	Description
__repr__	Return a string representation of the DetailedBalanceSettings.
to_dict	Convert an EasyScience object into a full dictionary using
from_dict	Re-create an EasyScience object from a full encoded
__dir__	This creates auto-completion and helps out in iPython
__copy__	Return a copy of the object.

Attributes:

Name	Type	Description
use_detailed_balance	bool	Get whether to apply detailed balance to the model.
normalize_detailed_balance	bool	Get whether to divide the detailed balance factor by temperature.
unique_name	str	Get the unique name of the object.
display_name	str	Get a pretty display name.
name	str	Get the name of the model.

Attributes

use_detailed_balance property writable

Get whether to apply detailed balance to the model.

Returns:

Type	Description
bool	True if detailed balance is applied, False otherwise.

normalize_detailed_balance property writable

Get whether to divide the detailed balance factor by temperature.

Returns:

Type	Description
bool	True if the detailed balance factor should be normalized by dividing with temperature, False otherwise.

unique_name property writable

Get the unique name of the object.

display_name property writable

Get a pretty display name.

:return: The pretty display name.

name property writable

Get the name of the model.

Returns:

Type	Description
str	The name of the model.

Functions

__repr__()

Return a string representation of the DetailedBalanceSettings.

Returns:

Type	Description
str	A string representation of the DetailedBalanceSettings.

to_dict(skip=None)

Convert an EasyScience object into a full dictionary using SerializerBases generic convert_to_dict method.

:param skip: List of field names as strings to skip when forming the dictionary :return: encoded object containing all information to reform an EasyScience object.

from_dict(obj_dict) classmethod

Re-create an EasyScience object from a full encoded dictionary.

:param obj_dict: dictionary containing the serialized contents (from SerializerDict) of an EasyScience object :return: Reformed EasyScience object

__dir__()

This creates auto-completion and helps out in iPython notebooks.

:return: list of function and parameter names for auto- completion

__copy__()

Return a copy of the object.