Relax source design

The following is a set of notes which will be used to design the layout of functions, modules, and packages in relax.

Packages

Package: specific_analyses

The package layout for each analysis is as follows. These are all modules:

• api - the specific analysis API. This module provides a class that inherits from specific_analyses.api_base.API_base (and optionally specific_analysis.api_common.API_common). This class is initialised as a singleton object and returned by the specific_analyses.api.return_api() function.
• checks - all functions for performing analysis specific checks.
• data - a module of all functions for handling the base data for the analysis.
• model - a module of all functions for handling the models of the analysis.
• optimisation - all functions related to optimisation which are not part of the specific analysis API.
• parameter_object - the parameter list singleton object for the specific analysis. This provides a class that inherits from specific_analysis.parameter_object.Param_list. This class is initialised and returned by the specific_analyses.api.return_parameter_list() function.
• parameters - all functions relating to the model parameters.
• uf - the user function backends. Any analysis specific user functions in user_functions should call functions in this module.
• variables - a module containing all fixed variables for the analysis.

Other modules may be present.

General

The check_*() functions

These functions are for performing checks for certain data being present. The idea uses the strategy design pattern which is implemented in the lib.checks.Check class.

Packages

These functions are found in the pipe_control and specific_analyses packages:

• pipe_control: The check_*() functions are located in the individual modules of this package.
• specific_analyses: For these packages, a special 'checks' module should be created for these functions.

Design

The check_*() functions, via the Check object, accept the 'escalate' keyword argument which can have the following values:

• 0 - This will simply cause the function to return True or False.
• 1 - In addition to returning True or False, the function will throw a RelaxWarning for better user feedback.
• 2 - This will cause a RelaxError to be raised if the data is missing, not set up, etc. Otherwise the function returns True.

Implementation

Here is a prototype for implementing the check object:

# relax module imports.
from lib.checks import Check


def check_xxx_func(a=None):
    """Check if xxx.

    @param a:       Some check specific argument.
    @type a:        str
    @keyword b:     Some check specific keyword argument.
    @type b:        int
    @return:        The status of the check and the message to send to the user.
    @rtype:         bool, str
    """

    # Init.
    check_ok = True

    # Check that...
    if not something(a, b):
        check_ok = False

    # Return the status and message.
    return check_ok, "Something is missing."

# Create the checking object.
check_xxx = Check(check_xxx_func)

In the module where the check is performed, the code would be:

# relax module imports.
from xxx import check_xxx


def aaa():
    """Some function."""

    # Checks.
    a = '600 MHz'
    b = 600
    check_xxx(a, b=b, escalate=2)

Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_xxx_func' function as arguments.