[7fb59b2] | 1 | # -*- coding: utf-8 -*- |
---|
[415fb82] | 2 | """ |
---|
| 3 | Base module for loading and running the main SasView application. |
---|
| 4 | """ |
---|
[f76bf17] | 5 | ################################################################################ |
---|
[f36e01f] | 6 | # This software was developed by the University of Tennessee as part of the |
---|
| 7 | # Distributed Data Analysis of Neutron Scattering Experiments (DANSE) |
---|
| 8 | # project funded by the US National Science Foundation. |
---|
[f76bf17] | 9 | # |
---|
[f36e01f] | 10 | # See the license text in license.txt |
---|
[f76bf17] | 11 | # |
---|
[f36e01f] | 12 | # copyright 2009, University of Tennessee |
---|
[f76bf17] | 13 | ################################################################################ |
---|
| 14 | import os |
---|
[5af6f58] | 15 | import os.path |
---|
[f76bf17] | 16 | import sys |
---|
[4e080980] | 17 | import traceback |
---|
[7c105e8] | 18 | import logging |
---|
[4e080980] | 19 | |
---|
[0225a3f] | 20 | try: |
---|
| 21 | reload(sys) |
---|
| 22 | sys.setdefaultencoding("iso-8859-1") |
---|
| 23 | except NameError: |
---|
| 24 | # On python 3 sys.setdefaultencoding does nothing, so pass. |
---|
| 25 | # We know we are in python 3 at this point since reload is no longer in |
---|
| 26 | # builtins, but instead has been moved to importlib, hence the NameError. |
---|
| 27 | pass |
---|
[f36e01f] | 28 | |
---|
[b963b20] | 29 | import sas |
---|
| 30 | |
---|
[f76bf17] | 31 | APP_NAME = 'SasView' |
---|
[1693141] | 32 | PLUGIN_MODEL_DIR = 'plugin_models' |
---|
[f76bf17] | 33 | |
---|
[1693141] | 34 | class SasView(object): |
---|
[f76bf17] | 35 | """ |
---|
[415fb82] | 36 | Main class for running the SasView application |
---|
[f76bf17] | 37 | """ |
---|
[6af5d75] | 38 | def __init__(self, threaded=False): |
---|
[f76bf17] | 39 | """ |
---|
| 40 | """ |
---|
[7c105e8] | 41 | logger = logging.getLogger(__name__) |
---|
| 42 | |
---|
[899e084] | 43 | from sas.sasgui.guiframe.gui_manager import SasViewApp |
---|
| 44 | self.gui = SasViewApp(0) |
---|
[8faef63] | 45 | if sys.platform == "darwin": |
---|
| 46 | self.check_sasmodels_compiler() |
---|
[f76bf17] | 47 | # Set the application manager for the GUI |
---|
| 48 | self.gui.set_manager(self) |
---|
| 49 | # Add perspectives to the basic application |
---|
| 50 | # Additional perspectives can still be loaded |
---|
| 51 | # dynamically |
---|
| 52 | # Note: py2exe can't find dynamically loaded |
---|
| 53 | # modules. We load the fitting module here |
---|
| 54 | # to ensure a complete Windows executable build. |
---|
| 55 | |
---|
[65f3930] | 56 | # Rebuild .sasview/categories.json. This triggers a load of sasmodels |
---|
| 57 | # and all the plugins. |
---|
| 58 | try: |
---|
| 59 | from sas.sascalc.fit.models import ModelManager |
---|
| 60 | from sas.sasgui.guiframe.CategoryInstaller import CategoryInstaller |
---|
| 61 | model_list = ModelManager().cat_model_list() |
---|
| 62 | CategoryInstaller.check_install(model_list=model_list) |
---|
| 63 | except Exception: |
---|
| 64 | logger.error("%s: could not load SasView models") |
---|
| 65 | logger.error(traceback.format_exc()) |
---|
| 66 | |
---|
[f76bf17] | 67 | # Fitting perspective |
---|
| 68 | try: |
---|
[77d92cd] | 69 | import sas.sasgui.perspectives.fitting as module |
---|
[f76bf17] | 70 | fitting_plug = module.Plugin() |
---|
| 71 | self.gui.add_perspective(fitting_plug) |
---|
[415fb82] | 72 | except Exception: |
---|
[b39d32d5] | 73 | logger.error("%s: could not find Fitting plug-in module", APP_NAME) |
---|
[64ca561] | 74 | logger.error(traceback.format_exc()) |
---|
[f76bf17] | 75 | |
---|
| 76 | # P(r) perspective |
---|
| 77 | try: |
---|
[d85c194] | 78 | import sas.sasgui.perspectives.pr as module |
---|
[f21d496] | 79 | pr_plug = module.Plugin() |
---|
[f76bf17] | 80 | self.gui.add_perspective(pr_plug) |
---|
[b39d32d5] | 81 | except Exception: |
---|
| 82 | logger.error("%s: could not find P(r) plug-in module", APP_NAME) |
---|
[64ca561] | 83 | logger.error(traceback.format_exc()) |
---|
[4e080980] | 84 | |
---|
[f36e01f] | 85 | # Invariant perspective |
---|
[f76bf17] | 86 | try: |
---|
[d85c194] | 87 | import sas.sasgui.perspectives.invariant as module |
---|
[f21d496] | 88 | invariant_plug = module.Plugin() |
---|
[f76bf17] | 89 | self.gui.add_perspective(invariant_plug) |
---|
[b39d32d5] | 90 | except Exception: |
---|
| 91 | logger.error("%s: could not find Invariant plug-in module", |
---|
| 92 | APP_NAME) |
---|
[64ca561] | 93 | logger.error(traceback.format_exc()) |
---|
[4e080980] | 94 | |
---|
[c23f303] | 95 | # Corfunc perspective |
---|
| 96 | try: |
---|
| 97 | import sas.sasgui.perspectives.corfunc as module |
---|
| 98 | corfunc_plug = module.Plugin() |
---|
| 99 | self.gui.add_perspective(corfunc_plug) |
---|
[b39d32d5] | 100 | except Exception: |
---|
[64ca561] | 101 | logger.error("Unable to load corfunc module") |
---|
[c23f303] | 102 | |
---|
[f36e01f] | 103 | # Calculator perspective |
---|
[f76bf17] | 104 | try: |
---|
[d85c194] | 105 | import sas.sasgui.perspectives.calculator as module |
---|
[f21d496] | 106 | calculator_plug = module.Plugin() |
---|
[f76bf17] | 107 | self.gui.add_perspective(calculator_plug) |
---|
[b39d32d5] | 108 | except Exception: |
---|
| 109 | logger.error("%s: could not find Calculator plug-in module", |
---|
| 110 | APP_NAME) |
---|
[64ca561] | 111 | logger.error(traceback.format_exc()) |
---|
[4e080980] | 112 | |
---|
[77d92cd] | 113 | # File converter tool |
---|
| 114 | try: |
---|
| 115 | import sas.sasgui.perspectives.file_converter as module |
---|
| 116 | converter_plug = module.Plugin() |
---|
| 117 | self.gui.add_perspective(converter_plug) |
---|
[b39d32d5] | 118 | except Exception: |
---|
| 119 | logger.error("%s: could not find File Converter plug-in module", |
---|
| 120 | APP_NAME) |
---|
[64ca561] | 121 | logger.error(traceback.format_exc()) |
---|
[77d92cd] | 122 | |
---|
[f76bf17] | 123 | # Add welcome page |
---|
[899e084] | 124 | from .welcome_panel import WelcomePanel |
---|
[f76bf17] | 125 | self.gui.set_welcome_panel(WelcomePanel) |
---|
[415fb82] | 126 | |
---|
[f76bf17] | 127 | # Build the GUI |
---|
| 128 | self.gui.build_gui() |
---|
[415fb82] | 129 | # delete unused model folder |
---|
[f76bf17] | 130 | self.gui.clean_plugin_models(PLUGIN_MODEL_DIR) |
---|
[6af5d75] | 131 | if not threaded: |
---|
| 132 | # Start the main loop |
---|
| 133 | self.gui.MainLoop() |
---|
[f76bf17] | 134 | |
---|
[8faef63] | 135 | def check_sasmodels_compiler(self): |
---|
| 136 | """ |
---|
| 137 | Checking c compiler for sasmodels and raises xcode command line |
---|
| 138 | tools for installation |
---|
| 139 | """ |
---|
[fac42cf] | 140 | #wx should be importable at this stage |
---|
[8faef63] | 141 | import wx |
---|
| 142 | import subprocess |
---|
| 143 | #Generic message box created becuase standard MessageBox is not moveable |
---|
| 144 | class GenericMessageBox(wx.Dialog): |
---|
| 145 | def __init__(self, parent, text, title = ''): |
---|
| 146 | |
---|
| 147 | wx.Dialog.__init__(self, parent, -1, title = title, |
---|
[1270e3c] | 148 | size = (360,200), pos=(20,60), |
---|
[8faef63] | 149 | style = wx.STAY_ON_TOP | wx.DEFAULT_DIALOG_STYLE) |
---|
| 150 | panel = wx.Panel(self, -1) |
---|
| 151 | top_row_sizer = wx.BoxSizer(wx.HORIZONTAL) |
---|
| 152 | |
---|
| 153 | error_bitmap = wx.ArtProvider.GetBitmap( |
---|
| 154 | wx.ART_ERROR, wx.ART_MESSAGE_BOX |
---|
| 155 | ) |
---|
| 156 | error_bitmap_ctrl = wx.StaticBitmap(panel, -1) |
---|
| 157 | error_bitmap_ctrl.SetBitmap(error_bitmap) |
---|
| 158 | label = wx.StaticText(panel, -1, text) |
---|
| 159 | top_row_sizer.Add(error_bitmap_ctrl, flag=wx.ALL, border=10) |
---|
| 160 | top_row_sizer.Add(label, flag=wx.ALIGN_CENTER_VERTICAL) |
---|
| 161 | |
---|
| 162 | #Create the OK button in the bottom row. |
---|
| 163 | ok_button = wx.Button(panel, wx.ID_OK ) |
---|
| 164 | self.Bind(wx.EVT_BUTTON, self.on_ok, source=ok_button) |
---|
| 165 | ok_button.SetFocus() |
---|
| 166 | ok_button.SetDefault() |
---|
| 167 | |
---|
| 168 | sizer = wx.BoxSizer(wx.VERTICAL) |
---|
| 169 | sizer.Add(top_row_sizer) |
---|
| 170 | sizer.Add(ok_button, flag=wx.ALIGN_CENTER | wx.ALL, border=5) |
---|
| 171 | panel.SetSizer(sizer) |
---|
| 172 | |
---|
| 173 | def on_ok(self, event): |
---|
| 174 | self.Destroy() |
---|
[fac42cf] | 175 | |
---|
[8faef63] | 176 | logger = logging.getLogger(__name__) |
---|
| 177 | try: |
---|
| 178 | subprocess.check_output(["cc","--version"], stderr=subprocess.STDOUT) |
---|
| 179 | except subprocess.CalledProcessError as exc: |
---|
| 180 | dlg = GenericMessageBox(parent=None, |
---|
[1270e3c] | 181 | text='No compiler installed. Please install command line\n' |
---|
| 182 | 'developers tools by clicking \"Install\" in another winodw\n\n' |
---|
| 183 | 'Alternatively click \"Not Now\" and use OpenCL\n' |
---|
| 184 | 'compiler, which can be set up from menu Fitting->OpenCL Options\n\n', |
---|
[8faef63] | 185 | title = 'Compiler Info') |
---|
[e979ad4] | 186 | dlg.Show() |
---|
[8faef63] | 187 | logger.error("No compiler installed. %s\n"%(exc)) |
---|
| 188 | logger.error(traceback.format_exc()) |
---|
| 189 | |
---|
[899e084] | 190 | def setup_logging(): |
---|
[7c105e8] | 191 | from sas.logger_config import SetupLogger |
---|
[899e084] | 192 | |
---|
[7c105e8] | 193 | logger = SetupLogger(__name__).config_production() |
---|
[899e084] | 194 | # Log the start of the session |
---|
[7c105e8] | 195 | logger.info(" --- SasView session started ---") |
---|
[899e084] | 196 | # Log the python version |
---|
[7c105e8] | 197 | logger.info("Python: %s" % sys.version) |
---|
| 198 | return logger |
---|
[899e084] | 199 | |
---|
| 200 | |
---|
| 201 | def setup_wx(): |
---|
| 202 | # Allow the dynamic selection of wxPython via an environment variable, when devs |
---|
| 203 | # who have multiple versions of the module installed want to pick between them. |
---|
| 204 | # This variable does not have to be set of course, and through normal usage will |
---|
| 205 | # probably not be, but this can make things a little easier when upgrading to a |
---|
| 206 | # new version of wx. |
---|
[7c105e8] | 207 | logger = logging.getLogger(__name__) |
---|
[899e084] | 208 | WX_ENV_VAR = "SASVIEW_WX_VERSION" |
---|
| 209 | if WX_ENV_VAR in os.environ: |
---|
[b39d32d5] | 210 | logger.info("You have set the %s environment variable to %s.", |
---|
| 211 | WX_ENV_VAR, os.environ[WX_ENV_VAR]) |
---|
[899e084] | 212 | import wxversion |
---|
| 213 | if wxversion.checkInstalled(os.environ[WX_ENV_VAR]): |
---|
[b39d32d5] | 214 | logger.info("Version %s of wxPython is installed, so using that version.", |
---|
| 215 | os.environ[WX_ENV_VAR]) |
---|
[899e084] | 216 | wxversion.select(os.environ[WX_ENV_VAR]) |
---|
| 217 | else: |
---|
[b39d32d5] | 218 | logger.error("Version %s of wxPython is not installed, so using default version.", |
---|
| 219 | os.environ[WX_ENV_VAR]) |
---|
[899e084] | 220 | else: |
---|
[b39d32d5] | 221 | logger.info("You have not set the %s environment variable, so using default version of wxPython.", |
---|
| 222 | WX_ENV_VAR) |
---|
[899e084] | 223 | |
---|
| 224 | import wx |
---|
| 225 | |
---|
| 226 | try: |
---|
[b39d32d5] | 227 | logger.info("Wx version: %s", wx.__version__) |
---|
| 228 | except AttributeError: |
---|
[914ba0a] | 229 | logger.error("Wx version: error reading version") |
---|
[899e084] | 230 | |
---|
| 231 | from . import wxcruft |
---|
| 232 | wxcruft.call_later_fix() |
---|
| 233 | #wxcruft.trace_new_id() |
---|
| 234 | #Always use private .matplotlib setup to avoid conflicts with other |
---|
| 235 | #uses of matplotlib |
---|
| 236 | |
---|
| 237 | |
---|
[b963b20] | 238 | def setup_mpl(backend=None): |
---|
[914ba0a] | 239 | # Always use private .matplotlib setup to avoid conflicts with other |
---|
[b963b20] | 240 | mplconfigdir = os.path.join(sas.get_user_dir(), '.matplotlib') |
---|
[899e084] | 241 | if not os.path.exists(mplconfigdir): |
---|
| 242 | os.mkdir(mplconfigdir) |
---|
| 243 | os.environ['MPLCONFIGDIR'] = mplconfigdir |
---|
| 244 | # Set backend to WXAgg; this overrides matplotlibrc, but shouldn't override |
---|
| 245 | # mpl.use(). Note: Don't import matplotlib here since the script that |
---|
| 246 | # we are running may not actually need it; also, putting as little on the |
---|
| 247 | # path as we can |
---|
[b277220] | 248 | if backend: |
---|
| 249 | os.environ['MPLBACKEND'] = backend |
---|
[899e084] | 250 | |
---|
[1693141] | 251 | # TODO: ... so much for not importing matplotlib unless we need it... |
---|
[914ba0a] | 252 | from matplotlib import backend_bases |
---|
| 253 | backend_bases.FigureCanvasBase.filetypes.pop('pgf', None) |
---|
| 254 | |
---|
[0a5d1a8] | 255 | def setup_sasmodels(): |
---|
| 256 | """ |
---|
| 257 | Prepare sasmodels for running within sasview. |
---|
| 258 | """ |
---|
[1693141] | 259 | # Set SAS_MODELPATH so sasmodels can find our custom models |
---|
[b963b20] | 260 | plugin_dir = os.path.join(sas.get_user_dir(), PLUGIN_MODEL_DIR) |
---|
[1693141] | 261 | os.environ['SAS_MODELPATH'] = plugin_dir |
---|
[20fa5fe] | 262 | #Initialize environment variable with custom setting but only if variable not set |
---|
[b963b20] | 263 | SAS_OPENCL = sas.get_custom_config().SAS_OPENCL |
---|
| 264 | if SAS_OPENCL and "SAS_OPENCL" not in os.environ: |
---|
| 265 | os.environ["SAS_OPENCL"] = SAS_OPENCL |
---|
[60a7820] | 266 | |
---|
[6af5d75] | 267 | |
---|
| 268 | def run_gui(threaded=False): |
---|
[415fb82] | 269 | """ |
---|
| 270 | __main__ method for loading and running SasView |
---|
| 271 | """ |
---|
[f76bf17] | 272 | from multiprocessing import freeze_support |
---|
| 273 | freeze_support() |
---|
[899e084] | 274 | setup_logging() |
---|
[b963b20] | 275 | setup_mpl(backend='WXAgg') |
---|
[1693141] | 276 | setup_sasmodels() |
---|
| 277 | setup_wx() |
---|
[6af5d75] | 278 | app = SasView(threaded=threaded) |
---|
| 279 | return app |
---|
[899e084] | 280 | |
---|
| 281 | |
---|
| 282 | def run_cli(): |
---|
[1693141] | 283 | from multiprocessing import freeze_support |
---|
| 284 | freeze_support() |
---|
[7c105e8] | 285 | setup_logging() |
---|
[b963b20] | 286 | # Use default matplotlib backend on mac/linux, but wx on windows. |
---|
| 287 | # The problem on mac is that the wx backend requires pythonw. On windows |
---|
| 288 | # we are sure to wx since it is the shipped with the app. |
---|
| 289 | setup_mpl(backend='WXAgg' if os.name == 'nt' else None) |
---|
[1693141] | 290 | setup_sasmodels() |
---|
[aaa801e] | 291 | if len(sys.argv) == 1 or sys.argv[1] == '-i': |
---|
[899e084] | 292 | # Run sasview as an interactive python interpreter |
---|
[4b26bc14] | 293 | try: |
---|
| 294 | from IPython import start_ipython |
---|
| 295 | sys.argv = ["ipython", "--pylab"] |
---|
| 296 | sys.exit(start_ipython()) |
---|
| 297 | except ImportError: |
---|
| 298 | import code |
---|
[b39d32d5] | 299 | code.interact(local={'exit': sys.exit}) |
---|
[0225a3f] | 300 | elif sys.argv[1] == '-c': |
---|
| 301 | exec(sys.argv[2]) |
---|
[899e084] | 302 | else: |
---|
[f76bf17] | 303 | thing_to_run = sys.argv[1] |
---|
| 304 | sys.argv = sys.argv[1:] |
---|
| 305 | import runpy |
---|
| 306 | if os.path.exists(thing_to_run): |
---|
| 307 | runpy.run_path(thing_to_run, run_name="__main__") |
---|
| 308 | else: |
---|
| 309 | runpy.run_module(thing_to_run, run_name="__main__") |
---|
| 310 | |
---|
[f36e01f] | 311 | |
---|
[f76bf17] | 312 | if __name__ == "__main__": |
---|
[899e084] | 313 | run_gui() |
---|