Changeset 6a6d687 in sasview for src/sas

Timestamp:

Jun 22, 2015 1:23:56 PM (10 years ago)

Author:

krzywon

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

4cf8db9

Parents:

0c17d96 (diff), 038ccfe6 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' of ​https://github.com/SasView/sasview.git

Location:

src/sas

Files:

• guiframe/acknowledgebox.py (modified) (4 diffs)
• guiframe/config.py (modified) (5 diffs)
• guiframe/data_processor.py (modified) (8 diffs)
• guiframe/documentation_window.py (modified) (4 diffs)
• guiframe/gui_manager.py (modified) (2 diffs)
• perspectives/fitting/media/fitting.rst (modified) (1 diff)

src/sas/guiframe/acknowledgebox.py

@@ -21 +21 @@
       (os.path.isfile("%s/%s.pyc" % (path, 'local_config'))):
         fObj, path, descr = imp.find_module('local_config', [path])
-        config = imp.load_module('local_config', fObj, path, descr)  
+        config = imp.load_module('local_config', fObj, path, descr)
     else:
         # Try simply importing local_config
         import local_config as config
 except:
-    # Didn't find local config, load the default 
+    # Didn't find local config, load the default
     import config
-    
+
 
 class DialogAcknowledge(wx.Dialog):
     """
     "Acknowledgement" Dialog Box
-    
+
     Shows the current method for acknowledging SasView in
     scholarly publications.
-    
+
     """
-    
+
     def __init__(self, *args, **kwds):
-        
+
         kwds["style"] = wx.DEFAULT_DIALOG_STYLE
         wx.Dialog.__init__(self, *args, **kwds)
-        
+
         self.ack = wx.TextCtrl(self, style=wx.TE_LEFT|wx.TE_MULTILINE|wx.TE_BESTWRAP|wx.TE_READONLY|wx.TE_NO_VSCROLL)
         self.ack.SetValue(config._acknowledgement_publications)
-        self.ack.SetMinSize((-1,55))
+        self.ack.SetMinSize((-1, 55))
         self.preamble = wx.StaticText(self, -1, config._acknowledgement_preamble)
         items = [config._acknowledgement_preamble_bullet1,
                  config._acknowledgement_preamble_bullet2,
-                 config._acknowledgement_preamble_bullet3]
+                 config._acknowledgement_preamble_bullet3,
+                 config._acknowledgement_preamble_bullet4]
         self.list1 = wx.StaticText(self, -1, "\t(1) " + items[0])
         self.list2 = wx.StaticText(self, -1, "\t(2) " + items[1])
         self.list3 = wx.StaticText(self, -1, "\t(3) " + items[2])
+        self.list4 = wx.StaticText(self, -1, "\t(4) " + items[3])
         self.static_line = wx.StaticLine(self, 0)
         self.__set_properties()
         self.__do_layout()
-        
+
     def __set_properties(self):
         """
+        :TODO - add method documentation
         """
         # begin wxGlade: DialogAbout.__set_properties
@@ -70 +73 @@
     def __do_layout(self):
         """
+        :TODO - add method documentation
         """
         # begin wxGlade: DialogAbout.__do_layout
@@ -78 +82 @@
         sizer_titles.Add(self.list2, 0, wx.ALL|wx.EXPAND, 5)
         sizer_titles.Add(self.list3, 0, wx.ALL|wx.EXPAND, 5)
+        sizer_titles.Add(self.list4, 0, wx.ALL|wx.EXPAND, 5)
         sizer_titles.Add(self.static_line, 0, wx.ALL|wx.EXPAND, 0)
         sizer_titles.Add(self.ack, 0, wx.ALL|wx.EXPAND, 5)
@@ -86 +91 @@
         self.Centre()
         # end wxGlade
-        
+
 
 ##### testing code ############################################################
 class MyApp(wx.App):
     """
+    Class for running module as stand alone for testing
     """
     def OnInit(self):
         """
+        Defines an init when running as standalone
         """
         wx.InitAllImageHandlers()

src/sas/guiframe/config.py

@@ -9 +9 @@
 __version__ = '0.0.0'
 __build__ = '1'
-__download_page__ = 'http://sourceforge.net/projects/sasview/files/'
-__update_URL__ = ['svn.code.sf.net', 
-                  '/p/sasview/code/trunk/sasview.latestversion']
+__download_page__ = 'https://github.com/SasView/sasview/releases'
+__update_URL__ = ['https://github.com/SasView/sasview.git']
 
 
@@ -21 +20 @@
 
 # Debug message should be written to a file?
-__EVT_DEBUG_2_FILE__   = False
+__EVT_DEBUG_2_FILE__ = False
 __EVT_DEBUG_FILENAME__ = "debug.log"
 
@@ -36 +35 @@
 '''Reference the following website: http://www.sasview.org'''
 _acknowledgement_preamble_bullet3 =\
-'''Send us your reference for our records: sansdanse@gmail.com'''
+'''Reference the model you used if appropriate (see documentation for refs)'''
+_acknowledgement_preamble_bullet4 =\
+'''Send us your reference for our records: developers@sasview.org'''
 _acknowledgement_publications = \
-'''This work benefited from the use of the SasView application, originally 
+'''This work benefited from the use of the SasView application, originally
 developed under NSF award DMR-0520547.
 '''
 _acknowledgement =  \
 '''This work originally developed as part of the DANSE project funded by the NSF
-under grant DMR-0520547, and currently maintained by NIST, UMD, ORNL, ISIS, ESS 
+under grant DMR-0520547, and currently maintained by NIST, UMD, ORNL, ISIS, ESS
 and ILL.
 
@@ -85 +86 @@
 PLUGINS_WLIST = []
 PLUGIN_STATE_EXTENSIONS = []
-SPLASH_SCREEN_PATH = "images/danse_logo.png"     
+SPLASH_SCREEN_PATH = "images/danse_logo.png"
 DEFAULT_STYLE = GUIFRAME.SINGLE_APPLICATION
 SPLASH_SCREEN_WIDTH = 500
 SPLASH_SCREEN_HEIGHT = 300
-WELCOME_PANEL_ON  = False
+WELCOME_PANEL_ON = False
 TUTORIAL_PATH = None
 SS_MAX_DISPLAY_TIME = 1500
@@ -125 +126 @@
 
 def printEVT(message):
+    """
+    :TODO - need method documentation
+    """
     if __EVT_DEBUG__:
         print "%g:  %s" % (time.clock(), message)
-        
+    
         if __EVT_DEBUG_2_FILE__:
             out = open(__EVT_DEBUG_FILENAME__, 'a')

src/sas/guiframe/data_processor.py

@@ -141 +141 @@
         self.Bind(wx.grid.EVT_GRID_CELL_LEFT_CLICK, self.OnLeftClick)
         self.Bind(wx.grid.EVT_GRID_CELL_RIGHT_CLICK, self.OnRightClick)
-        self.Bind(wx.grid.EVT_GRID_CELL_LEFT_DCLICK, self.OnLeftDoubleClick)
+        #self.Bind(wx.grid.EVT_GRID_CELL_LEFT_DCLICK, self.OnLeftDoubleClick)
         self.Bind(wx.grid.EVT_GRID_RANGE_SELECT, self.OnRangeSelect)
         self.Bind(wx.grid.EVT_GRID_ROW_SIZE, self.OnRowSize)
@@ -187 +187 @@
         if self.GetNumberCols() > 0:
             self.default_col_width = self.GetColSize(0)
-        self.Bind(wx.grid.EVT_GRID_LABEL_LEFT_CLICK, self.on_left_click)
-        self.Bind(wx.grid.EVT_GRID_LABEL_RIGHT_CLICK, self.on_right_click)
-        self.Bind(wx.grid.EVT_GRID_CELL_LEFT_CLICK, self.on_selected_cell)
-        self.Bind(wx.grid.EVT_GRID_CMD_CELL_CHANGE, self.on_edit_cell)
-        self.Bind(wx.grid.EVT_GRID_CELL_RIGHT_CLICK, self.onContextMenu)
-
+        #self.Bind(wx.grid.EVT_GRID_LABEL_LEFT_CLICK, self.on_left_click)
+        #self.Bind(wx.grid.EVT_GRID_LABEL_RIGHT_CLICK, self.on_right_click)
+        #self.Bind(wx.grid.EVT_GRID_CELL_LEFT_CLICK, self.on_selected_cell)
+        #self.Bind(wx.grid.EVT_GRID_CMD_CELL_CHANGE, self.on_edit_cell)
+        #self.Bind(wx.grid.EVT_GRID_CELL_RIGHT_CLICK, self.onContextMenu)
+
+    def OnLeftClick(self, event):
+        sheet.CSheet.OnLeftClick(self, event)
+        self.on_selected_cell(event)
+        
     def on_edit_cell(self, event):
         """
@@ -211 +215 @@
         row, col = event.GetRow(), event.GetCol()
         cell = (row, col)
-        event.Skip()
         if not flag and not flag_shift:
             self.selected_cols = []
@@ -273 +276 @@
             if cell_row > 0 and cell_row < self.max_row_touse:
                 self.axis_value.append(self.GetCellValue(cell_row, cell_col))
+        event.Skip()
 
     def on_left_click(self, event):
@@ -278 +282 @@
         Catch the left click on label mouse event
         """
-        event.Skip()
         flag = event.CmdDown() or event.ControlDown()
 
@@ -317 +320 @@
             if not self.axis_label:
                 self.axis_label = " "
+        event.Skip()
 
     def on_right_click(self, event):
@@ -1385 +1389 @@
         wx.EVT_MENU(self, self.save_menu.GetId(), self.on_save_page)
 
+        # To add the edit menu, call add_edit_menu() here.
+        self.edit = None
+        self.Bind(wx.EVT_MENU_OPEN, self.on_menu_open)
+        
+        self.Bind(wx.EVT_CLOSE, self.on_close)
+
+    def add_edit_menu(self, menubar):
         self.edit = wx.Menu()
 
@@ -1414 +1425 @@
         self.remove_menu = self.edit.Append(-1, 'Remove Column', hint)
         wx.EVT_MENU(self, self.remove_menu.GetId(), self.on_remove_column)
-
-        self.Bind(wx.EVT_MENU_OPEN, self.on_menu_open)
         menubar.Append(self.edit, "&Edit")
-        self.Bind(wx.EVT_CLOSE, self.on_close)
 
     def on_copy(self, event):

src/sas/guiframe/documentation_window.py

@@ +1 @@
+"""
+documentation module provides a simple means to add help throughout the
+application. It checks for the existence of html2 package needed to support
+fully html panel which supports css.  The class defined here takes a title for
+the particular help panel, a pointer to the html documentation file of interest
+within the documentation tree along with a 'command' string such as a page
+anchor or a query string etc.  The path to the doc directory is retrieved
+automatically by the class itself.  Thus with these three pieces of information
+the class generates a panel with the appropriate title bar and help file
+formatted according the style sheets called in the html file.  Finally, if an
+old version of Python is running and the html2 package is not available the
+class brings up the default browser and passes the file:/// string to it.  In
+this case however the instruction portion is usually not passed for security
+reasons.
+"""
 import os
 import logging
@@ -5 +20 @@
 import urllib
 
-wx_supports_html2 = True
+SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
+WX_SUPPORTS_HTML2 = True
 try:
     import wx.html2 as html
 except:
-    wx_supports_html2 = False
+    WX_SUPPORTS_HTML2 = False
+
 
 from gui_manager import get_app_dir
@@ -15 +32 @@
 
 class DocumentationWindow(wx.Frame):
-    def __init__(self, parent, id, path, url_instruction, title, size=(850, 540)):
-        wx.Frame.__init__(self, parent, id, title, size=size)
+    """
+    DocumentationWindow inherits from wx.Frame and provides a centralized
+    coherent framework for all help documentation.  Help files must be html
+    files stored in an properly organized tree below the top 'doc' folder.  In
+    order to display the appropriate help file from anywhere in the gui, the
+    code simply needs to know the location below the top level where the
+    help file resides along with the name of the help file.
+    called
+    (self, parent, dummy_id, path, url_instruction, title, size=(850, 540))
 
-        SPHINX_DOC_ENV = "SASVIEW_DOC_PATH"
+    :param path: path to html file beginning AFTER /doc/ and ending in the
+    file.html
+    :param url_instructions: anchor string or other query e.g. '#MyAnchor
+    :param title - text to place in the title bar of the help panel
+    """
+    def __init__(self, parent, dummy_id, path, url_instruction, title, size=(850, 540)):
+        wx.Frame.__init__(self, parent, dummy_id, title, size=size)
+
         if SPHINX_DOC_ENV in os.environ:
             docs_path = os.path.join(os.environ[SPHINX_DOC_ENV])
@@ -27 +58 @@
             docs_path = os.path.join(get_app_dir(), "doc")
 
+        #note that filepath for mac OS, at least in bundle starts with a
+        #forward slash as /Application, while the PC string begins C:\
+        #It seems that mac OS is happy with four slashes as in file:////App...
+        #Two slashes is not sufficient to indicate path from root.  Thus for now
+        #we use "file:///" +... If the mac behavior changes may need to make the
+        #file:/// be another constant at the beginning that yields // for Mac
+        #and /// for PC.
+        #Note added June 21, 2015     PDB
         file_path = os.path.join(docs_path, path)
-        url = "file:///" + urllib.quote(file_path,'\:')+ url_instruction
+        url = "file:///" + urllib.quote(file_path, r'/\:')+ url_instruction
 
         if not os.path.exists(file_path):
             logging.error("Could not find Sphinx documentation at %s \
             -- has it been built?", file_path)
-        elif wx_supports_html2:
+        elif WX_SUPPORTS_HTML2:
             # Complete HTML/CSS support!
             self.view = html.WebView.New(self)
             self.view.LoadURL(url)
             self.Show()
-        else: 
+        else:
             logging.error("No html2 support, popping up a web browser")
             #For cases that do not build against current version dependency
-            # Wx 3.0 we provide a webbrowser call - this is particularly for 
+            # Wx 3.0 we provide a webbrowser call - this is particularly for
             #Red hat used at SNS for which Wx 3.0 is not available.  This
-            #does not deal with issue of math in docs of course. 
+            #does not deal with issue of math in docs of course.
             webbrowser.open_new_tab(url)
 
 def main():
+    """
+    main loop function if running alone for testing.
+    """
     app = wx.App()
     DocumentationWindow(None, -1, "index.html", "", "Documentation",)

src/sas/guiframe/gui_manager.py

@@ -1296 +1296 @@
         #replace or add a new menu for the current plugin
         pos = self._menubar.FindMenu(str(self._applications_menu_name))
+        if pos == -1 and self._applications_menu_pos > 0:
+            pos = self._applications_menu_pos
         if pos != -1:
             menu_list = self._current_perspective.populate_menu(self)
             if menu_list:
                 for (menu, name) in menu_list:
+                    print "[%s]" % name
                     self._menubar.Replace(pos, menu, name)
                     self._applications_menu_name = name
+                self._applications_menu_pos = pos
             else:
                 self._menubar.Remove(pos)
                 self._applications_menu_name = None
-            #get the position of the menu when it first added
-            self._applications_menu_pos = pos
+                self._applications_menu_pos = -1
         else:
             menu_list = self._current_perspective.populate_menu(self)
@@ -1316 +1319 @@
                         if help_pos == -1:
                             self._menubar.Append(menu, name)
+                            self._applications_menu_pos = -1
                         else:
                             self._menubar.Insert(help_pos-1, menu, name)
+                            self._applications_menu_pos = help_pos - 1
                     else:
                         self._menubar.Insert(self._applications_menu_pos, menu, name)

src/sas/perspectives/fitting/media/fitting.rst

@@ -17 +17 @@
    Polarisation/Magnetic Scattering <mag_help>
 
-   Information on the SasView Optimisers - Local <optimizer.rst>
-
-   Information on the SasView Optimisers - Web <https://github.com/bumps/bumps/blob/master/doc/guide/optimizer.rst>
+   Information on the SasView Optimisers <optimizer.rst>