Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
bb4e7fd28da18dbf7870fc2e01ae33c73d4946c7
[simgrid.git] / doc / gtut-tour.doc
1
2 /** 
3 @page GRAS_tut_tour GRAS initiatic tour
4
5 During this tour, you will learn all you need to write your own GRAS
6 applications, from the installation of the framework to the use of (almost)
7 all features available in GRAS.
8
9     \htmlonly <!-- 
10       DOXYGEN_NAVBAR_CHILD "0: Installing"=GRAS_tut_tour_install.html
11       DOXYGEN_NAVBAR_CHILD "1: Setup a project"=GRAS_tut_tour_setup.html
12       DOXYGEN_NAVBAR_CHILD "2: Simple messaging"=GRAS_tut_tour_simpleexchange.html
13       DOXYGEN_NAVBAR_CHILD "3: Process args"=GRAS_tut_tour_args.html
14       DOXYGEN_NAVBAR_CHILD "4: Callbacks"=GRAS_tut_tour_callbacks.html
15       DOXYGEN_NAVBAR_CHILD "5: Globals"=GRAS_tut_tour_globals.html
16       DOXYGEN_NAVBAR_CHILD "6: Logs"=GRAS_tut_tour_logs.html
17       DOXYGEN_NAVBAR_CHILD "7: Timers"=GRAS_tut_tour_timers.html
18       DOXYGEN_NAVBAR_CHILD "8: Exceptions"=GRAS_tut_tour_exceptions.html
19       DOXYGEN_NAVBAR_CHILD "9: Simple data"=GRAS_tut_tour_simpledata.html
20       DOXYGEN_NAVBAR_CHILD "10: RPC"=GRAS_tut_tour_rpc.html
21     --> \endhtmlonly
22
23 <b>Part 1: Bases</b>
24
25    - \ref GRAS_tut_tour_install
26
27    - \ref GRAS_tut_tour_setup
28       - \ref GRAS_tut_tour_setup_C
29       - \ref GRAS_tut_tour_setup_plat
30       - \ref GRAS_tut_tour_setup_deploy
31       - \ref GRAS_tut_tour_setup_glue
32       - \ref GRAS_tut_tour_setup_make
33       - \ref GRAS_tut_tour_setup_start
34   
35 <b>Part 2: Message passing</b>
36   
37    - \ref GRAS_tut_tour_simpleexchange
38       - \ref GRAS_tut_tour_simpleexchange_msgtype
39       - \ref GRAS_tut_tour_simpleexchange_socks
40       - \ref GRAS_tut_tour_simpleexchange_exchange
41       - \ref GRAS_tut_tour_simpleexchange_recaping
42     
43    - \ref GRAS_tut_tour_args
44       - \ref GRAS_tut_tour_args_use
45       - \ref GRAS_tut_tour_args_sg
46       - \ref GRAS_tut_tour_args_recap
47     
48    - \ref GRAS_tut_tour_callbacks
49       - \ref GRAS_tut_tour_callbacks_declare
50       - \ref GRAS_tut_tour_callbacks_attach
51       - \ref GRAS_tut_tour_callbacks_handle
52       - \ref GRAS_tut_tour_callback_recap
53      
54    - \ref GRAS_tut_tour_globals
55       - \ref GRAS_tut_tour_globals_intro
56       - \ref GRAS_tut_tour_globals_use
57       - \ref GRAS_tut_tour_callback_pitfall
58       - \ref GRAS_tut_tour_callback_recap
59       
60    - \ref GRAS_tut_tour_logs
61       - \ref GRAS_tut_tour_logs_intro
62       - \ref GRAS_tut_tour_logs_practice
63       - \ref GRAS_tut_tour_logs_recap
64       - \ref GRAS_tut_tour_logs_config
65     
66    - \ref GRAS_tut_tour_timers
67       - \ref GRAS_tut_tour_timers_intro
68       - \ref GRAS_tut_tour_timers_use
69       - \ref GRAS_tut_tour_timers_recap
70     
71    - \ref GRAS_tut_tour_exceptions
72       - \ref GRAS_tut_tour_exceptions_intro
73       - \ref GRAS_tut_tour_exceptions_use
74       - \ref GRAS_tut_tour_exceptions_recap
75      
76    - \ref GRAS_tut_tour_simpledata
77       - \ref GRAS_tut_tour_simpledata_intro
78       - \ref GRAS_tut_tour_simpledata_example
79       - \ref GRAS_tut_tour_simpledata_recap
80       
81    - \ref GRAS_tut_tour_rpc
82       - \ref GRAS_tut_tour_rpc_intro
83       - \ref GRAS_tut_tour_rpc_use
84       - \ref GRAS_tut_tour_rpc_recap
85   
86 Unfortunately, the tour is not terminated yet, but I already know the kind
87 of missi^W lessons I want to add:
88
89 <b>Part 3: Data description</b>
90    - Exchanging simple data through ping-pong
91    - Automatic parsing of static data types
92    - Automatic parsing of datatypes containing pointers
93    - Exchanging dynars (and matrices)
94    - Manual data description: the full power
95    - Exchange callbacks: yes you can
96      
97 <b>Part 4: Advanced topics</b>
98    - Computation virtualization
99    - Splitting in several files (logs, datadesc)
100    - Debugging GRAS programs
101    - Doing proper GRAS modules
102   
103 <hr>
104
105
106
107 */
108
109 /** 
110 @page GRAS_tut_tour_install Lesson 0: Installing GRAS
111
112 Since GRAS is technically part of the SimGrid project, you have to install
113 SimGrid to install GRAS. Doing so is explained in the relevant FAQ section
114 (\ref faq_installation). 
115
116 Newcommers should install the stable release from the tarball, since the cvs
117 snapshots may suffer from (additionnal;) stability issues. Only go for the
118 CVS if you really need features not present in the stable releases yet (or
119 if you plan to help us improving the tool, what is always welcomed).
120
121 */