Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
878f901d0ac8baf0ee0aa3d81c2fb3e0d51c097c
[simgrid.git] / doc / doxygen / getting_started.doc
1 /*! @page getting_started Getting started with SimGrid
2
3 \tableofcontents
4
5 Welcome to SimGrid's documentation! %As you may know, SimGrid is an actively
6 developed research software and contains many features. This documentation is
7 \c "work in progress" (and we need the community's help to improve this
8 documentation! If you're ready to step up and help us, see Section \ref
9 contributing "Contributing"), but many features are already well described.
10
11 %As for many projects, our documentation consists mostly of documentation
12 for \ref gs_new_users "new" and \ref gs_experienced_users "experienced" users, but
13 we also have several pages plus a technical documentation; in addition to that, we have
14 also written many \ref gs_examples "examples" that you can easily adapt to your
15 own needs. This page gives you a brief overview of available resources.
16
17 \section gs_introduction Introduction, Installation and how we can help
18
19 | Document name   | Description                                       |
20 | --------------- | ------------------------------------------------- |
21 | \ref tutorial   | Introduces the user to basic features of SimGrid. |
22 | \ref install    | Explains how SimGrid can be installed; this covers Windows as well as Linux; plus, it shows how to install from a package or how to install from source. |
23 | \ref FAQ        | Our FAQ                                           |
24 | \ref help       | There are many ways to find answers to your questions. This document lists them. |
25
26 \section gs_new_users Documentation for new users
27
28 | Document name     | Description                                       |
29 | ----------------- | ------------------------------------------------- |
30 | \ref tutorial     | Introduces the user to basic features of SimGrid. |
31 | \ref install      | Explains how SimGrid can be installed; this covers Windows as well as Linux; plus, it shows how to install from a package or how to install from source. |
32 | [Online Tutorials](http://simgrid.gforge.inria.fr/tutorials.html) | These tutorials cover most of the basics and might be valuable for what you want to do, especially the [SimGrid User 101](http://simgrid.gforge.inria.fr/tutorials/simgrid-use-101.pdf). |
33 | \ref MSG_examples | This document explains several tests that we wrote for MSG; these tests are working simulations and you may learn something from looking at them. |
34
35 In order to actually use SimGrid, three steps are necessary:
36
37 \li Step 1: \ref platform
38 \li Step 2: \ref options
39 \li Step 3: \ref deployment
40
41 \section gs_experienced_users Documentation for experienced users
42
43 | Document name     | Description                                       |
44 | ----------------- | ------------------------------------------------- |
45 | \ref tracing      | Shows how the behavior of a program can be written to a file so that it can be analyzed. |
46 | \ref bindings     | You can write your application in Java, if you prefer. |
47 | \ref pls          | You can use the NS3 simulation models instead of our own. |
48 | \ref inside       | If you want to contribute or obtain a deeper understanding of SimGrid, this is the right location. |
49
50 \section gs_examples Examples shipped with SimGrid
51
52 SimGrid ships with many examples, detailed in Section \ref
53 MSG_examples. You can find them in the folder \c examples/. Especially
54 when you're looking for examples on how to use a specific XML-tag,
55 this will prove valuable, as you can easily search through all the
56 files with tools like \c grep.
57
58
59 Here is the output of a quick search for examples for \ref pf_trace "trace_connect":
60
61 \verbatim
62 % grep -R -i -n --include="*.xml" "trace_connect" .
63 ./simdag/two_hosts.xml:22:   <trace_connect trace="Tremblay_power" element="Tremblay" kind="POWER"/>
64 ./platforms/two_hosts_platform_with_availability_included.xml:24:<trace_connect kind="POWER" trace="A" element="Cpu A"/>
65 ./platforms/two_hosts_platform_with_availability_included.xml:25:<trace_connect kind="HOST_AVAIL" trace="A_failure" element="Cpu A"/>
66 ./platforms/two_hosts_platform_with_availability_included.xml:26:<trace_connect kind="POWER" trace="B" element="Cpu B"/>
67 \endverbatim
68
69 */