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 [![Doc](https://readthedocs.org/projects/pip/badge/?version=stable)](https://simgrid.org/doc/latest/)
   7 [![License: LGPL v2.1][license-badge]](COPYING)
   8 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1845/badge)](https://bestpractices.coreinfrastructure.org/projects/1845)
   9
  10 # Welcome to the SimGrid project!
  11
  12 SimGrid is a scientific instrument to study the behavior of
  13 large-scale distributed systems such as Grids, Clouds, HPC or P2P
  14 systems. It can be used to evaluate heuristics, prototype applications
  15 or even assess legacy MPI applications.
  16
  17 ## Installation
  18 Documentation: [online](https://simgrid.org/doc/latest/Installing_SimGrid.html#installing-from-the-source);
  19 [local copy](docs/source/Installing_SimGrid.rst). TL;DR:
  20 ```
  21 cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
  22 # Check the full list of options with `cmake -LH`
  23 make
  24 make install
  25 ```
  26
  27 ## More information
  28 [Online documentation](https://simgrid.org/doc/latest/) or
  29 [local version](docs/source).
  30
  31 You can also ask your questions, or simply discuss with other users on
  32 to the [user mailing list](http://lists.gforge.inria.fr/mailman/listinfo/simgrid-user)
  33 or on the #simgrid IRC channel of the oftc network.
  34
  35
  36 Thanks for using our software. Please do great things with it and tell
  37 the world about it. Tell us, too, because we love to have positive
  38 feedback. Welcome to our community.
  39
  40 Cheers,
  41 Da SimGrid Team.
  42
  43 [license-badge]: https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg
  44 [release-badge]: https://img.shields.io/github/release/simgrid/simgrid.svg
  45 [release-link]:  https://gforge.inria.fr/frs/?group_id=12