1 /*! @page getting_started Getting started with SimGrid!
5 Welcome to SimGrid's documentation! %As you may know, SimGrid is (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.
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.
17 \section gs_introduction Introduction, Installation and how we can help
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. |
26 \section gs_new_users Documentation for new users
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 | [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. |
35 In order to actually use SimGrid, three steps are necessary:
41 \section gs_experienced_users Documentation for experienced users
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 | SimGrid supports many different bindings for languages such as Lua, Ruby, Java, ... You can run your simulations with those! |
47 | \ref pls | Although SimGrid is not a packet level simulator, it does have bindings to two such simulators. |
48 | \ref inside | If you want to contribute or obtain a deeper understanding of SimGrid, this is the right location. |
50 \section gs_examples Examples shipped with SimGrid
52 SimGrid ships with many examples. You can find them in the folder
53 \c examples/. Especially when you're looking for examples on how to
54 use a specific XML-tag, this will prove valuable, as you can easily
55 search through all the files with tools like \c grep.
58 Here is the output of a quick search for examples for \ref pf_trace "trace_connect":
61 % grep -R -i -n --include="*.xml" "trace_connect" .
62 ./simdag/two_hosts.xml:22: <trace_connect trace="Tremblay_power" element="Tremblay" kind="POWER"/>
63 ./platforms/two_hosts_platform_with_availability_included.xml:24:<trace_connect kind="POWER" trace="A" element="Cpu A"/>
64 ./platforms/two_hosts_platform_with_availability_included.xml:25:<trace_connect kind="HOST_AVAIL" trace="A_failure" element="Cpu A"/>
65 ./platforms/two_hosts_platform_with_availability_included.xml:26:<trace_connect kind="POWER" trace="B" element="Cpu B"/>
69 There's also a Section on \ref MSG_examples "examples for MSG".