Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cosmetics.
[simgrid.git] / README.md
1 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
2 [![Build Status](https://ci.inria.fr/simgrid/buildStatus/icon?job=SimGrid)](https://ci.inria.fr/simgrid/job/SimGrid/)
3 [![Travis Status](https://img.shields.io/travis/simgrid/simgrid/master.svg?logo=travis)](https://travis-ci.org/simgrid/simgrid)
4 [![AppVeyor Status](https://ci.appveyor.com/api/projects/status/gvcssh340fwtoc35?svg=true)](https://ci.appveyor.com/project/mquinson/simgrid)
5 [![SonarCloud Status](https://sonarcloud.io/api/project_badges/measure?project=simgrid_simgrid&metric=alert_status)](https://sonarcloud.io/dashboard/?id=simgrid_simgrid)
6 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/bf1bdba50440485fbda2ac19f462ccc7)](https://www.codacy.com/app/mquinson/simgrid?utm_source=github.com&amp)
7 [![Doc](https://readthedocs.org/projects/pip/badge/?version=stable)](https://simgrid.org/doc/latest/)
8 [![License: LGPL v2.1][license-badge]](COPYING)
9 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1845/badge)](https://bestpractices.coreinfrastructure.org/projects/1845)
10
11 # Welcome to the SimGrid project!
12
13 SimGrid is a scientific instrument to study the behavior of 
14 large-scale distributed systems such as Grids, Clouds, HPC or P2P
15 systems. It can be used to evaluate heuristics, prototype applications 
16 or even assess legacy MPI applications.
17
18 ## Installation
19 Documentation: [online](https://simgrid.org/doc/latest/Installing_SimGrid.html#installing-from-the-source);
20 [local copy](docs/source/Installing_SimGrid.rst). TL;DR:
21 ```
22 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
23 #┬áCheck the full list of options with `cmake -LH`
24 make
25 make install
26 ```
27
28 ## More information
29 [Online documentation](https://simgrid.org/doc/latest/) or 
30 [local version](docs/source).
31
32 You can also ask your questions, or simply discuss with other users on 
33 to the [user mailing list](http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user)
34 or on the #simgrid IRC channel of the oftc network.
35
36
37 Thanks for using our software. Please do great things with it and tell
38 the world about it. Tell us, too, because we love to have positive
39 feedback. Welcome to our community.
40
41 Cheers,
42 Da SimGrid Team.
43
44 [license-badge]: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg
45 [release-badge]: https://img.shields.io/github/release/simgrid/simgrid.svg
46 [release-link]:  https://gforge.inria.fr/frs/?group_id=12