Rename dsm to dsf and add Python support (#302)

* Init python binding

* Change `dsm` to `dsf`

* Auto-fetch for pybind11

* Typo

* Missing files

* Fix pylinting

* Pylint

* Pylint bastaaaa

* Rename extension

* Add nlanes to exportEdges functioN

* Bugfix

* Add functions to binding

* Add debug msgs

* Verbose log

* Comments

* Fix tests

* Add agents tests

* Add instructions

Author: Grufoony

.github/workflows/cmake_install.yml

@@ -27,6 +27,6 @@ jobs:
       working-directory: ${{github.workspace}}
       run: |
         touch test.cpp
-        echo "#include <dsm/dsm.hpp>" >> test.cpp
+        echo "#include <dsf/dsf.hpp>" >> test.cpp
         echo "int main() {}" >> test.cpp
-        g++ test.cpp -std=c++20 && echo "Compiled successfully" || echo "Cannot include dsm"
+        g++ test.cpp -std=c++20 && echo "Compiled successfully" || echo "Cannot include dsf"

.github/workflows/cmake_install_macos.yml

@@ -34,8 +34,8 @@ jobs:
       working-directory: ${{github.workspace}}
       run: |
         touch test.cpp
-        echo "#include <dsm/dsm.hpp>" >> test.cpp
+        echo "#include <dsf/dsf.hpp>" >> test.cpp
         echo "int main() {}" >> test.cpp
         g++ test.cpp -std=c++20 -I$(brew --prefix tbb)/include -L$(brew --prefix tbb)/lib -ltbb \
           && echo "Compiled successfully" \
-          || (echo "Cannot include dsm" ; exit 1)
+          || (echo "Cannot include dsf" ; exit 1)

.github/workflows/cmake_test.yml

@@ -33,7 +33,7 @@ jobs:
 
     - name: Run tests
       working-directory: ${{github.workspace}}/test
-      run: ./dsm_tests.out
+      run: ./dsf_tests.out
 
     - name: create Report
       working-directory: ${{github.workspace}}/test

.github/workflows/cmake_test_macos.yml

@@ -27,4 +27,4 @@ jobs:
 
     - name: Run tests
       working-directory: ${{github.workspace}}/test
-      run: ./dsm_tests.out
+      run: ./dsf_tests.out

.gitignore

@@ -38,7 +38,8 @@ images
 examples/debug
 examples/release
 
-test/data/*dsm
+test/data/*dsf
 
 
 webapp/data/*
+*egg-info*

CMakeLists.txt

@@ -1,6 +1,17 @@
 cmake_minimum_required(VERSION 3.16.0)
 
-project(dms VERSION 2.5.8 LANGUAGES CXX)
+# Read version from header file
+file(READ "${CMAKE_CURRENT_SOURCE_DIR}/src/dsf/dsf.hpp" DSF_HPP_CONTENT)
+string(REGEX MATCH "DSF_VERSION_MAJOR = ([0-9]+)" _ ${DSF_HPP_CONTENT})
+set(DSF_VERSION_MAJOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "DSF_VERSION_MINOR = ([0-9]+)" _ ${DSF_HPP_CONTENT})
+set(DSF_VERSION_MINOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "DSF_VERSION_PATCH = ([0-9]+)" _ ${DSF_HPP_CONTENT})
+set(DSF_VERSION_PATCH ${CMAKE_MATCH_1})
+
+set(DSF_VERSION "${DSF_VERSION_MAJOR}.${DSF_VERSION_MINOR}.${DSF_VERSION_PATCH}")
+
+project(dsf VERSION ${DSF_VERSION} LANGUAGES CXX)
 
 # Set the C++ standard
 set(CMAKE_CXX_STANDARD 20)
@@ -14,16 +25,16 @@ endif()
 
 find_package(TBB REQUIRED CONFIG)
 
-file(GLOB SOURCES "src/dsm/sources/*.cpp" "src/dsm/utility/*.cpp")
+file(GLOB SOURCES "src/dsf/sources/*.cpp" "src/dsf/utility/*.cpp")
 
-add_library(dsm STATIC ${SOURCES})
-target_include_directories(dsm PUBLIC 
+add_library(dsf STATIC ${SOURCES})
+target_include_directories(dsf PUBLIC 
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/src/headers>
     $<INSTALL_INTERFACE:include>
 )
-target_link_libraries(dsm PRIVATE TBB::tbb)
+target_link_libraries(dsf PRIVATE TBB::tbb)
 
-install(TARGETS dsm
+install(TARGETS dsf
         EXPORT dsmConfig
         ARCHIVE DESTINATION lib
         LIBRARY DESTINATION lib
@@ -33,5 +44,40 @@ install(DIRECTORY ${PROJECT_SOURCE_DIR}/src/ DESTINATION ${CMAKE_INSTALL_PREFIX}
 
 install(EXPORT dsmConfig
         FILE dsmConfig.cmake
-        NAMESPACE dsm::
-        DESTINATION lib/cmake/dsm)
+        NAMESPACE dsf::
+        DESTINATION lib/cmake/dsf)
+
+# Optional Python bindings - only build if requested
+option(BUILD_PYTHON_BINDINGS "Build Python bindings" OFF)
+
+if(BUILD_PYTHON_BINDINGS)
+    include(FetchContent)
+    
+    # Get pybind11
+    FetchContent_Declare(pybind11
+        GIT_REPOSITORY https://github.com/pybind/pybind11.git
+        GIT_TAG v2.13.6
+    )
+    FetchContent_GetProperties(pybind11)
+    if(NOT pybind11_POPULATED)
+        FetchContent_MakeAvailable(pybind11)
+    endif()
+
+    # Add the Python binding module
+    add_library(dsf_python_module MODULE src/dsf/binding.cpp)
+
+    # Ensure the Python module name has no 'lib' prefix on Unix systems
+    set_target_properties(dsf_python_module PROPERTIES
+        PREFIX ""
+        OUTPUT_NAME "dsf"
+    )
+
+    # Link the pybind11 module with your static library and pybind11
+    target_link_libraries(dsf_python_module PRIVATE dsf pybind11::module pybind11::headers)
+
+    # Set include directories (if binding.cpp needs headers from your project)
+    target_include_directories(dsf_python_module PRIVATE 
+        ${CMAKE_CURRENT_SOURCE_DIR}/src/headers
+    )
+endif()
+

Doxyfile

@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./src/dsm/headers
+INPUT                  = ./src/dsf/headers
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

README.md

@@ -48,6 +48,24 @@ cmake --build build
 cmake --install build
 ```
 
+## Installation via Pybind11
+If you want to use the library from Python, you can build the Python bindings using [pybind11](https://github.com/pybind/pybind11). Make sure you have Python and pybind11 installed:
+```shell
+pip install pybind11
+```
+
+Then, the installation is automatic via `pip`:
+```shell
+pip install .
+```
+
+After installation, you should be able to import the module in Python:
+```python
+import dsf
+```
+
+If you encounter issues, ensure that the installation path is in your `PYTHONPATH` environment variable.
+
 ## Testing
 This project uses [Doctest](https://github.com/doctest/doctest) for testing.
 
@@ -58,7 +76,7 @@ cmake -B build && make -C build
 ```
 To run all the tests together use the command:
 ```shell
-./dsm_tests.out
+./dsf_tests.out
 ```
 
 ## Benchmarking

benchmark/Adj/BenchAdj.cpp

@@ -6,7 +6,7 @@
 #include "SparseMatrix.hpp"
 #include "Bench.hpp"
 
-using namespace dsm;
+using namespace dsf;
 
 using Bench = sb::Bench<long long int>;
 

benchmark/Adj/CMakeLists.txt

@@ -13,10 +13,10 @@ string(APPEND CMAKE_CXX_FLAGS "-Wall -Wextra -O3")
 # Set the folder for the executable
 set(EXECUTABLE_OUTPUT_PATH ../../)
 
-include_directories(../../src/dsm/headers)
-include_directories(../../src/dsm/utility/)
+include_directories(../../src/dsf/headers)
+include_directories(../../src/dsf/utility/)
 
-file(GLOB SOURCES "../../src/dsm/sources/*.cpp" "../../src/dsm/utility/*.cpp")
+file(GLOB SOURCES "../../src/dsf/sources/*.cpp" "../../src/dsf/utility/*.cpp")
 
 # Compile
 add_executable(bench_adj.out BenchAdj.cpp ${SOURCES})