source: sasview/src/sans/perspectives/fitting/models.py @ 79d5b6c

"""
    Utilities to manage models
"""
import wx
import imp
import os
import sys
import math
import os.path
# Time is needed by the log method
import time
import logging
import py_compile
import shutil
from sans.guiframe.events import StatusEvent
# Explicitly import from the pluginmodel module so that py2exe
# places it in the distribution. The Model1DPlugin class is used
# as the base class of plug-in models.
from sans.models.pluginmodel import Model1DPlugin
from sans.models.BaseComponent import BaseComponent
from sans.guiframe.CategoryInstaller import CategoryInstaller
   
PLUGIN_DIR = 'plugin_models'

def get_model_python_path():
    return os.path.dirname(__file__)


def log(message):
    """
        Log a message in a file located in the user's home directory
    """
    dir = os.path.join(os.path.expanduser("~"), '.sasview', PLUGIN_DIR)
    out = open(os.path.join(dir, "plugins.log"), 'a')
    out.write("%10g:  %s\n" % (time.clock(), message))
    out.close()


def _check_plugin(model, name):
    """
    Do some checking before model adding plugins in the list
    
    :param model: class model to add into the plugin list
    :param name:name of the module plugin
    
    :return model: model if valid model or None if not valid
    
    """
    #Check is the plugin is of type Model1DPlugin
    if not issubclass(model, Model1DPlugin):
        msg = "Plugin %s must be of type Model1DPlugin \n" % str(name)
        log(msg)
        return None
    if model.__name__ != "Model":
        msg = "Plugin %s class name must be Model \n" % str(name)
        log(msg)
        return None
    try:
        new_instance = model()
    except:
        msg = "Plugin %s error in __init__ \n\t: %s %s\n" % (str(name),
                                    str(sys.exc_type), sys.exc_value)
        log(msg)
        return None
   
    if hasattr(new_instance, "function"):
        try:
            value = new_instance.function()
        except:
            msg = "Plugin %s: error writing function \n\t :%s %s\n " % (str(name),
                                    str(sys.exc_type), sys.exc_value)
            log(msg)
            return None
    else:
        msg = "Plugin  %s needs a method called function \n" % str(name)
        log(msg)
        return None
    return model
  
  
def find_plugins_dir():
    """
        Find path of the plugins directory.
        The plugin directory is located in the user's home directory.
    """
    dir = os.path.join(os.path.expanduser("~"), '.sasview', PLUGIN_DIR)
    
    # If the plugin directory doesn't exist, create it
    if not os.path.isdir(dir):
        os.makedirs(dir)
        
    # Find paths needed
    try:
        # For source
        if os.path.isdir(os.path.dirname(__file__)):
            p_dir = os.path.join(os.path.dirname(__file__), PLUGIN_DIR)
        else:
            raise
    except:
        # Check for data path next to exe/zip file.
        #Look for maximum n_dir up of the current dir to find plugins dir
        n_dir = 12
        p_dir = None
        f_dir = os.path.join(os.path.dirname(__file__))
        for i in range(n_dir):
            if i > 1:
                f_dir, _ = os.path.split(f_dir)
            plugin_path = os.path.join(f_dir, PLUGIN_DIR)
            if os.path.isdir(plugin_path):
                p_dir = plugin_path
                break
        if not p_dir:
            raise
    # Place example user models as needed
    if os.path.isdir(p_dir):
        for file in os.listdir(p_dir):
            file_path = os.path.join(p_dir, file)
            if os.path.isfile(file_path):
                if file.split(".")[-1] == 'py' and\
                    file.split(".")[0] != '__init__':
                    if not os.path.isfile(os.path.join(dir, file)):
                        shutil.copy(file_path, dir)

    return dir


class ReportProblem:
    def __nonzero__(self):
        type, value, traceback = sys.exc_info()
        if type is not None and issubclass(type, py_compile.PyCompileError):
            print "Problem with", repr(value)
            raise type, value, traceback
        return 1
    
report_problem = ReportProblem()


def compile_file(dir):
    """
    Compile a py file
    """
    try:
        import compileall
        compileall.compile_dir(dir=dir, ddir=dir, force=1,
                               quiet=report_problem)
    except:
        type, value, traceback = sys.exc_info()
        return value
    return None


def _findModels(dir):
    """
    """
    # List of plugin objects
    plugins = {}
    # Go through files in plug-in directory
    #always recompile the folder plugin
    dir = find_plugins_dir()
    if not os.path.isdir(dir):
        msg = "SansView couldn't locate Model plugin folder."
        msg += """ "%s" does not exist""" % dir
        logging.warning(msg)
        return plugins
    else:
        log("looking for models in: %s" % str(dir))
        compile_file(dir)
        logging.info("pluging model dir: %s\n" % str(dir))
    try:
        list = os.listdir(dir)
        for item in list:
            toks = os.path.splitext(os.path.basename(item))
            if toks[1] == '.py' and not toks[0] == '__init__':
                name = toks[0]
            
                path = [os.path.abspath(dir)]
                file = None
                try:
                    (file, path, info) = imp.find_module(name, path)
                    module = imp.load_module(name, file, item, info)
                    if hasattr(module, "Model"):
                        try:
                            if _check_plugin(module.Model, name) != None:
                                plugins[name] = module.Model
                        except:
                            msg = "Error accessing Model"
                            msg += "in %s\n  %s %s\n" % (name,
                                    str(sys.exc_type), sys.exc_value)
                            log(msg)
                except:
                    msg = "Error accessing Model"
                    msg += " in %s\n  %s %s \n" % (name,
                                    str(sys.exc_type), sys.exc_value)
                    log(msg)
                finally:
              
                    if not file == None:
                        file.close()
    except:
        # Don't deal with bad plug-in imports. Just skip.
        msg = "Could not import model plugin: %s\n" % sys.exc_value
        log(msg)
        pass
    return plugins


class ModelList(object):
    """
    Contains dictionary of model and their type
    """
    def __init__(self):
        """
        """
        self.mydict = {}
        
    def set_list(self, name, mylist):
        """
        :param name: the type of the list
        :param mylist: the list to add
        
        """
        if name not in self.mydict.keys():
            self.reset_list(name, mylist)
            
    def reset_list(self, name, mylist):
        """
        :param name: the type of the list
        :param mylist: the list to add
        """
        self.mydict[name] = mylist
            
    def get_list(self):
        """
        return all the list stored in a dictionary object
        """
        return self.mydict
        
        
class ModelManagerBase:
    """
        Base class for the model manager
    """
    ## external dict for models
    model_combobox = ModelList()
    ## Dictionary of form models
    form_factor_dict = {}
    ## dictionary of other
    struct_factor_dict = {}
    ##list of form factors
    shape_list = []
    ## independent shape model list
    shape_indep_list = []
    ##list of structure factors
    struct_list = []
    ##list of model allowing multiplication
    multiplication_factor = []
    ##list of multifunctional shapes
    multi_func_list = []
    ## list of added models
    plugins = []
    ## Event owner (guiframe)
    event_owner = None
    last_time_dir_modified = 0
    
    def __init__(self):
        """
        """
        self.model_dictionary = {}
        self.stored_plugins = {}
        self._getModelList()
        
    def findModels(self):
        """
        find  plugin model in directory of plugin .recompile all file
        in the directory if file were modified
        """
        temp = {}
        if self.is_changed():
            return  _findModels(dir)
        logging.info("pluging model : %s\n" % str(temp))
        return temp
        
    def _getModelList(self):
        """
        List of models we want to make available by default
        for this application
    
        :return: the next free event ID following the new menu events
        
        """


        # regular model names only
        self.model_name_list = []
        from sans.models.SphereModel import SphereModel
        self.model_dictionary[SphereModel.__name__] = SphereModel
        self.shape_list.append(SphereModel)
        self.multiplication_factor.append(SphereModel)
        self.model_name_list.append(SphereModel.__name__)
        
        from sans.models.BinaryHSModel import BinaryHSModel
        self.model_dictionary[BinaryHSModel.__name__] = BinaryHSModel
        self.shape_list.append(BinaryHSModel)
        self.model_name_list.append(BinaryHSModel.__name__)
                        
        from sans.models.FuzzySphereModel import FuzzySphereModel
        self.model_dictionary[FuzzySphereModel.__name__] = FuzzySphereModel
        self.shape_list.append(FuzzySphereModel)
        self.multiplication_factor.append(FuzzySphereModel)
        self.model_name_list.append(FuzzySphereModel.__name__)
                        
        from sans.models.RaspBerryModel import RaspBerryModel
        self.model_dictionary[RaspBerryModel.__name__] = RaspBerryModel
        self.shape_list.append(RaspBerryModel)
        self.model_name_list.append(RaspBerryModel.__name__)
                
        from sans.models.CoreShellModel import CoreShellModel
        self.model_dictionary[CoreShellModel.__name__] = CoreShellModel
        self.shape_list.append(CoreShellModel)
        self.multiplication_factor.append(CoreShellModel)
        self.model_name_list.append(CoreShellModel.__name__)
        
        from sans.models.Core2ndMomentModel import Core2ndMomentModel
        self.model_dictionary[Core2ndMomentModel.__name__] = Core2ndMomentModel
        self.shape_list.append(Core2ndMomentModel)
        self.model_name_list.append(Core2ndMomentModel.__name__)
        
        from sans.models.CoreMultiShellModel import CoreMultiShellModel
        self.model_dictionary[CoreMultiShellModel.__name__] = CoreMultiShellModel
        self.shape_list.append(CoreMultiShellModel)
        self.multiplication_factor.append(CoreMultiShellModel)
        self.multi_func_list.append(CoreMultiShellModel)

        from sans.models.VesicleModel import VesicleModel
        self.model_dictionary[VesicleModel.__name__] = VesicleModel
        self.shape_list.append(VesicleModel)
        self.multiplication_factor.append(VesicleModel)
        self.model_name_list.append(VesicleModel.__name__)
        
        from sans.models.MultiShellModel import MultiShellModel
        self.model_dictionary[MultiShellModel.__name__] = MultiShellModel
        self.shape_list.append(MultiShellModel)
        self.multiplication_factor.append(MultiShellModel)
        self.model_name_list.append(MultiShellModel.__name__)
        
        from sans.models.OnionExpShellModel import OnionExpShellModel
        self.model_dictionary[OnionExpShellModel.__name__] = OnionExpShellModel
        self.shape_list.append(OnionExpShellModel)
        self.multiplication_factor.append(OnionExpShellModel)
        self.multi_func_list.append(OnionExpShellModel)
                         
        from sans.models.SphericalSLDModel import SphericalSLDModel
        self.model_dictionary[SphericalSLDModel.__name__] = SphericalSLDModel
        self.shape_list.append(SphericalSLDModel)
        self.multiplication_factor.append(SphericalSLDModel)
        self.multi_func_list.append(SphericalSLDModel)

        
        from sans.models.LinearPearlsModel import LinearPearlsModel
        self.model_dictionary[LinearPearlsModel.__name__] = LinearPearlsModel
        self.shape_list.append(LinearPearlsModel)
        self.model_name_list.append(LinearPearlsModel.__name__)
          
        from sans.models.PearlNecklaceModel import PearlNecklaceModel
        self.model_dictionary[PearlNecklaceModel.__name__] = PearlNecklaceModel
        self.shape_list.append(PearlNecklaceModel)
        self.model_name_list.append(PearlNecklaceModel.__name__)
        #self.multiplication_factor.append(PearlNecklaceModel)
        
        from sans.models.CylinderModel import CylinderModel
        self.model_dictionary[CylinderModel.__name__] = CylinderModel
        self.shape_list.append(CylinderModel)
        self.multiplication_factor.append(CylinderModel)
        self.model_name_list.append(CylinderModel.__name__)
        
        from sans.models.CoreShellCylinderModel import CoreShellCylinderModel
        self.model_dictionary[CoreShellCylinderModel.__name__] = CoreShellCylinderModel
        self.shape_list.append(CoreShellCylinderModel)
        self.multiplication_factor.append(CoreShellCylinderModel)
        self.model_name_list.append(CoreShellCylinderModel.__name__)
        
        from sans.models.CoreShellBicelleModel import CoreShellBicelleModel
        self.model_dictionary[CoreShellBicelleModel.__name__] = CoreShellBicelleModel
        self.shape_list.append(CoreShellBicelleModel)
        self.multiplication_factor.append(CoreShellBicelleModel)
        self.model_name_list.append(CoreShellBicelleModel.__name__)
                
        from sans.models.HollowCylinderModel import HollowCylinderModel
        self.model_dictionary[HollowCylinderModel.__name__] = HollowCylinderModel
        self.shape_list.append(HollowCylinderModel)
        self.multiplication_factor.append(HollowCylinderModel)
        self.model_name_list.append(HollowCylinderModel.__name__)
              
        from sans.models.FlexibleCylinderModel import FlexibleCylinderModel
        self.model_dictionary[FlexibleCylinderModel.__name__] = FlexibleCylinderModel
        self.shape_list.append(FlexibleCylinderModel)
        self.model_name_list.append(FlexibleCylinderModel.__name__)

        from sans.models.FlexCylEllipXModel import FlexCylEllipXModel
        self.model_dictionary[FlexCylEllipXModel.__name__] = FlexCylEllipXModel
        self.shape_list.append(FlexCylEllipXModel)
        self.model_name_list.append(FlexCylEllipXModel.__name__)
        
        from sans.models.StackedDisksModel import StackedDisksModel
        self.model_dictionary[StackedDisksModel.__name__] = StackedDisksModel
        self.shape_list.append(StackedDisksModel)
        self.multiplication_factor.append(StackedDisksModel)
        self.model_name_list.append(StackedDisksModel.__name__)
        
        from sans.models.ParallelepipedModel import ParallelepipedModel
        self.model_dictionary[ParallelepipedModel.__name__] = ParallelepipedModel
        self.shape_list.append(ParallelepipedModel)
        self.multiplication_factor.append(ParallelepipedModel)
        self.model_name_list.append(ParallelepipedModel.__name__)
        
        from sans.models.CSParallelepipedModel import CSParallelepipedModel
        self.model_dictionary[CSParallelepipedModel.__name__] = CSParallelepipedModel
        self.shape_list.append(CSParallelepipedModel)
        self.multiplication_factor.append(CSParallelepipedModel)
        self.model_name_list.append(CSParallelepipedModel.__name__)
        
        from sans.models.EllipticalCylinderModel import EllipticalCylinderModel
        self.model_dictionary[EllipticalCylinderModel.__name__] = EllipticalCylinderModel
        self.shape_list.append(EllipticalCylinderModel)
        self.multiplication_factor.append(EllipticalCylinderModel)
        self.model_name_list.append(EllipticalCylinderModel.__name__)
        
        from sans.models.BarBellModel import BarBellModel
        self.model_dictionary[BarBellModel.__name__] = BarBellModel
        self.shape_list.append(BarBellModel)
        self.model_name_list.append(BarBellModel.__name__)
        # not implemeted yet!
        #self.multiplication_factor.append(BarBellModel)
        
        from sans.models.CappedCylinderModel import CappedCylinderModel
        self.model_dictionary[CappedCylinderModel.__name__] = CappedCylinderModel
        self.shape_list.append(CappedCylinderModel)
        self.model_name_list.append(CappedCylinderModel.__name__)
        # not implemeted yet!
        #self.multiplication_factor.append(CappedCylinderModel)
        
        from sans.models.EllipsoidModel import EllipsoidModel
        self.model_dictionary[EllipsoidModel.__name__] = EllipsoidModel
        self.shape_list.append(EllipsoidModel)
        self.multiplication_factor.append(EllipsoidModel)
        self.model_name_list.append(EllipsoidModel.__name__)
      
        from sans.models.CoreShellEllipsoidModel import CoreShellEllipsoidModel
        self.model_dictionary[CoreShellEllipsoidModel.__name__] = CoreShellEllipsoidModel
        self.shape_list.append(CoreShellEllipsoidModel)
        self.multiplication_factor.append(CoreShellEllipsoidModel)
        self.model_name_list.append(CoreShellEllipsoidModel.__name__)
         
        from sans.models.TriaxialEllipsoidModel import TriaxialEllipsoidModel
        self.model_dictionary[TriaxialEllipsoidModel.__name__] = TriaxialEllipsoidModel
        self.shape_list.append(TriaxialEllipsoidModel)
        self.multiplication_factor.append(TriaxialEllipsoidModel)
        self.model_name_list.append(TriaxialEllipsoidModel.__name__)
        
        from sans.models.LamellarModel import LamellarModel
        self.model_dictionary[LamellarModel.__name__] = LamellarModel
        self.shape_list.append(LamellarModel)
        self.model_name_list.append(LamellarModel.__name__)
        
        from sans.models.LamellarFFHGModel import LamellarFFHGModel
        self.model_dictionary[LamellarFFHGModel.__name__] = LamellarFFHGModel
        self.shape_list.append(LamellarFFHGModel)
        self.model_name_list.append(LamellarFFHGModel.__name__)
        
        from sans.models.LamellarPSModel import LamellarPSModel
        self.model_dictionary[LamellarPSModel.__name__] = LamellarPSModel
        self.shape_list.append(LamellarPSModel)
        self.model_name_list.append(LamellarPSModel.__name__)
     
        from sans.models.LamellarPSHGModel import LamellarPSHGModel
        self.model_dictionary[LamellarPSHGModel.__name__] = LamellarPSHGModel
        self.shape_list.append(LamellarPSHGModel)
        self.model_name_list.append(LamellarPSHGModel.__name__)
        
        from sans.models.LamellarPCrystalModel import LamellarPCrystalModel
        self.model_dictionary[LamellarPCrystalModel.__name__] = LamellarPCrystalModel
        self.shape_list.append(LamellarPCrystalModel)
        self.model_name_list.append(LamellarPCrystalModel.__name__)
        
        from sans.models.SCCrystalModel import SCCrystalModel
        self.model_dictionary[SCCrystalModel.__name__] = SCCrystalModel
        self.shape_list.append(SCCrystalModel)
        self.model_name_list.append(SCCrystalModel.__name__)
        
        from sans.models.FCCrystalModel import FCCrystalModel
        self.model_dictionary[FCCrystalModel.__name__] = FCCrystalModel
        self.shape_list.append(FCCrystalModel)
        self.model_name_list.append(FCCrystalModel.__name__)
        
        from sans.models.BCCrystalModel import BCCrystalModel
        self.model_dictionary[BCCrystalModel.__name__] = BCCrystalModel
        self.shape_list.append(BCCrystalModel)
        self.model_name_list.append(BCCrystalModel.__name__)
      
        ## Structure factor
        from sans.models.SquareWellStructure import SquareWellStructure
        self.model_dictionary[SquareWellStructure.__name__] = SquareWellStructure
        self.struct_list.append(SquareWellStructure)
        self.model_name_list.append(SquareWellStructure.__name__)
        
        from sans.models.HardsphereStructure import HardsphereStructure
        self.model_dictionary[HardsphereStructure.__name__] = HardsphereStructure
        self.struct_list.append(HardsphereStructure)
        self.model_name_list.append(HardsphereStructure.__name__)
         
        from sans.models.StickyHSStructure import StickyHSStructure
        self.model_dictionary[StickyHSStructure.__name__] = StickyHSStructure
        self.struct_list.append(StickyHSStructure)
        self.model_name_list.append(StickyHSStructure.__name__)
        
        from sans.models.HayterMSAStructure import HayterMSAStructure
        self.model_dictionary[HayterMSAStructure.__name__] = HayterMSAStructure
        self.struct_list.append(HayterMSAStructure)
        self.model_name_list.append(HayterMSAStructure.__name__)


        ##shape-independent models
        from sans.models.PowerLawAbsModel import PowerLawAbsModel
        self.model_dictionary[PowerLawAbsModel.__name__] = PowerLawAbsModel
        self.shape_indep_list.append(PowerLawAbsModel)
        self.model_name_list.append(PowerLawAbsModel.__name__)
        
        from sans.models.BEPolyelectrolyte import BEPolyelectrolyte
        self.model_dictionary[BEPolyelectrolyte.__name__] = BEPolyelectrolyte
        self.shape_indep_list.append(BEPolyelectrolyte)
        self.model_name_list.append(BEPolyelectrolyte.__name__)
        self.form_factor_dict[str(wx.NewId())] =  [SphereModel]
        
        from sans.models.BroadPeakModel import BroadPeakModel
        self.model_dictionary[BroadPeakModel.__name__] = BroadPeakModel
        self.shape_indep_list.append(BroadPeakModel)
        self.model_name_list.append(BroadPeakModel.__name__)
        
        from sans.models.CorrLengthModel import CorrLengthModel
        self.model_dictionary[CorrLengthModel.__name__] = CorrLengthModel
        self.shape_indep_list.append(CorrLengthModel)
        self.model_name_list.append(CorrLengthModel.__name__)
        
        from sans.models.DABModel import DABModel
        self.model_dictionary[DABModel.__name__] = DABModel
        self.shape_indep_list.append(DABModel)
        self.model_name_list.append(DABModel.__name__)
        
        from sans.models.DebyeModel import DebyeModel
        self.model_dictionary[DebyeModel.__name__] = DebyeModel
        self.shape_indep_list.append(DebyeModel)
        self.model_name_list.append(DebyeModel.__name__)
        
        from sans.models.FractalModel import FractalModel
        self.model_dictionary[FractalModel.__name__] = FractalModel
        self.shape_indep_list.append(FractalModel)
        self.model_name_list.append(FractalModel.__name__)
        
        from sans.models.FractalCoreShellModel import FractalCoreShellModel
        self.model_dictionary[FractalCoreShellModel.__name__] = FractalCoreShellModel
        self.shape_indep_list.append(FractalCoreShellModel)
        self.model_name_list.append(FractalCoreShellModel.__name__)
        
        from sans.models.GaussLorentzGelModel import GaussLorentzGelModel
        self.model_dictionary[GaussLorentzGelModel.__name__] = GaussLorentzGelModel
        self.shape_indep_list.append(GaussLorentzGelModel)
        self.model_name_list.append(GaussLorentzGelModel.__name__)
                
        from sans.models.GuinierModel import GuinierModel
        self.model_dictionary[GuinierModel.__name__] = GuinierModel
        self.shape_indep_list.append(GuinierModel)
        self.model_name_list.append(GuinierModel.__name__)
        
        from sans.models.GuinierPorodModel import GuinierPorodModel
        self.model_dictionary[GuinierPorodModel.__name__] = GuinierPorodModel
        self.shape_indep_list.append(GuinierPorodModel)
        self.model_name_list.append(GuinierPorodModel.__name__)

        from sans.models.LorentzModel import LorentzModel
        self.model_dictionary[LorentzModel.__name__] = LorentzModel
        self.shape_indep_list.append(LorentzModel)
        self.model_name_list.append(LorentzModel.__name__)

        from sans.models.MassFractalModel import MassFractalModel
        self.model_dictionary[MassFractalModel.__name__] = MassFractalModel
        self.shape_indep_list.append(MassFractalModel)
        self.model_name_list.append(MassFractalModel.__name__)
        
        from sans.models.MassSurfaceFractal import MassSurfaceFractal
        self.model_dictionary[MassSurfaceFractal.__name__] = MassSurfaceFractal
        self.shape_indep_list.append(MassSurfaceFractal)
        self.model_name_list.append(MassSurfaceFractal.__name__)
        
        from sans.models.PeakGaussModel import PeakGaussModel
        self.model_dictionary[PeakGaussModel.__name__] = PeakGaussModel
        self.shape_indep_list.append(PeakGaussModel)
        self.model_name_list.append(PeakGaussModel.__name__)
        
        from sans.models.PeakLorentzModel import PeakLorentzModel
        self.model_dictionary[PeakLorentzModel.__name__] = PeakLorentzModel
        self.shape_indep_list.append(PeakLorentzModel)
        self.model_name_list.append(PeakLorentzModel.__name__)
        
        from sans.models.Poly_GaussCoil import Poly_GaussCoil
        self.model_dictionary[Poly_GaussCoil.__name__] = Poly_GaussCoil
        self.shape_indep_list.append(Poly_GaussCoil)
        self.model_name_list.append(Poly_GaussCoil.__name__)
        
        from sans.models.PolymerExclVolume import PolymerExclVolume
        self.model_dictionary[PolymerExclVolume.__name__] = PolymerExclVolume
        self.shape_indep_list.append(PolymerExclVolume)
        self.model_name_list.append(PolymerExclVolume.__name__)
        
        from sans.models.PorodModel import PorodModel
        self.model_dictionary[PorodModel.__name__] = PorodModel
        self.shape_indep_list.append(PorodModel)
        self.model_name_list.append(PorodModel.__name__)
        
        from sans.models.RPA10Model import RPA10Model
        self.model_dictionary[RPA10Model.__name__] = RPA10Model
        self.shape_indep_list.append(RPA10Model)
        self.multi_func_list.append(RPA10Model)

        from sans.models.StarPolymer import StarPolymer
        self.model_dictionary[StarPolymer.__name__] = StarPolymer
        self.shape_indep_list.append(StarPolymer)
        self.model_name_list.append(StarPolymer.__name__)

        from sans.models.SurfaceFractalModel import SurfaceFractalModel
        self.model_dictionary[SurfaceFractalModel.__name__] = SurfaceFractalModel
        self.shape_indep_list.append(SurfaceFractalModel)
        self.model_name_list.append(SurfaceFractalModel.__name__)
        
        from sans.models.TeubnerStreyModel import TeubnerStreyModel
        self.model_dictionary[TeubnerStreyModel.__name__] = TeubnerStreyModel
        self.shape_indep_list.append(TeubnerStreyModel)
        self.model_name_list.append(TeubnerStreyModel.__name__)

        from sans.models.TwoLorentzianModel import TwoLorentzianModel
        self.model_dictionary[TwoLorentzianModel.__name__] = TwoLorentzianModel
        self.shape_indep_list.append(TwoLorentzianModel)
        self.model_name_list.append(TwoLorentzianModel.__name__)
        
        from sans.models.TwoPowerLawModel import TwoPowerLawModel
        self.model_dictionary[TwoPowerLawModel.__name__] = TwoPowerLawModel
        self.shape_indep_list.append(TwoPowerLawModel)
        self.model_name_list.append(TwoPowerLawModel.__name__)
        
        from sans.models.UnifiedPowerRgModel import UnifiedPowerRgModel
        self.model_dictionary[UnifiedPowerRgModel.__name__] = UnifiedPowerRgModel
        self.shape_indep_list.append(UnifiedPowerRgModel)
        self.multi_func_list.append(UnifiedPowerRgModel)

        from sans.models.LineModel import LineModel
        self.model_dictionary[LineModel.__name__] = LineModel
        self.shape_indep_list.append(LineModel)
        self.model_name_list.append(LineModel.__name__)
        
        from sans.models.ReflectivityModel import ReflectivityModel
        self.model_dictionary[ReflectivityModel.__name__] = ReflectivityModel
        self.shape_indep_list.append(ReflectivityModel)
        self.multi_func_list.append(ReflectivityModel)
        
        from sans.models.ReflectivityIIModel import ReflectivityIIModel
        self.model_dictionary[ReflectivityIIModel.__name__] = ReflectivityIIModel
        self.shape_indep_list.append(ReflectivityIIModel)
        self.multi_func_list.append(ReflectivityIIModel)
        
        from sans.models.GelFitModel import GelFitModel
        self.model_dictionary[GelFitModel.__name__] = GelFitModel
        self.shape_indep_list.append(GelFitModel)
        self.model_name_list.append(GelFitModel.__name__)

        from sans.models.PringlesModel import PringlesModel
        self.model_dictionary[PringlesModel.__name__] = PringlesModel
        self.shape_indep_list.append(PringlesModel)
        self.model_name_list.append(PringlesModel.__name__)

        #from sans.models.FractalO_Z import FractalO_Z
        #self.model_dictionary[FractalO_Z.__name__] = FractalO_Z
        #self.shape_indep_list.append(FractalO_Z)
        #self.model_name_list.append(FractalO_Z.__name__)
    
        #Looking for plugins
        self.stored_plugins = self.findModels()
        self.plugins = self.stored_plugins.values()
        for name, plug in self.stored_plugins.iteritems():
            self.model_dictionary[name] = plug
            
        self._get_multifunc_models()
       
        return 0

    def is_changed(self):
        """
        check the last time the plugin dir has changed and return true
         is the directory was modified else return false
        """
        is_modified = False
        plugin_dir = find_plugins_dir()
        if os.path.isdir(plugin_dir):
            temp = os.path.getmtime(plugin_dir)
            if  self.last_time_dir_modified != temp:
                is_modified = True
                self.last_time_dir_modified = temp
        
        return is_modified
    
    def update(self):
        """
        return a dictionary of model if
        new models were added else return empty dictionary
        """
        new_plugins = self.findModels()
        if len(new_plugins) > 0:
            for name, plug in  new_plugins.iteritems():
                if name not in self.stored_plugins.keys():
                    self.stored_plugins[name] = plug
                    self.plugins.append(plug)
                    self.model_dictionary[name] = plug
            self.model_combobox.set_list("Customized Models", self.plugins)
            return self.model_combobox.get_list()
        else:
            return {}
    
    def pulgins_reset(self):
        """
        return a dictionary of model
        """
        self.plugins = []
        new_plugins = _findModels(dir)
        for name, plug in  new_plugins.iteritems():
            for stored_name, stored_plug in self.stored_plugins.iteritems():
                if name == stored_name:
                    del self.stored_plugins[name]
                    del self.model_dictionary[name]
                    break
            self.stored_plugins[name] = plug
            self.plugins.append(plug)
            self.model_dictionary[name] = plug

        self.model_combobox.reset_list("Customized Models", self.plugins)
        return self.model_combobox.get_list()
       
    def populate_menu(self, modelmenu, event_owner):
        """
        Populate a menu with our models
        
        :param id: first menu event ID to use when binding the menu events
        :param modelmenu: wx.Menu object to populate
        :param event_owner: wx object to bind the menu events to
        
        :return: the next free event ID following the new menu events
        
        """
        ## Fill model lists
        self._getModelList()
        ## store reference to model menu of guiframe
        self.modelmenu = modelmenu
        ## guiframe reference
        self.event_owner = event_owner
        
        shape_submenu = wx.Menu()
        shape_indep_submenu = wx.Menu()
        structure_factor = wx.Menu()
        added_models = wx.Menu()
        multip_models = wx.Menu()
        ## create menu with shape
        self._fill_simple_menu(menuinfo=["Shapes",
                                         shape_submenu,
                                         " simple shape"],
                         list1=self.shape_list)
        
        self._fill_simple_menu(menuinfo=["Shape-Independent",
                                         shape_indep_submenu,
                                         "List of shape-independent models"],
                         list1=self.shape_indep_list)
        
        self._fill_simple_menu(menuinfo=["Structure Factors",
                                         structure_factor,
                                         "List of Structure factors models"],
                                list1=self.struct_list)
        
        self._fill_plugin_menu(menuinfo=["Customized Models", added_models,
                                            "List of additional models"],
                                 list1=self.plugins)
        
        self._fill_menu(menuinfo=["P(Q)*S(Q)", multip_models,
                                  "mulplication of 2 models"],
                                   list1=self.multiplication_factor,
                                   list2=self.struct_list)
        return 0
    
    def _fill_plugin_menu(self, menuinfo, list1):
        """
        fill the plugin menu with costumized models
        """
        if len(list1) == 0:
            id = wx.NewId()
            msg = "No model available check plugins.log for errors to fix problem"
            menuinfo[1].Append(int(id), "Empty", msg)
        self._fill_simple_menu(menuinfo, list1)
        
    def _fill_simple_menu(self, menuinfo, list1):
        """
        Fill the menu with list item
        
        :param modelmenu: the menu to fill
        :param menuinfo: submenu item for the first column of this modelmenu
                         with info.Should be a list :
                         [name(string) , menu(wx.menu), help(string)]
        :param list1: contains item (form factor )to fill modelmenu second column
        
        """
        if len(list1) > 0:
            self.model_combobox.set_list(menuinfo[0], list1)
            
            for item in list1:
                try:
                    id = wx.NewId()
                    struct_factor = item()
                    struct_name = struct_factor.__class__.__name__
                    if hasattr(struct_factor, "name"):
                        struct_name = struct_factor.name
                        
                    menuinfo[1].Append(int(id), struct_name, struct_name)
                    if not  item in self.struct_factor_dict.itervalues():
                        self.struct_factor_dict[str(id)] = item
                    wx.EVT_MENU(self.event_owner, int(id), self._on_model)
                except:
                    msg = "Error Occured: %s" % sys.exc_value
                    wx.PostEvent(self.event_owner, StatusEvent(status=msg))
                
        id = wx.NewId()
        self.modelmenu.AppendMenu(id, menuinfo[0], menuinfo[1], menuinfo[2])
        
    def _fill_menu(self, menuinfo, list1, list2):
        """
        Fill the menu with list item
        
        :param menuinfo: submenu item for the first column of this modelmenu
                         with info.Should be a list :
                         [name(string) , menu(wx.menu), help(string)]
        :param list1: contains item (form factor )to fill modelmenu second column
        :param list2: contains item (Structure factor )to fill modelmenu
                third column
                
        """
        if len(list1) > 0:
            self.model_combobox.set_list(menuinfo[0], list1)
            
            for item in list1:
                form_factor = item()
                form_name = form_factor.__class__.__name__
                if hasattr(form_factor, "name"):
                    form_name = form_factor.name
                ### store form factor to return to other users
                newmenu = wx.Menu()
                if len(list2) > 0:
                    for model  in list2:
                        id = wx.NewId()
                        struct_factor = model()
                        name = struct_factor.__class__.__name__
                        if hasattr(struct_factor, "name"):
                            name = struct_factor.name
                        newmenu.Append(id, name, name)
                        wx.EVT_MENU(self.event_owner, int(id), self._on_model)
                        ## save form_fact and struct_fact
                        self.form_factor_dict[int(id)] = [form_factor,
                                                          struct_factor]
                        
                form_id = wx.NewId()
                menuinfo[1].AppendMenu(int(form_id), form_name,
                                       newmenu, menuinfo[2])
        id = wx.NewId()
        self.modelmenu.AppendMenu(id, menuinfo[0], menuinfo[1], menuinfo[2])
        
    def _on_model(self, evt):
        """
        React to a model menu event
        
        :param event: wx menu event
        
        """
        if int(evt.GetId()) in self.form_factor_dict.keys():
            from sans.models.MultiplicationModel import MultiplicationModel
            self.model_dictionary[MultiplicationModel.__name__] = MultiplicationModel
            model1, model2 = self.form_factor_dict[int(evt.GetId())]
            model = MultiplicationModel(model1, model2)
        else:
            model = self.struct_factor_dict[str(evt.GetId())]()
        
        #TODO: investigate why the following two lines were left in the code
        #      even though the ModelEvent class doesn't exist
        #evt = ModelEvent(model=model)
        #wx.PostEvent(self.event_owner, evt)
        
    def _get_multifunc_models(self):
        """
        Get the multifunctional models
        """
        for item in self.plugins:
            try:
                # check the multiplicity if any
                if item.multiplicity_info[0] > 1:
                    self.multi_func_list.append(item)
            except:
                # pass to other items
                pass
                    
    def get_model_list(self):
        """
        return dictionary of models for fitpanel use
        
        """
        self.model_combobox.set_list("Shapes", self.shape_list)
        self.model_combobox.set_list("Shape-Independent",
                                     self.shape_indep_list)
        self.model_combobox.set_list("Structure Factors", self.struct_list)
        self.model_combobox.set_list("Customized Models", self.plugins)
        self.model_combobox.set_list("P(Q)*S(Q)", self.multiplication_factor)
        self.model_combobox.set_list("multiplication",
                                     self.multiplication_factor)
        self.model_combobox.set_list("Multi-Functions", self.multi_func_list)
        return self.model_combobox.get_list()
    
    def get_model_name_list(self):
        """
        return regular model name list
        """
        return self.model_name_list

    def get_model_dictionary(self):
        """
        return dictionary linking model names to objects
        """
        return self.model_dictionary
  
        
class ModelManager(object):
    """
    implement model
    """
    __modelmanager = ModelManagerBase()
    cat_model_list = [model_name for model_name \
                      in __modelmanager.model_dictionary.keys() \
                      if model_name not in __modelmanager.stored_plugins.keys()]

    CategoryInstaller.check_install(model_list=cat_model_list)
    
    def findModels(self):
        return self.__modelmanager.findModels()
    
    def _getModelList(self):
        return self.__modelmanager._getModelList()
    
    def is_changed(self):
        return self.__modelmanager.is_changed()
    
    def update(self):
        return self.__modelmanager.update()
    
    def pulgins_reset(self):
        return self.__modelmanager.pulgins_reset()
    
    def populate_menu(self, modelmenu, event_owner):
        return self.__modelmanager.populate_menu(modelmenu, event_owner)
    
    def _on_model(self, evt):
        return self.__modelmanager._on_model(evt)
    
    def _get_multifunc_models(self):
        return self.__modelmanager._get_multifunc_models()
    
    def get_model_list(self):
        return self.__modelmanager.get_model_list()
    
    def get_model_name_list(self):
        return self.__modelmanager.get_model_name_list()

    def get_model_dictionary(self):
        return self.__modelmanager.get_model_dictionary()