9 SimGrid should work out of the box on Linux, macOS, FreeBSD, and
10 Windows (under Windows, you need to install the Windows Subsystem
11 Linux to get more than the Java bindings).
19 To get all of SimGrid on Debian or Ubuntu, simply type one of the
20 following lines, or several lines if you need several languages.
22 .. code-block:: console
24 $ apt install libsimgrid-dev # if you want to develop in C or C++
25 $ apt install simgrid-java # if you want to develop in Java
26 $ apt install python3-simgrid # if you want to develop in Python
28 If you use the Nix_ package manager, the latest SimGrid release is packaged as ``simgrid`` in Nixpkgs_.
29 Previous SimGrid versions are maintained in `NUR-Kapack`_ and are available
30 pre-compiled in release and debug modes on the `capack cachix binary cache`_
31 — refer to `NUR-Kapack's documentation`_ for usage instructions.
33 If you use a pacman-based system (*e.g.*, Arch Linux and derived distributions),
34 the latest SimGrid is available in the `simgrid AUR package`_
35 — refer to `AUR official documentation`_ for installation instructions.
37 If you build pre-compiled packages for other distributions, drop us an
40 .. _Nix: https://nixos.org/
41 .. _Nixpkgs: https://github.com/NixOS/nixpkgs
42 .. _NUR-Kapack: https://github.com/oar-team/nur-kapack
43 .. _capack cachix binary cache: https://app.cachix.org/cache/capack
44 .. _NUR-Kapack's documentation: https://github.com/oar-team/nur-kapack
45 .. _simgrid AUR package: https://aur.archlinux.org/packages/simgrid/
46 .. _AUR official documentation: https://wiki.archlinux.org/title/Arch_User_Repository
48 .. _install_java_precompiled:
53 The jar file can be retrieved from the `Release page
54 <https://framagit.org/simgrid/simgrid/-/releases>`_. This file is
55 self-contained, including the native components for Linux, macOS and
56 Windows. Copy it to your project's classpath and you're set.
58 Nightly built Java Package
59 ^^^^^^^^^^^^^^^^^^^^^^^^^^
61 Head to the corresponding `GitHub Action <https://github.com/simgrid/simgrid/actions/workflows/jarfile.yml>`_
62 and pick the last green build. At the bottom of the build page, click on the ``jar-final`` artefact.
63 Open this zip file to find the jar you need. This jar can be used under Linux, Mac OSX or Windows, as you wish.
65 Binary Java Troubleshooting
66 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
68 Here are some error messages that you may get when trying to use the
71 Your architecture is not supported by this jarfile
72 If your system is not supported, you should compile your
73 own jarfile :ref:`by compiling SimGrid <install_src>` from the source.
74 Library not found: boost-context
75 You should obviously install the ``boost-context`` library on your
76 machine, for example with ``apt``.
78 .. _deprecation_policy:
80 Version numbering and deprecation
81 ---------------------------------
83 SimGrid tries to be both a research instrument that you can trust, and
84 a vivid project targeting the future issues. We have 4 stable versions
85 per year, numbered 3.24 or 3.25. Backward compatibility is ensured for
86 one year: Code compiling without warning on 3.24 will still compile
87 with 3.28, but maybe with some deprecation warnings. You should update
88 your SimGrid installation at least once a year and fix those
89 deprecation warnings: the compatibility wrappers are usually removed
90 after 4 versions. Another approach is to never update your SimGrid
91 installation, but we don't provide any support to old versions.
93 Interim versions (also called pre-versions) may be released between
94 stable releases. They are numbered 3.X.Y, with even Y (for example,
95 3.23.2 was released on July 8. 2019 as a pre-version of 3.24). These
96 versions should be as usable as regular stable releases, even if they
97 may be somewhat less tested and documented. They play no role in our
98 deprecation handling, and they are not really announced to not spam
101 Version numbered 3.X.Y with odd Y are git versions. They often work,
102 but no guarantee is given whatsoever (all releases are given "as is",
103 but that's even more so for these unreleased versions).
107 Installing from the Source
108 --------------------------
110 Getting the Dependencies
111 ^^^^^^^^^^^^^^^^^^^^^^^^
113 C++ compiler (either g++, clang, or icc).
114 We use the C++14 standard, and older compilers tend to fail on
115 us. It seems that g++ 5.0 or higher is required nowadays (because of
116 boost). SimGrid compiles well with `clang` or `icc` too.
118 SimGrid should build without Python. That is only needed by our regression test suite.
120 ``ccmake`` provides a nicer graphical interface compared to ``cmake``.
121 Press ``t`` in ``ccmake`` if you need to see absolutely all
122 configuration options (e.g., if your Python installation is not standard).
123 boost (at least v1.48, v1.59 recommended)
124 - On Debian / Ubuntu: ``apt install libboost-dev libboost-context-dev``
125 - On macOS with homebrew: ``brew install boost``
127 - Debian / Ubuntu: ``apt install default-jdk libgcj18-dev`` (or
128 any version of libgcj)
129 - macOS or Windows: Grab a `full JDK <http://www.oracle.com/technetwork/java/javase/downloads>`_
130 Lua (optional -- must be v5.3)
131 - SimGrid won't work with any other version of Lua.
132 - Debian / Ubuntu: ``apt install liblua5.3-dev lua5.3``
133 - Windows: ``choco install lua53``
135 - You need to patch the sources to build dynamic libraries. First `download lua 5.3 <http://www.lua.org/download.html>`_
136 - Open the archive: ``tar xvfz lua-5.3.*.tar.gz``
137 - Enter the directory: ``cd lua-5.3*``
138 - Patch the sources: ``patch -p1 < /path/to/simgrid/...../tools/lualib.patch``
139 - Build and install lua: ``make linux && sudo make install``
141 For platform-specific details, please see below.
146 Grab the last **stable release** from `FramaGit
147 <https://framagit.org/simgrid/simgrid/-/releases>`_, and compile it as follows:
149 .. code-block:: console
151 $ tar xf simgrid-3-XX.tar.gz
153 $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
157 If you want to stay on the **bleeding edge**, get the current git version,
158 and recompile it as with stable archives. You may need some extra
161 .. code-block:: console
163 $ git clone https://framagit.org/simgrid/simgrid.git
165 $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid .
169 .. _install_src_config:
174 This section is about **compile-time options**, which are very
175 different from :ref:`run-time options <options>`. Compile-time options
176 fall into two categories. **SimGrid-specific options** define which part
177 of the framework to compile while **Generic options** are provided by
182 Our build system often gets mixed up if you change something on
183 your machine after the build configuration. For example, if
184 SimGrid fails to detect your fortran compiler, it is not enough to
185 install a fortran compiler. You also need to delete all Cmake
186 files, such as ``CMakeCache.txt``. Since Cmake also generates some
187 files in the tree, you may need to wipe out your complete tree and
188 start with a fresh one when you install new dependencies.
190 Another (better) solution is to :ref:`build out of the source tree
191 <install_cmake_outsrc>`.
193 Generic build-time options
194 """"""""""""""""""""""""""
196 These options specify, for example, the path to various system elements (Python
197 path, compiler to use, etc). In most case, CMake automatically discovers the
198 right value for these elements, but you can set them manually as needed.
199 Notably, such variables include ``CC`` and ``CXX``, defining the paths to the C
200 and C++ compilers; ``CFLAGS`` and ``CXXFLAGS`` specifying extra options to pass
201 to the C and C++ compilers; and ``PYTHON_EXECUTABLE`` specifying the path to the
204 The best way to discover the exact name of the option that you need to
205 change is to press ``t`` in the ``ccmake`` graphical interface, as all
206 options are shown (and documented) in the advanced mode.
208 Once you know their name, there are several ways to change the values of
209 build-time options. You can naturally use the ccmake graphical
210 interface for that, or you can use environment variables, or you can
211 prefer the ``-D`` flag of ``cmake``.
213 For example, you can change the compilers by issuing these commands to set some
214 environment variables before launching cmake:
216 .. code-block:: console
221 The same can be done by passing ``-D`` parameters to cmake, as follows.
222 Note that the dot at the end is mandatory (see :ref:`install_cmake_outsrc`).
224 .. code-block:: console
226 $ cmake -DCC=clang -DCXX=clang++ .
228 SimGrid compilation options
229 """""""""""""""""""""""""""
231 Here is the list of all SimGrid-specific compile-time options (the
232 default choice is in upper case).
234 CMAKE_INSTALL_PREFIX (path)
235 Where to install SimGrid (/opt/simgrid, /usr/local, or elsewhere).
237 enable_compile_optimizations (ON/off)
238 Ask the compiler to produce efficient code. You probably want to
239 leave this option activated, unless you plan to modify SimGrid itself:
240 efficient code takes more time to compile, and appears mangled to some debuggers.
242 enable_compile_warnings (on/OFF)
243 Ask the compiler to issue error messages whenever the source
244 code is not perfectly clean. If you are a SimGrid developer, you
245 have to activate this option to enforce the code quality. As a
246 regular user, this option is of little use.
248 enable_debug (ON/off)
249 Disabling this option discards all log messages of severity
250 debug or below at compile time (see :ref:`outcome_logs`). The resulting
251 code is marginaly faster than if you discard these messages at
252 runtime, but it obviously becomes impossible to get any debug
253 info from SimGrid when things go wrong.
255 enable_documentation (on/OFF)
256 Generates the documentation pages. Building the documentation is not
257 as easy as it used to be, and you should probably use the online
261 Generates the java bindings of SimGrid. You must also enable MSG for
264 enable_jedule (on/OFF)
265 Produces execution traces from SimDag simulations, which can then be visualized with the
266 Jedule external tool.
269 Generate the lua bindings to the SimGrid internals (requires lua-5.3).
271 enable_lib_in_jar (ON/off)
272 Embeds the native java bindings into the produced jar file.
275 Enables the *Link Time Optimization* in the C++ compiler.
276 This feature really speeds up the code produced, but it is fragile
277 with older gcc versions.
279 enable_maintainer_mode (on/OFF)
280 (dev only) Regenerates the XML parsers whenever the DTD is modified (requires flex and flexml).
282 enable_mallocators (ON/off)
283 Activates our internal memory caching mechanism. This produces faster
284 code, but it may fool the debuggers.
286 enable_model-checking (on/OFF)
287 Activates the formal verification mode. This will **hinder
288 simulation speed** even when the model checker is not activated at
292 Activates the :ref:`MSG <MSG_doc>` legacy interface.
295 Activates the ns-3 bindings. See section :ref:`model_ns3`.
298 Allows one to run MPI code on top of SimGrid.
300 enable_smpi_ISP_testsuite (on/OFF)
301 Adds many extra tests for the model checker module.
303 enable_smpi_MPICH3_testsuite (on/OFF)
304 Adds many extra tests for the MPI module.
306 minimal-bindings (on/OFF)
307 Take as few optional dependencies as possible, to get minimal
308 library bindings in Java and Python.
310 SMPI_C_FLAGS, SMPI_CXX_FLAGS, SMPI_Fortran_FLAGS (string)
311 Default compiler options to use in smpicc, smpicxx, or smpiff.
312 This can be useful to set options like "-m32" or "-m64".
314 Reset the build configuration
315 """""""""""""""""""""""""""""
317 To empty the CMake cache (either when you add a new library or when
318 things go seriously wrong), simply delete your ``CMakeCache.txt``. You
319 may also want to directly edit this file in some circumstances.
321 .. _install_cmake_outsrc:
323 Out of Tree Compilation
324 ^^^^^^^^^^^^^^^^^^^^^^^
326 By default, the files produced during the compilation are placed in
327 the source directory. It is however often better to put them all in a
328 separate directory: cleaning the tree becomes as easy as removing this
329 directory, and you can have several such directories to test several
330 parameter sets or architectures.
332 For that, go to the directory where the files should be produced, and
333 invoke cmake (or ccmake) with the full path to the SimGrid source as
336 .. code-block:: console
343 Existing Compilation Targets
344 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
346 In most cases, compiling and installing SimGrid is enough:
348 .. code-block:: console
351 $ make install # try "sudo make install" if you don't have the permission to write
353 In addition, several compilation targets are provided in SimGrid. If
354 your system is well configured, the full list of targets is available
355 for completion when using the ``Tab`` key. Note that some of the
356 existing targets are not really for public consumption so don't worry
357 if some do not work for you.
359 - **make**: Build the core of SimGrid that gets installed, but not any example.
360 - **make tests**: Build the tests and examples.
361 - **make simgrid**: Build only the SimGrid library. Not any example nor the helper tools.
362 - **make s4u-comm-pingpong**: Build only this example (works for any example)
363 - **make java-all**: Build all Java examples and their dependencies
364 - **make clean**: Clean the results of a previous compilation
365 - **make install**: Install the project (doc/ bin/ lib/ include/)
366 - **make uninstall**: Uninstall the project (doc/ bin/ lib/ include/)
367 - **make dist**: Build a distribution archive (tar.gz)
368 - **make distcheck**: Check the dist (make + make dist + tests on the distribution)
369 - **make documentation**: Create SimGrid documentation
371 If you want to see what is really happening, try adding ``VERBOSE=1`` to
372 your compilation requests:
374 .. code-block:: console
378 .. _install_src_test:
383 Once everything is built, you may want to test the result. SimGrid
384 comes with an extensive set of regression tests (as described in the
385 @ref inside_tests "insider manual"). The tests are not built by
386 default, so you first have to build them with ``make tests``. You can
387 then run them with ``ctest``, that comes with CMake. We run them
388 every commit and the results are on `our Jenkins <https://ci.inria.fr/simgrid/>`_.
390 .. code-block:: console
392 $ make tests # Build the tests
393 $ ctest # Launch all tests
394 $ ctest -R s4u # Launch only the tests whose names match the string "s4u"
395 $ ctest -j4 # Launch all tests in parallel, at most 4 concurrent jobs
396 $ ctest --verbose # Display all details on what's going on
397 $ ctest --output-on-failure # Only get verbose for the tests that fail
399 $ ctest -R s4u -j4 --output-on-failure # You changed S4U and want to check that you \
400 # didn't break anything, huh? \
401 # That's fine, I do so all the time myself.
403 .. _install_cmake_mac:
405 macOS-specific instructions
406 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
408 SimGrid compiles like a charm with clang (version 3.0 or higher) on macOS:
410 .. code-block:: console
412 $ cmake -DCMAKE_C_COMPILER=/path/to/clang -DCMAKE_CXX_COMPILER=/path/to/clang++ .
416 Troubleshooting your macOS build.
418 CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry: /SDKs/MacOSX10.8.sdk
419 This was reported with the XCode version of clang 4.1. The work
420 around is to edit the ``CMakeCache.txt`` file directly, to change
423 ``CMAKE_OSX_SYSROOT:PATH=/Applications/XCode.app/Contents/Developer/Platforms/MacOSX.platform/Developer``
425 You can safely ignore the warning about "-pthread" not being used, if it appears.
427 /usr/include does not seem to exist
428 This directory does not exist by default on modern macOS versions,
429 and you may need to create it with ``xcode-select -install``
431 .. _install_cmake_windows:
433 Windows-specific instructions
434 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
436 The best solution to get SimGrid working on windows is to install the
437 Ubuntu subsystem of Windows 10. All of SimGrid (but the model checker)
438 works in this setting.
440 Native builds not very well supported. Have a look to our `appveypor
442 <https://framagit.org/simgrid/simgrid/blob/master/.appveyor.yml>`_ to
443 see how we manage to use mingw-64 to build the DLL that the Java file
446 The drawback of MinGW-64 is that the produced DLL are not compatible
447 with MS Visual C. Some clang-based tools seem promising to fix this,
448 but this is of rather low priority for us. It it's important for you
449 and if you get it working, please @ref community_contact "tell us".
451 Python-specific instructions
452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
454 Once you have the Python development headers installed as well as a
455 recent version of the `pybind11 <https://pybind11.readthedocs.io/en/stable/>`
456 module (version at least 2.4), recompiling the Python bindings from
457 the source should be as easy as:
459 .. code-block:: console
461 # cd simgrid-source-tree
462 $ python setup.py build install
464 Starting with SimGrid 3.13, it should even be possible to install
465 simgrid without downloading the source with pip:
467 .. code-block:: console
469 $ pip install simgrid
471 Java-specific instructions
472 ^^^^^^^^^^^^^^^^^^^^^^^^^^
474 Once you have the `full JDK <http://www.oracle.com/technetwork/java/javase/downloads>`_ installed,
475 things should be as simple as:
477 .. code-block:: console
479 $ cmake -Denable_java=ON -Dminimal-bindings=ON .
480 $ make simgrid-java_jar # Only build the jarfile
482 After the compilation, the file ```simgrid.jar``` is produced in the
485 **Troubleshooting Java Builds**
487 Sometimes, the build system fails to find the JNI headers. First locate them as follows:
489 .. code-block:: console
492 /usr/lib/jvm/java-8-openjdk-amd64/include/jni.h
493 /usr/lib/jvm/java-9-openjdk-amd64/include/jni.h
494 /usr/lib/jvm/java-10-openjdk-amd64/include/jni.h
497 Then, set the JAVA_INCLUDE_PATH environment variable to the right
498 path, and relaunch cmake. If you have several versions of JNI installed
499 (as above), pick the one corresponding to the report of
502 .. code-block:: console
504 $ export JAVA_INCLUDE_PATH=/usr/lib/jvm/java-8-openjdk-amd64/include/
505 $ cmake -Denable_java=ON .
508 Note that the filename ```jni.h``` was removed from the path.
510 Linux Multi-Arch specific instructions
511 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
513 On a multiarch x86_64 Linux, it should be possible to compile a 32-bit
514 version of SimGrid with something like:
516 .. code-block:: console
521 PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig/ \
523 -DCMAKE_SYSTEM_PROCESSOR=i386 \
524 -DCMAKE_Fortran_COMPILER=/some/path/to/i686-linux-gnu-gfortran \
525 -DGFORTRAN_EXE=/some/path/to/i686-linux-gnu-gfortran \
526 -DSMPI_C_FLAGS=-m32 \
527 -DSMPI_CXX_FLAGS=-m32 \
528 -DSMPI_Fortran_FLAGS=-m32
530 If needed, implement ``i686-linux-gnu-gfortran`` as a script:
532 .. code-block:: shell
535 exec gfortran -m32 "$@"