X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fbcf6ab31cae1988be858f9f894dafe529c575d7..aea841b4127bacfa23de320d95bbd8efec2b9a08:/docs/source/Installing_SimGrid.rst
diff --git a/docs/source/Installing_SimGrid.rst b/docs/source/Installing_SimGrid.rst
index 275e7739d4..bb655faf1b 100644
--- a/docs/source/Installing_SimGrid.rst
+++ b/docs/source/Installing_SimGrid.rst
@@ -16,11 +16,15 @@ Pre-compiled Packages
Binaries for Linux
^^^^^^^^^^^^^^^^^^
-On Debian or Ubuntu, simply type:
+To get all of SimGrid on Debian or Ubuntu, simply type the following.
.. code-block:: shell
- apt install simgrid
+ apt install libsimgrid-dev simgrid-java
+
+The package ``libsimgrid-dev`` is sufficient if you only plan to use the
+C or C++ interfaces of SimGrid while ``simgrid-java`` if you only plan
+to use the Java bindings.
If you build pre-compiled packages for other distributions, drop us an
email.
@@ -247,7 +251,7 @@ enable_model-checking (on/OFF)
run time.
enable_ns3 (on/OFF)
- Activates the ns-3 bindings. See section @ref pls_ns3.
+ Activates the ns-3 bindings. See section :ref:`model_ns3`.
enable_smpi (ON/off)
Allows to run MPI code on top of SimGrid.
@@ -258,8 +262,9 @@ enable_smpi_ISP_testsuite (on/OFF)
enable_smpi_MPICH3_testsuite (on/OFF)
Adds many extra tests for the MPI module.
-minimal_java (on/OFF)
- Build a java library with as few dependencies as possible.
+minimal-bindings (on/OFF)
+ Take as few optional dependencies as possible, to get minimal
+ library bindings in Java and Python.
Reset the build configuration
"""""""""""""""""""""""""""""
@@ -347,8 +352,8 @@ on `our Jenkins `_.
.. _install_cmake_mac:
-macOS Specifics
-^^^^^^^^^^^^^^^
+macOS-specific instructions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
SimGrid compiles like a charm with clang (version 3.0 or higher) on macOS:
@@ -375,8 +380,8 @@ CMake Error: Parse error in cache file build_dir/CMakeCache.txt. Offending entry
.. _install_cmake_windows:
-Windows Specifics
-^^^^^^^^^^^^^^^^^
+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)
@@ -389,19 +394,36 @@ see how we manage to use mingw-64 to build the DLL that the Java file
needs.
The drawback of MinGW-64 is that the produced DLL are not compatible
-with MS Visual C. `clang-cl `_
-sounds promising to fix this. If you get something working or if you
-have any other improvement, please @ref community_contact "tell us".
+with MS Visual C. Some clang-based tools seem promising to fix this,
+but this is of rather low priority for us. It it's important for you
+and if you get it working, please @ref community_contact "tell us".
+
+Python-specific instructions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Recompiling the python bindings from the source should be as easy as:
+
+.. code-block:: shell
-Java Specifics
-^^^^^^^^^^^^^^
+ # cd simgrid-source-tree
+ python setup.py build install
+
+Starting with SimGrid 3.13, it should even be possible to install
+simgrid without downloading the source with pip:
+
+.. code-block:: shell
+
+ pip install simgrid
+
+Java-specific instructions
+^^^^^^^^^^^^^^^^^^^^^^^^^^
Once you have the `full JDK `_ installed,
things should be as simple as:
.. code-block:: shell
- cmake -Denable_java=ON .
+ 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
@@ -432,8 +454,8 @@ path, and relaunch cmake. If you have several versions of JNI installed
Note that the filename ```jni.h``` was removed from the path.
-Linux Multi-Arch Specifics
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+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: