Trusted, Bureaucrats
4,223
edits
Changes
Jump to navigation
Jump to search
Added the Category:Infobox templates category.
{{lowercase title}}
{{stub}}
The following is a set of notes which will be used to design the layout of functions, modules, and packages in relax.
== 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 [[Relax_source_design#The_check_.2A.28.29_functions|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. They can return True or False, throw RelaxWarnings, or raise RelaxErrorsThe idea uses the [https://en.wikipedia.org/wiki/Strategy_pattern strategy design pattern] which is implemented in the lib.checks.Check class. Therefore these are really function-like objects.
=== Packages ===
=== Design ===
The check_*() functions should have , via the Check object __call__() method, 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.
The default value is 2.
=== Implementation ===
Here is a prototype for implementing the check object:
<source lang="python">
# relax module imports.
from lib.checks import Check
from lib.errors import RelaxError
def check_aaa_func(a, b=None):
"""Check if aaa.
@param a: Some check specific argument.
@type a: str
@keyword b: Some check specific keyword argument.
@type b: int
@return: The initialised RelaxError object or nothing.
@rtype: None or RelaxError instance
"""
# Check that...
if not something(a, b):
return RelaxError("Some text")
# Create the checking object.
check_aaa = Check(check_aaa_func)
</source>
In the module where the check is performed, the code would be:
<source lang="python">
# relax module imports.
from aaa import check_aaa
def bbb():
"""Some function."""
# Checks.
a = '600 MHz'
b = 600
check_aaa(a, b=b)
</source>
Note that the lib.checks.Check.__call__() method will take the escalate argument for itself and pass 'a' and 'b' into the 'check_aaa_func' function as arguments. The escalate argument defaults to 2.
== See also ==
[[Category:Development]]
