X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3109acfa21fc51d0227ce2e14562ddc7f2c0fca9..20f5604e5582663868f57fb5db28a88929ac3d43:/doc/doxygen/inside.doc diff --git a/doc/doxygen/inside.doc b/doc/doxygen/inside.doc deleted file mode 100644 index 04c4122c8c..0000000000 --- a/doc/doxygen/inside.doc +++ /dev/null @@ -1,96 +0,0 @@ -/*! @page inside Coding Standard and Project Architecture - -TBD: Coding Standard - -There is two main things you want to know about the internals of -SimGrid. First, you need to understand the component organization, as -SimGrid is heavily layered, with each level being rather highly -specialized and optimized toward a task. For that, please keep reading -this page. If you work actively on the SimGrid project, the second -point you need to understand is about the infrastructure of the -SimGrid project, ie how to extend the framework in any way, how the -automatic tests are run, and so on. These informations are split on -several pages, as follows: - - - @subpage inside_tests - - @subpage inside_doxygen - - @subpage inside_extending - - @subpage inside_cmake - - @subpage inside_release - - -\htmlonly - -\endhtmlonly -\htmlinclude simgrid_modules.map -\htmlonly -
SimGrid Components (click to jump to API) - -\endhtmlonly - - -\section ug_overview Overview of the toolkit components - - -\subsection ug_overview_envs Programing environments layer - -SimGrid provides several programming environments built on top of a unique -simulation kernel. Each environment targets a specific audience and -constitutes a different paradigm. To choose which of them you want to use, -you have to think about what you want to do and what would be the result of -your work. - - - If you want to study a theoretical problem and compare several - heuristics, you probably want to try \ref MSG_API (yet another - historical name). It was designed exactly to that extend and should allow - you to build easily rather realistic multi-agents simulation. Yet, - realism is not the main goal of this environment and the most annoying - technical issues of real platforms are masked here. Check the \ref - MSG_API section for more information. - - - If you want to study the behavior of a MPI application using emulation, - you should have a look at the \ref SMPI_API (Simulated - MPI) programming environment. Unfortunately, this work is still underway. - Check the \ref SMPI_API section for more information. - -If your favorite programming environment/model is not there (BSP, -components, OpenMP, etc.) is not represented in the SimGrid toolkit yet, you may -consider adding it. You should contact us first on the -SimGrid -developers mailing list, though. - -\subsection ug_overview_kernel Simulation kernel layer - -The core functionalities to simulate a virtual platform are provided by a -module called \ref SURF_API. It is -very low-level and is not intended to be used as such by end-users. Instead, -it serve as a basis for the higher level layer. - -SURF main features are a fast max-min linear solver and the ability to -change transparently the model used to describe the platform. This greatly -eases the comparison of the several models existing in the literature. - -See the \ref SURF_API section for more details. - -\subsection ug_overview_fundation Base layer - -The base of the whole toolkit is constituted by the \ref XBT_API -(eXtended Bundle of Tools). - -It is a portable library providing some grounding features such as \ref -XBT_log, \ref XBT_ex and \ref XBT_config. - -XBT also encompass the following convenient C data structures: -\ref XBT_dynar, \ref XBT_fifo, \ref XBT_dict, \ref XBT_heap, \ref XBT_set and -\ref XBT_swag. The code is being migrated in C++ so you should probably want -to use standard C++ containers instead of them if possible. - -It contains some C++ polyfills and utilities as well. - -See the \ref XBT_API section for more details. - - -\subsection ug_lucas_layer Tracing simulation -Finally, a transversal module allows you to trace your simulation. More documentation in the section \ref TRACE_doc - -*/