9 SimGrid should work out of the box on Linux, macOS, FreeBSD, and
18 To get all of SimGrid on Debian or Ubuntu, simply type one of the
19 following lines, or several lines if you need several languages.
21 .. code-block:: console
23 $ apt install libsimgrid-dev # if you want to develop in C or C++
24 $ apt install python3-simgrid # if you want to develop in Python
26 If you use the Nix_ package manager, the latest SimGrid release is packaged as ``simgrid`` in Nixpkgs_.
27 Previous SimGrid versions are maintained in `NUR-Kapack`_ and are available
28 pre-compiled in release and debug modes on the `capack cachix binary cache`_
29 — refer to `NUR-Kapack's documentation`_ for usage instructions.
31 If you use a pacman-based system (*e.g.*, Arch Linux and derived distributions),
32 the latest SimGrid is available in the `simgrid AUR package`_
33 — refer to `AUR official documentation`_ for installation instructions.
35 If you build pre-compiled packages for other distributions, drop us an
38 .. _Nix: https://nixos.org/
39 .. _Nixpkgs: https://github.com/NixOS/nixpkgs
40 .. _NUR-Kapack: https://github.com/oar-team/nur-kapack
41 .. _capack cachix binary cache: https://app.cachix.org/cache/capack
42 .. _NUR-Kapack's documentation: https://github.com/oar-team/nur-kapack
43 .. _simgrid AUR package: https://aur.archlinux.org/packages/simgrid/
44 .. _AUR official documentation: https://wiki.archlinux.org/title/Arch_User_Repository
46 .. _deprecation_policy:
48 Version numbering and deprecation
49 ---------------------------------
51 SimGrid tries to be both a research instrument that you can trust, and
52 a vivid project targeting the future issues. We have 4 stable versions
53 per year, numbered 3.24 or 3.25. Backward compatibility is ensured for
54 one year: Code compiling without warning on 3.24 will still compile
55 with 3.28, but maybe with some deprecation warnings. You should update
56 your SimGrid installation at least once a year and fix those
57 deprecation warnings: the compatibility wrappers are usually removed
58 after 4 versions. Another approach is to never update your SimGrid
59 installation, but we don't provide any support to old versions.
61 Interim versions (also called pre-versions) may be released between
62 stable releases. They are numbered 3.X.Y, with even Y (for example,
63 3.23.2 was released on July 8. 2019 as a pre-version of 3.24). These
64 versions should be as usable as regular stable releases, even if they
65 may be somewhat less tested and documented. They play no role in our
66 deprecation handling, and they are not really announced to not spam
69 Version numbered 3.X.Y with odd Y are git versions. They often work,
70 but no guarantee is given whatsoever (all releases are given "as is",
71 but that's even more so for these unreleased versions).
75 Installing from the Source
76 --------------------------
80 Getting the Dependencies
81 ^^^^^^^^^^^^^^^^^^^^^^^^
83 C++ compiler (either g++, clang, or icc).
84 We use the C++17 standard, and older compilers tend to fail on
85 us. It seems that g++ 7.0 or higher is required nowadays (because of
86 boost). SimGrid compiles well with `clang` or `icc` too.
88 SimGrid should build without Python. That is only needed by our regression test suite.
90 ``ccmake`` provides a nicer graphical interface compared to ``cmake``.
91 Press ``t`` in ``ccmake`` if you need to see absolutely all
92 configuration options (e.g., if your Python installation is not standard).
93 boost mandatory components (at least v1.48, v1.59 recommended)
94 - On Debian / Ubuntu: ``apt install libboost-dev``
95 - On CentOS / Fedora: ``dnf install boost-devel``
96 - On macOS with homebrew: ``brew install boost``
97 boost recommended components (optional).
98 - boost-context may be used instead of our own fast context switching code which only works on amd64.
99 - boost-stacktrace is used to get nice stacktraces on errors in SimGrid.
100 - On Debian / Ubuntu: ``apt install libboost-context-dev libboost-stacktrace-dev``
101 python bindings (optional):
102 - On Debian / Ubuntu: ``apt install pybind11-dev python3-dev``
103 Model-checking mandatory dependencies
104 - On Debian / Ubuntu: ``apt install libevent-dev``
105 Model-checking optional dependencies
106 - On Debian / Ubuntu: ``apt install libunwind-dev libdw-dev libelf-dev``
108 - On Debian / Ubuntu: ``apt install libeigen3-dev``
109 - On CentOS / Fedora: ``dnf install eigen3-devel``
110 - On macOS with homebrew: ``brew install eigen``
111 - Use EIGEN3_HINT to specify where it's installed if cmake doesn't find it automatically. Set EIGEN3_HINT=OFF to disable detection even if it could be found.
112 JSON (optional, for the DAG wfcommons loader)
113 - On Debian / Ubuntu: ``apt install nlohmann-json3-dev``
114 - Use nlohmann_json_HINT to specify where it's installed if cmake doesn't find it automatically.
116 For platform-specific details, please see below.
121 Grab the last **stable release** from `FramaGit
122 <https://framagit.org/simgrid/simgrid/-/releases>`_, and compile it as follows:
124 .. code-block:: console
126 $ tar xf simgrid-3-XX.tar.gz
128 $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid -GNinja .
132 If you want to stay on the **bleeding edge**, get the current git version,
133 and recompile it as with stable archives. You may need some extra
136 .. code-block:: console
138 $ git clone https://framagit.org/simgrid/simgrid.git
140 $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
144 .. _install_src_config:
149 This section is about **compile-time options**, which are very
150 different from :ref:`run-time options <options>`. Compile-time options
151 fall into two categories. **SimGrid-specific options** define which part
152 of the framework to compile while **Generic options** are provided by
157 Our build system often gets mixed up if you change something on
158 your machine after the build configuration. For example, if
159 SimGrid fails to detect your fortran compiler, it is not enough to
160 install a fortran compiler. You also need to delete all Cmake
161 files, such as ``CMakeCache.txt``. Since Cmake also generates some
162 files in the tree, you may need to wipe out your complete tree and
163 start with a fresh one when you install new dependencies.
165 A better solution is to :ref:`build out of the source tree <install_cmake_outsrc>`.
167 Generic build-time options
168 """"""""""""""""""""""""""
170 These options specify, for example, the path to various system elements (Python
171 path, compiler to use, etc). In most case, CMake automatically discovers the
172 right value for these elements, but you can set them manually as needed.
173 Notably, such variables include ``CC`` and ``CXX``, defining the paths to the C
174 and C++ compilers; ``CFLAGS`` and ``CXXFLAGS`` specifying extra options to pass
175 to the C and C++ compilers; and ``PYTHON_EXECUTABLE`` specifying the path to the
178 The best way to discover the exact name of the option that you need to
179 change is to press ``t`` in the ``ccmake`` graphical interface, as all
180 options are shown (and documented) in the advanced mode.
182 Once you know their name, there are several ways to change the values of
183 build-time options. You can naturally use the ccmake graphical
184 interface for that, or you can use environment variables, or you can
185 prefer the ``-D`` flag of ``cmake``.
187 For example, you can change the compilers by issuing these commands to set some
188 environment variables before launching cmake:
190 .. code-block:: console
195 The same can be done by passing ``-D`` parameters to cmake, as follows.
196 Note that the dot at the end is mandatory (see :ref:`install_cmake_outsrc`).
198 .. code-block:: console
200 $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ .
202 SimGrid compilation options
203 """""""""""""""""""""""""""
205 Here is the list of all SimGrid-specific compile-time options (the
206 default choice is in upper case).
208 CMAKE_INSTALL_PREFIX (path)
209 Where to install SimGrid (/opt/simgrid, /usr/local, or elsewhere).
211 enable_compile_optimizations (ON/off)
212 Ask the compiler to produce efficient code. You probably want to
213 leave this option activated, unless you plan to modify SimGrid itself:
214 efficient code takes more time to compile, and appears mangled to some debuggers.
216 enable_compile_warnings (on/OFF)
217 Ask the compiler to issue error messages whenever the source
218 code is not perfectly clean. If you are a SimGrid developer, you
219 have to activate this option to enforce the code quality. As a
220 regular user, this option is of little use.
222 enable_debug (ON/off)
223 Disabling this option discards all log messages of severity
224 debug or below at compile time (see :ref:`outcome_logs`). The resulting
225 code is marginaly faster than if you discard these messages at
226 runtime, but it obviously becomes impossible to get any debug
227 info from SimGrid when things go wrong.
229 enable_documentation (on/OFF)
230 Generates the documentation pages. Building the documentation is not
231 as easy as it used to be, and you should probably use the online
235 Enables the *Link Time Optimization* in the C++ compiler.
236 This feature really speeds up the code produced, but it is fragile
237 with older gcc versions.
239 enable_maintainer_mode (on/OFF)
240 (dev only) Regenerates the XML parsers whenever the DTD is modified (requires flex and flexml).
242 enable_mallocators (ON/off)
243 Activates our internal memory caching mechanism. This produces faster
244 code, but it may fool the debuggers.
246 enable_model-checking (on/OFF)
247 Activates the liveness verification mode. This will hinder simulation speed even when the model checker is not activated at run
248 time, because some optimizations such as LTO must be disabled at compile time. You need to have the :ref:`required
249 build-dependencies <install_src_deps>` to activate this option.
252 Activates the ns-3 bindings. See section :ref:`models_ns3`.
255 Allows one to run MPI code on top of SimGrid.
257 enable_testsuite_McMini (on/OFF)
258 Adds several extra tests for the model checker module (targeting threaded applications).
260 enable_testsuite_smpi_MBI (on/OFF)
261 Adds many extra tests for the model checker module (targeting MPI applications).
263 enable_testsuite_smpi_MPICH3 (on/OFF)
264 Adds many extra tests for the MPI module.
266 minimal-bindings (on/OFF)
267 Take as few optional dependencies as possible, to get minimal
268 library bindings in Python.
270 NS3_HINT (empty by default)
271 Alternative path into which ns-3 should be searched for.
273 EIGEN3_HINT (empty by default)
274 Alternative path into which Eigen3 should be searched for.
275 Providing the value OFF as an hint will disable the detection alltogether.
277 SIMGRID_PYTHON_LIBDIR (auto-detected)
278 Where to install the Python module library. By default, it is set to the cmake Python3_SITEARCH variable if installing to /usr,
279 and a modified version of that variable if installing to another path. Just force another value if the auto-detected default
280 does not fit your setup.
282 SMPI_C_FLAGS, SMPI_CXX_FLAGS, SMPI_Fortran_FLAGS (string)
283 Default compiler options to use in smpicc, smpicxx, or smpiff.
284 This can be useful to set options like "-m32" or "-m64".
286 Reset the build configuration
287 """""""""""""""""""""""""""""
289 To empty the CMake cache (either when you add a new library or when
290 things go seriously wrong), simply delete your ``CMakeCache.txt``. You
291 may also want to directly edit this file in some circumstances.
293 .. _install_cmake_outsrc:
295 Out of Tree Compilation
296 ^^^^^^^^^^^^^^^^^^^^^^^
298 By default, the files produced during the compilation are placed in
299 the source directory. It is however often better to put them all in a
300 separate directory: cleaning the tree becomes as easy as removing this
301 directory, and you can have several such directories to test several
302 parameter sets or architectures.
304 For that, go to the directory where the files should be produced, and
305 invoke cmake (or ccmake) with the full path to the SimGrid source as
308 .. code-block:: console
315 Existing Compilation Targets
316 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
318 In most cases, compiling and installing SimGrid is enough:
320 .. code-block:: console
323 $ make install # try "sudo make install" if you don't have the permission to write
325 In addition, several compilation targets are provided in SimGrid. If
326 your system is well configured, the full list of targets is available
327 for completion when using the ``Tab`` key. Note that some of the
328 existing targets are not really for public consumption so don't worry
329 if some do not work for you.
331 - **make**: Build the core of SimGrid that gets installed, but not any example.
332 - **make examples**: Build the examples, which are needed by the tests.
333 - **make simgrid**: Build only the SimGrid library. Not any example nor the helper tools.
334 - **make s4u-comm-pingpong**: Build only this example (works for any example)
335 - **make python-bindings**: Build the Python bindings
336 - **make clean**: Clean the results of a previous compilation
337 - **make install**: Install the project (doc/ bin/ lib/ include/)
338 - **make dist**: Build a distribution archive (tar.gz)
339 - **make distcheck**: Check the dist (make + make dist + tests on the distribution)
340 - **make documentation**: Create SimGrid documentation
342 If you want to see what is really happening, try adding ``VERBOSE=1`` to
343 your compilation requests:
345 .. code-block:: console
349 .. _install_src_test:
354 Once everything is built, you may want to test the result. SimGrid
355 comes with an extensive set of regression tests (as described in the
356 @ref inside_tests "insider manual"). The tests are not built by
357 default, so you first have to build them with ``make tests``. You can
358 then run them with ``ctest``, that comes with CMake. We run them
359 every commit and the results are on `our Jenkins <https://ci.inria.fr/simgrid/>`_.
361 .. code-block:: console
363 $ make tests # Build the tests
364 $ ctest # Launch all tests
365 $ ctest -R s4u # Launch only the tests whose names match the string "s4u"
366 $ ctest -j4 # Launch all tests in parallel, at most 4 concurrent jobs
367 $ ctest --verbose # Display all details on what's going on
368 $ ctest --output-on-failure # Only get verbose for the tests that fail
370 $ ctest -R s4u -j4 --output-on-failure # You changed S4U and want to check that you \
371 # didn't break anything, huh? \
372 # That's fine, I do so all the time myself.
374 .. _install_cmake_mac:
376 macOS-specific instructions
377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
379 SimGrid compiles like a charm with clang (version 3.0 or higher) on macOS:
381 .. code-block:: console
383 $ cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
387 Troubleshooting your macOS build.
389 CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
390 This was reported with the XCode version of clang 4.1. The work
391 around is to edit the ``CMakeCache.txt`` file directly, to change
394 ``CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer``
396 You can safely ignore the warning about "-pthread" not being used, if it appears.
398 /usr/include does not seem to exist
399 This directory does not exist by default on modern macOS versions,
400 and you may need to create it with ``xcode-select -install``
402 .. _install_cmake_windows:
404 Windows-specific instructions
405 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
407 The best solution to get SimGrid working on windows is to install the
408 Ubuntu subsystem of Windows 10. All of SimGrid (but the liveness model checker)
409 works in this setting. Native builds never really worked, and they are
410 disabled starting with SimGrid v3.33.
412 Python-specific instructions
413 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
415 Once you have the Python development headers installed as well as a
416 recent version of the `pybind11 <https://pybind11.readthedocs.io/en/stable/>`_
417 module (version at least 2.4), recompiling the Python bindings from
418 the source should be as easy as:
420 .. code-block:: console
422 # cd simgrid-source-tree
423 $ python setup.py build install
425 Starting with SimGrid 3.13, it should even be possible to install
426 simgrid without downloading the source with pip:
428 .. code-block:: console
430 $ pip install simgrid
432 If you installed SimGrid to a non-standard directory (such as ``/opt/simgrid`` as advised earlier), you should tell python where
433 to find the libraries as follows (notice the elements suffixed to the configured prefix).
435 .. code-block:: console
437 $ PYTHONPATH="/opt/simgrid/lib/python3/dist-packages" LD_LIBRARY_PATH="/opt/simgrid/lib" python your_script.py
439 You can add those variables to your bash profile to not specify it each time by adding these lines to your ``~/.profile``:
441 .. code-block:: console
443 export PYTHONPATH="$PYTHONPATH:/opt/simgrid/lib/python3/dist-packages"
444 export LD_LIBRARY_PATH="$PYTHONPATH:/opt/simgrid/lib"