Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
rewrite the doc on configuring simgrid
[simgrid.git] / doc / index.doc
index c7def67..07a91f4 100644 (file)
@@ -2,56 +2,36 @@
 
 <center>
 \htmlonly
-<img align=center src="simgrid_logo.png" alt="SimGrid"><br>
+<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
+\htmlinclude .index.doc.toc                    
+\htmlonly
+               </td> 
+       </tr> 
+</table> 
 \endhtmlonly
 </center>
 
-\htmlinclude index.toc
-
-\section hot_news HOT NEWS
-
-<b>SimGrid 3.0.1 was released on 22st of October 2005. Get it from
-<a href="https://gforge.inria.fr/frs/?group_id=12">here</a>.</b> 
-
-\section quick Quick start
-
 SimGrid is a toolkit that provides core functionalities for the simulation
 of distributed applications in heterogeneous distributed environments.
+\htmlonly <!-- ______BODY_BEGIN______ --!> \endhtmlonly
 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.
-
-\subsection quick_dl Getting and installing the software
+\htmlonly <!-- ______BODY_END______ --!> \endhtmlonly
 
   - The official webpage is <a href="http://simgrid.gforge.inria.fr/">simgrid.gforge.inria.fr</a>. 
+  - The Frequently Asked Questions are <a href="http://simgrid.gforge.inria.fr/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="https://gforge.inria.fr/frs/?group_id=12">here</a>. 
-
-To compile and install it, simply type the following. If you are not
-familiar with compiling C files under UNIX and using libraries, please check
-the \ref faq. SimGrid also works under Windows, but we do not distribute any
-pre-compiled binaries [yet].
-
-\verbatim $ ./configure
- $ make all
- [become root]
- # make install\endverbatim
-\subsection quick_more More information
-
-The API (along with some example of
-use) is described in \ref SimGrid_API.
-
-For more information about the SimGrid toolkit, please simply keep reading
-this page. It is organized as follow:
-
-  - \ref overview : Presentation of the toolkit, of each of its components
-    and of their interactions.
-  - \ref people : Who is behind this project.
-  - \ref publis : Some articles providing more details about the
-    SimGrid toolkit or using and validating it.
+  - The SimGrid software package can be downloaded from <a href="http://simgrid.gforge.inria.fr/download.php">here</a>.
+<br>
 
 <hr>
 
@@ -60,19 +40,20 @@ this page. It is organized as follow:
 As depicted by the following diagram, the SimGrid toolkit is basically
 three-layered (click on the picture to jump to a specific component).
 
-
+\htmlonly <!-- ______BODY_BEGIN______ --!> \endhtmlonly
 \htmlonly
 <center>
 \endhtmlonly
 \htmlinclude simgrid_modules.map
 \htmlonly
-<br><b>Relationships between the SimGrid components</b>
+<br><b>Relationships between the SimGrid components (click to jump to API)</b>
 </center>
 \endhtmlonly
+\htmlonly <!-- ______BODY_END______ --!> \endhtmlonly
 
 \subsection overview_envs Programmation environments layer
 
-SimGrid provides several programmation environments built on top of a uniq
+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
@@ -108,7 +89,7 @@ your work.
    See the \ref GRAS_API section for more details.
 
 If your favorite programming environment/model is not there (BSP,
-components, DAG, etc.) is not represented in the SimGrid toolkit yet, you may
+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.
@@ -116,7 +97,7 @@ developers mailing list</a>, though.
 \subsection overview_kernel Simulation kernel layer
 
 The core functionnalities to simulate a virtual platform are provided by a
-module called <b>\ref SURF_API</b> ("that's historical, my friend").  It is
+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.
 
@@ -139,33 +120,25 @@ XBT_dict, \ref XBT_heap, \ref XBT_set and \ref XBT_swag.
 See the \ref XBT_API section for more details.
 
 
-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>
-
-\section people People
-
-SimGrid is a joint project between University of Hawai at Manoa, ID
-Laboratory (Grenoble, France) and University of Nancy (France). The
-authors of SimGrid are:
+\htmlonly <!-- ______BODY_BEGIN______ --!> \endhtmlonly
+<br>
+The SimGrid software package can be downloaded from 
+<a href="http://simgrid.gforge.inria.fr/download.php">here</a>.<br>
 
- - Henri Casanova <casanova#cs.ucsd.edu> (Information and Computer Sciences Department, University of Hawai`i at Manoa)
- - Arnaud Legrand <arnaud.legrand#imag.fr> ("Informatique et Distribution" Laboratory (Grenoble, France), MESCal project)
- - Martin Quinson <martin.quinson#loria.fr> (University of Nancy (Nancy, France), LORIA Laboratory, Algorille project)
+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>.
 
-\subsection contributers Contributers and alumni project members
+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>.
 
- - Loris Marchal: wrote the algorithm for simulation TCP bandwidth-sharing.
- - Julien Lerouge : wrote a XML parser for ENV descriptions and helped for
-   the general design during a 4 month period (march-june 2002) 
-   in the LIP.
- - ClĂ©ment Menier and Marc Perache : wrote a first prototype of the MSG
-   interface during a project at ENS-Lyon (jan 2002). 
- - Dmitrii Zagorodnov : wrote some parts of the first version of SimGrid
-   (1999). 
+\htmlonly <!-- ______BODY_END______ --!> \endhtmlonly
 
 <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
 
 */