updated docs

svn path=/trunk/matplotlib/; revision=12

Author: jdh2358

CHANGELOG

@@ -50,3 +50,6 @@
 
 
 
+2003-05-01
+   
+   Fixed ytick bug where grid and tick show outside axis viewport with gc clip

GOALS

@@ -0,0 +1,38 @@
+Here's a list of things the remaining things I think need to be done
+before publication quality (2D) is achieved (if you have suggested
+additions to this list, email me)
+
+   * Display fonts vertically (ylabel).  Arbitrary orientations would
+      be nicer and would be matlab mimic the matlab handle rotation
+      for text.
+
+       UPDATE: vertical text support and ylabel added 2003-05-01
+
+   * Arbitrary locs for axis text
+
+      UPDATE: added the text command, which provides arbitrary axis
+      text
+
+   * Legend
+
+   * Allow text to scale for high res prints 
+
+   * Support multiple output resolutions and formats: 
+
+      UPDATE: Added support for png and jpeg. 2003-05-01  Gdk-Pixbufs
+      can support more types, but apparently pygtk only supports these
+      2.  This may be GTK or pygtk build dependent.  
+
+   * Fix the script time render time inconsitencies (like axis lim
+      autoscalig which occurs at rendering and is not available during
+      script
+
+   * Allow interactive control of plot thru threading
+
+      UPDATE: added examples/interactive.py which is an interactive
+      prompt for making figures
+
+   * Support a richer char set for labeling, eg greek letters, as
+      well as sub and superscripts
+
+   * Support log scaling

INSTALL

@@ -1,15 +1,31 @@
-This package requires python 2.2+, Numeric and pygtk 1.99.x (which
-requires gnome2).
+matplotlib requires python 2.2+, Numeric and pygtk 1.99.16, which
+requires GTK2.
 
 If these dependencies are satisfied, just do the usual thing:
 
   > python setup.py install
 
-I have installed and tested this on linux and win32, but in theory it
-should run anywhere that Numeric and pygtk run.
+I have installed and tested this on linux and several win32 platforms,
+but it should run anywhere that Numeric and pygtk run.
+
+
+Redhat Users:
+
+  GTK2 became the default with the Redhat Linux 8 series.  If you're
+  distro is older than that, you'll need to upgrade your desktop,
+  upgrade your gtk libs, or upgrade your distro.
+
+
+Windows Users:
+
+   Windows users should consult
+   http://www.mapr.ucl.ac.be/~gustin/win32_ports for information about
+   pygtk for win32.  Basically, you need to install the GTK+ 2.2
+   runtime and pygtk-1.99.16, both of which have friendly windows
+   installers.  After you install the runtime, you may need to add the
+   bin and lib subdirs of your install dir to your PATH.
+
 
-Take a look at the scripts in the demo dir for examples of how to use
-matplotlib.
 
 If you have any questions, email me at 
 John Hunter <jdhunter@ace.bsd.uchicago.edu> or post to

README

@@ -1,23 +1,25 @@
 INTRODUCTION:
-
-  This is a gtk based python plotting library which makes a faint
-  attempt at emulating matlab style plot commands.  The src is divided
-  into 2 parts, located in the src dir.  matplotlib.py is the plotting
-  lib which does the heavy lifting, and matplot.py defines some
-  functions to give a matlab style functional interface to the plot
-  lib, which is suitable for use from the interactive prompt.
+	
+   matplotlib is a pure python plotting library designed to bring
+   publication quality plotting to python with a syntax familiar to
+   matlab users.  Although the goal of publication quality is not yet
+   attained (see GOALS), the library does produce high quality 2D
+   plots.  All of the plotting commands can be accessed either via a
+   functional interface familiar to matlab users or an object oriented
+   interface familiar to python users.
+   
 
 REQUIREMENTS:
 
-   python 2.2+, pygtk-1.99.x and Numeric
+   python 2.2+, pygtk-1.99.16 (requires GTK2) and Numeric-22+
 
 INSTALL
 
-  If you have the requirements, just do 'python setup.py install'
+  If you have the requirements, just do 'python setup.py install'.  
 
 EXAMPLES
 
-  See the demos in the demo dir.
+  See the examples in the examples dir.
 
 AUTHOR
 

TODO

@@ -3,7 +3,9 @@
    the window.  I suppose I need to first draw to a pixbuf.  I would
    also like to control the resolution.  
 
-   DONE: just need to make a GUI to set size and fname
+     UPDATE: high resolution printing.  Resolution can be set from the
+     command line, but the GUI needs to be updated to allow resolution
+     to be set along with filename
 
 -- fix text size calculations using pango layouts: DONE
 
@@ -19,7 +21,7 @@
 -- add a color selection dialog for the background, lines, and text
 
 -- allow interactive control of the plot from the python shell after
-   it has been launched using the cookbook thread recipe.
+   it has been launched using the cookbook thread recipe.  DONE
 
 -- write a user guide
 
@@ -34,7 +36,6 @@
    working cross platform.  According to the docs this is better
    handled using size hints -- but I don't know how to use them, yet.
 
-
 -- vlines and hlines disappear on in some instance due to improper
    clipping
 
@@ -44,50 +45,17 @@
 
 -- Clip patches outside view port
 
--- Here's a list of things the remaining things I think need to be
-   done before publication quality (2D) is achieved
-
-   1) Display fonts vertically (ylabel).  Arbitrary orientations would
-      be nicer and would be matlab mimic the matlab handle rotation
-      for text.
-
-       Update: vertical text support and ylabel added 2003-05-01
-
-   2) Arbitrary locs for axis text
-
-   3) Legend
-
-   4) Fix ytick bug where grid and tick show outside axis viewport
-
-      DONE 2003-05-01 with gc clip
-
-   5) Allow text to scale for high res prints 
-
-   6) Support multiple output resolutions and formats: 
-
-      Updates: Added support for png and jpeg. 2003-05-01  Gdk-Pixbufs
-      can support more types, but apparently pygtk only supports these
-      2.  This may be GTK or pygtk build dependent.  
-
-   7) Fix the script time render time inconsitencies (like axis lim
-      autoscalig which occurs at rendering and is not available during
-      script
-
-   8) Allow interactive control of plot thru threading
-
-   9) Support a richer char set for labeling, eg greek letters, as
-      well as sub and superscripts
-
-   10) Support log scaling
-
-
 -- Allow background color to be set for subplots  
 
 -- Expose bug on win32 for axis text
 
 -- Fix floating point bug on panx/pany where 0 is computed as 5e-17
+   
+   UPDATE: hack workaround.  If the distance of the tickloc from the
+   nearest integer is a small fraction of the view lim, just use the
+   integer
 
--- fmt process  bug on this kind of plot command (2nd of 3 has no
+-- fmt process bug on this kind of plot command (2nd of 3 has no
    format string)
 
    plot(t1, p1, 'o', t2, p2, ogtt.times, ogtt.cpeptide, 's')