Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
start refunding the userguide
[simgrid.git] / doc / user_guide / doxygen / index.doc
diff --git a/doc/user_guide/doxygen/index.doc b/doc/user_guide/doxygen/index.doc
deleted file mode 100644 (file)
index 33d26a6..0000000
+++ /dev/null
@@ -1,132 +0,0 @@
-/*!  
-@mainpage SimGrid User Guide
-<center>
-\htmlonly
-<table width="100%">
-       <tr>
-               <td valign="middle" align="left">
-                               <img src="simgrid_logo_2011.png" alt="SimGrid - Scalable simulation of distributed systems, ranging from grids to peer-to-peer systems" />
-               </td>
-               <td valign="middle" align="left">
-\endhtmlonly
-\htmlonly
-               </td>
-       </tr>
-</table>
-\endhtmlonly
-</center>
-
-Welcome to the SimGrid user guide. In this document, you will find how to install, get started, configure, and run your first simulation with SimGrid.
-
-\section sim_over SimGrid Overview
-SimGrid is a toolkit that provides core functionalities for the simulation
-of distributed applications in heterogeneous distributed environments.
-
-The specific goal of the project is to facilitate research in the area of
-distributed and parallel application scheduling on distributed computing
-platforms ranging from simple network of workstations to Computational
-Grids.
-
-  - The official webpage is <a href="http://simgrid.gforge.inria.fr/">simgrid.gforge.inria.fr</a>.
-  - The Frequently Asked Questions for the latest version are <a href="http://simgrid.gforge.inria.fr/simgrid/latest/doc/FAQ.html">here</a>.
-  - The development webpage is <a href="https://gforge.inria.fr/projects/simgrid//">gforge.inria.fr/projects/simgrid</a>.
-  - The user mailing list is <simgrid-user@lists.gforge.inria.fr>
-  - The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.html">here</a>.
-<br>
-
-<hr>
-
-\section ug_overview Overview of the toolkit components
-
-As depicted by the following diagram, the SimGrid toolkit is basically
-three-layered (click on the picture to jump to a specific component).
-
-
-\htmlonly
-<center>
-\endhtmlonly
-\htmlinclude simgrid_modules.map
-\htmlonly
-<br><b>Relationships between the SimGrid components (click to jump to API)</b>
-</center>
-\endhtmlonly
-
-
-\subsection ug_overview_envs Programmation environments layer
-
-SimGrid provides several programmation environments built on top of a unique
-simulation kernel. Each environment targets a specific audiance 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 theoritical problem and compare several
-   heuristics, you probably want to try <b>\ref MSG_API</b> (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 behaviour of a MPI application using emulation
-   technics, you should have a look at the <b>\ref SMPI_API</b> (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
-<a href=http://lists.gforge.inria.fr/mailman/listinfo/simgrid-devel>SimGrid
-developers mailing list</a>, though.
-
-\subsection ug_overview_kernel Simulation kernel layer
-
-The core functionnalities to simulate a virtual platform are provided by a
-module called <b>\ref SURF_API</b>.  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 litterature.
-
-See the \ref SURF_API section for more details.
-
-\subsection ug_overview_fondation Base layer
-
-The base of the whole toolkit is constituted by the <b>\ref XBT_API
-(eXtended Bundle of Tools)</b>.
-
-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 datastructures: \ref XBT_dynar, \ref XBT_fifo, \ref
-XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag.
-
-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
-
-
-<br>
-The SimGrid software package can be downloaded from
-<a href="http://simgrid.gforge.inria.fr/download.html">here</a>.<br>
-
-If you are interested in the history of SimGrid and in current and planned development,
-you can find out more <a href="http://simgrid.gforge.inria.fr/history.html">here</a>.
-
-Any question, remark or suggestion are welcome on the
-<a href="http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user">SimGrid users
-mailing list</a>.
-
-
-<hr>
-\htmlonly
-<center>
-<a href="http://creativecommons.org/licenses/LGPL/2.1/"><img alt="CC-GNU LGPL" border="0" src="http://creativecommons.org/images/public/cc-LGPL-a.png" /></a>
-</center>
-\endhtmlonly
-
-
-*/