The new matplotlib hierarchy

jdh2358 · jdh2358 · commit 48111d043ec5 · 2003-05-12T15:20:38.000Z
svn path=/trunk/matplotlib/; revision=7
diff --git a/CHANGELOG b/CHANGELOG
@@ -0,0 +1,52 @@
+2002-12-10 - Added a TODO file and CHANGELOG.  Lots to do -- get
+             crackin'!
+
+           - Fixed y zoom tool bug
+
+           - Adopted a compromise fix for the y data clipping problem.
+             The problem was that for solid lines, the y data clipping
+             (as opposed to the gc clipping) caused artifactual
+             horizontal solid lines near the ylim boundaries.  I did a
+             5% offset hack in Axes set_ylim functions which helped,
+             but didn't cure the problem for very high gain y zooms.
+             So I disabled y data clipping for connected lines .  If
+             you need extensive y clipping, either plot(y,x) because x
+             data clipping is always enabled, or change the _set_clip
+             code to 'if 1' as indicated in the lines.py src.  See
+             _set_clip in lines.py and set_ylim in figure.py for more
+             information.
+
+
+2002-12-11 - Added a measurement dialog to the figure window to
+             measure axes position and the delta x delta y with a left
+             mouse drag.  These defaults can be overridden by deriving
+             from Figure and overrriding button_press_event,
+             button_release_event, and motion_notify_event,
+             and _dialog_measure_tool.
+
+           - fixed the navigation dialog so you can check the axes the
+             navigation buttons apply to.
+
+
+
+2003-04-23 Released matplotlib v0.1
+
+2003-04-24 Added a new line style PixelLine2D which is the plots the
+           markers as pixels (as small as possible) with format
+           symbol ','
+ 
+           Added a new class Patch with derived classes Rectangle,
+           RegularPolygon and Circle
+
+2003-04-25 Implemented new functions errorbar, scatter and hist
+ 
+           Added a new line type '|' which is a vline.  syntax is 
+	   plot(x, Y, '|') where y.shape = len(x),2 and each row gives
+	   the ymin,ymax for the respective values of x.  Previously I
+	   had implemented vlines as a list of lines, but I needed the
+	   efficientcy of the numeric clipping for large numbers of
+	   vlines outside the viewport, so I wrote a dedicated class
+	   Vline2D which derives from Line2D
+
+
+            
diff --git a/INSTALL b/INSTALL
@@ -0,0 +1,16 @@
+This package requires python 2.2+, Numeric and pygtk 1.99.x (which
+requires gnome2).
+
+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.
+
+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
+comp.lang.python, which I read frequently.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,49 @@
+LICENSE AGREEMENT FOR MATPLOTLIB 0.01
+--------------------------------------
+
+1. This LICENSE AGREEMENT is between the John D. Hunter ("JDH"), and
+the Individual or Organization ("Licensee") accessing and otherwise
+using matplotlib software in source or binary form and its associated
+documentation.
+
+2. Subject to the terms and conditions of this License Agreement, JDH
+hereby grants Licensee a nonexclusive, royalty-free, world-wide
+license to reproduce, analyze, test, perform and/or display publicly,
+prepare derivative works, distribute, and otherwise use matplotlib
+0.01 alone or in any derivative version, provided, however, that JDH's
+License Agreement and JDH's notice of copyright, i.e., "Copyright (c)
+2002 John D. Hunter; All Rights Reserved" are retained in matplotlib
+0.01 alone or in any derivative version prepared by Licensee.
+
+3. In the event Licensee prepares a derivative work that is based on
+or incorporates matplotlib 0.01 or any part thereof, and wants to make
+the derivative work available to others as provided herein, then
+Licensee hereby agrees to include in any such work a brief summary of
+the changes made to matplotlib 0.01.
+
+4. JDH is making matplotlib 0.01 available to Licensee on an "AS IS"
+basis.  JDH MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, JDH MAKES NO AND
+DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF MATPLOTLIB 0.01 WILL NOT
+INFRINGE ANY THIRD PARTY RIGHTS.
+
+5. JDH SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF
+MATPLOTLIB 0.01 FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES
+OR LOSS AS A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING
+MATPLOTLIB 0.01, OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE
+POSSIBILITY THEREOF.
+
+6. This License Agreement will automatically terminate upon a material
+breach of its terms and conditions.
+
+7. Nothing in this License Agreement shall be deemed to create any
+relationship of agency, partnership, or joint venture between JDH and
+Licensee.  This License Agreement does not grant permission to use JDH
+trademarks or trade name in a trademark sense to endorse or promote
+products or services of Licensee, or any third party.
+
+8. By copying, installing or otherwise using matplotlib 0.01, Licensee
+agrees to be bound by the terms and conditions of this License
+Agreement.
+
diff --git a/README b/README
@@ -0,0 +1,31 @@
+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.
+
+REQUIREMENTS:
+
+   python 2.2+, pygtk-1.99.x and Numeric
+
+INSTALL
+
+  If you have the requirements, just do 'python setup.py install'
+
+EXAMPLES
+
+  See the demos in the demo dir.
+
+AUTHOR
+
+  John D. Hunter <jdhunter@ace.bsd.uchicago.edu>
+  Copyright (c) 2002 John D. Hunter; All Rights Reserved
+
+LICENSE
+
+  Based on that of python 2.2.  See the LICENSE file that ships with
+  the matplotlib source code
+  
diff --git a/TODO b/TODO
@@ -0,0 +1,96 @@
+-- add print/save functionality.  Currently you can save by right
+   clicking on the fig window, but you must have nothing in front of
+   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
+
+-- fix text size calculations using pango layouts: DONE
+ 
+-- add a font selection dialog for the axis text
+
+-- enable vertical rendering for ylabels: DONE
+
+-- enable anti aliasing for fonts: DONE with pango
+
+-- enable fancy text labels (eg, greek letters, math symbols,
+   superscripts) ala TeX or unicode
+
+-- 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.
+
+-- write a user guide
+
+-- allow more intelligent choice of tick labels and locs when panning and
+   zooming.
+
+-- figure out why the positioning of dialog boxes based on position
+   and size of main window and dialog window doesn't work exactly as
+   expected.  For example, the width of the dialog box is being
+   reported as being much smaller than it is.  Is window pixels the
+   unit being returned by for gtk.Dialogs.get_size?  Also, this isn't
+   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
+
+-- One the errorbar demo the hlines do not always appear symmetric
+   about the x values.  Is there an tranformation or rounding problem
+   occurring somewhere?
+
+-- 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
+
+-- 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')
+
+-- xlabel is lower than it needs to be
+
diff --git a/setup.py b/setup.py
@@ -0,0 +1,19 @@
+from distutils.core import setup
+import sys,os
+
+
+setup(name="matplotlib",
+      version= '0.2b',
+      description = "Matlab style plotting lib using pygtk",
+      author = "John D. Hunter",
+      author_email="jdhunter@ace.bsd.uchicago.edu",
+      url = "http://nitace.bsd.uchicago.edu:8080/matplotlib",
+      long_description = """
+      matplotlib strives to produce publication quality 2D graphics
+      using matlab plotting for inspiration.  Although the main lib is
+      object oriented, there is a functional matlab style interface
+      for people coming from matlab.
+      """,
+      packages=['matplotlib'],
+      platforms='any',
+      )
