Changes in / [b12404e:2f539b2] in sasview

Location:

src/sas

Files:

• qtgui/Calculators/DensityPanel.py (modified) (4 diffs)
• qtgui/Calculators/UnitTesting/DensityCalculatorTest.py (modified) (3 diffs)
• qtgui/Calculators/media/data_oper_pic.png (modified) (1 prop) (previous)
• qtgui/Calculators/media/density_calculator_help.rst (modified) (1 diff)
• qtgui/Calculators/media/density_tutor.png (modified) (1 prop) (previous)
• qtgui/MainWindow/GuiManager.py (modified) (2 diffs)
• qtgui/Perspectives/Fitting/media/batch_button_area.png (modified) (previous)
• qtgui/Perspectives/Fitting/media/dataset_name.png (deleted)
• qtgui/Perspectives/Fitting/media/edit_model_menu.png (modified) (previous)
• qtgui/Perspectives/Fitting/media/file_menu.png (modified) (previous)
• qtgui/Perspectives/Fitting/media/fit_algorithms.png (deleted)
• qtgui/Perspectives/Fitting/media/fitting_help.rst (modified) (17 diffs)
• qtgui/Perspectives/Fitting/media/log_explorer.png (deleted)
• qtgui/Perspectives/Fitting/media/model_editor_empty.png (deleted)
• qtgui/Perspectives/Fitting/media/new_model.png (modified) (previous)
• qtgui/Perspectives/Fitting/media/plugin_manager.png (deleted)
• qtgui/Perspectives/Fitting/media/sum_model.png (modified) (previous)
• qtgui/Utilities/CategoryInstaller.py (modified) (1 diff)
• qtgui/Utilities/TabbedModelEditor.py (modified) (1 diff)
• sascalc/fit/models.py (modified) (1 diff)

src/sas/qtgui/Calculators/DensityPanel.py

@@ -16 +16 @@
 
 from sas.qtgui.Utilities.GuiUtils import enum
-from sas.qtgui.Utilities.GuiUtils import formatNumber
 
 MODEL = enum(
@@ -99 +98 @@
             if index == MODEL.MOLECULAR_FORMULA:
                 molarMass = toMolarMass(self.model.item(MODEL.MOLECULAR_FORMULA).text())
-                molarMass = formatNumber(molarMass, high=True)
                 self.model.item(MODEL.MOLAR_MASS).setText(molarMass)
 
@@ -122 +120 @@
 
             molarDensity = molarMass / molarVolume
-            molarDensity = formatNumber(molarDensity, high=True)
             self.model.item(MODEL.MASS_DENSITY).setText(str(molarDensity))
 
@@ -134 +131 @@
 
             molarVolume = molarMass / molarDensity
-            molarVolume = formatNumber(molarVolume, high=True)
             self.model.item(MODEL.MOLAR_VOLUME).setText(str(molarVolume))
 

src/sas/qtgui/Calculators/UnitTesting/DensityCalculatorTest.py

@@ -78 +78 @@
 
         # Assure the mass density field is set
-        self.assertEqual(self.widget.ui.editMassDensity.text(), '18.015')
+        self.assertEqual(self.widget.ui.editMassDensity.text(), '18.0153')
 
         # Change mass density
@@ -88 +88 @@
 
         # Assure the molar volume field got updated
-        self.assertEqual(self.widget.ui.editMolarVolume.text(), '1.126')
+        self.assertEqual(self.widget.ui.editMolarVolume.text(), '1.12595625')
 
     def testComplexEntryAndReset(self):
@@ -113 +113 @@
 
         self.assertEqual(self.widget.ui.editMolecularFormula.text(), "H2O")
-        self.assertEqual(self.widget.ui.editMolarMass.text(), "18.015")
+        self.assertEqual(self.widget.ui.editMolarMass.text(), "18.0153")
         self.assertEqual(self.widget.ui.editMolarVolume.text(), "")
         self.assertEqual(self.widget.ui.editMassDensity.text(), "")

src/sas/qtgui/Calculators/media/density_calculator_help.rst

@@ -27 +27 @@
    then type in an input value.
 
-4) Press Tab button or click out to perform the calculation.
+4) Click the 'Calculate' button to perform the calculation.
 
 .. image:: density_tutor.png

src/sas/qtgui/MainWindow/GuiManager.py

@@ -65 +65 @@
         # Add signal callbacks
         self.addCallbacks()
-
-        # Assure model categories are available
-        self.addCategories()
 
         # Create the data manager
@@ -145 +142 @@
         self.ResolutionCalculator = ResolutionCalculatorPanel(self)
         self.DataOperation = DataOperationUtilityPanel(self)
-
-    def addCategories(self):
-        """
-        Make sure categories.json exists and if not compile it and install in ~/.sasview
-        """
-        try:
-            from sas.sascalc.fit.models import ModelManager
-            from sas.qtgui.Utilities.CategoryInstaller import CategoryInstaller
-            model_list = ModelManager().cat_model_list()
-            CategoryInstaller.check_install(model_list=model_list)
-        except Exception:
-            logger.error("%s: could not load SasView models")
-            logger.error(traceback.format_exc())
 
     def statusBarSetup(self):

src/sas/qtgui/Perspectives/Fitting/media/fitting_help.rst

@@ -52 +52 @@
 
 Use the *Category* drop-down menu to chose a category of model, then select
-a model from the drop-down menu to the right. The "Show Plot" button on the
-bottom of the dialog will become active. If you click on it, 
-a graph of the chosen model, calculated using default parameter values, will appear.
-The graph will update dynamically as the parameter values are changed.
+a model from the drop-down menu beneath. A graph of the chosen model, calculated
+using default parameter values, will appear. The graph will update dynamically
+as the parameter values are changed.
 
 You can decide your own model categorizations using the :ref:`Category_Manager`.
 
-Once you have selected a model you can read its help documentation by right clicking
-on the empty space in the parameter table.
-
-.. image:: descr_fig.png
+Once you have selected a model you can read its help documentation by clicking
+on the *Description* button to the right.
 
 Show 1D/2D
@@ -72 +69 @@
 *NB: Magnetic scattering can only be fitted in SasView in 2D.*
 
-To activate 2D fitting mode, select the *2D view* checkbox on the *Fit Page*. To
-return to 1D fitting model, de-select the same checkbox.
+To activate 2D fitting mode, click the *Show 2D* button on the *Fit Page*. To
+return to 1D fitting model, click the same button (which will now say *Show 1D*).
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -139 +136 @@
 *  By copying/editing an existing model (this can include models generated by
    the New Plugin Model* dialog) in the :ref:`Python_shell` or
-   :ref:`Plugin_Editor` (suitable for all use cases)
+   :ref:`Advanced_Plugin_Editor` (suitable for all use cases)
 *  By writing a model from scratch outside of SasView (only recommended for code
    monkeys!)
@@ -154 +151 @@
 -----------------------
 
-From the *Fitting* option in the menu bar, select one of the options:
+From the *Fitting* option in the menu bar, select *Plugin Model Operations*
 
 .. image:: edit_model_menu.png
 
-*  *Add Custom Model* - to create a plugin model template with a helper dialog
-*  *Edit Custom Model* - to edit a plugin model in an editor window
-*  *Manage Custom Models* - to open a custom model manager allowing for a number of actions to be taken on custom models: listing, adding, deleteing, duplicating, editing
-*  *Add/Multiply Models* - to create a plugin model by summing/multiplying *existing models* in the model library
+and then one of the sub-options
+
+*  *New Plugin Model* - to create a plugin model template with a helper dialog
+*  *Sum|Multi(p1,p2)* - to create a plugin model by summing/multiplying *existing models* in the model library
+*  *Advanced Plugin Editor* - to create/edit a plugin model in a Python shell
+*  *Delete Plugin Models* - to delete a plugin model
+*  *Load Plugin Models* - to (re-)load plugin models
 
 .. _New_Plugin_Model:
 
-Add Custom Model
+New Plugin Model
 ^^^^^^^^^^^^^^^^
 
 Relatively straightforward models can be programmed directly from the SasView
-GUI using the *Plugin Definition* Function.
+GUI using the *New Plugin Model Function*.
 
 .. image:: new_model.png
@@ -185 +185 @@
 
 A model file generated by this option can be viewed and further modified using
-the :ref:`Model_Editor`.
+the :ref:`Advanced_Plugin_Editor` .
 
 **SasView version 4.2** made it possible to specify whether a plugin created with
@@ -217 +217 @@
 a P(Q) model has been selected).
 
-
-.. Model_Editor:
-
-Model Editor
-^^^^^^^^^^^^
-
-Selecting "Edit Custom Model" option opens the editor window.
-
-.. image :: model_editor_empty.png
-
-Initially, the editor is empty. A custom model can be loaded by clicking on the *Load plugin...* button and choosing one of the existing custom plugins.
-
-Once the model is loaded, it can be edited and saved with *Save* button.
-Saving the model will perform the validation and only when the model is correct it will be saved to a file.
-Successful model check is indicated by a SasView status bar message.
-
-When *Cancel* is clicked, any changes to the model are discarded and the window is closed.
-
-
-For details of the SasView plugin model format see :ref:`Writing_a_Plugin` .
-
-To use the model, go to the relevant *Fit Page*, select the *Plugin Models*
-category and then select the model from the drop-down menu.
-
-
-.. Plugin_Manager:
-
-Plugin Manager
-^^^^^^^^^^^^^^
-
-Selecting the *Manage Custom Models* option shows a list of all the plugin models in the plugin model folder, on Windows this is
-
-  *C:\\Users\\{username}\\.sasview\\plugin_models*
-
-You can add, edit, duplicate and delete these models using buttons on the right side of the list.
-
-.. image:: plugin_manager.png
-
-
-Add a model
-^^^^^^^^^^^
-
-Clicking the "Add" button opens the Model Editor window, allowing you to create a new plugin as described above.
-
-Duplicate a model
-^^^^^^^^^^^^^^^^^
-
-Clicking the "Duplicate" button will create a copy of the selected model(s). Naming of the duplicate follows the standard, with added * (n)* to the plugin model name, with *n* being the first unused yet integer.
-
-Edit a model
-^^^^^^^^^^^^
-
-When a single model is selected, clicking this button will open the Advanced *Model Editor* allowing you to edit the
-Python code of the model.
-If no models or multiple models are selected, the *Edit* button is disabled.
-
-Delete Plugin Models
-^^^^^^^^^^^^^^^^^^^^
-
-Simply highlight the plugin model(s) to be removed and click on the "Delete" button. The operation is final.
-
-*NB: Models shipped with SasView cannot be removed in this way.*
-
-
-Add/Multiply Models
-^^^^^^^^^^^^^^^^^^^
+Sum|Multi(p1,p2)
+^^^^^^^^^^^^^^^^
 
 .. image:: sum_model.png
@@ -294 +230 @@
      Plugin Model = scale_factor * (model1 * model2) + background
 
-In the *Add/Multiply Models* give the new model a function name and brief
+In the *Easy Sum/Multi Editor* give the new model a function name and brief
 description (to appear under the *Details* button on the *FitPage*). Then select
-two existing models, as model_1 and model_2, and the required operator, '+' or '*' between
+two existing models, as p1 and p2, and the required operator, '+' or '*' between
 them. Finally, click the *Apply* button to generate and test the model and then click *Close*.
 
+Any changes to a plugin model generated in this way only become effective *after* it is re-selected
+from the plugin models drop-down menu on the FitPage. If the model is not listed you can force a
+recompilation of the plugins by selecting *Fitting* > *Plugin Model Operations* > *Load Plugin Models*.
 
 **SasView version 4.2** introduced a much simplified and more extensible structure for plugin models
-generated through the Add/Multiply Models editor. For example, the code for a combination of a sphere model
+generated through the Easy Sum/Multi Editor. For example, the code for a combination of a sphere model
 with a power law model now looks like this::
 
@@ -336 +275 @@
 that was not possible in earlier versions of SasView.
 
-
+.. _Advanced_Plugin_Editor:
+
+Advanced Plugin Editor
+^^^^^^^^^^^^^^^^^^^^^^
+
+Selecting this option shows all the plugin models in the plugin model folder, on Windows this is
+
+  *C:\\Users\\{username}\\.sasview\\plugin_models*
+
+You can edit, modify, and save the Python code in any of these models using the
+*Advanced Plugin Model Editor*. Note that this is actually the same tool as the :ref:`Python_shell` .
+
+For details of the SasView plugin model format see :ref:`Writing_a_Plugin` .
+
+.. note:: Model files generated with the Sum/Multi option are still using the SasView 3.x model format. Unless you are confident about what you are doing, it is recommended that you only modify lines denoted with the ## <----- comments!
+
+When editing is complete, select *Run* > *Check Model* from the *Advanced Plugin Model Editor* menu bar. An *Info* box will appear with the results of the compilation and model unit tests. The model will only be usable if the tests 'pass'.
+
+.. image:: ../calculator/new_pycrust_example_2.png
+
+To use the model, go to the relevant *Fit Page*, select the *Plugin Models*
+category and then select the model from the drop-down menu.
+
+Any changes to a plugin model generated in this way only become effective *after* it is re-selected from the model drop-down menu on the FitPage.
+
+Delete Plugin Models
+^^^^^^^^^^^^^^^^^^^^
+
+Simply highlight the plugin model to be removed. The operation is final!!!
+
+*NB: Models shipped with SasView cannot be removed in this way.*
+
+Load Plugin Models
+^^^^^^^^^^^^^^^^^^
+
+This option loads (or re-loads) all models present in the
+*~\\.sasview\\plugin_models* folder.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -342 +317 @@
 .. _Fitting_Options:
 
-Fit Algorithms
+Fitting Options
 ---------------
 
@@ -348 +323 @@
 to modify some of the configurational parameters for each optimiser.
 
-From *Fitting* in the menu bar select *Fit Algorithms*, then select one of the following
+From *Fitting* in the menu bar select *Fit Options*, then select one of the following
 optimisers:
 
@@ -357 +332 @@
 *  Nelder-Mead Simplex
 
-.. image:: fit_algorithms.png
-
 The DREAM optimiser is the most sophisticated, but may not necessarily be the best
 option for fitting simple models. If uncertain, try the Levenberg-Marquardt optimiser
@@ -375 +348 @@
 sub-region of the data for fitting.
 
-In a *FitPage* or *BatchPage* change the tab to *Fit Options* and then change 
-the *Q* values in the *Min* and/or *Max*
-text boxes. 
-
-..
-  Vertical coloured bars will appear on the graph with the data and
-  'theory' indicating the current *Q* limits (red = *Qmin*, purple = *Qmax*).
+In a *FitPage* or *BatchPage* change the *Q* values in the *Min* and/or *Max*
+text boxes. Vertical coloured bars will appear on the graph with the data and
+'theory' indicating the current *Q* limits (red = *Qmin*, purple = *Qmax*).
 
 To return to including all data in the fit, click the *Reset* button.
@@ -387 +356 @@
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
 
-..
-
-  Shortcuts
-  ---------
-
-  Copy/Paste Parameters
-  ^^^^^^^^^^^^^^^^^^^^^
-
-  It is possible to copy the parameters from one *Fit Page* and to paste them into
-  another *Fit Page* using the same model.
-
-  To *copy* parameters, either:
-
-  *  Select *Edit -> Copy Params* from the menu bar, or
-  *  Use Ctrl(Cmd on Mac) + Left Mouse Click on the *Fit Page*.
-
-  To *paste* parameters, either:
-
-  *  Select *Edit -> Paste Params* from the menu bar, or
-  *  Use Ctrl(Cmd on Mac) + Shift + Left-click on the *Fit Page*.
-
-  If either operation is successful a message will appear in the info line at the
-  bottom of the SasView window.
-
-  Bookmark
-  ^^^^^^^^
-
-  To *Bookmark* a *Fit Page* either:
-
-  *  Select a *Fit Page* and then click on *Bookmark* in the tool bar, or
-  *  Right-click and select the *Bookmark* in the popup menu.
+
+Shortcuts
+---------
+
+Copy/Paste Parameters
+^^^^^^^^^^^^^^^^^^^^^
+
+It is possible to copy the parameters from one *Fit Page* and to paste them into
+another *Fit Page* using the same model.
+
+To *copy* parameters, either:
+
+*  Select *Edit -> Copy Params* from the menu bar, or
+*  Use Ctrl(Cmd on Mac) + Left Mouse Click on the *Fit Page*.
+
+To *paste* parameters, either:
+
+*  Select *Edit -> Paste Params* from the menu bar, or
+*  Use Ctrl(Cmd on Mac) + Shift + Left-click on the *Fit Page*.
+
+If either operation is successful a message will appear in the info line at the
+bottom of the SasView window.
+
+Bookmark
+^^^^^^^^
+
+To *Bookmark* a *Fit Page* either:
+
+*  Select a *Fit Page* and then click on *Bookmark* in the tool bar, or
+*  Right-click and select the *Bookmark* in the popup menu.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -423 +391 @@
 .. _Status_bar:
 
-Status Bar & Log Explorer
--------------------------
+Status Bar & Console
+--------------------
 
 The status bar is located at the bottom of the SasView window and displays
-messages, warnings and errors.
-
-.. image:: log_explorer.png
-
-The bottom part of the SasView application window contains the *Log Explorer*.
-The *Log Explorer* displays available message history and run-time traceback information.
+messages, hints, warnings and errors.
+
+At the right-hand side of the status bar is a button marked *Console*. The *Console*
+displays available message history and some run-time traceback information.
+
+During a long task the *Console* can also be used to monitor the progress.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
@@ -441 +409 @@
 ---------------
 
-*NB: Before proceeding, ensure that the Batch mode checkbox at the bottom of*
-*the Data Explorer is unchecked (see the section* :ref:`Loading_data` *).*
+*NB: Before proceeding, ensure that the Single Mode radio button at the bottom of*
+*the Data Explorer is checked (see the section* :ref:`Loading_data` *).*
 
 This mode fits one data set.
 
-.. When data is sent to the fitting it is plotted in a graph window as markers.
-When data is sent to the fitting, the Fit Page will show the dataset name.
-
-.. image:: dataset_name.png
-
-Clicking on the *Show Plot* will cause the data can be plotted in a graph window as markers.
+When data is sent to the fitting it is plotted in a graph window as markers.
 
 If a graph does not appear, or a graph window appears but is empty, then the data
@@ -457 +420 @@
 or in the *Console* window.
 
-Assuming the data has loaded correctly, when a model is selected a blue model
+Assuming the data has loaded correctly, when a model is selected a green model
 calculation (or what SasView calls a 'Theory') line will appear in the earlier graph
 window, and a second graph window will appear displaying the residuals (the
@@ -477 +440 @@
 *'correlated').*
 
-In the bottom right corner of the *Fit Page* is a box displaying the normalised value
+In the bottom left corner of the *Fit Page* is a box displaying the normalised value
 of the statistical $\chi^2$ parameter returned by the optimiser.
 

src/sas/qtgui/Utilities/CategoryInstaller.py

@@ -174 +174 @@
                                                           model_enabled_dict)
 
-            json.dump(master_category_dict, open(serialized_file, "w", encoding="utf8"))
+            json.dump(master_category_dict, open(serialized_file, 'wb'))
 

src/sas/qtgui/Utilities/TabbedModelEditor.py

@@ -241 +241 @@
         # Run the model test in sasmodels
         try:
-            model_results = GuiUtils.checkModel(full_path)
+            model_results = self.checkModel(full_path)
             logging.info(model_results)
         except Exception as ex:

src/sas/sascalc/fit/models.py

@@ -181 +181 @@
             try:
                 model = load_custom_model(path)
+                # TODO: add [plug-in] tag to model name in sasview_model
+                if not model.name.startswith(PLUGIN_NAME_BASE):
+                    model.name = PLUGIN_NAME_BASE + model.name
                 plugins[model.name] = model
             except Exception: