PEACE

API and programmer documentation for PEACE: Parallel Environment for Assembly and Clustering of gene Expressions.

See:
          Description

Packages
org.peace_tools Provides all the packages and classes associated with PEACE GUI, including files necessary to install the C++ clustering engine on local and remote servers.
org.peace_tools.core Contains the core classes that coordinate the activities of various classes and wizards.
org.peace_tools.core.dataset Contains the classes associated with the data set wizard.
org.peace_tools.core.job Contains the classes associated with the job wizard.
org.peace_tools.core.server Contains the classes associated with the server wizard.
org.peace_tools.core.session Contains the classes associated with providing a session on a local or remote server.
org.peace_tools.data Contains the classes that provide data for the various views in the GUI.
org.peace_tools.generic Provides a generic set of application-independent classes for performing standard GUI operations.
org.peace_tools.generic.dndTabs Provides generic functionality to organize GUI as dockable tabs.
org.peace_tools.views Contains the classes that provide views for the various data objects in the GUI.
org.peace_tools.views.overlap Contains the classes that provide a custom overlap view of clusters.
org.peace_tools.workspace Contains the classes that provide persistent storage of work space configuration.

 

API and programmer documentation for PEACE: Parallel Environment for Assembly and Clustering of gene Expressions.

Overview

PEACE is essentially a parallel and distributed clustering software system. It consists of two main components. The core clustering is performed by a standalone software subsystem. The core clustering engine has been developed in C++ and utilizes the Message Passing Library (MPI) to enable parallel and distributed clustering of large data sets of sequenced transcript fragments.

The second component of PEACE is a Graphical User Interface (GUI) that has been developed in Java to serve as an integrated clustering and analysis workbench. This documentation provides detailed information about the software system constituting PEACE GUI. This documentation is primarily intended for use by programmers who wish to further enhance or modify PEACE to suit their needs.

As of 2010, PEACE is actively maintained and managed by the original authors at Miami University, Oxford, OH. If you would like enhancements or changes to PEACE, feel free to contact the authors. Contact and additional information is available off PEACE website at: http://www.peace-tools.org/ .

License and Disclaimer

PEACE is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PEACE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PEACE. If not, see http://www.gnu.org/licenses/ .

Miami University makes no representations or warranties about the suitability of the software, either express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, or non-infringement. Miami University shall not be liable for any damages suffered by licensee as a result of using, result of using, modifying or distributing this software or its derivatives.

By using or copying this Software, Licensee agrees to abide by the intellectual property laws, and all other applicable laws of the U.S., and the terms of GNU General Public License (version 3).

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see: http://www.peace-tools.org/ .