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       DOXYGEN_NAVBAR_CHILD "11: Static data"=GRAS_tut_tour_staticstruct.html
  22       DOXYGEN_NAVBAR_CHILD "12: Pointers"=GRAS_tut_tour_pointers.html
  23       DOXYGEN_NAVBAR_CHILD "13: Dynars"=GRAS_tut_tour_dynars.html
  24       DOXYGEN_NAVBAR_CHILD "14: Manual data definition"=GRAS_tut_tour_manualdatadef.html
  25       DOXYGEN_NAVBAR_CHILD "15: Advanced data definition"=GRAS_tut_tour_exchangecb.html
  26     --> \endhtmlonly
  27
  28 <b>Part 1: Bases</b>
  29
  30    - \ref GRAS_tut_tour_install
  31
  32    - \ref GRAS_tut_tour_setup
  33       - \ref GRAS_tut_tour_setup_C
  34       - \ref GRAS_tut_tour_setup_plat
  35       - \ref GRAS_tut_tour_setup_deploy
  36       - \ref GRAS_tut_tour_setup_glue
  37       - \ref GRAS_tut_tour_setup_make
  38       - \ref GRAS_tut_tour_setup_start
  39
  40 <b>Part 2: Message passing</b>
  41
  42    - \ref GRAS_tut_tour_simpleexchange
  43       - \ref GRAS_tut_tour_simpleexchange_msgtype
  44       - \ref GRAS_tut_tour_simpleexchange_socks
  45       - \ref GRAS_tut_tour_simpleexchange_exchange
  46       - \ref GRAS_tut_tour_simpleexchange_recaping
  47
  48    - \ref GRAS_tut_tour_args
  49       - \ref GRAS_tut_tour_args_use
  50       - \ref GRAS_tut_tour_args_sg
  51       - \ref GRAS_tut_tour_args_recap
  52
  53    - \ref GRAS_tut_tour_callbacks
  54       - \ref GRAS_tut_tour_callbacks_declare
  55       - \ref GRAS_tut_tour_callbacks_attach
  56       - \ref GRAS_tut_tour_callbacks_handle
  57       - \ref GRAS_tut_tour_callback_recap
  58
  59    - \ref GRAS_tut_tour_globals
  60       - \ref GRAS_tut_tour_globals_intro
  61       - \ref GRAS_tut_tour_globals_use
  62       - \ref GRAS_tut_tour_callback_pitfall
  63       - \ref GRAS_tut_tour_callback_recap
  64
  65    - \ref GRAS_tut_tour_logs
  66       - \ref GRAS_tut_tour_logs_intro
  67       - \ref GRAS_tut_tour_logs_practice
  68       - \ref GRAS_tut_tour_logs_recap
  69       - \ref GRAS_tut_tour_logs_config
  70
  71    - \ref GRAS_tut_tour_timers
  72       - \ref GRAS_tut_tour_timers_intro
  73       - \ref GRAS_tut_tour_timers_use
  74       - \ref GRAS_tut_tour_timers_recap
  75
  76    - \ref GRAS_tut_tour_exceptions
  77       - \ref GRAS_tut_tour_exceptions_intro
  78       - \ref GRAS_tut_tour_exceptions_use
  79       - \ref GRAS_tut_tour_exceptions_recap
  80
  81    - \ref GRAS_tut_tour_simpledata
  82       - \ref GRAS_tut_tour_simpledata_intro
  83          - \ref GRAS_tut_tour_simpledata_intro_conv
  84          - \ref GRAS_tut_tour_simpledata_intro_gras
  85          - \ref GRAS_tut_tour_simpledata_use
  86       - \ref GRAS_tut_tour_simpledata_example
  87       - \ref GRAS_tut_tour_simpledata_recap
  88
  89    - \ref GRAS_tut_tour_rpc
  90       - \ref GRAS_tut_tour_rpc_intro
  91       - \ref GRAS_tut_tour_rpc_use
  92       - \ref GRAS_tut_tour_rpc_recap
  93
  94 <b>Part 3: Data description</b>
  95
  96    - \ref GRAS_tut_tour_staticstruct Automatic parsing of static data types
  97       - \ref GRAS_tut_tour_staticstruct_intro
  98       - \ref GRAS_tut_tour_staticstruct_use
  99       - \ref GRAS_tut_tour_staticstruct_recap
 100
 101    - \ref GRAS_tut_tour_pointers Automatic parsing of datatypes containing pointers
 102       - \ref GRAS_tut_tour_pointers_intro
 103       - \ref GRAS_tut_tour_pointers_use
 104       - \ref GRAS_tut_tour_pointers_recap
 105
 106    - \ref GRAS_tut_tour_dynar Exchanging dynars (and matrices)
 107       - \ref GRAS_tut_tour_dynar_intro
 108       - \ref GRAS_tut_tour_dynar_use
 109       - \ref GRAS_tut_tour_dynar_recap
 110
 111    - \ref GRAS_tut_tour_manualdatadef Manual data description: the full power
 112       - \ref GRAS_tut_tour_manualdatadef_intro
 113       - \ref GRAS_tut_tour_manualdatadef_use
 114       - \ref GRAS_tut_tour_manualdatadef_recap
 115
 116    - \ref GRAS_tut_tour_exchangecb Exchange callbacks: yes you can
 117       - \ref GRAS_tut_tour_exchangecb_intro
 118       - \ref GRAS_tut_tour_exchangecb_use
 119       - \ref GRAS_tut_tour_exchangecb_recap
 120
 121 <b>Part 4: Advanced topics</b>
 122
 123 Unfortunately, the tour is not terminated yet, but I already know the kind
 124 of missi^W lessons I want to add:
 125
 126    - Computation virtualization
 127    - Splitting in several files (logs, datadesc)
 128    - Debugging GRAS programs
 129    - Doing proper GRAS modules
 130
 131 <hr>
 132
 133
 134
 135 */
 136
 137 /**
 138 @page GRAS_tut_tour_install Lesson 0: Installing GRAS
 139
 140 Since GRAS is technically part of the SimGrid project, you have to install
 141 SimGrid to install GRAS. Doing so is explained in the relevant FAQ section
 142 (\ref faq_installation).
 143
 144 Newcommers should install the stable release from the tarball, since the cvs
 145 snapshots may suffer from (additionnal;) stability issues. Only go for the
 146 CVS if you really need features not present in the stable releases yet (or
 147 if you plan to help us improving the tool, what is always welcomed).
 148
 149 */