From 22f807e63ea618e259327fca648d76cb1963bc0d Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Sat, 28 Jan 2017 14:57:47 +0100 Subject: [PATCH] tuto improvements, and add a link to the SMPI CourseWare --- doc/Doxyfile.in | 3 ++- doc/doxygen/index.doc | 3 ++- doc/doxygen/{tutorial.doc => tutorial_msg.doc} | 12 +++++++++--- doc/doxygen/tutorial_smpi.doc | 13 +++++++++++++ tools/cmake/DefinePackages.cmake | 3 ++- 5 files changed, 28 insertions(+), 6 deletions(-) rename doc/doxygen/{tutorial.doc => tutorial_msg.doc} (97%) create mode 100644 doc/doxygen/tutorial_smpi.doc diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index 96b7571e64..70717d6a9a 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -659,7 +659,8 @@ INPUT = doxygen/index.doc \ doxygen/outcomes_logs.doc \ doxygen/outcomes_vizu.doc \ doxygen/outcomes_MC.doc \ - doxygen/tutorial.doc \ + doxygen/tutorial_msg.doc \ + doxygen/tutorial_smpi.doc \ doxygen/examples.doc \ doxygen/howtos.doc \ doxygen/uhood.doc \ diff --git a/doc/doxygen/index.doc b/doc/doxygen/index.doc index f5240b7b6b..b12ea4fea0 100644 --- a/doc/doxygen/index.doc +++ b/doc/doxygen/index.doc @@ -13,6 +13,8 @@ - @subpage getting_started - @subpage install - @subpage install_yours + - @subpage tutorial_msg "Tutorial with MSG" + - @subpage tutorial_smpi "Tutorials with SMPI" - @subpage application - @subpage s4u_api - @subpage MSG_API @@ -33,7 +35,6 @@ - @subpage howto - Energy, Clouds - Scalability Tweaks - - @subpage tutorial - @subpage examples - @subpage uhood - @subpage uhood_arch diff --git a/doc/doxygen/tutorial.doc b/doc/doxygen/tutorial_msg.doc similarity index 97% rename from doc/doxygen/tutorial.doc rename to doc/doxygen/tutorial_msg.doc index af4bd36ecc..a830c41f1b 100644 --- a/doc/doxygen/tutorial.doc +++ b/doc/doxygen/tutorial_msg.doc @@ -1,4 +1,4 @@ -/*! @page tutorial SimGrid First Tutorial +/*! @page tutorial_msg SimGrid Tutorial with MSG SimGrid is a toolkit providing the core functionalities for the simulation of distributed applications in heterogeneous distributed @@ -138,7 +138,8 @@ directory in one archive file. If you wish, you can find other platform file in As you can see, there is already a little Makefile that compiles everything for you. If you struggle with the compilation, then you should double check -your SimGrid installation. On need, please refer to the @ref install_yours_trouble section. +your @ref install "SimGrid installation". +On need, please refer to the @ref install_yours_trouble section. Once the tiny example has been compiled and it can be easily run as follows: @@ -146,12 +147,17 @@ Once the tiny example has been compiled and it can be easily run as follows: ./masterworker0 platforms/platform.xml deployment0.xml ~~~~ -For a more "fancy" output, you can try: +For a more "fancy" output, you can use simgrid-colorizer. ~~~~{.sh} ./masterworker0 platforms/platform.xml deployment0.xml 2>&1 | simgrid-colorizer ~~~~ +If you installed SimGrid to a non-standard path, you may have to +specify the full path to simgrid-colorizer on the above line, such as +\c /opt/simgrid/bin/simgrid-colorizer. If you did not install it at all, +you can find it in /bin/colorize. + For a really fancy output, you should use [viva/triva][fn:1]: ~~~~{.sh} diff --git a/doc/doxygen/tutorial_smpi.doc b/doc/doxygen/tutorial_smpi.doc new file mode 100644 index 0000000000..0261df8521 --- /dev/null +++ b/doc/doxygen/tutorial_smpi.doc @@ -0,0 +1,13 @@ +/*! @page tutorial_smpi SMPI Tutorials + +We regularly use SimGrid in our teachings on MPI. This way, our +student can experiment with platforms that they do not have access to, +and the associated visualisation tools helps them to understand their +work. + +The whole material is available online, in a separate project: +the SMPI +CourseWare. + + +*/ diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake index 452314dc52..fe90e71f2e 100644 --- a/tools/cmake/DefinePackages.cmake +++ b/tools/cmake/DefinePackages.cmake @@ -831,7 +831,8 @@ set(DOC_SOURCES doc/doxygen/install.doc doc/doxygen/install_yours.doc doc/doxygen/java.doc - doc/doxygen/tutorial.doc + doc/doxygen/tutorial_msg.doc + doc/doxygen/tutorial_smpi.doc doc/doxygen/models.doc doc/doxygen/module-msg.doc doc/doxygen/module-s4u.doc -- 2.20.1