Changeset 3764ec1 in sasmodels

Timestamp:

Sep 12, 2016 1:21:45 AM (8 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, costrafo411, magnetic_model, release_v0.94, release_v0.95, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

733a3e1

Parents:

4cc161e

Message:

improve docs; support python 3.x

File:

• sasmodels/kerneldll.py (modified) (3 diffs)

sasmodels/kerneldll.py

@@ -2 +2 @@
 DLL driver for C kernels
 
-The global attribute *ALLOW_SINGLE_PRECISION_DLLS* should be set to *True* if
-you wish to allow single precision floating point evaluation for the compiled
-models, otherwise it defaults to *False*.
-
-The compiler command line is stored in the attribute *COMPILE*, with string
-substitutions for %(source)s and %(output)s indicating what to compile and
-where to store it.  The actual command is system dependent.
-
-On windows systems, you have a choice of compilers.  *MinGW* is the GNU
-compiler toolchain, available in packages such as anaconda and PythonXY,
-or available stand alone. This toolchain has had difficulties on some
-systems, and may or may not work for you.  In order to build DLLs, *gcc*
-must be on your path.  If the environment variable *SAS_OPENMP* is given
-then -fopenmp is added to the compiler flags.  This requires a version
-of MinGW compiled with OpenMP support.
-
-An alternative toolchain uses the Microsoft Visual C++ compiler, available
-free from microsoft:
+If the environment variable *SAS_OPENMP* is set, then sasmodels
+will attempt to compile with OpenMP flags so that the model can use all
+available kernels.  This may or may not be available on your compiler
+toolchain.  Depending on operating system and environment.
+
+Windows does not have provide a compiler with the operating system.
+Instead, we assume that TinyCC is installed and available.  This can
+be done with a simple pip command if it is not already available::
+
+    pip install tinycc
+
+If Microsoft Visual C++ is available (because VCINSTALLDIR is
+defined in the environment), then that will be used instead.
+Microsoft Visual C++ for Python is available from Microsoft:
 
     `<http://www.microsoft.com/en-us/download/details.aspx?id=44266>`_
 
-Again, this requires that the compiler is available on your path.  This is
-done by running vcvarsall.bat in a windows terminal.  Install locations are
-system dependent, such as:
+If neither compiler is available, sasmodels will check for *MinGW*,
+the GNU compiler toolchain. This available in packages such as Anaconda
+and PythonXY, or available stand alone. This toolchain has had
+difficulties on some systems, and may or may not work for you.
+
+You can control which compiler to use by setting SAS_COMPILER in the
+environment:
+
+  - tinycc (Windows): use the TinyCC compiler shipped with SasView
+  - msvc (Windows): use the Microsoft Visual C++ compiler
+  - mingw (Windows): use the MinGW GNU cc compiler
+  - unix (Linux): use the system cc compiler.
+  - unix (Mac): use the clang compiler. You will need XCode installed, and
+    the XCode command line tools. Mac comes with OpenCL drivers, so generally
+    this will not be needed.
+
+Both *msvc* and *mingw* require that the compiler is available on your path.
+For *msvc*, this can done by running vcvarsall.bat in a windows terminal.
+Install locations are system dependent, such as:
 
     C:\Program Files (x86)\Common Files\Microsoft\Visual C++ for Python\9.0\vcvarsall.bat
@@ -33 +45 @@
     C:\Users\yourname\AppData\Local\Programs\Common\Microsoft\Visual C++ for Python\9.0\vcvarsall.bat
 
-And again, the environment variable *SAS_OPENMP* controls whether OpenMP is
-used to compile the C code.  This requires the Microsoft vcomp90.dll library,
-which doesn't seem to be included with the compiler, nor does there appear
-to be a public download location.  There may be one on your machine already
-in a location such as:
+OpenMP for *msvc* requires the Microsoft vcomp90.dll library, which doesn't
+seem to be included with the compiler, nor does there appear to be a public
+download location.  There may be one on your machine already in a location
+such as:
 
     C:\Windows\winsxs\x86_microsoft.vc90.openmp*\vcomp90.dll
 
-If you copy this onto your path, such as the python directory or the install
-directory for this application, then OpenMP should be supported.
+If you copy this to somewhere on your path, such as the python directory or
+the install directory for this application, then OpenMP should be supported.
+
+For full control of the compiler, define a function
+*compile_command(source,output)* which takes the name of the source file
+and the name of the output file and returns a compile command that can be
+evaluated in the shell.  For even more control, replace the entire
+*compile(source,output)* function.
+
+The global attribute *ALLOW_SINGLE_PRECISION_DLLS* should be set to *False* if
+you wish to prevent single precision floating point evaluation for the compiled
+models, otherwise set it defaults to *True*.
 """
 from __future__ import print_function
@@ -90 +111 @@
     compiler = "unix"
 
-ARCH = "" if sys.maxint > 2**32 else "x86"  # maxint=2**31-1 on 32 bit
+ARCH = "" if ct.sizeof(c_void_p) > 4 else "x86"  # 4 byte pointers on x86
 if compiler == "unix":
     # Generic unix compile