Changeset ec8b9a3 in sasmodels for doc

Timestamp:

Oct 8, 2016 11:47:03 AM (8 years ago)

Author:

smk78

Branches:

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

Children:

3a45c2c

Parents:

711f17e

Message:

Tweaks to text, including a warning about OpenCL drivers and a link to
an Apple compatibility table. Closes #734

File:

• doc/ref/gpu/opencl_installation.rst (modified) (4 diffs)

doc/ref/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.*
 
 1. Check if you have OpenCL already installed
@@ -9 +10 @@
 
 Windows
-=========
+.......
     The following instructions are based on
     http://web.engr.oregonstate.edu/~mjb/cs475/DoIHaveOpenCL.pdf
 
-    * Go to: Start -> Control Panel -> Administrative Tools
+    * Go to: Start -> Control Panel -> System & Security -> Administrative Tools
     * Double Click on Computer Managment
     * Click on Device Manager
@@ -23 +24 @@
 
 Mac OSX
-=========
-    For OSXs 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
 
 
@@ -31 +34 @@
 
 Windows
-=========
-    Depeneding on the graphic card on your system, drivers
+.......
+    Depending on the graphic card in your system, drivers
     can be obtained from different sources:
 
-    * Nvidia: https://developer.nvidia.com/opencl
+    * 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::
-    Note that Intel provides an OpenCL drivers for Intel processors:
-    https://software.intel.com/en-us/articles/opencl-drivers
-    This can sometimes make use of special vector instructions across multiple
+    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.
+
+        
+.. note::
+    This help document was last changed by Steve King, 08Oct2016