Changeset 990d8df in sasmodels

Timestamp:

May 7, 2017 11:20:44 PM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

2e66ef5

Parents:

8ae8532

Message:

move polydispersity and resolution docs into sasmodels; write installation instructions

Files:

• doc/gentoc.py (modified) (2 diffs)
• doc/guide/gpu/opencl_installation.rst (modified) (4 diffs)
• doc/guide/index.rst (modified) (1 diff)
• doc/guide/install.rst (added)
• doc/guide/magnetism/magnetism.rst (modified) (2 diffs)
• doc/guide/pd/pd_gaussian.jpg (added)
• doc/guide/pd/pd_lognormal.jpg (added)
• doc/guide/pd/pd_rectangular.jpg (added)
• doc/guide/pd/pd_schulz.jpg (added)
• doc/guide/pd/polydispersity.rst (added)
• doc/guide/plugin.rst (added)
• doc/guide/resolution.rst (added)
• doc/guide/resolution_2d_rotation.gif (added)
• sasmodels/resolution.py (modified) (3 diffs)
• sasmodels/rst2html.py (modified) (1 diff)

doc/gentoc.py

@@ -98 +98 @@
     struct_toc = _make_category(
         'structure-factor', 'Structure-factor', 'Structure Factors')
-    custom_toc = _make_category(
-        'custom-models', 'Custom-models', 'Custom Models')
+    #custom_toc = _make_category(
+    #    'custom-models', 'Custom-models', 'Custom Models')
 
     # remember to top level categories
@@ -107 +107 @@
         'shape-independent':free_toc,
         'structure-factor': struct_toc,
-        'custom': custom_toc,
+        #'custom': custom_toc,
         }
 

doc/guide/gpu/opencl_installation.rst

@@ -4 +4 @@
 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.*
+*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
+ithout 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.*
 
 1. Check if you have OpenCL already installed
@@ -25 +32 @@
 Mac OSX
 .......
-    For OS X operating systems higher than 10.6 OpenCL is shipped along with the system.
+    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
+    However, OpenCL has had a rocky history on Macs. Apple provide a useful
+    compatibility table at https://support.apple.com/en-us/HT202823
 
 
@@ -44 +53 @@
 .......
     N/A
-        
-        You cannot download OpenCL driver updates for your Mac. They are packaged with the normal quarterly OS X updates from Apple. 
+
+ 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 
+    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
@@ -55 +66 @@
     or AMD.
 
-        
+
 .. note::
     This help document was last changed by Steve King, 08Oct2016

doc/guide/index.rst

@@ -8 +8 @@
 
    intro.rst
-   gpu/gpu_computations.rst
-   gpu/opencl_installation.rst
+   install.rst
+   pd/polydispersity.rst
+   resolution.rst
    magnetism/magnetism.rst
    sesans/sans_to_sesans.rst
    sesans/sesans_fitting.rst
+   plugin.rst
    refs.rst

doc/guide/magnetism/magnetism.rst

@@ -2 +2 @@
 
 Polarisation/Magnetic Scattering
-=======================================================
+================================
 
-In earlier versions of SasView magnetic scattering was implemented in just five 
-(2D) models
-
-*  :ref:`sphere`
-*  :ref:`core-shell-sphere`
-*  :ref:`core-multi-shell`
-*  :ref:`cylinder`
-*  :ref:`parallelepiped`
-
-From SasView 4.x it is implemented on most models in the 'shape' category.
-
-In general, the scattering length density (SLD = $\beta$) in each region where the
-SLD is uniform, is a combination of the nuclear and magnetic SLDs and, for polarised
-neutrons, also depends on the spin states of the neutrons.
+Models which define a scattering length density parameter can be evaluated
+ as magnetic models. In general, the scattering length density (SLD =
+ $\beta$) in each region where the SLD is uniform, is a combination of the
+ nuclear and magnetic SLDs and, for polarised neutrons, also depends on the
+ spin states of the neutrons.
 
 For magnetic scattering, only the magnetization component $\mathbf{M_\perp}$
@@ -98 +89 @@
 .. note::
     This help document was last changed by Steve King, 02May2015
+
+* Document History *
+
+| 2017-05-08 Paul Kienzle

sasmodels/resolution.py

@@ -437 +437 @@
     .. math::
 
-         \log \Delta q = (\log q_n - log q_1) / (n - 1)
+         \log \Delta q = (\log q_n - \log q_1) / (n - 1)
 
     From this we can compute the number of steps required to extend $q$
@@ -451 +451 @@
 
          n_\text{extend} = (n-1) (\log q_\text{max} - \log q_n)
-            / (\log q_n - log q_1)
+            / (\log q_n - \log q_1)
     """
     q = np.sort(q)
@@ -459 +459 @@
         log_delta_q = log(10.) / points_per_decade
     if q_min < q[0]:
-        if q_min < 0: q_min = q[0]*MINIMUM_ABSOLUTE_Q
+        if q_min < 0:
+            q_min = q[0]*MINIMUM_ABSOLUTE_Q
         n_low = log_delta_q * (log(q[0])-log(q_min))
         q_low = np.logspace(log10(q_min), log10(q[0]), np.ceil(n_low)+1)[:-1]

sasmodels/rst2html.py

@@ -211 +211 @@
     sys.exit(app.exec_())
 
+def can_use_qt():
+    """
+    Return True if QWebView exists.
+
+    Checks first in PyQt5 then in PyQt4
+    """
+    try:
+        from PyQt5.QtWebKitWidgets import QWebView
+        return True
+    except ImportError:
+        try:
+            from PyQt4.QtWebkit import QWebView
+            return True
+        except ImportError:
+            return False
+
 def view_help(filename, qt=False):
     import os
-    url="file:///"+os.path.abspath(filename).replace("\\","/")
+
+    if qt:
+        qt = can_use_qt()
+
+    url = "file:///"+os.path.abspath(filename).replace("\\", "/")
     if filename.endswith('.rst'):
         html = load_rst_as_html(filename)