Skip to content

Commit 7251fb1

Browse files
authored
fix paths in CI workflow for uploading Paraview-generated animations; add link to animation-generating notebook below the animations (#1613)
1 parent 6fc8899 commit 7251fb1

File tree

3 files changed

+13
-7
lines changed

3 files changed

+13
-7
lines changed

.github/workflows/tests.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,15 +294,15 @@ jobs:
294294
if: ( ! startsWith(matrix.platform, 'windows-') ) && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
295295
uses: actions/upload-artifact@v4
296296
with:
297-
name: animation-movie
297+
name: animation-movie-${{ matrix.platform }}
298298
if-no-files-found: error
299299
path: ~/work/_temp/_github_home/figures/*.mp4
300300

301301
- name: animation frame upload
302302
if: ( ! startsWith(matrix.platform, 'windows-') ) && matrix.test-suite == env.anim_test-suite && matrix.python-version == env.anim_python-version
303303
uses: actions/upload-artifact@v4
304304
with:
305-
name: animation-frame
305+
name: animation-frame-${{ matrix.platform }}
306306
if-no-files-found: error
307307
path: ~/work/_temp/_github_home/figures/*.pdf
308308

@@ -311,4 +311,4 @@ jobs:
311311
uses: eine/tip@master
312312
with:
313313
token: ${{ secrets.GITHUB_TOKEN }}
314-
files: /*(home|Users)/runner/work/_temp/_github_home/figures/*.mp4
314+
files: ~/work/_temp/_github_home/figures/*.mp4

docs/templates/index.html.jinja2

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,13 @@
3131
<div style="padding-top: 2em">
3232
<h2>What is PySDM?</h2>
3333
<p>
34-
<video controls style="float:right; width:40%">
34+
<div style="float:right; width:40%">
35+
<video controls style="width:100%">
3536
<source src="https://github.com/open-atmos/PySDM/releases/download/tip/docs_intro_animation_ubuntu-24.04.mp4" type="video/mp4">
3637
Your browser does not support the video tag.
3738
</video>
39+
<a href="https://github.com/open-atmos/PySDM/blob/main/examples/PySDM_examples/_HOWTOs/paraview_hello_world.ipynb" style="small">Jupyter notebook setting up and running the above PySDM simulation and generating the visualisation using Paraview</a>
40+
</div>
3841
PySDM is a package for simulating the <mark>dynamics of population of particles undergoing diffusional and collisional growth (and breakage)</mark>.
3942
The package features a Pythonic high-performance (multi-threaded CPU &amp; CUDA GPU) implementation of the <mark>Super-Droplet Method (SDM) Monte-Carlo algorithm</mark>
4043
for representing collisional growth (<a href="https://doi.org/10.1002/qj.441">Shima et al. 2009</a>), hence the name.

examples/docs/pysdm_examples_landing.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,15 @@ The 2D prescribed-flow framework used here can be traced back to the work of
3939
and dry-air potential temperature.
4040
In PySDM-examples, the Eulerian advection is handled using the <a href="https://doi.org/10.21105/joss.03896">PyMPDATA</a> Numba-based
4141
implementation of the <a href="https://doi.org/10.1002/fld.1071">MPDATA numerical scheme of Smolarkiewicz (e.g., 2006)</a>.
42-
An animation depicting PySDM simulation capturing <mark>aerosol collisional processing</mark> by warm rain is shown below:
43-
44-
<video controls style="width:100%">
42+
An animation depicting PySDM simulation capturing <mark>aerosol collisional processing</mark> by warm rain is shown below
43+
(<a href="https://github.com/open-atmos/PySDM/blob/main/examples/PySDM_examples/_HOWTOs/paraview_hello_world.ipynb">see
44+
the Paraview hello-world HOWTO Jupyter notbook for code generating the simulation and visualisation</a>):
45+
<center>
46+
<video controls style="width:80%">
4547
<source src="https://github.com/open-atmos/PySDM/releases/download/tip/docs_intro_animation_ubuntu-24.04.mp4" type="video/mp4">
4648
Your browser does not support the video tag.
4749
</video>
50+
</center>
4851

4952
Example notebooks:
5053
- `PySDM_examples.Arabas_et_al_2015`

0 commit comments

Comments
 (0)