
The org.nddp packages
-----------------------------------

The org.nddp packages are contributed by the Natural Diversity Discovery Project
(www.nddp.org) and authored by Tim McPhillips (tmcphillips@nddp.org).  See the
NDDP web site for a description of the project.  

These packages provide support for 'collection-aware' actors that operate on 
streams of tokens structured into nested collections using opening and closing 
delimiter tokens inserted into the data streams.  This approach makes it much 
easier to process the deeply nested data structures typical of bioinformatics 
while maximizing efficiencies that may be gained by concurrently operating on 
collection contents using computational pipelines.

Software license
-----------------------------------

See copyright.txt for software license information.


Software support
-----------------------------------

Although these packages are being released as part of Kepler 1.0.0alpha7, all 
software herein should be considered experimental and subject to change at any
time.  No support will be provided to users of this version; other packages in
Kepler are not expected to make use of these packages at this time.  

To contribute to these packages please contact Tim McPhillips.

Documentation
-----------------------------------

Javadoc documention is not provided for the org.nddp packages at this time
because (1) this version is not intended for use by other developers and 
(2) preparation of javadoc documentation often leads to refactoring (it is 
sometimes easier to improve code than to explain it).  Since refactoring is 
risky in the absence of comprehensive unit tests, javadoc documentation will
be developed after the unit tests are complete.

For an overview of the approach taken in this package, please request from 
Tim McPhillips or Shawn Bowers a copy of a paper submitted for publication
explaining the software.

Projected release schedule
-----------------------------------

Kepler 1.0.0.alpha8 (Oct 3, 2005) will include a complete API for developing
collection-aware actors, and JUnit tests and javadoc documentation for all core 
org.nddp classes.

Kepler 1.0.0.alpha9 (Dec 9, 2005) will include JUnit tests and javadoc 
documentation for all org.nddp classes, user documentation for org.nddp 
actors, and demo phylogenetics workflows.

Kepler 1.0.0.beta1 (Feb 3, 2006) will include a full complement of actors and
example workflows for phylogenetics in beta form.