SF.net SVN: matplotlib:[6037] trunk/toolkits/basemap

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 6037
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6037&view=rev
Author:   jswhit
Date:     2008-08-16 22:48:18 +0000 (Sat, 16 Aug 2008)

Log Message:
-----------
added install instructions to new docs

Modified Paths:
--------------
    trunk/toolkits/basemap/README
    trunk/toolkits/basemap/doc/users/index.rst

Added Paths:
-----------
    trunk/toolkits/basemap/doc/users/installing.rst

Modified: trunk/toolkits/basemap/README
===================================================================

--- trunk/toolkits/basemap/README	2008-08-14 13:38:01 UTC (rev 6036)
+++ trunk/toolkits/basemap/README	2008-08-16 22:48:18 UTC (rev 6037)
@@ -14,8 +14,6 @@
 The GEOS (Geometry Engine - Open Source) library (version 2.2.3 or higher).
 Source code is included in the geos-2.2.3 directory.
 
-setuptools (only if your are using python 2.3)
-
 PIL (http://pythonware.com/products/pil) is optional (only
 needed for Basemap warpimage and bluemarble methods).
 
@@ -71,11 +69,8 @@
 
 0) Install pre-requisite python modules numpy and matplotlib.
 
-1) Then download basemap-X.Y.Z.tar.gz (approx 32 mb) from
+1) Then download basemap-X.Y.Z.tar.gz (approx 100 mb) from
 the sourceforge download site, unpack and cd to basemap-X.Y.Z.
-If you want the full-resolution coastline dataset (useful if you
-will be making maps of very small regions), get 
-basemap-fullresdata-X.Y.Z.tar.gz (approx. 100 mb).
 
 2) Install the GEOS library.  If you already have it on your
 system, just set the environment variable GEOS_DIR to point to the location 

Modified: trunk/toolkits/basemap/doc/users/index.rst
===================================================================
--- trunk/toolkits/basemap/doc/users/index.rst	2008-08-14 13:38:01 UTC (rev 6036)
+++ trunk/toolkits/basemap/doc/users/index.rst	2008-08-16 22:48:18 UTC (rev 6037)
@@ -10,6 +10,7 @@
 .. toctree::
 
     intro.rst
+    installing.rst
     mapsetup.rst
     geography.rst
     graticule.rst

Added: trunk/toolkits/basemap/doc/users/installing.rst
===================================================================
--- trunk/toolkits/basemap/doc/users/installing.rst	                        (rev 0)
+++ trunk/toolkits/basemap/doc/users/installing.rst	2008-08-16 22:48:18 UTC (rev 6037)
@@ -0,0 +1,99 @@
+.. _installing:
+
+**********
+Installing
+**********
+
+Dependencies
+============
+
+**Requirements**
+
+These are external packages which you will need to install before
+installing basemap. 
+
+
+matplotlib 0.98 (or later, `download <http://sf.net/projects/matplotlib/>`__)
+
+python 2.4 (or later but not python3)
+    matplotlib requires python 2.4 or later (`download <http://www.python.org/download/>`__)
+
+numpy 1.1 (or later)
+    array support for python (`download <http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103>`__)
+
+**Required libraries that ship with basemap**
+
+`GEOS <http://trac.osgeo.org/geos/>`__ (Geometry Engine - Open Source) library 2.2.3 or later (2.2.3 recommended).
+    Source code is included in the geos-2.2.3 directory. 
+    When building from source, must be built and installed separately
+    from basemap (see build instructions below).
+    Included in Windows binary installers.
+
+`PROJ4 <http://trac.osgeo.org/proj/>`__ Cartographic Projections Library.
+    Patched version automatically built into basemap.
+
+`pyshapelib <http://intevation.de/pipermail/thuban-devel/2004-May/000184.html>`__
+    C library with python interface for reading ESRI shapefiles (automatically
+    built and installed with basemap).
+
+`pupnyere <http://pypi.python.org/pypi/pupynere/>`__ 
+    Pure python `netCDF <http://www.unidata.ucar.edu/software/netcdf/>`__
+    interface automatically installed with basemap.
+
+`pydap <http://code.google.com/p/pydap>`__ 
+    Pure python `OPeNDAP <http://opendap.org>`__ implementation.
+    If not present, client (not server) will be installed with basemap.
+
+`httplib2 <http://code.google.com/p/httplib2>`__ (needed for pydap client).
+    If not present, will be installed with basemap.
+  
+
+**Optional libraries**
+
+PIL
+    Python Imaging Library (`download <http://www.pythonware.com/products/pil/>`__),
+    only needed for :func:`~mpl_toolkits.basemap.Basemap.bluemarble` and :func:`~mpl_toolkits.basemap.Basemap.warpimage` instance methods.
+
+Installation
+============
+
+Windows binary installers are available for
+`download <http://sourceforge.net/project/showfiles.php?group_id=80706&package_id=142792/&abmode=1>`__. 
+
+For other platforms, download the source release and follow these steps:
+
+
+* Install pre-requisite requirements.
+
+* Untar the basemap version X.Y.Z source tar.gz file, and
+  and cd to the basemap-X.Y.Z directory.
+
+* Install the GEOS library.  If you already have it on your
+  system, just set the environment variable GEOS_DIR to point to the location 
+  of libgeos_c and geos_c.h (if libgeos_c is in /usr/local/lib and
+  geos_c.h is in /usr/local/include, set GEOS_DIR to /usr/local).
+  Then go to next step.  If you don't have it, you can build it from
+  the source code included with basemap by following these steps::
+
+      cd geos-2.2.3
+      export GEOS_DIR=<where you want the libs and headers to go>
+      # A reasonable choice on a Unix-like system is /usr/local, or
+      # if you don't have permission to write there, your home directory.
+      ./configure --prefix=$GEOS_DIR 
+      make; make install
+
+* cd back to the top level basemap directory (basemap-X.Y.Z) and
+  run the usual ``python setup.py install``.  Check your installation
+  by running ``from mpl_toolkits.basemap import Basemap`` at the python
+  prompt.
+
+  Basemap includes two auxilliary packages, pydap and httplib2.
+  By default, setup.py checks to 
+  see if these are already installed, and if so does not try to overwrite 
+  them. If you get import errors related to either of these two packages, 
+  edit setup.cfg and set pydap and/or httplib2 to True to force 
+  installation of the included versions.
+
+* To test, cd to the examples directory and run ``python simpletest.py``.
+  To run all the examples (except those that have extra dependencies
+  or require an internet connection), execute ``python run_all.py``.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


