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 dependencies (optional)
104 - On Debian / Ubuntu: ``apt install libunwind-dev libdw-dev libelf-dev libevent-dev``
106 - On Debian / Ubuntu: ``apt install libeigen3-dev``
107 - On CentOS / Fedora: ``dnf install eigen3-devel``
108 - On macOS with homebrew: ``brew install eigen``
109 - Use EIGEN3_HINT to specify where it's installed if cmake doesn't find it automatically.
111 For platform-specific details, please see below.
116 Grab the last **stable release** from `FramaGit
117 <https://framagit.org/simgrid/simgrid/-/releases>`_, and compile it as follows:
119 .. code-block:: console
121 $ tar xf simgrid-3-XX.tar.gz
123 $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid -GNinja .
127 If you want to stay on the **bleeding edge**, get the current git version,
128 and recompile it as with stable archives. You may need some extra
131 .. code-block:: console
133 $ git clone https://framagit.org/simgrid/simgrid.git
135 $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
139 .. _install_src_config:
144 This section is about **compile-time options**, which are very
145 different from :ref:`run-time options <options>`. Compile-time options
146 fall into two categories. **SimGrid-specific options** define which part
147 of the framework to compile while **Generic options** are provided by
152 Our build system often gets mixed up if you change something on
153 your machine after the build configuration. For example, if
154 SimGrid fails to detect your fortran compiler, it is not enough to
155 install a fortran compiler. You also need to delete all Cmake
156 files, such as ``CMakeCache.txt``. Since Cmake also generates some
157 files in the tree, you may need to wipe out your complete tree and
158 start with a fresh one when you install new dependencies.
160 A better solution is to :ref:`build out of the source tree <install_cmake_outsrc>`.
162 Generic build-time options
163 """"""""""""""""""""""""""
165 These options specify, for example, the path to various system elements (Python
166 path, compiler to use, etc). In most case, CMake automatically discovers the
167 right value for these elements, but you can set them manually as needed.
168 Notably, such variables include ``CC`` and ``CXX``, defining the paths to the C
169 and C++ compilers; ``CFLAGS`` and ``CXXFLAGS`` specifying extra options to pass
170 to the C and C++ compilers; and ``PYTHON_EXECUTABLE`` specifying the path to the
173 The best way to discover the exact name of the option that you need to
174 change is to press ``t`` in the ``ccmake`` graphical interface, as all
175 options are shown (and documented) in the advanced mode.
177 Once you know their name, there are several ways to change the values of
178 build-time options. You can naturally use the ccmake graphical
179 interface for that, or you can use environment variables, or you can
180 prefer the ``-D`` flag of ``cmake``.
182 For example, you can change the compilers by issuing these commands to set some
183 environment variables before launching cmake:
185 .. code-block:: console
190 The same can be done by passing ``-D`` parameters to cmake, as follows.
191 Note that the dot at the end is mandatory (see :ref:`install_cmake_outsrc`).
193 .. code-block:: console
195 $ cmake -DCC=clang -DCXX=clang++ .
197 SimGrid compilation options
198 """""""""""""""""""""""""""
200 Here is the list of all SimGrid-specific compile-time options (the
201 default choice is in upper case).
203 CMAKE_INSTALL_PREFIX (path)
204 Where to install SimGrid (/opt/simgrid, /usr/local, or elsewhere).
206 enable_compile_optimizations (ON/off)
207 Ask the compiler to produce efficient code. You probably want to
208 leave this option activated, unless you plan to modify SimGrid itself:
209 efficient code takes more time to compile, and appears mangled to some debuggers.
211 enable_compile_warnings (on/OFF)
212 Ask the compiler to issue error messages whenever the source
213 code is not perfectly clean. If you are a SimGrid developer, you
214 have to activate this option to enforce the code quality. As a
215 regular user, this option is of little use.
217 enable_debug (ON/off)
218 Disabling this option discards all log messages of severity
219 debug or below at compile time (see :ref:`outcome_logs`). The resulting
220 code is marginaly faster than if you discard these messages at
221 runtime, but it obviously becomes impossible to get any debug
222 info from SimGrid when things go wrong.
224 enable_documentation (on/OFF)
225 Generates the documentation pages. Building the documentation is not
226 as easy as it used to be, and you should probably use the online
230 Enables the *Link Time Optimization* in the C++ compiler.
231 This feature really speeds up the code produced, but it is fragile
232 with older gcc versions.
234 enable_maintainer_mode (on/OFF)
235 (dev only) Regenerates the XML parsers whenever the DTD is modified (requires flex and flexml).
237 enable_mallocators (ON/off)
238 Activates our internal memory caching mechanism. This produces faster
239 code, but it may fool the debuggers.
241 enable_model-checking (on/OFF)
242 Activates the formal verification mode. This will hinder simulation speed even when the model checker is not activated at run
243 time, because some optimizations such as LTO must be disabled at compile time. You need to have the :ref:`required
244 build-dependencies <install_src_deps>` to activate this option.
247 Activates the ns-3 bindings. See section :ref:`models_ns3`.
250 Allows one to run MPI code on top of SimGrid.
252 enable_smpi_MBI_testsuite (on/OFF)
253 Adds many extra tests for the model checker module.
255 enable_smpi_MPICH3_testsuite (on/OFF)
256 Adds many extra tests for the MPI module.
258 minimal-bindings (on/OFF)
259 Take as few optional dependencies as possible, to get minimal
260 library bindings in Python.
262 NS3_HINT (empty by default)
263 Alternative path into which ns-3 should be searched for.
265 EIGEN3_HINT (empty by default)
266 Alternative path into which Eigen3 should be searched for.
268 SIMGRID_PYTHON_LIBDIR (auto-detected)
269 Where to install the Python module library. By default, it is set to the cmake Python3_SITEARCH variable if installing to /usr,
270 and a modified version of that variable if installing to another path. Just force another value if the auto-detected default
271 does not fit your setup.
273 SMPI_C_FLAGS, SMPI_CXX_FLAGS, SMPI_Fortran_FLAGS (string)
274 Default compiler options to use in smpicc, smpicxx, or smpiff.
275 This can be useful to set options like "-m32" or "-m64".
277 Reset the build configuration
278 """""""""""""""""""""""""""""
280 To empty the CMake cache (either when you add a new library or when
281 things go seriously wrong), simply delete your ``CMakeCache.txt``. You
282 may also want to directly edit this file in some circumstances.
284 .. _install_cmake_outsrc:
286 Out of Tree Compilation
287 ^^^^^^^^^^^^^^^^^^^^^^^
289 By default, the files produced during the compilation are placed in
290 the source directory. It is however often better to put them all in a
291 separate directory: cleaning the tree becomes as easy as removing this
292 directory, and you can have several such directories to test several
293 parameter sets or architectures.
295 For that, go to the directory where the files should be produced, and
296 invoke cmake (or ccmake) with the full path to the SimGrid source as
299 .. code-block:: console
306 Existing Compilation Targets
307 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
309 In most cases, compiling and installing SimGrid is enough:
311 .. code-block:: console
314 $ make install # try "sudo make install" if you don't have the permission to write
316 In addition, several compilation targets are provided in SimGrid. If
317 your system is well configured, the full list of targets is available
318 for completion when using the ``Tab`` key. Note that some of the
319 existing targets are not really for public consumption so don't worry
320 if some do not work for you.
322 - **make**: Build the core of SimGrid that gets installed, but not any example.
323 - **make tests**: Build the tests and examples.
324 - **make simgrid**: Build only the SimGrid library. Not any example nor the helper tools.
325 - **make s4u-comm-pingpong**: Build only this example (works for any example)
326 - **make python-bindings**: Build the Python bindings
327 - **make clean**: Clean the results of a previous compilation
328 - **make install**: Install the project (doc/ bin/ lib/ include/)
329 - **make dist**: Build a distribution archive (tar.gz)
330 - **make distcheck**: Check the dist (make + make dist + tests on the distribution)
331 - **make documentation**: Create SimGrid documentation
333 If you want to see what is really happening, try adding ``VERBOSE=1`` to
334 your compilation requests:
336 .. code-block:: console
340 .. _install_src_test:
345 Once everything is built, you may want to test the result. SimGrid
346 comes with an extensive set of regression tests (as described in the
347 @ref inside_tests "insider manual"). The tests are not built by
348 default, so you first have to build them with ``make tests``. You can
349 then run them with ``ctest``, that comes with CMake. We run them
350 every commit and the results are on `our Jenkins <https://ci.inria.fr/simgrid/>`_.
352 .. code-block:: console
354 $ make tests # Build the tests
355 $ ctest # Launch all tests
356 $ ctest -R s4u # Launch only the tests whose names match the string "s4u"
357 $ ctest -j4 # Launch all tests in parallel, at most 4 concurrent jobs
358 $ ctest --verbose # Display all details on what's going on
359 $ ctest --output-on-failure # Only get verbose for the tests that fail
361 $ ctest -R s4u -j4 --output-on-failure # You changed S4U and want to check that you \
362 # didn't break anything, huh? \
363 # That's fine, I do so all the time myself.
365 .. _install_cmake_mac:
367 macOS-specific instructions
368 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
370 SimGrid compiles like a charm with clang (version 3.0 or higher) on macOS:
372 .. code-block:: console
374 $ cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
378 Troubleshooting your macOS build.
380 CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
381 This was reported with the XCode version of clang 4.1. The work
382 around is to edit the ``CMakeCache.txt`` file directly, to change
385 ``CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer``
387 You can safely ignore the warning about "-pthread" not being used, if it appears.
389 /usr/include does not seem to exist
390 This directory does not exist by default on modern macOS versions,
391 and you may need to create it with ``xcode-select -install``
393 .. _install_cmake_windows:
395 Windows-specific instructions
396 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
398 The best solution to get SimGrid working on windows is to install the
399 Ubuntu subsystem of Windows 10. All of SimGrid (but the model checker)
400 works in this setting. Native builds never really worked, and they are
401 disabled starting with SimGrid v3.33.
403 Python-specific instructions
404 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
406 Once you have the Python development headers installed as well as a
407 recent version of the `pybind11 <https://pybind11.readthedocs.io/en/stable/>`_
408 module (version at least 2.4), recompiling the Python bindings from
409 the source should be as easy as:
411 .. code-block:: console
413 # cd simgrid-source-tree
414 $ python setup.py build install
416 Starting with SimGrid 3.13, it should even be possible to install
417 simgrid without downloading the source with pip:
419 .. code-block:: console
421 $ pip install simgrid