Improving documentation for scheduling routines.
[charm.git] / doc / doxygen / src / main_page.C
1 /* This is the master Doxygen documentation links page--
2    It contains no actual executable source code. */
3 /**
4 \mainpage Charm Source Code Documentation
5 <!-- This HTML is generated from charm/doc/doxygen/main_page.C -->
6
7 \section layers Major Runtime Layers:
8
9 <table border=2>
10
11
12 <tr><td>
13 Charm++:
14  -  \ref CkArray "Arrays"
15  -  Load balancer
16  -  \ref Comlib "Comlib"
17  -  \ref CkPerf "Tracing"
18  -  Reductions
19  -  \ref CkArrayImpl "Array Implementation"
20  -  \ref Ck "Groups and Chares"
21  -  \ref CkRegister "Registration"
22  -  \ref CkQD "Quiescence detection" 
23  -  \ref CkFutures "Futures"
24  -  \ref CkInit "Startup"
25  -  Message Envelopes
26  -  \ref CharmScheduler "Charm++ Scheduler"
27  -  Translator
28  -  SDAG
29
30 </td></tr>
31  
32  <tr><td>
33  Converse:
34  -  \ref Converse "Converse Core"
35  -  \ref ConverseScheduler "Converse Scheduler"
36  -  threads
37  -  memory allocation
38  -  conditions
39  -  random numbers
40  -  converse client/server (CCS)
41  -  Converse tracing
42  -  parameter marshalling (CPM)
43  - quiescence
44 </ul>
45  </td></tr>
46  
47  
48  
49  <tr><td>
50  \ref Machine "Converse Machine Layers":
51  -  \ref NET "net"
52  -  ...
53  </td></tr>
54  
55  
56  <tr><td>
57  Converse Configuration Layer:
58  - build system
59  - charmc
60  - configure script
61  - conv-mach.h/.sh
62  </td></tr>
63  
64  
65 <tr><td>
66 <p>Libraries:
67 <p>Communication: Barrier, commlib, multicast, sparseReducer, sparseContiguousReducer
68 <P>Languages: ARMCI, AMPI, TCharm, taskGraph, search
69 <p>Frameworks: \ref ParFUM "ParFUM", IFEM, IDXL, Collide, MBlock, AMR
70 <p>Visualization: liveViz, liveViz3d, netFEM
71 </td></tr>
72  
73  
74
75  
76  
77  </table>
78
79 \section utilities Utility Code
80 PUP, CkBitVector, CkDll, CkHashtable, 
81 CkImage, CkVec, CkQ, CkStatistics, CkVector3d,
82 sockets.
83
84 */