Read Me

**Descripton**

basemap.py - plot on map projections (with coastlines and political boundaries)
using matplotlib.

**Requirements**

matplotlib 0.87.3 (or higher)

**Copyright**

source code from proj.4 (http://proj.maptools.org) is included in the
'src' directory (under the terms given in LICENSE_proj4).

pyshapelib by Bernhard Herzog is included in the 'pyshapelib' directory
under the terms given in LICENSE_pyshapelib.

the coastline, lake, river and political boundary data are extracted
from datasets provided with the Generic Mapping Tools
(http://gmt.soest.hawaii.edu)
and are included under the terms given in LICENSE_data.

a public domain 5-minute land/sea/lake mask dataset from
http://www.ngdc.noaa.gov/seg/cdroms/graham/graham/graham.htm
is included.

Everything else (include src/pyproj.pyx and src/pyproj.c):

copyright (c) 2004 by Jeffrey Whitaker.

Permission to use, copy, modify, and distribute this software and its
documentation for any purpose and without fee is hereby granted,
provided that the above copyright notices appear in all copies and that
both the copyright notices and this permission notice appear in
supporting documentation.
THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.

**Documentation** 

see basemap.py docstrings.

see scripts in 'examples' directory for example usage.

read the FAQ and/or email the matplotlib-users mailing list if 
you have problems or questions.

**Install**

1) run 'python setup.py install' 

This installs the basemap package including the 
crude ('c') and low ('l') resolution boundary data files,
plus the 5-minute land/sea mask.
If you also want the intermediate and high resolution boundary
datasets, you'll also need step (2).

If you don't want the boundary data files to be installed in the 
default location (sys.prefix/share), set the BASEMAP_DATA_PATH
environment variable to where you would like them to go.  This
environment variable is also used at run-time to find the files.

2) if you need the intermediate ('i') or high ('h') resolution boundary 
datasets, download the basemap-data tarball, unpack and run "setup.py install"
This does not need to be done every time you update basemap (via step 1),
only when the basemap-data package is updated.

**Contact**

Jeff Whitaker <jeffrey.s.whitaker@noaa.gov>