Paraview visualisation tool stand-alone; generation of docs landing site animation on CI + upload to tip release

.github/workflows/pdoc.yml

@@ -26,6 +26,10 @@ jobs:
       - uses: actions/[email protected]
         with:
           python-version: "3.12"
+
+      - name: exclude pvpython scripts
+        run: rm examples/PySDM_examples/utils/pvanim.py
+
       - run: pip install pdoc nbformat gitpython
       - run: pip install -e .
       - run: pip install -e examples

.github/workflows/tests.yml

@@ -4,6 +4,13 @@ defaults:
   run:
     shell: bash
 
+env:
+  # arbitrarily selected runs for generating animation
+  anim_python-version: '3.12'
+  anim_test-suite: 'multi-process_a'
+  # common options for pytest
+  pytest_options: "--durations=10 -v -s -We -p no:unraisableexception"
+
 on:
   push:
     branches: [ main ]
@@ -67,7 +74,7 @@ jobs:
       - run: pip install -r tests/devops_tests/requirements.txt
       - env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: pytest --durations=10 -v -s -We -p no:unraisableexception -k "not test_run_notebooks" tests/devops_tests
+        run: pytest  ${{ env.pytest_options }} -k "not test_run_notebooks" tests/devops_tests
 
   zenodo_json:
     runs-on: ubuntu-24.04
@@ -96,7 +103,7 @@ jobs:
         pip install -e .[tests]
         pip install -e ./examples
         pip install pytest-cov
-        pytest --durations=10 -We tests/unit_tests --cov-report=xml --cov=PySDM
+        pytest ${{ env.pytest_options }} tests/unit_tests --cov-report=xml --cov=PySDM
     - uses: codecov/[email protected]
       with:
         fail_ci_if_error: true
@@ -164,12 +171,7 @@ jobs:
           NUMBA_OPT: 1
         run: |
           shopt -s extglob
-          pytest --durations=10 --timeout=900 --timeout_method=thread -p no:unraisableexception -We tests/${{ matrix.test-suite }}
-
-#       - if: ${{ failure() }}
-#         uses: mxschmitt/action-tmate@v3
-#         with:
-#           limit-access-to-actor: true
+          pytest ${{ env.pytest_options }} --timeout=900 --timeout_method=thread tests/${{ matrix.test-suite }}
 
   examples-setup:
     needs: [nojit_and_codecov]
@@ -245,7 +247,7 @@ jobs:
       - if: startsWith(matrix.platform, 'ubuntu-') && (matrix.test-suite == 'multi-process_a' || matrix.test-suite == 'multi-process_b')
         run: |
           sudo apt-get update
-          sudo apt-get install libegl1 libopengl0 ghostscript
+          sudo apt-get install libegl1 libopengl0 ghostscript ffmpeg
           wget -nv "https://paraview.org/paraview-downloads/download.php?submit=Download&version=v5.13&type=binary&os=Linux&downloadFile=ParaView-5.13.1-egl-MPI-Linux-Python3.10-x86_64.tar.gz" -O paraview.tar.gz
           tar xzf paraview.tar.gz
           echo `pwd`/`dirname ParaView*/bin/pvpython` >> $GITHUB_PATH
@@ -254,7 +256,7 @@ jobs:
         run: |
           brew install --cask paraview
           echo `dirname /Applications/ParaView-*.app/Contents/bin/pvpython | head -1` >> $GITHUB_PATH
-          brew install ghostscript
+          brew install ghostscript ffmpeg
 
       - if: startsWith(matrix.platform, 'windows-') && (matrix.test-suite == 'multi-process_a' || matrix.test-suite == 'multi-process_b')
         run: |
@@ -268,11 +270,45 @@ jobs:
           pvpython -c "from paraview import simple"
 
       - run: |
-          python -m pytest --durations=10 -v -p no:unraisableexception -We tests/examples_tests/test_tests_completeness.py
+          python -m pytest ${{ env.pytest_options }} tests/examples_tests/test_tests_completeness.py
 
-       # TODO #1207
+      # TODO #1207
       - if: startsWith(matrix.platform, 'macos-13')
-        run: python -m pytest --durations=10 -v -p no:unraisableexception -We tests/examples_tests/test_run* -k "not Rozanski_and_Sonntag_1982" --suite ${{ matrix.test-suite }}
+        run: python -m pytest --basetemp=/tmp/pytest ${{ env.pytest_options }} tests/examples_tests/test_run* -k "not Rozanski_and_Sonntag_1982" --suite ${{ matrix.test-suite }}
 
       - if: ( ! startsWith(matrix.platform, 'macos-13') )
-        run: python -m pytest --durations=10 -v -p no:unraisableexception -We tests/examples_tests/test_run* --suite ${{ matrix.test-suite }}
+        run: python -m pytest ${{ env.pytest_options }} --basetemp=/tmp/pytest tests/examples_tests/test_run* --suite ${{ matrix.test-suite }}
+
+      - if: ( ! startsWith(matrix.platform, 'windows-') ) && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
+        run: |
+          set -x
+          mkdir -p $HOME/work/_temp/_github_home/figures
+          rm /tmp/pytest/test_run_notebooks_*current
+          ls /tmp/pytest/test_run_notebooks_*/
+          ls /tmp/pytest/test_run_notebooks_*/output/
+          ffmpeg -i /tmp/pytest/test_run_notebooks_*/output/docs_intro_animation.ogv $HOME/work/_temp/_github_home/figures/docs_intro_animation_${{ matrix.platform }}.mp4
+          mv /tmp/pytest/test_run_notebooks_*/output/last_animation_frame.pdf $HOME/work/_temp/_github_home/figures/last_animation_frame_${{ matrix.platform }}.pdf
+          ls $HOME/work/_temp/_github_home/figures
+
+      - name: animation movie upload
+        if: ( ! startsWith(matrix.platform, 'windows-') ) && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
+        uses: actions/upload-artifact@v4
+        with:
+          name: animation-movie
+          if-no-files-found: error
+          path: ~/work/_temp/_github_home/figures/*.mp4
+
+      - name: animation frame upload
+        if: ( ! startsWith(matrix.platform, 'windows-') ) && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
+        uses: actions/upload-artifact@v4
+        with:
+          name: animation-frame
+          if-no-files-found: error
+          path: ~/work/_temp/_github_home/figures/*.pdf
+
+      - name: tip release upload
+        if: github.ref == 'refs/heads/main' && ( ! startsWith(matrix.platform, 'windows-') ) && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
+        uses: eine/tip@master
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: /*(home|Users)/runner/work/_temp/_github_home/figures/*.mp4

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 files: '.py'
 exclude: '.git'
-default_stages: [commit]
+default_stages: [pre-commit]
 
 repos:
   - repo: https://github.com/psf/black

docs/templates/index.html.jinja2

@@ -32,7 +32,7 @@
         <h2>What is PySDM?</h2>
         <p>
             <video controls style="float:right; width:40%">
-                <source src="https://github.com/open-atmos/PySDM/wiki/files/animation_save.mp4" type="video/mp4">
+                <source src="https://github.com/open-atmos/PySDM/releases/download/tip/docs_intro_animation_ubuntu-24.04.mp4" type="video/mp4">
                 Your browser does not support the video tag.
             </video>
             PySDM is a package for simulating the <mark>dynamics of population of particles undergoing diffusional and collisional growth (and breakage)</mark>.