Changes in / [f202138:e82a901] in sasview

Files:

• .pydevproject (modified) (1 diff)
• src/sas/guiframe/documentation_window.py (modified) (3 diffs)
• src/sas/guiframe/gui_manager.py (modified) (1 diff)
• src/sas/perspectives/calculator/data_operator.py (modified) (1 diff)
• src/sas/perspectives/calculator/density_panel.py (modified) (1 diff)
• src/sas/perspectives/calculator/gen_scatter_panel.py (modified) (1 diff)
• src/sas/perspectives/calculator/image_viewer.py (modified) (1 diff)
• src/sas/perspectives/calculator/kiessig_calculator_panel.py (modified) (1 diff)
• src/sas/perspectives/calculator/model_editor.py (modified) (6 diffs)
• src/sas/perspectives/calculator/resolution_calculator_panel.py (modified) (1 diff)
• src/sas/perspectives/calculator/sld_panel.py (modified) (1 diff)
• src/sas/perspectives/calculator/slit_length_calculator_panel.py (modified) (1 diff)
• src/sas/perspectives/fitting/basepage.py (modified) (3 diffs)
• src/sas/perspectives/fitting/fitpage.py (modified) (6 diffs)
• src/sas/perspectives/invariant/invariant_panel.py (modified) (1 diff)
• src/sas/perspectives/pr/inversion_panel.py (modified) (1 diff)

.pydevproject

@@ -4 +4 @@
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.7</pydev_property>
 <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
-<path>/sasview-git/src</path>
+<path>/sasview/src</path>
 </pydev_pathproperty>
 </pydev_project>

src/sas/guiframe/documentation_window.py

@@ -15 +15 @@
 
 class DocumentationWindow(wx.Frame):
-    def __init__(self, parent, id, path, title, size=(850, 540)):
+    def __init__(self, parent, id, path, url_instruction, title, size=(850, 540)):
         wx.Frame.__init__(self, parent, id, title, size=size)
 
@@ -28 +28 @@
 
         file_path = os.path.join(docs_path, path)
-        url = "file:///" + urllib.quote(file_path)
+        url = "file:///" + urllib.quote(file_path,'\:')+ url_instruction
 
         if not os.path.exists(file_path):
@@ -48 +48 @@
 def main():
     app = wx.App()
-    DocumentationWindow(None, -1, "index.html", "Documentation",)
+    DocumentationWindow(None, -1, "index.html", "", "Documentation",)
     app.MainLoop()
 

src/sas/guiframe/gui_manager.py

@@ -2166 +2166 @@
         # different place than they would otherwise.
         from documentation_window import DocumentationWindow
-        DocumentationWindow(self, -1, "index.html", "General Help")
+        DocumentationWindow(self, -1, "index.html", "", "SasView Documentation")
 
     def set_manager(self, manager):

src/sas/perspectives/calculator/data_operator.py

@@ -635 +635 @@
 
         _TreeLocation = "user/perspectives/calculator/data_operator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Data Operation Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Data Operation Help")
 
     def disconnect_panels(self):

src/sas/perspectives/calculator/density_panel.py

@@ -385 +385 @@
 
         _TreeLocation = "user/perspectives/calculator/density_calculator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Density/Volume Calculator Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Density/Volume Calculator Help")
 
     def on_close(self, event):

src/sas/perspectives/calculator/gen_scatter_panel.py

@@ -914 +914 @@
 
         _TreeLocation = "user/perspectives/calculator/sas_calculator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "General Scattering Calculator Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "General Scattering Calculator Help")
 
     def _check_value(self):

src/sas/perspectives/calculator/image_viewer.py

@@ -150 +150 @@
 
         _TreeLocation = "user/perspectives/calculator/image_viewer_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Image Viewer Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Image Viewer Help")
 
 

src/sas/perspectives/calculator/kiessig_calculator_panel.py

@@ -173 +173 @@
     """
         _TreeLocation = "user/perspectives/calculator/kiessig_calculator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1,
-                                          _TreeLocation,
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
                                           "Density/Volume Calculator Help")
 

src/sas/perspectives/calculator/model_editor.py

@@ -29 +29 @@
 import re
 from wx.py.editwindow import EditWindow
+from sas.guiframe.documentation_window import DocumentationWindow
+
 
 if sys.platform.count("win32") > 0:
@@ -271 +273 @@
         # Eventually need to add help here
         self.ok_button = wx.Button(self, wx.ID_OK, 'Apply')
+        _app_tip = "Save the new Model."
+        self.ok_button.SetToolTipString(_app_tip)
         self.ok_button.Bind(wx.EVT_BUTTON, self.check_name)
+        self.help_button = wx.Button(self, -1, 'HELP')
+        _app_tip = "Help on composite model creation."
+        self.help_button.SetToolTipString(_app_tip)
+        self.help_button.Bind(wx.EVT_BUTTON, self.on_help)
         self.close_button = wx.Button(self, wx.ID_CANCEL, 'Close')
         sizer_button = wx.BoxSizer(wx.HORIZONTAL)
         sizer_button.AddMany([((20, 20), 1, 0),
                               (self.ok_button, 0, 0),
+                              (self.help_button, 0, 0),
                               (self.close_button, 0, wx.LEFT | wx.RIGHT, 10)])
         mainsizer.Add(sizer_button, 0, wx.EXPAND | wx.BOTTOM | wx.TOP, 10)
@@ -392 +401 @@
         else:
             raise
+
+    def on_help(self, event):
+        """
+        Bring up the Composite Model Editor Documentation whenever
+        the HELP button is clicked.
+
+        Calls DocumentationWindow with the path of the location within the
+        documentation tree (after /doc/ ....".  Note that when using old
+        versions of Wx (before 2.9) and thus not the release version of
+        installers, the help comes up at the top level of the file as
+        webbrowser does not pass anything past the # to the browser when it is
+        running "file:///...."
+
+    :param evt: Triggers on clicking the help button
+    """
+
+        _TreeLocation = "user/perspectives/fitting/fitting_help.html"
+        _PageAnchor = "#sum-multi-p1-p2"
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, _PageAnchor,
+                                          "Composite Model Editor Help")
 
     def _set_model_list(self):
@@ -756 +785 @@
         self.bt_apply.Bind(wx.EVT_BUTTON, self.on_click_apply)
 
+        self.bt_help = wx.Button(self, -1, "HELP", size=(_BOX_WIDTH, -1))
+        self.bt_help.SetToolTipString("Get Help For Model Editor")
+        self.bt_help.Bind(wx.EVT_BUTTON, self.on_help)
+
         self.bt_close = wx.Button(self, -1, 'Close', size=(_BOX_WIDTH, -1))
         self.bt_close.Bind(wx.EVT_BUTTON, self.on_close)
@@ -762 +795 @@
         self.button_sizer.AddMany([(self.bt_apply, 0,
                                     wx.LEFT, EDITOR_WIDTH * 0.8),
+                                   (self.bt_help, 0,
+                                    wx.LEFT,15),
                                    (self.bt_close, 0,
                                     wx.LEFT | wx.BOTTOM, 15)])
@@ -1089 +1124 @@
         """
         return self.warning
+
+    def on_help(self, event):
+        """
+        Bring up the Custom Model Editor Documentation whenever
+        the HELP button is clicked.
+
+        Calls DocumentationWindow with the path of the location within the
+        documentation tree (after /doc/ ....".  Note that when using old
+        versions of Wx (before 2.9) and thus not the release version of
+        installers, the help comes up at the top level of the file as
+        webbrowser does not pass anything past the # to the browser when it is
+        running "file:///...."
+
+    :param evt: Triggers on clicking the help button
+    """
+
+        _TreeLocation = "user/perspectives/fitting/fitting_help.html"
+        _PageAnchor = "#custom-model-editor"
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, _PageAnchor,
+                                          "Custom Model Editor Help")
 
     def on_close(self, event):

src/sas/perspectives/calculator/resolution_calculator_panel.py

@@ -642 +642 @@
 
         _TreeLocation = "user/perspectives/calculator/resolution_calculator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1,
-                                          _TreeLocation, "Resolution Calculator Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Resolution Calculator Help")
 
     def on_close(self, event):

src/sas/perspectives/calculator/sld_panel.py

@@ -326 +326 @@
 
         _TreeLocation = "user/perspectives/calculator/sld_calculator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "General Scattering Calculator Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "General Scattering Calculator Help")
 
     def on_close(self, event):

src/sas/perspectives/calculator/slit_length_calculator_panel.py

@@ -187 +187 @@
 
         _TreeLocation = "user/perspectives/calculator/slit_calculator_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Slit Length Calculator Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Slit Length Calculator Help")
 
     def on_close(self, event):

src/sas/perspectives/fitting/basepage.py

@@ -2847 +2847 @@
         """
 
-        if self.model == None:
-            name = 'index.html'
+        _TreeLocation = 'user/models/model_functions.html'
+        if self.model != None:
+            name = self.formfactorbox.GetValue()
+            _PageAnchor = '#' + name
+            _doc_viewer = DocumentationWindow(self, -1, _TreeLocation,
+                                              _PageAnchor, name + "Help")
         else:
-            name = self.formfactorbox.GetValue()
-
-        if self.model != None:
-            _docspath = 'user/models/model_functions.html#' + name
-            _doc_viewer = DocumentationWindow(self, -1, _docspath, name + "Help")
-        else:
-            _doc_viewer = DocumentationWindow(self, -1, "index.html", \
-                                                "General Help")
+            _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                                "General Model Help")
 
 
@@ -2908 +2906 @@
 
         _TreeLocation = "_images/M_angles_pic.bmp"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Magnetic Angle Defintions")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Magnetic Angle Defintions")
 
     def _on_mag_on(self, event):
@@ -2953 +2951 @@
         """
 
-        _TreeLocation = "user/perspectives/fitting/fitting_help.html"
-        _TreeLocation += "#polydispersity-distributions"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Polydispersity Help")
+        _TreeLocation = "user/perspectives/fitting/pd_help.html"
+        _PageAnchor = ""
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation,
+                                          _PageAnchor, "Polydispersity Help")
 
     def on_left_down(self, event):

src/sas/perspectives/fitting/fitpage.py

@@ -16 +16 @@
 from sas.guiframe.utils import format_number
 from sas.guiframe.utils import check_float
+from sas.guiframe.documentation_window import DocumentationWindow
 
 (Chi2UpdateEvent, EVT_CHI2_UPDATE) = wx.lib.newevent.NewEvent()
@@ -188 +189 @@
     def _fill_range_sizer(self):
         """
-        Fill the sizer containing the plotting range
-        add  access to npts
+        Fill the Fitting sizer on the fit panel which contains: the smearing
+        information (dq), the weighting information (dI or other), the plotting
+        range, access to the 2D mask editor, the compute, fit, and help
+        buttons, xi^2, number of points etc.
         """
         is_2Ddata = False
@@ -265 +268 @@
         weighting_box.Add(sizer_weighting)
 
-        sizer_fit = wx.GridSizer(2, 4, 2, 6)
+        sizer_fit = wx.GridSizer(2, 5, 2, 6)
 
         # combobox for smear2d accuracy selection
@@ -284 +287 @@
         self.btFit.SetToolTipString("Start fitting.")
 
+        #General Help button
+        self.btFitHelp = wx.Button(self, -1, 'HELP')
+        self.btFitHelp.SetToolTipString("General Fitting Help.")
+        self.btFitHelp.Bind(wx.EVT_BUTTON, self._onFitHelp)
+        
+        #Resolution Smearing Help button
+        self.btSmearHelp = wx.Button(self, -1, '?')
+        self.btSmearHelp.SetToolTipString("Resolution Smearing Help.")
+        self.btSmearHelp.Bind(wx.EVT_BUTTON, self._onSmearHelp)
+        
         #textcntrl for custom resolution
         self.smear_pinhole_max = ModelTextCtrl(self, -1,
@@ -391 +404 @@
         #sizer_fit.Add(box_description_3, 0, 0)
         sizer_fit.Add(self.draw_button, 0, 0)
+        sizer_fit.Add((-1,5))
         sizer_fit.Add(self.tcChi, 0, 0)
         sizer_fit.Add(self.Npts_fit, 0, 0)
         sizer_fit.Add(self.Npts_total, 0, 0)
         sizer_fit.Add(self.btFit, 0, 0)
+        sizer_fit.Add(self.btFitHelp, 0, 0)
 
         # StaticText for smear
@@ -1046 +1061 @@
         self.fit_started = self._manager.onFit(uid=self.uid)
         wx.CallAfter(self.set_fitbutton)
+
+    def _onFitHelp(self, event):
+        """
+        Bring up the Full Fitting Documentation whenever the HELP button is
+        clicked.
+
+        Calls DocumentationWindow with the path of the location within the
+        documentation tree (after /doc/ ....".  Note that when using old
+        versions of Wx (before 2.9) and thus not the release version of
+        installers, the help comes up at the top level of the file as
+        webbrowser does not pass anything past the # to the browser when it is
+        running "file:///...."
+
+    :param evt: Triggers on clicking the help button
+    """
+
+        _TreeLocation = "user/perspectives/fitting/fitting_help.html"
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "General Fitting Help")
+
+    def _onSmearHelp(self, event):
+        """
+        Bring up the instrumental resolution smearing Documentation whenever
+        the ? button in the smearing box is clicked.
+
+        Calls DocumentationWindow with the path of the location within the
+        documentation tree (after /doc/ ....".  Note that when using old
+        versions of Wx (before 2.9) and thus not the release version of
+        installers, the help comes up at the top level of the file as
+        webbrowser does not pass anything past the # to the browser when it is
+        running "file:///...."
+
+    :param evt: Triggers on clicking the help button
+    """
+
+        _TreeLocation = "user/perspectives/fitting/sm_help.html"
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Instrumental Resolution Smearing \
+                                          Help")
 
     def set_fitbutton(self):

src/sas/perspectives/invariant/invariant_panel.py

@@ -1893 +1893 @@
 
         _TreeLocation = "user/perspectives/invariant/invariant_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "Invariant Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "Invariant Help")
 
 

src/sas/perspectives/pr/inversion_panel.py

@@ -958 +958 @@
 
         _TreeLocation = "user/perspectives/pr/pr_help.html"
-        _doc_viewer = DocumentationWindow(self, -1, \
-             _TreeLocation, "P(r) Help")
+        _doc_viewer = DocumentationWindow(self, -1, _TreeLocation, "",
+                                          "P(r) Help")