Commits

ksbuble committed c4460cc

Updated for submission to PyPI

  • Participants
  • Parent commits 1cb6f5e

Comments (0)

Files changed (1)

 .. conventions.  It will be displayed on the bitbucket source page and
 .. serves as the documentation of the directory.
 
+
+
+Async Plotter
+=============
+
+Simple two-process client/server plotting with the following features:
+
+* Plotting does not slow down calculations.
+* User maintains control of the calculation (i.e. KeyboardInterrupts work).
+* Auto-launch client from the server.
+
+  * The user defines the plotting code in a (picklable) class, and
+    provides the class to the Server() constructor.  The Server passes the pickled Plotter
+    to the client when the client process is launched in a new python interpreter. 
+    The python interpreter command line options for the client are passed to the Server 
+    constructor at the time of instantiation. Default values are: 
+    (ex. ["ipython", "--pylab=osx", "-c"])
+
+
 To Do
 =====
 
 * Comprehensive testing
 * Logging (print debug messages in debug mode for checking network problems)
 * Profile performance.
-* Auto-launch client from the server.
-
-  * The user defines the plotting code in a (picklable) class, and
-    provides the class to the Server() constructor.  The Server passes the pickled Plotter
-    to the client when the client process is launched in a new python interpreter. 
-    The python interpreter command line options for the client are passed to the Server 
-    constructor at the time of instantiation. Default values are: 
-    (ex. ["ipython", "--pylab=osx", "-c"])
-
 * Configuration (hostname, port specification etc.)
 
-I think that these have been dealt with, but they need testing.
+I think that these have been dealt with, but they need testing:
 
 * socket buffer overflow (recv)
 * cleanup thread and socket command line termination
 * multiple clients (plotting)
 
 
-Async Plotter
-=============
-
-Simple two-process client/server plotting with the following features:
-
-* Plotting does not slow down calculations.
-* User maintains control of the calculation (i.e. KeyboardInterrupts work).
+Other Design Approaches
+=======================
 
 Threading Solution
 ==================
 be sent across the network.
 
 
-Other Approaches
-================
+Additional Approaches
+=====================
 It seems that one should be able to use IPython_ to do this, but I have not
 found a simple way to do this yet.