root/README

Revision 136 (checked in by apokayi, 1 year ago)

add the main script and README

Line 
1 --------------------------------------------------------------------------
2                 GWU Unified Testing Suite (GUTS)
3 --------------------------------------------------------------------------
4
5 GUTS is a new framework which includes various UPC testing suites. The main
6 goal behind this new framework is to hold different UPC testing benches in a
7 single unified environment as much as possible.
8
9 This README file contains general information for GUTS, if you would like to
10 know more about the specific testing suites please go to those directories
11 and refer to the information provided there.
12
13 BUG REPORTS MAY BE SUBMITTED USING OUR TICKET SYSTEM AT:
14         http://threads.seas.gwu.edu/sites/guts
15        
16 IF FOR SOME REASON THIS IS NOT AN OPTION, E-MAIL THE MAINTAINER AT:
17         apokayi@gwu.edu
18
19
20 Quick Overview:
21 ----------------
22
23 Currently GUTS include the following test benches:
24        
25         1- guts_main: This is the main UPC testing suite for the language specification
26         compliance check for the UPC compilers
27
28         2- guts_io: This is the testing suite for the UPC/IO library
29
30         3- guts_collectives: This is the testing suite released by Michigan Tech University
31         and it is used for testing the UPC/Collectives library
32
33         4- guts_npb: This bench provides an extra stress testing on the compilers by running
34         some of the kernels from the NAS Parallel Benchmarks
35
36 Again for more information in any of these testing suites please go to that specific
37 directory and use the README file.
38
39 Background information and changes:
40 ------------------------------------
41
42 GUTS is a modified version of the previous GWU testing efforts especially
43 Unified UPC Test Framework (UUTF) which was released June 2005. It differs
44 mainly in the testing strategy i.e. GUTS follow the "unit" based testing
45 wherever possible (guts_io & guts_main). Also, GUTS includes various bug fixes
46 and modifications to previous release. Last but not least, GUTS tries to provide
47 clear information as the output of testing by going through each unit one by one and
48 at the end including statistics for the whole run.
49
50 For more information on the official releases of the test suites, please refer to
51 http://upc.gwu.edu.
52
53 Requirements:
54 --------------
55
56 Please refer to the README files provided for each sub testing suite.
57 GUTS itself does not require to be installed and requires only working UPC compiler.
58
59 How to use GUTS?
60 ----------------
61
62 There are two main alternatives to use GUTS for testing purposes.
63        
64         1- Use the "guts.sh" script provided in the top directory and run any of the testing
65         suite by specifying the name in the command line
66        
67         2- Use the scripts provided inside each testing suite to run that specific test bench
68         e.g. to run the UPC/IO testing suite first go to "guts_io" directory, refer to the
69         README file provided for any specific information, and run the test bench using the
70         script provided in that directory which is "guts_io.sh" by calling
71                 ./guts_io.sh [#of threads]
72
73 User does not need to compile anything, every source file is compiled and run accordingly
74 using the scripts provided. Statistical output is provided at the end where applicable.
75
76 Portability:
77 ------------
78
79 Testing of GUTS is mainly done using the Berkeley 2.4.0 compiler and the scripts are provided
80 according to that compiler. However, we have provided Makefiles for different UPC compilers
81 inside the guts_npb folders for users convenience. Even though those makefiles are specific to
82 run NPB kernels one can use the information from them to modify the scripts. We will provide an
83 interface to select any UPC compiler as we get access to those UPC compilers and tested them.
84 In order to get more information how to modify the various test bench scripts please refer to
85 the information provided in that specific test bench directory.
86
87 License:
88 --------
89
90 Please refer to each source file for the licenses as they may come from different sources.
91
92
93
94
95
96  
Note: See TracBrowser for help on using the browser.