[MOAB-dev] r3026 - in MOAB/trunk: . tools/iMesh/python tools/iMesh/python/doc

[jvporter at mcs.anl.gov]

Author: jvporter
Date: 2009-07-17 15:40:34 -0500 (Fri, 17 Jul 2009)
New Revision: 3026

Modified:
   MOAB/trunk/configure.ac
   MOAB/trunk/tools/iMesh/python/doc/build.rst
   MOAB/trunk/tools/iMesh/python/setup.cfg.in
Log:
* Update Python documentation
* Add support for installing Python interface to alternate locations via 
  autotools


Modified: MOAB/trunk/configure.ac
===================================================================
--- MOAB/trunk/configure.ac	2009-07-17 19:30:21 UTC (rev 3025)
+++ MOAB/trunk/configure.ac	2009-07-17 20:40:34 UTC (rev 3026)
@@ -64,6 +64,8 @@
     AC_MSG_ERROR([Invalid argument to --enable-pytaps : $ENABLE_pytaps])
     ;;
 esac
+AC_MSG_CHECKING([if Python support is to be built])
+AC_MSG_RESULT([$ENABLE_pytaps])
 AM_CONDITIONAL([ENABLE_pytaps],[test "xyes" == "x$ENABLE_pytaps"])
 
 ################################################################################

Modified: MOAB/trunk/tools/iMesh/python/doc/build.rst
===================================================================
--- MOAB/trunk/tools/iMesh/python/doc/build.rst	2009-07-17 19:30:21 UTC (rev 3025)
+++ MOAB/trunk/tools/iMesh/python/doc/build.rst	2009-07-17 20:40:34 UTC (rev 3026)
@@ -2,6 +2,33 @@
  Building PyTAPS
 =================
 
+Requirements
+============
+
+In order to build PyTAPS, several external libraries are required:
+
+* Python 2.5+
+* `Numpy <http://numpy.scipy.org/>`_ 1.3.0+
+* An iMesh implementation (currently only `MOAB
+  <http://trac.mcs.anl.gov/projects/ITAPS/wiki/MOAB>`_ is explicitly supported)
+
+To run the performance tests or tools, `Matplotlib
+<http://matplotlib.sourceforge.net/>`_ is also required. Finally, to build the
+documentation (you're reading it!), `Sphinx <http://sphinx.pocoo.org/>`_ is
+required.
+
+Building Within MOAB
+====================
+
+If you downloaded PyTAPS as a part of MOAB, you can use the standard UNIX
+``./configure; make; make install`` process to build it. To do so, add
+``--enable-pytaps`` to your configure command. If your Python or Numpy libraries
+are in a non-standard location, also specify ``--with-python=DIR`` and
+``--with-numpy=DIR``, respectively.
+
+Building Independently
+======================
+
 Like most Python packages, PyTAPS uses Distutils for installation, so in general
 setup consists simply of typing ``python setup.py install`` at the root
 directory for PyTAPS. However, certain iMesh interfaces may require some
@@ -22,30 +49,15 @@
 you can manually specify the build options as described below in `Non-standard
 Library Locations`_.
 
-Requirements
-============
-
-In order to build PyTAPS, several external libraries are required:
-
-* Python 2.5+
-* `Numpy <http://numpy.scipy.org/>`_ 1.3.0+
-* An iMesh implementation (currently only `MOAB
-  <http://trac.mcs.anl.gov/projects/ITAPS/wiki/MOAB>`_ is supported)
-
-To run the performance tests or tools, `Matplotlib
-<http://matplotlib.sourceforge.net/>`_ is also required. Finally, to build the
-documentation (you're reading it!), `Sphinx <http://sphinx.pocoo.org/>`_ is
-required.
-
 Testing
-=======
+-------
 
 To run unit/regression tests on the package, you may specify ``test`` as an
 argument to `setup.py`. The test command also accepts a verbosity level (an
 integer), specified with ``-v`` or ``--verbosity``.
 
 Performance Testing
-===================
+-------------------
 
 To run performance tests on the package comparing the speed of a pure-C
 usage of ITAPS with PyTAPS, you may pass ``perf`` as a command to `setup.py`.
@@ -57,7 +69,7 @@
 The performance tests consist of two sub-commands, described below.
 
 Building the Performance Test
------------------------------
+_____________________________
 
 This command builds the C portion of the performance tests. The following
 options are allowed:
@@ -75,7 +87,7 @@
 +--------------------------+--------+---------------------------------------+
 
 Running the Performance Test
-----------------------------
+____________________________
 
 This command executes the performance tests. The following options are allowed
 (as with ``perf``):
@@ -87,7 +99,7 @@
 +-----------------+--------+-------------------------------------------+
 
 Building Documentation
-======================
+----------------------
 
 The documentation that you're currently reading can be built from `setup.py` by
 specifying ``doc`` as an argument. This command supports the following options:
@@ -99,14 +111,14 @@
 +-----------------------+--------+---------------------------------------+
 
 With MOAB
-=========
+---------
 
 Since Python modules are loaded as shared libraries, MOAB's iMesh library needs
 to be built with position-independent code. When configuring MOAB, specify
 ``--with-pic`` on the command line.
 
 Non-standard Library Locations
-==============================
+------------------------------
 
 In some cases, required objects for building PyTAPS aren't in the expected
 directories. One solution to this is to include the appropriate directories in

Modified: MOAB/trunk/tools/iMesh/python/setup.cfg.in
===================================================================
--- MOAB/trunk/tools/iMesh/python/setup.cfg.in	2009-07-17 19:30:21 UTC (rev 3025)
+++ MOAB/trunk/tools/iMesh/python/setup.cfg.in	2009-07-17 20:40:34 UTC (rev 3026)
@@ -1,3 +1,5 @@
 [build_ext]
 imesh-dir = @abs_srcdir@/..
 include-dirs = @PYTHON_DIR@:@NUMPY_DIR@:@abs_top_srcdir@
+[install]
+install-base = @prefix@