X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/bf1552d3dc6d594e8601b7460f25c8b9e370e4b8..6e8c91fbf97819081008566496f5798182affb59:/doc/doxygen/uhood_arch.doc diff --git a/doc/doxygen/uhood_arch.doc b/doc/doxygen/uhood_arch.doc deleted file mode 100644 index ea0a3eb607..0000000000 --- a/doc/doxygen/uhood_arch.doc +++ /dev/null @@ -1,88 +0,0 @@ -/*! @page uhood_arch Project Architecture Overview - -This page presents the current code organization, as you will see it -if you dig into the src/ directory. But things will change during -the current Gran Refactoring leading to SimGrid 4. So take the -information on this page with a grain of salt, and don't be afraid if -things are not exactly as documented here. - -At some point, we at least extend this page to present the overall -design that we are currently pursuing for SimGrid 4. - -If you need to extend SimGrid, then you probably need to head to @ref -uhood_tech once you understant the overall design presented on this -page. - -@htmlonly -
-htmlinclude simgrid_modules.map -
SimGrid Components (click to jump to API) -
-@endhtmlonly - - -@section ug_overview Overview of the toolkit components - - -@subsection ug_overview_envs Programming 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 an 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 and @ref XBT_dict. -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 - -*/