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/setup-python@v5.0.0
         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,12 @@ defaults:
   run:
     shell: bash
 
+# arbitrarily selected runs
+env:
+  anim_platform: 'ubuntu-24.04'
+  anim_python-version: '3.12'
+  anim_test-suite: 'multi-process_a'
+
 on:
   push:
     branches: [ main ]
@@ -166,11 +172,6 @@ jobs:
           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
-
   examples-setup:
     needs: [nojit_and_codecov]
     strategy:
@@ -269,10 +270,50 @@ jobs:
 
       - run: |
           python -m pytest --durations=10 -v -p no:unraisableexception -We 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 }}
 
       - 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 }}
+
+      - if: matrix.platform == env.anim_platform && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
+        run: |
+          set -x
+          mkdir -p /home/runner/work/_temp/_github_home/figures
+          ls /tmp/pytest-of-runner/pytest-current/
+          rm /tmp/pytest-of-runner/pytest-current/test_run_notebooks__home_runnecurrent
+          ls /tmp/pytest-of-runner/pytest-current/test_run_notebooks__home_runne*/
+          ls /tmp/pytest-of-runner/pytest-current/test_run_notebooks__home_runne*/output/
+          mv /tmp/pytest-of-runner/pytest-current/test_run_notebooks__home_runne*/output/docs_intro_animation.mp4 /home/runner/work/_temp/_github_home/figures
+          mv /tmp/pytest-of-runner/pytest-current/test_run_notebooks__home_runne*/output/last_animation_frame.pdf /home/runner/work/_temp/_github_home/figures
+          ls /home/runner/work/_temp/_github_home/figures
+
+      - if: ${{ failure() }}
+        uses: mxschmitt/action-tmate@v3
+        with:
+          limit-access-to-actor: true
+
+      - name: animation movie upload
+        if: matrix.platform == env.anim_platform && 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: /github/home/figures/*.mp4
+
+      - name: animation frame upload
+        if: matrix.platform == env.anim_platform && 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: /github/home/figures/*.pdf
+
+      - name: tip release upload
+        if: github.ref == 'refs/heads/main' && matrix.platform == env.anim_platform && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
+        uses: eine/tip@master
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: |
+              /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.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>.