Add Abstract Droplet Simulation (#14)

* Add JSON porter for network and simulation import new json model

* :text: Update Network1a to new json model

* :text: Refactor Network1a-d JSON files

* 🔨 Merge 1D and Hybrid - network architecture

* 🎉 Initial commit merged 1D and Hybrid Simulators

* 🔀 merge main into addDroplet1D

* 🚨 Add tests of 1D droplet simulator

* 🚧 WIP: Making 1D droplet tests pass

* ✔️ Make 1D droplet tests pass

* ✔️ Make all tests pass

* ⚡ Update example cases for new JSON porting definition

* 🚨 Update tests with main branch

* Refactor code for no interdependency

* 🐛 Fix compiler warnings

* 🐛 Memory allocation in lbmModule

* 🐍 Fix python binding

* Add Windows CI

* 🚨 Add tests for windows

* 🐍 Add python wheels - windows

* Undo separate droplet definition in JSON

* Rename enumeration values of Type and Platform

* Create porting functions for json string

* 🔨 Refactor result.json output

* :bugfix: Store JSON results according to index ordering

* 🐛 Fix unique droplet ID in JSON result

* 🐛 Add volume to droplet definition in JSON result

* WIP: Update Python Bindings

* Add Python Test Abstract Droplet

* WIP: Add Python Test for Continuous Hybrid

* Add tests for JSON definition

* WIP: Update Readme

* Add VTK Folder entry to JSON Definition

* 📚 🚨 WIP: Update Readme and Add Tests New Release

* 📚 🚨 Update Readme and Add Tests New Release

* 📚 Update Readme New Release

* Prepare Rename MMFT Hybrid Simulator to MMFT Simulator

* Update Readme

* Add missing documentation

* Fix python package init

* 🔥 Disable windows wheel build

* 🐛 Fix Test option cmake

Author: micheltakken

.github/workflows/cmake_windows.yml

@@ -0,0 +1,24 @@
+name: Windows-build
+
+on: [push]
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  build:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+    
+    - uses: msys2/setup-msys2@v2
+
+    - name: Configure CMake
+      run: cmake -S . -B build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -G "MinGW Makefiles"
+
+    - name: Build
+      run: cmake --build build

.github/workflows/publish-to-pypi.yml

@@ -15,21 +15,41 @@ concurrency:
 
 jobs:
   build_wheels:
-    name:    ${{ matrix.os }} wheels
-    runs-on: ${{ matrix.os }}
+    name:    ${{ matrix.runs-on.os }} ${{ matrix.python }} wheels
+    runs-on: ${{ matrix.runs-on.os }}
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest ]
+        runs-on:
+          - { os: ubuntu-latest, shell: bash }
+          - { os: macos-11, shell: bash }
+          #- { os: windows-latest, shell: "msys2 {0}" }
+        python: ["cp38", "cp39", "cp310", "cp311", "cp312"]
+    defaults:
+      run:
+        shell: ${{ matrix.runs-on.shell }}
     steps:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
           submodules:  recursive
+      - if: runner.os == 'Windows' 
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: MINGW64
+          path-type: inherit
+          install: >-
+            mingw-w64-x86_64-gcc
       - name: Build wheels
-        uses: pypa/cibuildwheel@v2.12.3
-      - uses: actions/upload-artifact@v3
+        run: |
+          pipx run cibuildwheel
+        env:
+          CIBW_ARCHS_WINDOWS: auto64
+          CIBW_ENVIRONMENT_WINDOWS: CC=gcc CXX=g++
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
         with:
+          name: cibw-wheels-${{ runner.os }}-${{ matrix.python }}-${{ strategy.job-index }}
           path: ./wheelhouse/*.whl
 
   build_sdist:

.github/workflows/ubuntu_test.yml

@@ -15,7 +15,7 @@ jobs:
         submodules: recursive
 
     - name: Configure CMake
-      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
+      run: cmake -DTEST=ON -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
 
     - name: Build
       run: cmake --build ${{github.workspace}}/build

.github/workflows/windows_test.yml

@@ -0,0 +1,31 @@
+name: Windows-test
+
+on:
+  pull_request:
+    types: [opened, reopened, edited]
+    branches: [main, develop]
+
+defaults:
+  run:
+    shell: pwsh
+
+jobs:
+  test:
+    runs-on: windows-latest
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+
+    - uses: msys2/setup-msys2@v2
+
+    - name: Configure CMake
+      run: cmake -DTEST=ON -S . -B build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -G "MinGW Makefiles"
+
+    - name: Build
+      run: cmake --build build
+
+    - name: Test 
+      working-directory: ${{github.workspace}}/build
+      run: ./simulatorTest

CMakeLists.txt

@@ -1,8 +1,8 @@
 cmake_minimum_required(VERSION 3.21.0)
 
-project(hybrid-simulator
-    DESCRIPTION "Hybrid simulator for closed channel-based microfluidic devices."
-    HOMEPAGE_URL "https://github.com/cda-tum/mmft-hybrid-simulator.git"
+project(MMFT-simulator
+    DESCRIPTION "Simulator for closed channel-based microfluidic devices."
+    HOMEPAGE_URL "https://github.com/cda-tum/mmft-simulator.git"
     LANGUAGES CXX C
 )
 
@@ -14,6 +14,13 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 add_compile_definitions(PLATFORM_CPU_SISD)
 set(CMAKE_CXX_FLAGS "-O3 -Wall -march=native -mtune=native")
 
+IF (WIN32)
+    set(patch_file ${CMAKE_CURRENT_BINARY_DIR}/_deps/lbm-src/src/core/singleton.h)
+    set(lbm_patch sed -i -f ${CMAKE_CURRENT_SOURCE_DIR}/script.sed ${patch_file})
+ELSE()
+    set(lbm_patch )
+ENDIF()
+
 # download external libraries
 include(FetchContent)
 FetchContent_Declare(
@@ -34,6 +41,7 @@ FetchContent_Declare(
 FetchContent_Declare(
     lbm
     URL https://www.openlb.net/wp-content/uploads/2022/04/olb-1.5r0.tgz
+    PATCH_COMMAND ${lbm_patch}
     CONFIGURE_COMMAND ""
     BUILD_COMMAND ""
 )
@@ -90,7 +98,7 @@ target_include_directories(
     ${lbm_SOURCE_DIR}/external/zlib
 )
 # add library
-set(TARGET_NAME hybridLib)
+set(TARGET_NAME simLib)
 add_library(${TARGET_NAME})
 
 # add sources
@@ -99,23 +107,29 @@ add_subdirectory(src)
 # create executable and tests (if build as main project)
 
 # main executable
-add_executable(hybridSim)
-target_sources(hybridSim PUBLIC src/main.cpp)
-target_link_libraries(hybridSim PUBLIC ${TARGET_NAME})
+add_executable(MMFTSim)
+target_sources(MMFTSim PUBLIC src/main.cpp)
+target_link_libraries(MMFTSim PUBLIC ${TARGET_NAME})
 
 # add Python binding code
 option(BINDINGS "Configure for building Python bindings")
 if(BINDINGS)
-	add_subdirectory(python/mmft/hybridsim)
+	add_subdirectory(python/mmft/simulator)
 endif()
 
 # create tests
-enable_testing()
-include(GoogleTest)
-set(TARGET_NAME simulatorTest)
-add_executable(${TARGET_NAME})
-target_link_libraries(${TARGET_NAME} PUBLIC gtest gtest_main)
-target_link_libraries(${TARGET_NAME} PUBLIC gtest lbmLib)
-target_link_libraries(${TARGET_NAME} PUBLIC gtest hybridLib)
-add_subdirectory(tests)
-gtest_discover_tests(${TARGET_NAME})
+option(TEST "Configure for building test cases")
+if(TEST)
+    enable_testing()
+    include(GoogleTest)
+    set(TARGET_NAME testLib)
+    add_library(${TARGET_NAME})
+    add_subdirectory(tests)
+    add_executable(simulatorTest)
+    target_sources(simulatorTest PUBLIC tests/test.cpp)
+    target_link_libraries(simulatorTest PUBLIC gtest gtest_main)
+    target_link_libraries(simulatorTest PUBLIC gtest lbmLib)
+    target_link_libraries(simulatorTest PUBLIC gtest simLib)
+    target_link_libraries(simulatorTest PUBLIC gtest testLib)
+    gtest_discover_tests(simulatorTest)
+endif()