Changeset 00323d6 in sasview

Timestamp:

Feb 18, 2015 1:35:24 AM (9 years ago)

Author:

butler

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:

e4d4de2

Parents:

707c6be (diff), d838715 (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

Files:

• docs/sphinx-docs/source/user/user.rst (modified) (3 diffs)
• src/sas/guiframe/media/data_explorer_help.rst (modified) (9 diffs)
• src/sas/guiframe/media/data_formats_help.rst (added)
• src/sas/models/media/model_functions.rst (modified) (1 diff)
• src/sas/perspectives/fitting/basepage.py (modified) (1 diff)
• src/sas/perspectives/fitting/pagestate.py (modified) (1 diff)
• src/sas/perspectives/invariant/invariant_panel.py (modified) (1 diff)
• src/sas/guiframe/gui_manager.py (modified) (1 diff)
• src/sas/guiframe/local_perspectives/data_loader/data_loader.py (modified) (1 diff)

docs/sphinx-docs/source/user/user.rst

@@ -4 +4 @@
 .. toctree::
    :maxdepth: 1
-
+   
    Model Documentation <models/model_functions>
    
+   Data Formats <guiframe/data_formats_help>
    
    Loading Data <guiframe/data_explorer_help>
    
    Plotting Data/Models <guiframe/graph_help>
-   
    
    Fitting Perspective <perspectives/fitting/fitting_help>
@@ -19 +19 @@
    Invariant Calculation Perspective <perspectives/invariant/invariant_help>
    
-  
    Data Operations Tool <perspectives/calculator/data_operator_help>
       
@@ -36 +35 @@
    SANS Resolution Estimator Tool <perspectives/calculator/resolution_calculator_help>
    
-   
    Python Shell Tool <perspectives/calculator/python_shell_help>

src/sas/guiframe/media/data_explorer_help.rst

@@ -33 +33 @@
 
 *Data Explorer* is a panel that allows the user more interactions with data. 
-Some functionalities provided by the Data Explorer are also available through 
-the context menu of plot panels or other menus of the applications.Under menu 
-*View*  of the menubar, Data explorer can be toggled between Show and Hide by 
-clicking the menu *Show/Hide Data Explorer* .
+Some functionalities provided by the *Data Explorer* are also available through 
+the context menu of plot panels or other menus within the application.
 
-*IMPORTANT!*  When Data explorer is hidden, all the data loaded will be sent 
-directly to the current active application, if possible. When data Explorer is 
-shown data go first to the Data Explorer for the user to handle them later.
+Under *View* in the menu bar, *Data Explorer* can be toggled between Show and 
+Hide by clicking *Show/Hide Data Explorer*.
+
+NOTE! When *Data Explorer* is hidden, all data loaded will be sent directly 
+to the current active application, if possible. When *Data Explorer* is 
+shown, data go first to the *Data Explorer*.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -49 +50 @@
 ---------
 
-To Load data, click the button *Load Data* , then select one or more (holding 
-Ctrl key) files to load into the application. In the list, the *Data*  will be 
-displayed as the name of each selected file. Expending this data by clicking 
-the *+*  symbol will display available information about the data such as data 
-title if exists.
+To load data, click the button *Load Data*, then select one or more (by holding 
+the Ctrl key) files to load into the application. The name of each selected 
+file will be listed. Clicking the *+*  symbol will display any available 
+metadata.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -62 +62 @@
 ----------
 
-For a quick Data-info/Save/Plot/3d-plot(2d only)/Edit-mask(2d only), 
-high-light the data/theory, right-click, and select a proper item from the 
-context menu.
+Right-clicking on a loaded dataset (or model calculation, what SasView calls a 
+theory) brings up a *Handy Menu* from which it is possible to access Data Info, 
+Save the data/theory, or Plot the data/theory.
 
 .. image:: hand_menu.png
@@ -75 +75 @@
 -------------
 
-To interact with data, check a data label and click on a button. Checking Data 
-make them active for the button operation. Unchecking Data labels will 
-deactivate them.
+To interact with data it must be activated. This is accomplished by checking 
+the box next to the data label. A green tick will appear.
 
-There is a combo box labeled *Selection Options*  that allows to activate or 
-select multiple data simultaneously.
+Unchecking/unticking the box deactivates a data set.
+
+There is also a combo box labeled *Selection Options* from which you can 
+activate or deactivate multiple data sets.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -89 +90 @@
 -----------
 
-Remove data button remove all reference of this data into the application.
+WARNING! *Remove Data* will stop any data operations currently using the 
+selected data sets.
 
-*WARNING!* Remove data will stop any jobs currently using the selected data.
+
+*Remove Data* removes all reference to selected data from the application.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -100 +103 @@
 --------------------
 
-Click on the button *Append To*  to append selected Data to a plot panel on 
-focus. Next to this button is a combo box containing available panels names. 
-Selecting a name from this combo box will set the corresponding lot panel on 
-focus. If not plot panel is available, the combo box and button will be 
-disable. 2D Data cannot be appended to any plot panels . This operation can 
+Click on the button *Append To* to add selected data to a plot panel. Next to 
+the button is a combo box containing the names of available plot panels. 
+Selecting a name from this combo box will move that plot into focus.
+ 
+If a plot panel is not available, the combo box and button will be 
+disabled.
+
+2D Data cannot be appended to any plot panels. This operation can 
 only be performed on 1D data and plot panels currently containing 1D data.
 
@@ -114 +120 @@
 ---------------
 
-Click on *New Plot*  button to create a new plot panel where selected data 
-will be plotted.
+Click on the *New Plot* button to create a new plot panel where the currently 
+selected data will be plotted.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -124 +130 @@
 -------------
 
-*Freeze Theory*  button generate Data from selected theory. This operation can 
-only be performed when theory labels are selected.
+The *Freeze Theory* button generates data from the selected theory.
+
+NOTE! This operation can only be performed when theory labels are selected.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -134 +141 @@
 -------------------
 
-Click on the button *Send To*  to send Data to the current active control 
-page. One of the single/batch mode can be selected only for Fitting. The batch 
-mode provides serial (batch) fitting with one model, i.e., fitting one data by 
-another data. Note that only the Fitting allows more that one data to be sent.
+Click on the button *Send To* button to send the currently selected data to 
+a perspective (for *Fitting*, *P(r) Inversion*, or *Invariant* calculation).
+ 
+The *Single*/*Batch* mode radio buttons only apply to the *Fitting* perspective.
+
+*Batch mode* provides serial (batch) fitting with one model function, that is, 
+fitting one data set followed by another. If several data sets need to be 
+fitted at the same time, use *Simultaneous* fitting under the *Fitting* 
+option on the menu bar.

src/sas/models/media/model_functions.rst

@@ -87 +87 @@
 
  2.1 Shape-based_ Functions
+ 
  2.2 Shape-independent_ Functions
+ 
  2.3 Structure-factor_ Functions
+ 
  2.4 Customised_ Functions
 

src/sas/perspectives/fitting/basepage.py

@@ -832 +832 @@
             infor = 'warning'
         elif flag:
-            msg = " Parameter values are pasted from the clipboad..."
+            msg = " Parameter values are pasted from the clipboard..."
             infor = "warning"
         else:
-            msg = "Error occured: "
+            msg = "Error occurred: "
             msg += "No valid parameter values to paste from the clipboard..."
-            infor = "error"
-            wx.PostEvent(self._manager.parent,
-                    StatusEvent(status=msg, info=infor))
+            infor = "warning"
         # inform msg to wx
         wx.PostEvent(self._manager.parent,

src/sas/perspectives/fitting/pagestate.py

@@ -637 +637 @@
         report_list = [report_str, text_str, images]
         dialog = ReportDialog(report_list, None, -1, "")
-        dialog.ShowModal()
+        dialog.Show()
         
     def _toXML_helper(self, thelist, element, newdoc):

src/sas/perspectives/invariant/invariant_panel.py

@@ -774 +774 @@
         report_list = [report_html_str, report_text_str, report_img]
         dialog = ReportDialog(report_list, None, -1, "")
-        dialog.ShowModal()
+        dialog.Show()
         
     def get_state_by_num(self, state_num=None):

src/sas/guiframe/gui_manager.py

@@ -2164 +2164 @@
         from documentation_window import DocumentationWindow
         
-        sphinx_doc_viewer = DocumentationWindow(self, -1, "index.html")
-#        sphinx_doc_viewer.Show()
-
+        sphinx_doc_viewer = DocumentationWindow(self, -1, "index.html", \
+                                                "General Help")
 
     def set_manager(self, manager):

src/sas/guiframe/local_perspectives/data_loader/data_loader.py

@@ -57 +57 @@
         Show a general help dialog. 
         """
-        from help_panel import  HelpWindow
-        frame = HelpWindow(None, -1) 
-        if hasattr(frame, "IsIconized"):
-            if not frame.IsIconized():
-                try:
-                    icon = self.parent.GetIcon()
-                    frame.SetIcon(icon)
-                except:
-                    pass  
-        frame.Show(True)
+#        from documentation_window import DocumentationWindow     
+#        _sphinx_doc_viewer = DocumentationWindow(self, -1, "/user/guiframe/ \
+#            data_explorer_help.html", "DataLoader Help")
+#        from help_panel import  HelpWindow
+#        frame = HelpWindow(None, -1) 
+#        if hasattr(frame, "IsIconized"):
+#            if not frame.IsIconized():
+#                try:
+#                    icon = self.parent.GetIcon()
+#                    frame.SetIcon(icon)
+#                except:
+#                    pass  
+#        frame.Show(True)
         
     def populate_file_menu(self):