Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
81ea6497ab4432644ccd5606172698943580fac7
[simgrid.git] / doc / doxygen / platform_lua.doc
1 /*! \page platform_lua Describing the platform with lua
2
3 @tableofcontents
4
5 To describe your virtual platform, you can provide a lua script
6 instead of an XML file. In the near future, this should become
7 possible from in C++ and Java thanks to the the S4U interface. When
8 this happens, the lua interface will be changed to match the S4U one.
9
10 That is why the current lua API is not documented. It is very close to
11 the XML interface, and you have some examples that you can use to
12 understand this module. If you use the current API, just drop us a
13 mail so that we keep it working once S4U is out, to give you the time
14 to switch at your pace.
15
16
17 \section pf_lua_why Why lua ?
18
19 Lua is a fast and portable scripting language. Its main goal is to
20 make the internal mechanics of C/C++ programs easily recombinable from
21 a script. It is for example heavily used in the gaming industry: C++
22 programmers do fast 3D game engines, that game designers reuse easily to
23 tell stories. 
24
25 Similarly, our goal is to decouple the internals of the simulation
26 engine from the usage of that engine. It should give our users the
27 full power of reconfiguring the tool without digging into our
28 implementation. Admittedly, we are not there yet...
29
30 */