Changes in / [62d7601:bf09f55] in sasmodels

Files:

• doc/genmodel.py (modified) (1 diff)
• doc/guide/gpu_setup.rst (deleted)
• doc/guide/index.rst (modified) (1 diff)
• doc/guide/install.rst (modified) (1 diff)
• doc/guide/magnetism/magnetism.rst (modified) (1 diff)
• doc/guide/plugin.rst (modified) (7 diffs)
• sasmodels/conversion_table.py (modified) (1 diff)
• sasmodels/custom/__init__.py (modified) (1 diff)
• sasmodels/kernelpy.py (modified) (1 diff)
• sasmodels/sasview_model.py (modified) (1 diff)

doc/genmodel.py

@@ -3 +3 @@
 import sys, os, math, re
 import numpy as np
-import matplotlib
-matplotlib.use('Agg')
 import matplotlib.pyplot as plt
 sys.path.insert(0, os.path.abspath('..'))

doc/guide/index.rst

@@ -9 +9 @@
    intro.rst
    install.rst
-   gpu_setup.rst
    pd/polydispersity.rst
    resolution.rst

doc/guide/install.rst

@@ -53 +53 @@
 This will allow you to edit the files in the package and have the changes
 show up immediately in python the next time you load your program.
+
+OpenCL Installation
+*******************
+*Warning! GPU devices do not in general offer the same level of memory
+protection as CPU devices. If your code attempts to write outside allocated
+memory buffers unpredicatable behaviour may result (eg, your video display
+may freeze, or your system may crash, etc). Do not install OpenCL drivers
+without first checking for known issues (eg, some computer manufacturers
+install modified graphics drivers so replacing these may not be a good
+idea!). If in doubt, seek advice from an IT professional before proceeding
+further.*
+
+Check if you have OpenCL already installed
+==========================================
+
+**Windows**
+
+The following instructions are based on
+http://web.engr.oregonstate.edu/~mjb/cs475/DoIHaveOpenCL.pdf
+
+* Go to: Start -> Control Panel -> System & Security -> Administrative Tools
+* Double Click on Computer Managment
+* Click on Device Manager
+* Click open Display Adapters
+* Right-click on available adapter and select Properties
+* Click on Driver
+* Go to Driver Details
+* Scroll down and see if OpenCL is installed (look for OpenCL*.dll files)
+
+**Mac OSX**
+
+For OS X operating systems higher than 10.6 OpenCL is shipped along with
+the system.
+
+However, OpenCL has had a rocky history on Macs. Apple provide a useful
+compatibility table at https://support.apple.com/en-us/HT202823
+
+
+Installation
+============
+
+**Windows**
+
+Depending on the graphic card in your system, drivers
+can be obtained from different sources:
+
+* NVIDIA: https://developer.nvidia.com/opencl
+* AMD: http://developer.amd.com/tools-and-sdks/opencl-zone/
+
+
+**Mac OSX**
+
+N/A
+
+You cannot download OpenCL driver updates for your Mac. They are packaged
+with the normal quarterly OS X updates from Apple.
+
+
+.. note::
+    Intel provides OpenCL drivers for Intel processors at
+    https://software.intel.com/en-us/articles/opencl-drivers
+    These can sometimes make use of special vector instructions across multiple
+    processors, so it is worth installing if the GPU does not support double
+    precision. You can install this driver alongside the GPU driver for NVIDIA
+    or AMD.
+
+
+GPU Selection
+*************
+
+sasmodels evaluations can run on your graphics card (GPU) or they can run
+on the processor (CPU). In general, calculations performed on the GPU will run faster.
+
+To run on the GPU, your computer must have OpenCL drivers installed.
+For information about OpenCL installation see this
+:ref:`opencl-installation` guidance.
+
+Where the model is evaluated is a little bit complicated.
+If the model has the line *single=False* then it requires double precision.
+If the GPU is single precision only, then it will try running via OpenCL
+on the CPU.  If the OpenCL driver is not available for the CPU then
+it will run as a normal program on the CPU.
+
+For models with a large number of parameters or with a lot of code,
+the GPU may be too small to run the program effectively.
+In this case, you should try simplifying the model, maybe breaking it
+into several different modules so that you don't need *IF* statements in your code.
+If it is still too big, you can set *opencl=False* in the model file and
+the model will only run as a normal program on the CPU.
+This will not usually be necessary.
+
+Device Selection
+================
+If you have multiple GPU devices you can tell SasView which device to use.
+By default, SasView looks for one GPU and one CPU device
+from available OpenCL platforms.
+
+SasView prefers AMD or NVIDIA drivers for GPU, and prefers Intel or
+Apple drivers for CPU. Both GPU and CPU are included on the assumption that CPU
+is always available and supports double precision.
+
+The device order is important: GPU is checked before CPU on the assumption that
+it will be faster. By examining ~/sasview.log you can see which device SasView
+chose to run the model.
+
+**If you don't want to use OpenCL, you can set** *SAS_OPENCL=None*
+**in your environment settings, and it will only use normal programs.**
+
+If you want to use one of the other devices, you can run the following
+from the python console in SasView::
+
+    import pyopencl as cl
+    cl.create_some_context()
+
+This will provide a menu of different OpenCL drivers available.
+When one is selected, it will say "set PYOPENCL_CTX=..."
+Use that value as the value of *SAS_OPENCL*.
+
+Compiler Selection
+==================
+For models run as normal programs, you may need to specify a compiler.
+This is done using the SAS_COMPILER environment variable.
+Set it to *tinycc* for the tinycc compiler, *msvc* for the
+Microsoft Visual C compiler, or *mingw* for the MinGW compiler.
+TinyCC is provided with SasView so that is the default.
+If you want one of the other compilers, be sure to have it available
+in your *PATH* so SasView can find it!
+
+
+*Document History*
+
+| 2017-05-17 Paul Kienzle

doc/guide/magnetism/magnetism.rst

@@ -87 +87 @@
     The values of the 'Up_frac_i' and 'Up_frac_f' must be in the range 0 to 1.
 
-*Document History*
+.. note::
+    This help document was last changed by Steve King, 02May2015
 
-| 2015-05-02 Steve King
+* Document History *
+
 | 2017-05-08 Paul Kienzle

doc/guide/plugin.rst

@@ -78 +78 @@
      at the start of the model documentation and as a tooltip in the SasView GUI
 
-- a **short description**:
+- a **short discription**:
    - this is the **description** string in the *.py* file
    - this is a medium length description which appears when you click
@@ -233 +233 @@
 
 **name = "mymodel"** defines the name of the model that is shown to the user.
-If it is not provided it will use the name of the model file. The name must
-be a valid variable name, starting with a letter and contains only letters,
-numbers or underscore.  Spaces, dashes, and other symbols are not permitted.
+If it is not provided, it will use the name of the model file, with '_'
+replaced by spaces and the parts capitalized.  So *adsorbed_layer.py* will
+become *Adsorbed Layer*.  The predefined models all use the name of the
+model file as the name of the model, so the default may be changed.
 
 **title = "short description"** is short description of the model which
@@ -297 +298 @@
 - **"name"** is the name of the parameter shown on the FitPage.
 
-  - the name must be a valid variable name, starting with a letter and
-    containing only letters, numbers and underscore.
-
   - parameter names should follow the mathematical convention; e.g.,
     *radius_core* not *core_radius*, or *sld_solvent* not *solvent_sld*.
@@ -368 +366 @@
     dispersion.
 
-Some models will have integer parameters, such as number of pearls in the
-pearl necklace model, or number of shells in the multi-layer vesicle model.
-The optimizers in BUMPS treat all parameters as floating point numbers which
-can take arbitrary values, even for integer parameters, so your model should
-round the incoming parameter value to the nearest integer inside your model
-you should round to the nearest integer.  In C code, you can do this using::
-
-    static double
-    Iq(double q, ..., double fp_n, ...)
-    {
-        int n = (int)(fp_n + 0.5);
-        ...
-    }
-
-in python::
-
-    def Iq(q, ..., n, ...):
-        n = int(n+0.5)
-        ...
-
-Derivative based optimizers such as Levenberg-Marquardt will not work
-for integer parameters since the partial derivative is always zero, but
-the remaining optimizers (DREAM, differential evolution, Nelder-Mead simplex)
-will still function.
 
 Model Computation
@@ -417 +391 @@
      \approx \frac{\sum_{i=1}^n G(x_i) I(q,x_i)}{\sum_{i=1}^n G(x_i) V(x_i)}
 
-That is, the individual models do not need to include polydispersity
+That is, the indivdual models do not need to include polydispersity
 calculations, but instead rely on numerical integration to compute the
 appropriately smeared pattern.   Angular dispersion values over polar angle
@@ -437 +411 @@
 The parameters *par1, par2, ...* are the list of non-orientation parameters
 to the model in the order that they appear in the parameter table.
-**Note that the auto-generated model file uses** *x* **rather than** *q*.
+**Note that the autogenerated model file uses** *x* **rather than** *q*.
 
 The *.py* file should import trigonometric and exponential functions from
@@ -961 +935 @@
 across multiple parameters can be very slow).
 
-If your model has 2D orientation calculation, then you should also
+If your model has 2D orientational calculation, then you should also
 test with::
 

sasmodels/conversion_table.py

@@ -11 +11 @@
 account for that.
 
-Usage::
-
-    <old_Sasview_version> : {
-        <new_model_name> : [
-            <old_model_name> ,
-            {
-                <new_param_name_1> : <old_param_name_1>,
-                ...
-                <new_param_name_n> : <old_param_name_n>
-            }
-        ]
-    }
+Usage:
+<old_Sasview_version> : {
+    <new_model_name> : [
+        <old_model_name> ,
+        {
+            <new_param_name_1> : <old_param_name_1>,
+            ...
+            <new_param_name_n> : <old_param_name_n>
+        }
+    ]
+}
 
 Any future parameter and model name changes can and should be given in this

sasmodels/custom/__init__.py

@@ -31 +31 @@
         if fullname in sys.modules:
             del sys.modules[fullname]
-        if path.endswith(".py") and os.path.exists(path) and os.path.exists(path+"c"):
-            # remove automatic pyc file before loading a py file
-            os.unlink(path+"c")
         module = imp.load_source(fullname, os.path.expanduser(path))
+        #os.unlink(path+"c")  # remove the automatic pyc file
         return module
 

sasmodels/kernelpy.py

@@ -34 +34 @@
         self.info = model_info
         self.dtype = np.dtype('d')
-        logging.info("load python model " + self.info.name)
 
     def make_kernel(self, q_vectors):
+        logging.info("creating python kernel " + self.info.name)
         q_input = PyInput(q_vectors, dtype=F64)
         kernel = self.info.Iqxy if q_input.is_2d else self.info.Iq

sasmodels/sasview_model.py

@@ -16 +16 @@
 import logging
 from os.path import basename, splitext, abspath, getmtime
-try:
-    import _thread as thread
-except ImportError:
-    import thread
+import thread
 
 import numpy as np  # type: ignore