- On Debian / Ubuntu: ``apt install libboost-context-dev libboost-stacktrace-dev``
python bindings (optional):
- On Debian / Ubuntu: ``apt install pybind11-dev python3-dev``
-Model-checking dependencies (optional)
- - On Debian / Ubuntu: ``apt install libunwind-dev libdw-dev libelf-dev libevent-dev``
+Model-checking mandatory dependencies
+ - On Debian / Ubuntu: ``apt install libevent-dev``
+Model-checking optional dependencies
+ - On Debian / Ubuntu: ``apt install libunwind-dev libdw-dev libelf-dev``
Eigen3 (optional)
- On Debian / Ubuntu: ``apt install libeigen3-dev``
- On CentOS / Fedora: ``dnf install eigen3-devel``
- On macOS with homebrew: ``brew install eigen``
- - Use EIGEN3_HINT to specify where it's installed if cmake doesn't find it automatically.
+ - 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.
JSON (optional, for the DAG wfcommons loader)
- On Debian / Ubuntu: ``apt install nlohmann-json3-dev``
- Use nlohmann_json_HINT to specify where it's installed if cmake doesn't find it automatically.
code, but it may fool the debuggers.
enable_model-checking (on/OFF)
- Activates the formal verification mode. This will hinder simulation speed even when the model checker is not activated at run
+ Activates the liveness verification mode. This will hinder simulation speed even when the model checker is not activated at run
time, because some optimizations such as LTO must be disabled at compile time. You need to have the :ref:`required
build-dependencies <install_src_deps>` to activate this option.
enable_smpi (ON/off)
Allows one to run MPI code on top of SimGrid.
-enable_smpi_MBI_testsuite (on/OFF)
- Adds many extra tests for the model checker module.
+enable_testsuite_McMini (on/OFF)
+ Adds several extra tests for the model checker module (targeting threaded applications).
-enable_smpi_MPICH3_testsuite (on/OFF)
+enable_testsuite_smpi_MBI (on/OFF)
+ Adds many extra tests for the model checker module (targeting MPI applications).
+
+enable_testsuite_smpi_MPICH3 (on/OFF)
Adds many extra tests for the MPI module.
minimal-bindings (on/OFF)
EIGEN3_HINT (empty by default)
Alternative path into which Eigen3 should be searched for.
+ Providing the value OFF as an hint will disable the detection alltogether.
SIMGRID_PYTHON_LIBDIR (auto-detected)
Where to install the Python module library. By default, it is set to the cmake Python3_SITEARCH variable if installing to /usr,
if some do not work for you.
- **make**: Build the core of SimGrid that gets installed, but not any example.
-- **make tests**: Build the tests and examples.
+- **make examples**: Build the examples, which are needed by the tests.
- **make simgrid**: Build only the SimGrid library. Not any example nor the helper tools.
- **make s4u-comm-pingpong**: Build only this example (works for any example)
- **make python-bindings**: Build the Python bindings
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The best solution to get SimGrid working on windows is to install the
-Ubuntu subsystem of Windows 10. All of SimGrid (but the model checker)
+Ubuntu subsystem of Windows 10. All of SimGrid (but the liveness model checker)
works in this setting. Native builds never really worked, and they are
disabled starting with SimGrid v3.33.
.. code-block:: console
$ pip install simgrid
+
+If you installed SimGrid to a non-standard directory (such as ``/opt/simgrid`` as advised earlier), you should tell python where
+to find the libraries as follows (notice the elements suffixed to the configured prefix).
+
+.. code-block:: console
+
+ $ PYTHONPATH="/opt/simgrid/lib/python3/dist-packages" LD_LIBRARY_PATH="/opt/simgrid/lib" python your_script.py
+
+You can add those variables to your bash profile to not specify it each time by adding these lines to your ``~/.profile``:
+
+.. code-block:: console
+
+ export PYTHONPATH="$PYTHONPATH:/opt/simgrid/lib/python3/dist-packages"
+ export LD_LIBRARY_PATH="$PYTHONPATH:/opt/simgrid/lib"
