Trusted, Bureaucrats
4,223
edits
Changes
Jump to navigation
Jump to search
→Package: specific_analyses: Added a package layout description.
== Package: specific_analyses ==
The package layout of modules is as follows:
* '''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.
= General =
