Prep Release number 2

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: ["**"]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install MPI
+        run: sudo apt-get update && sudo apt-get install -y openmpi-bin libopenmpi-dev
+
+      - name: Build
+        run: make -C src/
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install Python dependencies
+        run: pip install -r requirements-test.txt
+
+      - name: Run unit tests
+        run: pytest tests/ -v
+
+      - name: Run integration tests
+        run: pytest tests/ -v --run-integration

.gitignore

@@ -1,34 +1,53 @@
-# POREMAPS
+# ============================================================
+# POREMAPS — project-specific simulation files
+# ============================================================
+
+# Binary input geometry files (keep only benchmark examples)
 *.raw
 !simulations/99_benchmarks/01_poiseuille/ptube_54_54_50_vs_2e-05.raw
 !simulations/99_benchmarks/02_channel_flow/rect_channel_24_14_50_vs_5e-05.raw
 !simulations/99_benchmarks/03_spherepackings/SPHERE3D_bcc_NX100_NY100_NZ100_PHI0.3_DIAMETER0.0008745237084764591_VSIZE1e-05.raw
 !simulations/99_benchmarks/03_spherepackings/SPHERE3D_fcc_NX100_NY100_NZ100_PHI0.3_DIAMETER0.000693979234383925_VSIZE1e-05.raw
+
+# Solver input files (keep only benchmark examples and the template)
 *.inp
 !simulations/99_benchmarks/01_poiseuille/input_ptube_54_54_50_vs_2e-05.inp
 !simulations/99_benchmarks/02_channel_flow/input_rect_channel_24_14_50_vs_5e-05.raw
 !simulations/99_benchmarks/03_spherepackings/input_SPHERE3D_bcc_NX100_NY100_NZ100_PHI0.3_DIAMETER0.0008745237084764591_VSIZE1e-05.inp
 !simulations/99_benchmarks/03_spherepackings/input_SPHERE3D_fcc_NX100_NY100_NZ100_PHI0.3_DIAMETER0.000693979234383925_VSIZE1e-05.inp
 !input_template.inp
+
+# Solver log and binary output files
 *.log
+
+# VTK/ParaView output files (generated by fields2vtu.py)
+*.vtu
+*.pvtu
+*.vts
+*.pvts
+
+# Compiled solver binary (legacy name kept for safety)
 STOKES_SOLVER*
-POREMAPS*
+bin/POREMAPS
 
+# ============================================================
+# C/C++ build artifacts
+# ============================================================
 
-# Prerequisites
+# Dependency files
 *.d
 
-# Compiled Object files
+# Compiled object files
 *.slo
 *.lo
 *.o
 *.obj
 
-# Precompiled Headers
+# Precompiled headers
 *.gch
 *.pch
 
-# Compiled Dynamic libraries
+# Shared libraries
 *.so
 *.dylib
 *.dll
@@ -37,7 +56,7 @@ POREMAPS*
 *.mod
 *.smod
 
-# Compiled Static libraries
+# Static libraries
 *.lai
 *.la
 *.a
@@ -47,3 +66,31 @@ POREMAPS*
 *.exe
 *.out
 *.app
+
+# ============================================================
+# Python
+# ============================================================
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+.pytest_cache/
+.coverage
+htmlcov/
+
+# ============================================================
+# Editors and IDEs
+# ============================================================
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.clangd/
+compile_commands.json
+
+# ============================================================
+# Operating system
+# ============================================================
+.DS_Store
+Thumbs.db

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2024 David Krach, Matthias Ruf
+Copyright 2024-2026 David Krach, Matthias Ruf
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of 
 this software and associated documentation files (the “Software”), to deal in