Changeset b0ab6cb in sasview for calculatorview/perspectives/calculator/help_panel.py

Timestamp:

Oct 27, 2010 4:41:30 PM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

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:

6cda91f

Parents:

c4d6900

Message:

working with pylint

File:

• calculatorview/perspectives/calculator/help_panel.py (modified) (8 diffs)

calculatorview/perspectives/calculator/help_panel.py

@@ -1 +1 @@
 #!/usr/bin/python
+"""
+Help panel for calculator
+"""
+import os
 import wx
 import wx.html as html
 from wx.lib.splitter import MultiSplitterWindow
 import sans.perspectives.calculator as calculator
-import os
-def help():
-    """
-        Provide general online help text
-        Future work: extend this function to allow topic selection
-    """
-    info_txt  = "The inversion approach is based on Moore, J. Appl. Cryst. (1980) 13, 168-175.\n\n"
-    info_txt += "P(r) is set to be equal to an expansion of base functions of the type "
-    info_txt += "phi_n(r) = 2*r*sin(pi*n*r/D_max). The coefficient of each base functions "
-    info_txt += "in the expansion is found by performing a least square fit with the "
-    info_txt += "following fit function:\n\n"
-    info_txt += "chi**2 = sum_i[ I_meas(q_i) - I_th(q_i) ]**2/error**2 + Reg_term\n\n"
-    info_txt += "where I_meas(q) is the measured scattering intensity and I_th(q) is "
-    info_txt += "the prediction from the Fourier transform of the P(r) expansion. "
-    info_txt += "The Reg_term term is a regularization term set to the second derivative "
-    info_txt += "d**2P(r)/dr**2 integrated over r. It is used to produce a smooth P(r) output.\n\n"
-    info_txt += "The following are user inputs:\n\n"
-    info_txt += "   - Number of terms: the number of base functions in the P(r) expansion.\n\n"
-    info_txt += "   - Regularization constant: a multiplicative constant to set the size of "
-    info_txt += "the regularization term.\n\n"
-    info_txt += "   - Maximum distance: the maximum distance between any two points in the system.\n"
-     
-    return info_txt
-    
-class HelpDialog(wx.Dialog):
-    def __init__(self, parent, id):
-      
-        wx.Dialog.__init__(self, parent, id, size=(400, 420))
-        self.SetTitle("Calculator help") 
-        
-
-        vbox = wx.BoxSizer(wx.VERTICAL)
-
-        explanation = help()
-           
-        label_explain = wx.StaticText(self, -1, explanation, size=(350,320))
-            
-        vbox.Add(label_explain, 0, wx.ALL|wx.EXPAND, 15)
 
 
-        static_line = wx.StaticLine(self, -1)
-        vbox.Add(static_line, 0, wx.EXPAND, 0)
-        
-        button_OK = wx.Button(self, wx.ID_OK, "OK")
-
-        sizer_button = wx.BoxSizer(wx.HORIZONTAL)
-        sizer_button.Add((20, 20), 1, wx.EXPAND|wx.ADJUST_MINSIZE, 0)
-        sizer_button.Add(button_OK, 0, wx.LEFT|wx.RIGHT|wx.ADJUST_MINSIZE, 10)       
-        vbox.Add(sizer_button, 0, wx.EXPAND|wx.BOTTOM|wx.TOP, 10)
-
-        self.SetSizer(vbox)
-        self.SetAutoLayout(True)
-        
-        self.Layout()
-        self.Centre()
-
 class HelpWindow(wx.Frame):
-    def __init__(self, parent, id, title= 'HelpWindow', pageToOpen=None):
-        wx.Frame.__init__(self, parent, id, title, size=(700, 450))
+    """
+    """
+    def __init__(self, parent, title='HelpWindow', pageToOpen=None):
+        wx.Frame.__init__(self, parent, title, size=(700, 450))
         """
              contains help info
         """
-      
         splitter = MultiSplitterWindow(self, style=wx.SP_LIVE_UPDATE)
         rpanel = wx.Panel(splitter, -1)
-        lpanel = wx.Panel(splitter, -1,style=wx.BORDER_SUNKEN)
+        lpanel = wx.Panel(splitter, -1, style=wx.BORDER_SUNKEN)
         
         vbox = wx.BoxSizer(wx.VERTICAL)
@@ -84 +35 @@
         vbox.Add(header, 0, wx.EXPAND)
        
-        vboxl= wx.BoxSizer(wx.VERTICAL)
+        vboxl = wx.BoxSizer(wx.VERTICAL)
         headerl = wx.Panel(lpanel, -1, size=(-1, 20))
        
@@ -103 +54 @@
         self.path = calculator.get_data_path(media='media')
        
-       
-        page1="""<html>
+        page1 = """<html>
             <body>
              <p>Select topic on Menu</p>
@@ -110 +60 @@
             </html>"""
         self.rhelp.SetPage(page1)
-        page="""<html>
+        page = """<html>
             <body>
             <ul>
-            <li><a href ="sld_calculator_help.html" target ="showframe">SLD Calculator</a><br></li>
-            <li><a href ="slit_calculator_help.html" target ="showframe">Slit Size Calculator</a><br></li>
-            <li><a href ="kiessig_calculator_help.html" target ="showframe">Kiessig Thickness Calculator</a><br></li>
+            <li><a href ="sld_calculator_help.html" 
+            target ="showframe">SLD Calculator</a><br></li>
+            <li><a href ="slit_calculator_help.html" 
+            target ="showframe">Slit Size Calculator</a><br></li>
+            <li><a href ="kiessig_calculator_help.html" 
+            target ="showframe">Kiessig Thickness Calculator</a><br></li>
             </ul>
             </body>
@@ -121 +74 @@
 
         self.lhelp.SetPage(page)
-        self.lhelp.Bind(wx.html.EVT_HTML_LINK_CLICKED,self.OnLinkClicked )
+        self.lhelp.Bind(wx.html.EVT_HTML_LINK_CLICKED, self.OnLinkClicked)
         
-        vbox.Add(self.rhelp,1, wx.EXPAND)
+        vbox.Add(self.rhelp, 1, wx.EXPAND)
         vboxl.Add(self.lhelp, 1, wx.EXPAND)
         rpanel.SetSizer(vbox)
@@ -130 +83 @@
         
         vbox1 = wx.BoxSizer(wx.HORIZONTAL)
-        vbox1.Add(splitter,1,wx.EXPAND)
+        vbox1.Add(splitter, 1, wx.EXPAND)
         splitter.AppendWindow(lpanel, 200)
         splitter.AppendWindow(rpanel)
@@ -138 +91 @@
         self.Show(True)
         
-        
     def OnLinkClicked(self, event):
         """
             Function to diplay html page related to the hyperlinktext selected
         """
-       
-        link= event.GetLinkInfo().GetHref()
-        link = os.path.join(self.path,link)
+        link = event.GetLinkInfo().GetHref()
+        link = os.path.join(self.path, link)
         self.rhelp.LoadPage(link)
+        
         
 class ViewApp(wx.App):
@@ -153 +105 @@
         frame.Show(True)
         self.SetTopWindow(frame)
-        
         return True
         
-
 if __name__ == "__main__": 
     app = ViewApp(0)