demonstrate (within readme) how to use PyPartMC from C++ (incl. shipping the needed C++ header files and a CMake script with the files installed by pip install)

.github/workflows/buildwheels.yml

@@ -82,7 +82,7 @@ jobs:
 
       - uses: actions/upload-artifact@v4
         with:
-          name: dist-${{matrix.os}}-${{matrix.manylinux}}
+          name: dist-${{matrix.os}}
           path: dist
 
   run_example_notebooks:
@@ -106,7 +106,7 @@ jobs:
 
       - uses: actions/download-artifact@v4
         with:
-          name: dist-${{matrix.os}}-${{matrix.manylinux}}
+          name: dist-${{matrix.os}}
           path: dist
 
       # install fortran compiler needed by dustpy
@@ -155,7 +155,7 @@ jobs:
     - run: pip install twine auditwheel
     - uses: actions/download-artifact@v4
       with:
-        name: dist-${{matrix.os}}-${{matrix.manylinux}}
+        name: dist-${{matrix.os}}
         path: dist
     - run: twine check --strict dist/*
     - run: for i in dist/*-manylinux*.whl; do auditwheel show $i; done;
@@ -223,3 +223,251 @@ jobs:
       uses: pypa/gh-action-pypi-publish@release/v1.14
       with:
         attestations: false
+
+  readme_julia:
+    runs-on: ${{ matrix.os }}
+    needs: [build_wheels]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-${{matrix.os}}
+          path: dist
+
+      - run: | 
+          temp=`find dist/ -name "*cp313*.whl"`
+          python -m pip install $temp[examples]
+      - run: pip install pytest-codeblocks pytest
+      - run: python -c "import pytest_codeblocks; code=pytest_codeblocks.extract_from_file('README.md'); f=open('readme.jl', 'w'); f.writelines(block.code for block in code if block.syntax=='Julia'); f.close()"
+      - run: cat -n readme.jl
+
+      - uses: julia-actions/setup-julia@v3
+      - run: mkdir readme_output
+      - run: julia readme.jl > readme_output/julia_${{ matrix.os }}.txt
+      - uses: actions/upload-artifact@v4
+        with:
+          name: readme_output-julia_${{matrix.os}}
+          path: readme_output
+
+  readme_python:
+    runs-on: ${{ matrix.os }}
+    needs: [build_wheels]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-${{matrix.os}}
+          path: dist
+
+      - run: | 
+          temp=`find dist/ -name "*cp313*.whl"`
+          python -m pip install $temp[examples]
+
+      - run: pip install pytest-codeblocks pytest
+      - run: python -c "import pytest_codeblocks; code=pytest_codeblocks.extract_from_file('README.md'); f=open('readme.py', 'w'); f.writelines(block.code for block in code if block.syntax=='Python'); f.close()"
+      - run: cat -n readme.py
+
+      - run: mkdir readme_output
+      - run: python -We readme.py > readme_output/python_${{ matrix.os }}.txt
+      - uses: actions/upload-artifact@v4
+        with:
+          name: readme_output-python_${{matrix.os}}
+          path: readme_output
+
+  readme_fortran:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - run: |
+          sudo apt-get update
+          sudo apt-get install libnetcdff-dev
+      - run: |
+          cd readme_fortran
+          mkdir build
+          cd build
+          PARTMC_HOME=../../gitmodules/partmc cmake ..
+          make
+
+      - run: |
+          mkdir readme_output
+          cd readme_fortran
+          ./build/main > ../readme_output/fortran_${{matrix.os}}.txt
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: readme_output-fortran_${{matrix.os}}
+          path: readme_output
+
+  readme_assert:
+    runs-on: ubuntu-latest
+    needs: [readme_julia, readme_python, readme_matlab, readme_fortran, readme_cpp]
+    steps:
+    - uses: actions/setup-python@v6
+    - run: pip install numpy
+    - uses: actions/download-artifact@v4
+      with:
+          pattern: readme_output-*
+          merge-multiple: true
+          path: readme_output
+    - run : python -c 'import numpy as np; import os; dir="readme_output/"; data=[float(np.loadtxt(dir+file)) for file in os.listdir(dir)]; print("data:", data); similar_as_first = np.array([abs(data[0]-k)/data[0] for k in data[1:]]); print("similar_as_first", similar_as_first); assert((similar_as_first < .5).all())'
+
+  readme_cpp:
+    runs-on: ${{ matrix.os }}
+    needs: [build_wheels]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, ubuntu-24.04-arm, macos-15, macos-15-intel, windows-latest]
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.12"
+
+      - uses: jwlawson/actions-setup-cmake@v2.2.0
+        with:
+          cmake-version: '3.26.x'
+
+      - if: matrix.os == 'windows-latest'
+        uses: msys2/setup-msys2@v2
+        with:
+          msystem: UCRT64
+          update: false
+          install: >-
+            mingw-w64-ucrt-x86_64-gcc
+            mingw-w64-ucrt-x86_64-ninja
+            m4
+
+      - if: matrix.os == 'windows-latest'
+        shell: msys2 {0}
+        run: |
+          echo "$(cygpath -m /ucrt64/bin)" >> $GITHUB_PATH
+          echo "$(cygpath -m /usr/bin)" >> $GITHUB_PATH
+          echo "CMAKE_GENERATOR=Ninja" >> $GITHUB_ENV
+          echo "CMAKE_ARGS=-DNC_M4=$(cygpath -m $(which m4))" >> $GITHUB_ENV
+
+      - if: startsWith(matrix.os, 'macos-')
+        run: |
+          brew reinstall gcc
+          pip install --only-binary=llvmlite numba llvmlite!=0.46.0b1
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-${{matrix.os}}
+          path: dist
+
+      - run: | 
+          temp=`find dist/ -name "*cp312*.whl"`
+          python -m pip install $temp[examples]
+
+      - run: pip install pytest-codeblocks pytest
+      - run: mkdir readme_cpp
+      - run: python -c "import pytest_codeblocks; code=pytest_codeblocks.extract_from_file('README.md'); f=open('readme_cpp/test.cpp', 'w'); f.writelines(block.code for block in code if block.syntax=='cpp'); f.close()"
+      - run: cat -n readme_cpp/test.cpp
+
+      - run: python -c "import pytest_codeblocks; code=pytest_codeblocks.extract_from_file('README.md'); f=open('readme_cpp/CMakeLists.txt', 'w'); f.writelines(block.code for block in code if block.syntax=='cmake'); f.close()"
+      - run: cat -n readme_cpp/CMakeLists.txt
+
+      - name: build
+        run: |
+         cd readme_cpp
+         mkdir build
+         cd build
+         cmake ..
+         cmake --build .
+      - if: matrix.os == 'windows-latest'
+        run: |
+         gdb -batch \
+         -ex "run" \
+         -ex "bt full" \
+         -ex "quit $_exitcode" \
+         --args readme_cpp/build/my_test.exe
+      - name: Execute tests
+        run: | 
+         mkdir -p readme_output
+         if [ "$RUNNER_OS" == "Windows" ]; then
+           ./readme_cpp/build/my_test.exe > readme_output/cpp_${{matrix.os}}.txt
+         else
+           ./readme_cpp/build/my_test > readme_output/cpp_${{matrix.os}}.txt
+         fi
+      - uses: actions/upload-artifact@v4
+        with:
+          name: readme_output-cpp_${{matrix.os}}
+          path: readme_output
+
+  readme_matlab:
+    runs-on: ${{ matrix.os }}
+    needs: [build_wheels]
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist-${{matrix.os}}
+          path: dist
+
+      - run: pip install --verbose dist/*cp310*manylinux*.whl
+
+      - run: pip install pytest-codeblocks pytest
+      - run: python -c "import pytest_codeblocks; code=pytest_codeblocks.extract_from_file('README.md'); f=open('readme.m', 'w'); f.writelines(block.code for block in code if block.syntax=='Matlab'); f.close()"
+      - run: cat -n readme.m
+
+      - uses: matlab-actions/setup-matlab@v2.6.1
+        with:
+          release: R2024b
+          cache: true
+
+      - run: mkdir readme_output
+
+      - uses: matlab-actions/run-command@v2.4.0
+        with:
+          startup-options: -nojvm
+          command: diary('readme_output/matlab.txt'), readme
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: readme_output-matlab
+          path: readme_output