SF.net SVN: matplotlib: [5595] trunk/matplotlib/doc

[<jd...@us...>]

Revision: 5595
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5595&view=rev
Author:   jdh2358
Date:     2008-06-19 06:59:08 -0700 (Thu, 19 Jun 2008)

Log Message:
-----------
added the installing doc

Modified Paths:
--------------
    trunk/matplotlib/doc/faq/installing_faq.rst

Added Paths:
-----------
    trunk/matplotlib/doc/users/installing.rst

Modified: trunk/matplotlib/doc/faq/installing_faq.rst
===================================================================
--- trunk/matplotlib/doc/faq/installing_faq.rst	2008-06-19 13:23:04 UTC (rev 5594)
+++ trunk/matplotlib/doc/faq/installing_faq.rst	2008-06-19 13:59:08 UTC (rev 5595)
@@ -55,10 +55,12 @@
 
      easy_install -m PackageName
 
+
 3. Delete any .egg files or directories from your :ref:`installation
    directory <locating-matplotlib-install>`.
 
 
+
 Windows installer
 -----------------
 

Added: trunk/matplotlib/doc/users/installing.rst
===================================================================
--- trunk/matplotlib/doc/users/installing.rst	                        (rev 0)
+++ trunk/matplotlib/doc/users/installing.rst	2008-06-19 13:59:08 UTC (rev 5595)
@@ -0,0 +1,91 @@
+.. _installing:
+
+**********
+Installing
+**********
+
+Dependencies
+============
+
+**Requirements**
+
+These are external packages which you will need to install before
+installing matplotlib. Windows users only need the first two (python
+and numpy) since the others are built into the matplotlib windows
+installers available for download at the sourceforge site.
+
+python 2.4 (or later but not python3)
+    matplotlib requires python 2.4 or later
+
+numpy 1.1 (or later)
+    array support for python
+
+libpng 1.1 (or later)
+    library for loading and saving PNG files. libpng requires zlib. If
+    you are a windows user, you can ignore this since we build support
+    into the matplotlib single click installer.
+
+freetype 1.4 (or later)
+    library for reading true type font files. If you are a windows
+    user, you can ignore this since we build support into the
+    matplotlib single click installer.
+
+**Optional**
+
+These are optional packages which you may want to install to use
+matplotlib with a user interface toolkit. See
+:ref:`what-is-a-backend` for more details on the optional matplotlib
+backends and the capabilities they provide
+
+tk 8.3 or later
+    The TCL/Tk widgets library used by the TkAgg backend
+
+pyqt 3.1 or later
+    The Qt3 widgets library python wrappers for the QtAgg backend
+
+pyqt 4.0 or later
+    The Qt4 widgets library python wrappersfor the Qt4Agg backend
+
+pygtk 2.2 or later
+    The python wrappers for the GTK widgets library for use with the GTK or GTKAgg backend
+
+wxpython 2.6 or later
+    The python wrappers for the wx widgets library for use with the WXAgg backend
+
+wxpython 2.8 or later
+    The python wrappers for the wx widgets library for use with the WX backend
+
+pyfltk 1.0 or later
+    The python wrappers of the FLTK widgets library for use with FLTKAgg
+
+**Required libraries that ship with matplotlib**
+
+If you are downloading matplotlib or installing from source or
+subversion, you can ignore this section. This is useful for matplotlib
+developers and packagers who may want to disable the matplotlib
+version and ship a packaged version.
+
+agg2.4
+    The antigrain C++ rendering engine
+
+pytz 2007g or later
+    timezone handling for python datetime objects
+
+dateutil 1.1 or later
+    extensions to python datetime handling
+
+**Optional libraries that ship with matplotlib**
+
+As above, if you are downloading matplotlib or installing from source
+or subversion, you can ignore this section. This is useful for
+matplotlib developers and packagers who may want to disable the
+matplotlib version and ship a packaged version.
+
+enthought traits 2.6
+    The traits component of the Enthought Tool Suite used in the
+    experimental matplotlib traits rc system. matplotlib has decided
+    to stop installing this library so packagers should not distribute
+    the version included with matplotlib. packagers do not need to
+    list this as a requirement because the traits support is
+    experimental and disabled by default.
+


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