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