Merge pull request #203 from bakpaul/25_07_update_build_instruction_for_new_release

Update installation and build instruction for new release

Author: hugtalbot

10_Getting_Started/20_Build/10_Linux.md

@@ -94,18 +94,16 @@ SOFA requires some libraries:
     sudo apt install libboost-all-dev
     ```
     
--   **Python 3.10** + pip + numpy + scipy
+-   **Python 3.12** + pip + numpy + scipy
     ```
-    sudo apt install python3.10-dev pybind11-dev
+    sudo apt install python3.12-dev python3.12-venv
     ```
-    
+    Python 3.12 now favor the use of venv. We highly recommend it too. To bootstrap it type `python3.12 -m venv sofa-venv` in the folder you want to keep this venv. We recommend creating it either in your home directory, in the folder containing both your sources and the build directory. Once created, you can activate it by calling `source /path/to/sofa-venv/bin/activate`. Now you can install all dependency through the following commands:
     ```
-    sudo apt-get install python3.10-distutils \
-    && curl -L https://bootstrap.pypa.io/pip/get-pip.py --output /tmp/get-pip3.py \
-    && python3.10 /tmp/get-pip3.py \
-    && python3.10 -m pip install --upgrade pip \
-    && python3.10 -m pip install numpy scipy pybind11==2.9.1
+    python3.12 -m pip install --upgrade pip \
+    && python3.12 -m pip install numpy scipy pybind11==2.12.0
     ```
+    Now, each time you want to build or use SOFA, you first need to call `source /path/to/sofa-venv/bin/activate` to activate this virtual environment and get access to the dependencies. 
 
 -   **Additional libraries**: libPNG, libJPEG, libTIFF, Glew, Zlib   
     ```
@@ -207,6 +205,8 @@ git clone -b master https://github.com/sofa-framework/sofa.git sofa/src
 
 ## Generate a Makefile with CMake
 
+0. Activate your venv `source /path/to/sofa-venv/bin/activate` and tell CMake to look there to find pybind11 `export CMAKE_PREFIX_PATH=/path/to/sofa-venv/lib/python3.12/site-packages`
+
 1. Create build directories respecting the arrangement above.
 
 2. Run CMake-GUI and set source folder and build folder.
@@ -256,7 +256,8 @@ Time for a coffee!
 To solve Qt detection errors, click on **Add Entry** and add
 `CMAKE_PREFIX_PATH` with path `/home/YOUR_USERNAME/Qt/QT_VERSION/COMPILER` matching your
 Qt installation.  
-Example: `CMAKE_PREFIX_PATH=/home/bob/Qt/5.15/gcc_64`  
+Example: `CMAKE_PREFIX_PATH=/home/bob/Qt/5.15/gcc_64`.
+Note that this is a list, in which you can provide multiple paths by separating them with a semicolon ';'.
 
 Then, **Configure** again.
 

10_Getting_Started/20_Build/20_MacOS.md

@@ -84,14 +84,19 @@ SOFA requires some libraries:
     brew install boost
     ```
 
--   **Python 3.10** + pip + numpy + scipy
-    ```bash
-    brew install python@3.10
+-   **Python 3.12** + pip + numpy + scipy
+    ```
+    brew install python@3.12
     brew link --force python@3.10
-    python3 -m pip install --upgrade pip
-    python3 -m pip install numpy scipy
-    brew install pybind11
     ```
+    Python 3.12 now favor the use of venv. We highly recommend it too. To bootstrap it type `python3.12 -m venv sofa-venv` in the folder you want to keep this venv. We recommend creating it either in your home directory, in the folder containing both your sources and the build directory. Once created, you can activate it by calling `source /path/to/sofa-venv/bin/activate`. Now you can install all dependency through the following commands:
+    ```
+    python3.12 -m pip install --upgrade pip \
+    && python3.12 -m pip install numpy scipy pybind11==2.12.0
+    ```
+    Now, each time you want to build or use SOFA, you first need to call `source /path/to/sofa-venv/bin/activate` to activate this virtual environment and get access to the dependencies. 
+
+   
 
 -   **Additional libraries**: libPNG, libJPEG, libTIFF, Glew   
     ```bash
@@ -173,6 +178,8 @@ git clone -b master https://github.com/sofa-framework/sofa.git sofa/src
 
 ## Generate a Makefile with CMake
 
+0. Activate your venv `source /path/to/sofa-venv/bin/activate` and tell CMake to look there to find pybind11 `export CMAKE_PREFIX_PATH=/path/to/sofa-venv/lib/python3.12/site-packages`
+
 1. Create build directories respecting the arrangement above.
 
 2. Run CMake.app and set source folder and build folder.
@@ -214,7 +221,9 @@ To solve Qt detection errors, click on **Add Entry** and add
 `CMAKE_PREFIX_PATH` with path `/home/YOUR_USERNAME/Qt/QT_VERSION/COMPILER` matching your
 Qt architecture.  
 Example: `CMAKE_PREFIX_PATH=/home/bob/Qt/5.7/gcc_64`  
-**Configure** again.
+Note that this is a list, in which you can provide multiple paths by separating them with a semicolon ';'.
+
+Then, **Configure** again.
 
 A further dev warning may appear:
 

10_Getting_Started/20_Build/30_Windows.md

@@ -56,13 +56,15 @@ SOFA requires some libraries:
     - **For Visual Studio 2019**: choose boost_X_X_X-msvc-14.2-64.exe
     - **For Visual Studio 2017**: choose boost_X_X_X-msvc-14.1-64.exe
 
--   **Python** (= 3.10.x)  
-    Download and install the latest [**Python 3.10 (amd64)**](https://www.python.org/ftp/python/3.10.10/python-3.10.10-amd64.exe).
-    Then install the python dependencies. Run the following commands in cmd by replacing `path\to\Python310\ ` by the path where python was installed on your OS.
+-   **Python** (= 3.12.x)  
+    Download and install the latest [**Python 3.12 (amd64)**](https://www.python.org/ftp/python/3.12.10/python-3.12.10-amd64.exe).
+    Python 3.12 now favor the use of venv. We highly recommend it too. To bootstrap it type `C:\path\to\python3.12 -m venv sofa-venv` in the folder you want to keep this venv. We recommend creating it either in your home directory, in the folder containing both your sources and the build directory. Once created, you can activate it by calling `C:\path\to\sofa-venv\bin\Scripts\activate.bat`. Now you can install all dependency through the following commands.
+    Then, install the Python dependencies. Run the following commands in cmd by replacing `path\to\Python312\` by the path to you venv bin directory.
     ```
-    path\to\Python310\python.exe -m pip install --upgrade pip
-    path\to\Python310\python.exe -m pip install numpy scipy pybind11==2.9.1
+    path\to\Python312\python.exe -m pip install --upgrade pip
+    path\to\Python312\python.exe -m pip install numpy scipy pybind11==2.12.0
     ```
+    Now, each time you want to build or use SOFA, you first need to call `C:\path\to\sofa-venv\bin\Scripts\activate.bat` to activate this virtual environment and get access to the dependencies. 
     
 -   **Additional libraries**: libPNG, libJPEG, libTIFF, Glew, Zlib, TinyXML2
     Download the [Windows dependency pack](https://www.sofa-framework.org/download/WinDepPack/VS-2017/latest).  
@@ -130,32 +132,35 @@ git clone -b master https://github.com/sofa-framework/sofa.git sofa/src
 2. In Windows Start menu, search for `Native Tools Command Prompt` and run the one corresponding to your Windows architecture (x64 for 64-bit, x86 for 32-bit).  
 ![](https://www.sofa-framework.org/wp-content/uploads/2020/04/SearchCommandPrompt2.png)
 
-3. In the command prompt, type `cmake-gui` and press Enter.  
+3. Call ``C:\path\to\sofa-venv\bin\Scripts\activate.bat`` to activate the virtual environment. 
+
+4. In the command prompt, type `cmake-gui` and press Enter.  
    If you get the error `'cmake-gui' is not recognized as an internal or external command`, it means that your system PATH does not correctly include the path to cmake-gui. In this case, you need to provide the full path to your cmake-gui.
 
-4. In CMake-GUI, set source folder and build folder.
+5. In CMake-GUI, set source folder and build folder.
 
-5. Run **Configure**.
+6. Run **Configure**.
 
-6. A popup will ask you to specify the generator for the project.
+7. A pop-up will ask you to specify the generator for the project.
 
    - If you want use **Visual Studio IDE**, select "Visual Studio 15 2017 Win64" or "Visual Studio 16 2019 Win64" (or without the "Win64" if you are on Windows 32-bit).
    - If you want to use **another IDE like QtCreator**, select "CodeBlocks - Ninja" (recommended, needs [Ninja](#optional-ninja-build-system)) or "CodeBlocks - NMake".
    Keep "Use default native compilers" and press "Finish".
 
-7. Fix eventual dependency errors by following CMake messages (see Troubleshoot section below). Do not worry about warnings.
+8. Fix eventual dependency errors by following CMake messages (see Troubleshoot section below). You may ignore warnings.
 
    - e.g. define the `Eigen3_DIR` with the path where you installed Eigen
+   - Add the path to your venv site-packages to CMake by setting a path variable called `CMAKE_PREFIX_PATH=C:\path\to\sofa-venv\Lib\site-packages`
 
-8. (optional) Customize SOFA via CMake variables
+9. (optional) Customize SOFA via CMake variables
 
    - choose the build type by setting CMAKE_BUILD_TYPE to "Release" or "RelWithDebInfo" (recommended) or "Debug"
    - activate or deactivate plugins: see PLUGIN_XXX variables
    - activate or deactivate features: see SOFA_XXX variables
    Do not forget to **Configure** again to check if your changes are valid.
    **_NOTE_**: here is an [exhaustive list of plugins](../activate-plugins/) that can be activated for an in-tree compilation.
 
-9. When you are ready, run **Generate**. In the build directory, this will create a Visual Studio project (.sln) or a Makefile depending on the generator you chose at step 4.
+10. When you are ready, run **Generate**. In the build directory, this will create a Visual Studio project (.sln) or a Makefile depending on the generator you chose at step 4.
 
 
 ## Compile
@@ -181,7 +186,9 @@ Time for a coffee!
 To solve Qt detection errors, click on **Add Entry** and add
 `CMAKE_PREFIX_PATH` with path to your Qt directory (navigate until msvcXXXX_XX directory).  
 Example: `CMAKE_PREFIX_PATH=C:/dev/Qt/5.11.3/msvc2017_64`
-**Configure** again.
+Note that this is a list, in which you can provide multiple paths by separating them with a semicolon ';'.
+
+Then, **Configure** again.
 
 A further dev warning may appear: