Merge pull request #178 from bakpaul/25_04_add_automatic_generation_of_plugin_lists

fredroy · web-flow · commit 7ca5ba598112 · 2025-04-17T08:23:20.000+09:00
Add scripts for auto generation
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -31,7 +31,7 @@ jobs:
 
     steps:
 
-      - name: Setup SOFA and environment
+      - name: Install SOFA binaries and setting up environment
         id: sofa
         uses: sofa-framework/sofa-setup-action@v5
         with:
@@ -51,6 +51,14 @@ jobs:
           path: 'merged_doc'
           ref: 'merged_doc'
 
+      - name: Clone sofa source code from GitHub
+        uses: actions/checkout@v4
+        with:
+          repository: 'sofa-framework/sofa'
+          ref: 'master'
+          path: sofa_src
+
+
       - name: Generate doc
         run: |
           echo $SOFA_ROOT
@@ -63,6 +71,10 @@ jobs:
           
           python ${{ github.workspace }}/SofaDocGenerator/script/title_metadata.py ${{ github.workspace }}/SofaDocGenerator/doc
           python ${{ github.workspace }}/SofaDocGenerator/script/generate_nav.py ${{ github.workspace }}/SofaDocGenerator/mkdocs/mkdocs.yml ${{ github.workspace }}/SofaDocGenerator/doc
+          
+          # Export plugin lists into the merged doc
+          python ${{ github.workspace }}/SofaDocGenerator/script/PluginLists/exportInTreePlugins.py ${{ github.workspace }}/sofa_src >> ${{ github.workspace }}/SofaDocGenerator/doc/10_Getting_Started/20_Build/50_Activate_Plugins.md
+          python ${{ github.workspace }}/SofaDocGenerator/script/PluginLists/exportSupportedPlugins.py ${{ github.workspace }}/sofa_src >> ${{ github.workspace }}/SofaDocGenerator/doc/35_Plugins/45_Suported_Plugins_List.md
 
       - name: Save merged doc
         uses: actions/upload-artifact@v4
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
@@ -62,6 +62,7 @@ markdown_extensions:
       alternate_style: true
   - pymdownx.arithmatex:
       generic: true
+  - pymdownx.blocks
 
 extra_javascript:
   - javascripts/config.js
diff --git a/script/PluginLists/AdvancedDescriptions/ArticulatedSystemPlugin b/script/PluginLists/AdvancedDescriptions/ArticulatedSystemPlugin
@@ -0,0 +1 @@
+Plugin that allow the simulation of rigid kinematic chains.
diff --git a/script/PluginLists/AdvancedDescriptions/BeamAdapter b/script/PluginLists/AdvancedDescriptions/BeamAdapter
@@ -0,0 +1 @@
+Plugin implementing a 1-dimensional Finite Element Method (FEM) based on the Kirchhoff rod theory and allows to simulate any 1D flexible structure.
diff --git a/script/PluginLists/AdvancedDescriptions/CGALPlugin b/script/PluginLists/AdvancedDescriptions/CGALPlugin
@@ -0,0 +1 @@
+Plugins offering SOFA bindings to the [CGAL library](https://www.cgal.org/) for meshing purposes.
diff --git a/script/PluginLists/AdvancedDescriptions/CSparseSolvers b/script/PluginLists/AdvancedDescriptions/CSparseSolvers
@@ -0,0 +1 @@
+Plugin containing a collection of linear solver components that are built on top of the [CSparse library](https://people.math.sc.edu/Burkardt/c_src/csparse/csparse.html).
diff --git a/script/PluginLists/AdvancedDescriptions/Geomagic b/script/PluginLists/AdvancedDescriptions/Geomagic
@@ -0,0 +1 @@
+Plugin enabling the use of the [Touch haptic device from 3D Systems](https://www.3dsystems.com/haptics-devices/touch).
diff --git a/script/PluginLists/AdvancedDescriptions/ModelOrderReduction b/script/PluginLists/AdvancedDescriptions/ModelOrderReduction
@@ -0,0 +1 @@
+Plugin containing C++ components with python utilities allowing to perform model reduction and use these reduced model easily in a SOFA scene.
diff --git a/script/PluginLists/AdvancedDescriptions/MultiThreading b/script/PluginLists/AdvancedDescriptions/MultiThreading
@@ -0,0 +1 @@
+Plugin implementing CPU-parallelized version of some SOFA components.
diff --git a/script/PluginLists/AdvancedDescriptions/PluginExample b/script/PluginLists/AdvancedDescriptions/PluginExample
@@ -0,0 +1 @@
+A template and a good starting point to create a new plugin from scratch.
diff --git a/script/PluginLists/AdvancedDescriptions/Registration b/script/PluginLists/AdvancedDescriptions/Registration
@@ -0,0 +1 @@
+Plugin offering registering tools for deformable surfaces.
diff --git a/script/PluginLists/AdvancedDescriptions/STLIB b/script/PluginLists/AdvancedDescriptions/STLIB
@@ -0,0 +1 @@
+Sofa Template Library: high level reusable python objects used to write complex parts of a simulation.
diff --git a/script/PluginLists/AdvancedDescriptions/SceneChecking b/script/PluginLists/AdvancedDescriptions/SceneChecking
@@ -0,0 +1 @@
+Plugin developed to provide insights to user when a scene launched with runSofa uses deprecated components/datas.
diff --git a/script/PluginLists/AdvancedDescriptions/Sofa.Metis b/script/PluginLists/AdvancedDescriptions/Sofa.Metis
@@ -0,0 +1 @@
+Plugin adding METIS-based ordering method for SOFA's linear solvers.
diff --git a/script/PluginLists/AdvancedDescriptions/Sofa.Qt b/script/PluginLists/AdvancedDescriptions/Sofa.Qt
@@ -0,0 +1 @@
+Plugin containing Qt-based GUI for SOFA.
diff --git a/script/PluginLists/AdvancedDescriptions/SofaCUDA b/script/PluginLists/AdvancedDescriptions/SofaCUDA
@@ -0,0 +1 @@
+Plugin that provides a number of SOFA components that have been re-implemented using CUDA.
diff --git a/script/PluginLists/AdvancedDescriptions/SofaGLFW b/script/PluginLists/AdvancedDescriptions/SofaGLFW
@@ -0,0 +1 @@
+Project containing two plugins: a simple GUI based on GLFW and a user interface based on [Dear ImGui](https://github.com/ocornut/imgui).
diff --git a/script/PluginLists/AdvancedDescriptions/SofaMatrix b/script/PluginLists/AdvancedDescriptions/SofaMatrix
@@ -0,0 +1 @@
+Plugin containing components used to provide insights on linear system matrices by exporting them of drawing them.
diff --git a/script/PluginLists/AdvancedDescriptions/SofaPython3 b/script/PluginLists/AdvancedDescriptions/SofaPython3
@@ -0,0 +1 @@
+Plugin enabling to write SOFA scenes in Python that also introduce several Python modules that exposes different C++ components used in SOFA.
diff --git a/script/PluginLists/AdvancedDescriptions/SoftRobots b/script/PluginLists/AdvancedDescriptions/SoftRobots
@@ -0,0 +1 @@
+Plugin containing components dedicated to forward simulation of soft robots.
diff --git a/script/PluginLists/AdvancedDescriptions/runSofa b/script/PluginLists/AdvancedDescriptions/runSofa
@@ -0,0 +1 @@
+Project containing the main runSofa, used to launch the scene files.
diff --git a/script/PluginLists/exportInTreePlugins.py b/script/PluginLists/exportInTreePlugins.py
@@ -0,0 +1,88 @@
+from utils import *
+import os
+import sys
+
+SOFA_SRC=sys.argv[1]
+
+## Find all meaningful CMakeLists in applications
+## This automated search is looking first in the CMakeLists at the root of {SOFA_SRC}/applications/ and for each 'add_subdirectory' it finds, it look inside of it the same way in a recursive way.
+## An easier way would have been to look for all CMakeLists in applications, but this might be wrong because some in tree plugins might also use the macros.
+def recFindCMakeLists(currFilename, fileList):
+    currfolder = currFilename.removesuffix('CMakeLists.txt')
+    with open(currFilename) as file:
+        for line in [line.rstrip() for line in file]:
+            if("add_subdirectory" in line and not "sofa_add_subdirectory" in line):
+                folderName = line.split('(')[1].split(')')[0].split()[0]
+                foundFile = os.path.join(currfolder,folderName,'CMakeLists.txt')
+                fileList.append(foundFile)
+                recFindCMakeLists(foundFile, fileList)
+
+filenames=[f"{SOFA_SRC}/applications/CMakeLists.txt"]
+recFindCMakeLists(filenames[0],filenames)
+
+presetFilename=f"{SOFA_SRC}/CMakePresets.json"
+descriptionFolder=f"{SOFA_SRC}/scripts/subProjectLister/AdvancedDescriptions/"
+
+possibleTypes=["application","folder","plugin"]
+
+applications = []
+folders = []
+plugins = []
+
+presetLookup = PresetLookup(presetFilename)
+
+def saveProject(proj:Projects):
+    global applications, folders, plugins
+    match proj.type:
+        case "application":
+            applications.append(proj)
+        case "directory":
+            folders.append(proj)
+        case "plugin":
+            plugins.append(proj)
+
+
+## Extract all subprojects
+lines = []
+for filename in filenames:
+    cmakeFolderRelativePath = filename.removeprefix(f"{SOFA_SRC}/").removesuffix("CMakeLists.txt")
+    with open(filename) as file:
+        ## Transform into Projects type and sort them regarding type
+        for line in [line.rstrip() for line in file]:
+            if("sofa_add_subdirectory" in line):
+                arguments = line.split('(')[1].split(')')[0]
+                proj = InternalProjects.createFromArguments(arguments, cmakeFolderRelativePath, descriptionFolder)
+                proj.extractPresets(presetLookup)
+                saveProject(proj)
+            elif("sofa_add_external" in line):
+                arguments = line.split('(')[1].split(')')[0]
+                proj = ExternalProjects.createFromArguments(arguments,descriptionFolder)
+                proj.extractPresets(presetLookup)
+
+                saveProject(proj)
+
+
+
+## Sort list regarding the name of the project
+applications = sortProjectByNames(applications)
+plugins = sortProjectByNames(plugins)
+folders = sortProjectByNames(folders)
+
+## Print markdown tables
+
+
+
+print("### Applications")
+print()
+print(printTableFromProjectListToString(applications))
+print()
+
+print("### Plugins")
+print()
+print(printTableFromProjectListToString(plugins))
+print()
+
+print("### Directories")
+print()
+print(printTableFromProjectListToString(folders))
+print()
diff --git a/script/PluginLists/exportSupportedPlugins.py b/script/PluginLists/exportSupportedPlugins.py
@@ -0,0 +1,73 @@
+from utils import *
+import os
+import sys
+
+SOFA_SRC=sys.argv[1]
+
+## Find all meaningful CMakeLists in applications
+## This automated search is looking first in the CMakeLists at the root of {SOFA_SRC}/applications/ and for each 'add_subdirectory' it finds, it look inside of it the same way in a recursive way.
+## An easier way would have been to look for all CMakeLists in applications, but this might be wrong because some in tree plugins might also use the macros.
+def recFindCMakeLists(currFilename, fileList):
+    currfolder = currFilename.removesuffix('CMakeLists.txt')
+    with open(currFilename) as file:
+        for line in [line.rstrip() for line in file]:
+            if("add_subdirectory" in line and not "sofa_add_subdirectory" in line):
+                folderName = line.split('(')[1].split(')')[0].split()[0]
+                foundFile = os.path.join(currfolder,folderName,'CMakeLists.txt')
+                fileList.append(foundFile)
+                recFindCMakeLists(foundFile, fileList)
+
+filenames=[f"{SOFA_SRC}/applications/CMakeLists.txt"]
+recFindCMakeLists(filenames[0],filenames)
+
+presetFilename=f"{SOFA_SRC}/CMakePresets.json"
+descriptionFolder=f"{SOFA_SRC}/scripts/subProjectLister/AdvancedDescriptions/"
+
+possibleTypes=["application","folder","plugin"]
+
+allProjects = []
+def saveProject(proj):
+    allProjects.append(proj)
+
+presetLookup = PresetLookup(presetFilename)
+
+
+
+
+## Extract all subprojects
+lines = []
+for filename in filenames:
+    cmakeFolderRelativePath = filename.removeprefix(f"{SOFA_SRC}/").removesuffix("CMakeLists.txt")
+    with open(filename) as file:
+        ## Transform into Projects type and sort them regarding type
+        for line in [line.rstrip() for line in file]:
+            if("sofa_add_subdirectory" in line):
+                arguments = line.split('(')[1].split(')')[0]
+                proj = InternalProjects.createFromArguments(arguments, cmakeFolderRelativePath, descriptionFolder)
+                proj.extractPresets(presetLookup)
+                if 'supported-plugins' in proj.presetList:
+                    saveProject(proj)
+            elif("sofa_add_external" in line):
+                arguments = line.split('(')[1].split(')')[0]
+                proj = ExternalProjects.createFromArguments(arguments,descriptionFolder)
+                proj.extractPresets(presetLookup)
+                if 'supported-plugins' in proj.presetList:
+                    saveProject(proj)
+
+
+
+## Sort list regarding the name of the project
+allProjects = sortProjectByNames(allProjects)
+
+print("| Plugin Name | Description |")
+print("| ----------- | ----------- |")
+
+## Print markdown tables
+for project in allProjects:
+    string = f"| {project.getDisplayName()}"
+    if not project.isPluginized():
+        string += "*"
+    string += f" | {project.getDescription()} |"
+    print(string)
+print()
+print("(*) Projects which sources are present in SOFA sources")
diff --git a/script/PluginLists/utils.py b/script/PluginLists/utils.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugin that allow the simulation of rigid kinematic chains.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugin implementing a 1-dimensional Finite Element Method (FEM) based on the Kirchhoff rod theory and allows to simulate any 1D flexible structure.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugins offering SOFA bindings to the [CGAL library](https://www.cgal.org/) for meshing purposes.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugin containing a collection of linear solver components that are built on top of the [CSparse library](https://people.math.sc.edu/Burkardt/c_src/csparse/csparse.html).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugin enabling the use of the [Touch haptic device from 3D Systems](https://www.3dsystems.com/haptics-devices/touch).`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugin containing C++ components with python utilities allowing to perform model reduction and use these reduced model easily in a SOFA scene.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Plugin implementing CPU-parallelized version of some SOFA components.`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+A template and a good starting point to create a new plugin from scratch.`