Commits

ksbuble committed c4460cc

Updated for submission to PyPI

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.
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.