SF.net SVN: matplotlib: [5154] trunk/matplotlib/examples/README.txt

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

Revision: 5154
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5154&view=rev
Author:   jdh2358
Date:     2008-05-16 13:08:39 -0700 (Fri, 16 May 2008)

Log Message:
-----------
added readme for examples

Added Paths:
-----------
    trunk/matplotlib/examples/README.txt

Added: trunk/matplotlib/examples/README.txt
===================================================================
--- trunk/matplotlib/examples/README.txt	                        (rev 0)
+++ trunk/matplotlib/examples/README.txt	2008-05-16 20:08:39 UTC (rev 5154)
@@ -0,0 +1,42 @@
+matplotlib examples
+===================
+
+There are a variety of ways to use matplotlib, and most of them are
+illustrated in the examples in this directory.
+
+Probably the most common way people use matplotlib is with the
+procedural interface, which follows the matlab/IDL/mathematica
+approach of using simple procedures like "plot" or "title" to modify
+the current figure.  These examples are included in the "pylab"
+directory.  If you want to write more robust scripts, eg for
+production use or in a web application server, you will probably want
+to use the matplotlib API for full control.  These examples are found
+in the "api" directory.  Below is a brief description of the different
+directories found here:
+
+  * animation - dynamic plots, see the tutorial at
+    http://www.scipy.org/Cookbook/Matplotlib/Animations
+
+  * api - working with the matplotlib API directory.  See the
+    doc/artist_api_tut.txt in the matplotlib src directory ((PDF at
+    http://matplotlib.sf.net/pycon)
+
+  * data - some data files we use in the examples
+
+  * event_handling - how to interact with your figure, mouse presses,
+    key presses, object picking, etc.  See the event handling tutorial
+    in the "doc" directory of the source distribution (PDF at
+    http://matplotlib.sf.net/pycon)
+
+  * misc - some miscellaneous examples.  some demos for loading and
+    working with record arrays
+
+  * pylab - the  interface to matplotlib similar to matlab
+
+  * tests - tests used by matplotlib developers to check functionality
+
+  * units - working with unit data an custom types in matplotlib
+
+  * user_interfaces - using matplotlib in a GUI application, eg
+    TkInter, WXPython, pygtk, pyqt or FLTK widgets
+


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