X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5ec2b80b686983f84ebab7c7398a29e73286deee..da64c6383731d10c6174f81b4b6a20ff0ea186ae:/docs/source/Installing_SimGrid.rst diff --git a/docs/source/Installing_SimGrid.rst b/docs/source/Installing_SimGrid.rst index 0ee66be77c..7cd24049a8 100644 --- a/docs/source/Installing_SimGrid.rst +++ b/docs/source/Installing_SimGrid.rst @@ -21,7 +21,6 @@ following lines, or several lines if you need several languages. .. code-block:: console $ apt install libsimgrid-dev # if you want to develop in C or C++ - $ apt install simgrid-java # if you want to develop in Java $ apt install python3-simgrid # if you want to develop in Python If you use the Nix_ package manager, the latest SimGrid release is packaged as ``simgrid`` in Nixpkgs_. @@ -44,36 +43,6 @@ email. .. _simgrid AUR package: https://aur.archlinux.org/packages/simgrid/ .. _AUR official documentation: https://wiki.archlinux.org/title/Arch_User_Repository -.. _install_java_precompiled: - -Stable Java Package -^^^^^^^^^^^^^^^^^^^ - -The jar file can be retrieved from the `Release page -`_. This file is -self-contained, including the native components for Linux, macOS and -Windows. Copy it to your project's classpath and you're set. - -Nightly built Java Package -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Head to the corresponding `GitHub Action `_ -and pick the last green build. At the bottom of the build page, click on the ``jar-final`` artefact. -Open this zip file to find the jar you need. This jar can be used under Linux, Mac OSX or Windows, as you wish. - -Binary Java Troubleshooting -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Here are some error messages that you may get when trying to use the -binary Java package. - -Your architecture is not supported by this jarfile - If your system is not supported, you should compile your - own jarfile :ref:`by compiling SimGrid ` from the source. -Library not found: boost-context - You should obviously install the ``boost-context`` library on your - machine, for example with ``apt``. - .. _deprecation_policy: Version numbering and deprecation @@ -106,6 +75,8 @@ but that's even more so for these unreleased versions). Installing from the Source -------------------------- +.. _install_src_deps: + Getting the Dependencies ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -119,19 +90,28 @@ cmake (v3.5). ``ccmake`` provides a nicer graphical interface compared to ``cmake``. Press ``t`` in ``ccmake`` if you need to see absolutely all configuration options (e.g., if your Python installation is not standard). -boost (at least v1.48, v1.59 recommended) - - On Debian / Ubuntu: ``apt install libboost-dev libboost-context-dev`` +boost mandatory components (at least v1.48, v1.59 recommended) + - On Debian / Ubuntu: ``apt install libboost-dev`` - On CentOS / Fedora: ``dnf install boost-devel`` - On macOS with homebrew: ``brew install boost`` +boost recommended components (optional). + - boost-context may be used instead of our own fast context switching code which only works on amd64. + - boost-stacktrace is used to get nice stacktraces on errors in SimGrid. + - 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 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. -Java (optional): - - Debian / Ubuntu: ``apt install default-jdk libgcj18-dev`` (or - any version of libgcj) - - macOS or Windows: Grab a `full JDK `_ +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. For platform-specific details, please see below. @@ -145,7 +125,7 @@ Grab the last **stable release** from `FramaGit $ tar xf simgrid-3-XX.tar.gz $ cd simgrid-* - $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid -GNinja. + $ cmake -DCMAKE_INSTALL_PREFIX=/opt/simgrid -GNinja . $ make $ make install @@ -182,8 +162,7 @@ cmake itself. files in the tree, you may need to wipe out your complete tree and start with a fresh one when you install new dependencies. - Another (better) solution is to :ref:`build out of the source tree - `. + A better solution is to :ref:`build out of the source tree `. Generic build-time options """""""""""""""""""""""""" @@ -218,7 +197,7 @@ Note that the dot at the end is mandatory (see :ref:`install_cmake_outsrc`). .. code-block:: console - $ cmake -DCC=clang -DCXX=clang++ . + $ cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ . SimGrid compilation options """"""""""""""""""""""""""" @@ -252,13 +231,6 @@ enable_documentation (on/OFF) as easy as it used to be, and you should probably use the online version for now. -enable_java (on/OFF) - Generates the java bindings of SimGrid. You must also enable MSG for - this to work. - -enable_lib_in_jar (ON/off) - Embeds the native java bindings into the produced jar file. - enable_lto (ON/off) Enables the *Link Time Optimization* in the C++ compiler. This feature really speeds up the code produced, but it is fragile @@ -272,15 +244,12 @@ enable_mallocators (ON/off) 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 time. - -enable_msg (on/OFF) - Activates the :ref:`MSG ` legacy interface. + 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 ` to activate this option. enable_ns3 (on/OFF) - Activates the ns-3 bindings. See section :ref:`model_ns3`. + Activates the ns-3 bindings. See section :ref:`models_ns3`. enable_smpi (ON/off) Allows one to run MPI code on top of SimGrid. @@ -293,7 +262,7 @@ enable_smpi_MPICH3_testsuite (on/OFF) minimal-bindings (on/OFF) Take as few optional dependencies as possible, to get minimal - library bindings in Java and Python. + library bindings in Python. NS3_HINT (empty by default) Alternative path into which ns-3 should be searched for. @@ -302,8 +271,8 @@ EIGEN3_HINT (empty by default) Alternative path into which Eigen3 should be searched for. 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, - and a modified version of that variable if installing to another path. Just force another value if the auto-detected default + Where to install the Python module library. By default, it is set to the cmake Python3_SITEARCH variable if installing to /usr, + and a modified version of that variable if installing to another path. Just force another value if the auto-detected default does not fit your setup. SMPI_C_FLAGS, SMPI_CXX_FLAGS, SMPI_Fortran_FLAGS (string) @@ -359,7 +328,6 @@ if some do not work for you. - **make tests**: Build the tests and examples. - **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 java-all**: Build all Java examples and their dependencies - **make python-bindings**: Build the Python bindings - **make clean**: Clean the results of a previous compilation - **make install**: Install the project (doc/ bin/ lib/ include/) @@ -433,7 +401,7 @@ Windows-specific instructions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 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. @@ -441,7 +409,7 @@ Python-specific instructions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Once you have the Python development headers installed as well as a -recent version of the `pybind11 ` +recent version of the `pybind11 `_ module (version at least 2.4), recompiling the Python bindings from the source should be as easy as: @@ -457,68 +425,16 @@ simgrid without downloading the source with pip: $ pip install simgrid -Java-specific instructions -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once you have the `full JDK `_ installed, -things should be as simple as: - -.. code-block:: console - - $ cmake -Denable_java=ON -Dminimal-bindings=ON . - $ make simgrid-java_jar # Only build the jarfile - -After the compilation, the file ```simgrid.jar``` is produced in the -root directory. - -**Troubleshooting Java Builds** - -Sometimes, the build system fails to find the JNI headers. First locate them as follows: - -.. code-block:: console - - $ locate jni.h - /usr/lib/jvm/java-8-openjdk-amd64/include/jni.h - /usr/lib/jvm/java-9-openjdk-amd64/include/jni.h - /usr/lib/jvm/java-10-openjdk-amd64/include/jni.h - - -Then, set the JAVA_INCLUDE_PATH environment variable to the right -path, and relaunch cmake. If you have several versions of JNI installed -(as above), pick the one corresponding to the report of -``javac -version`` +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 - $ export JAVA_INCLUDE_PATH=/usr/lib/jvm/java-8-openjdk-amd64/include/ - $ cmake -Denable_java=ON . - $ make - -Note that the filename ```jni.h``` was removed from the path. + $ PYTHONPATH="/opt/simgrid/lib/python3/dist-packages" LD_LIBRARY_PATH="/opt/simgrid/lib" python your_script.py -Linux Multi-Arch specific instructions -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -On a multiarch x86_64 Linux, it should be possible to compile a 32-bit -version of SimGrid with something like: +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 - $ CFLAGS=-m32 \ - CXXFLAGS=-m32 \ - FFLAGS=-m32 \ - PKG_CONFIG_LIBDIR=/usr/lib/i386-linux-gnu/pkgconfig/ \ - cmake . \ - -DCMAKE_SYSTEM_PROCESSOR=i386 \ - -DCMAKE_Fortran_COMPILER=/some/path/to/i686-linux-gnu-gfortran \ - -DGFORTRAN_EXE=/some/path/to/i686-linux-gnu-gfortran \ - -DSMPI_C_FLAGS=-m32 \ - -DSMPI_CXX_FLAGS=-m32 \ - -DSMPI_Fortran_FLAGS=-m32 - -If needed, implement ``i686-linux-gnu-gfortran`` as a script: - -.. code-block:: shell - - #!/usr/bin/env sh - exec gfortran -m32 "$@" + export PYTHONPATH="$PYTHONPATH:/opt/simgrid/lib/python3/dist-packages" + export LD_LIBRARY_PATH="$PYTHONPATH:/opt/simgrid/lib"