Miami University
Miami University

DOCUMENTATION LICENSE

Creative Commons License This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.

QUICK START GUIDE

The welcome screen and quick start guide that is displayed the first time PEACE is run is available via the following link: Quick Start Guide. In PEACE, you may view the quick start guide by clicking the corresponding tool bar button. In PEACE, you may click on the hyperlinks or icons in the quick start guide to launch the various wizards that will further guide you through the different steps.

USER GUIDE & MANUAL

The user guide and manual for PEACE can be obtained by clicking on the following link: User Guide & Manual. This comprehensive document provides a detailed description of using both the GUI version of PEACE and the textual (non-GUI) version of PEACE. In addition, it also enumerates the software tools required to install and run PEACE.

VIDEO TUTORIALS

The following videos provide a multi-media demonstration of performing the core tasks of working with PEACE GUI. You may either download the videos (some of them are reasonably large) to your machine and view them. For convenience, the same videos may also be viewed off YouTube.com via the corresponding links.

File Size Description
Adding a new Data Set YouTube (14MB) This video demonstrates the process of adding a new data set to a workspace in PEACE GUI. Optionally, download this video.
Adding a new Server to PEACE YouTube (41MB) This video demonstrates the process of adding a new server to a workspace in PEACE GUI. Optionally, download this video.
Starting a Job in PEACE YouTube (30MB) This video demonstrates the process of launching a new clustering job on a server. Optionally, download this video.
Working with Cluster Summary Graph YouTube (14MB) This video demonstrates the process of working with the cluster summary graph and creating virtual database classifiers. Optionally, download this video.

PROGRAMMER DOCUMENTATION

The following links provide detailed documentation on the source code for both PEACE GUI (developed in Java) and the parallel clustering engine (developed in C++). The documentation has been directly derived from PEACE source code using Javadoc (for Java) and doxygen (for C++). Click on the corresponding links below to view the documentation for the two major subsystems constituting PEACE. The complete source code can be obtained from the downloads page.

URL Description
PEACE GUI (Java) documentation This link provides details regarding the various classes along with Application Program Interface (API) documentation for the PEACE Graphical User Interface (GUI) subsystem. The GUI has been developed in Java. The programmer documentation was generated using Javadoc. The complete documentation is available for download at gui_docs.tar.gz .
Parallel clustering engine (C++) documentation This link provides details regarding the various classes along with Application Program Interface (API) documentation for the PEACE parallel clustering engine. The parallel clustering engine has been developed in C++ to provide a flexible, yet robust API without compromising performance. The C++ documentation has been generated directly from the source using doxygen . The complete documentation can be downloaded via this link: peace_cpp_html_docs.tar.gz.