PySDM-examples 3.0.0rc12__tar.gz → 3.0.0rc13__tar.gz

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm-examples
-Version: 3.0.0rc12
+Version: 3.0.0rc13
 Summary: PySDM usage examples reproducing results from literature and depicting how to use PySDM from Python Jupyter notebooks
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors
@@ -15,7 +15,6 @@ Requires-Dist: PyMPDATA
 Requires-Dist: open-atmos-jupyter-utils
 Requires-Dist: pystrict
 Requires-Dist: matplotlib
-Requires-Dist: Pillow
 Requires-Dist: joblib
 Requires-Dist: ipywidgets
 Requires-Dist: seaborn
@@ -26,11 +25,10 @@ Requires-Dist: pyvinecopulib
 Requires-Dist: networkx
 Provides-Extra: ci-version-pins
 Requires-Dist: PySDM[CI_version_pins]; extra == "ci-version-pins"
-Requires-Dist: PyMPDATA==1.6.1; extra == "ci-version-pins"
+Requires-Dist: PyMPDATA==1.6.3; extra == "ci-version-pins"
 Requires-Dist: open-atmos-jupyter-utils==1.3.0; extra == "ci-version-pins"
 Requires-Dist: pystrict==1.3; extra == "ci-version-pins"
 Requires-Dist: matplotlib!=3.9.1; extra == "ci-version-pins"
-Requires-Dist: Pillow<11.3.0; extra == "ci-version-pins"
 Requires-Dist: joblib==1.5.1; extra == "ci-version-pins"
 Requires-Dist: ipywidgets==8.1.7; extra == "ci-version-pins"
 Requires-Dist: seaborn==0.13.2; extra == "ci-version-pins"
@@ -137,6 +135,7 @@ Example notebooks include:
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Yang_et_al_2018.html">Yang_et_al_2018</a>: polydisperse particle spectrum, activation/deactivation cycles
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Abdul_Razzak_Ghan_2000.html">Abdul_Razzak_Ghan_2000</a>: polydisperse activation, comparison against <mark>GCM parameterisation</mark>
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Pyrcel.html">Pyrcel</a>: polydisperse activation, mimicking example test case from <mark>Pyrcel</mark> documentation
+  - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Strzabala_2025_BEng.html">Strzabala_2025_BEng</a>: ParaView visualisation example
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Lowe_et_al_2019.html">Lowe_et_al_2019</a>: externally mixed polydisperse size spectrum with <mark>surface-active organics</mark> case
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Grabowski_and_Pawlowska_2023.html">Grabowski_and_Pawlowska_2023</a>: polydisperse activation, focus on <mark>ripening</mark>
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Jensen_and_Nugent_2017.html">Jensen_and_Nugent_2017</a>: polydisperse activation featuring <mark>giant CCN</mark>
@@ -148,6 +147,10 @@ Example notebooks include:
 
 The parcel environment is also featured in the <a href="https://open-atmos.github.io/PySDM/PySDM.html#tutorials">PySDM tutorials</a>.
 
+<center>
+  <img src="https://github.com/open-atmos/PySDM/releases/download/tip/parcel_animation_ubuntu-24.04.gif" style="width:80%" />
+</center>
+
 ## 0D box environment
 
 The box environment is void of any spatial or thermodynamic context, it constitutes the most basic framework.

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/PySDM_examples/Pyrcel/simulation.py

@@ -13,7 +13,13 @@ from PySDM.physics import si
 
 class Simulation(BasicSimulation):
     def __init__(
-        self, settings, products=None, scipy_solver=False, rtol_thd=1e-10, rtol_x=1e-10
+        self,
+        settings,
+        products=None,
+        scipy_solver=False,
+        rtol_thd=1e-10,
+        rtol_x=1e-10,
+        mass_of_dry_air=44 * si.kg,
     ):
         n_sd = sum(settings.n_sd_per_mode)
         builder = Builder(
@@ -27,7 +33,7 @@ class Simulation(BasicSimulation):
                 initial_water_vapour_mixing_ratio=settings.initial_vapour_mixing_ratio,
                 T0=settings.initial_temperature,
                 w=settings.vertical_velocity,
-                mass_of_dry_air=44 * si.kg,
+                mass_of_dry_air=mass_of_dry_air,
             ),
         )
         builder.add_dynamic(AmbientThermodynamics())

pysdm_examples-3.0.0rc13/PySDM_examples/Strzabala_2025_BEng/__init__.py

@@ -0,0 +1,8 @@
+# pylint: disable=invalid-name
+"""
+ParaView visualisation of a parcel-model example based on the test case from
+[Pyrcel package docs](https://pyrcel.readthedocs.io/)
+
+paraview_parcel_model.ipynb:
+.. include:: ./paraview.ipynb.badges.md
+"""

pysdm_examples-3.0.0rc13/PySDM_examples/Strzabala_2025_BEng/paraview_parcel_model.py

@@ -0,0 +1,244 @@
+#!/usr/bin/env pvpython
+"""
+ParaView pvpython script for visualizing sd_products and sd_attributes.
+"""
+
+import argparse
+from collections import namedtuple
+import pathlib
+from paraview import simple as pvs  # pylint: disable=import-error
+
+pvs._DisableFirstRenderCameraReset()  # pylint: disable=protected-access
+
+
+def cli_using_argparse(argparse_parser):
+    """
+    Command line interface using argparse.
+    """
+    argparse_parser.add_argument(
+        "--sd-products-pvd",
+        dest="sd_products_pvd",
+        help="Path to sd_products.pvd",
+    )
+    argparse_parser.add_argument(
+        "--sd-attributes-pvd",
+        dest="sd_attributes_pvd",
+        help="Path to sd_attributes.pvd",
+    )
+    argparse_parser.add_argument(
+        "--output-animation-path",
+        help="Output path for the animation file.",
+    )
+    argparse_parser.add_argument(
+        "--output-screenshot-path",
+        help="Output path for the screenshot file.",
+    )
+
+    argparse_parser.add_argument(
+        "--scalarbar-title-size",
+        type=int,
+        default=30,
+        help="Font size for scalar bar titles.",
+    )
+    argparse_parser.add_argument(
+        "--scalarbar-label-size",
+        type=int,
+        default=30,
+        help="Font size for scalar bar labels.",
+    )
+    argparse_parser.add_argument(
+        "--axes-title-size",
+        type=int,
+        default=30,
+        help="Font size for axes titles.",
+    )
+    argparse_parser.add_argument(
+        "--axes-label-size",
+        type=int,
+        default=30,
+        help="Font size for axes labels.",
+    )
+
+
+parser = argparse.ArgumentParser(
+    description="ParaView pvpython script for visualizing sd_products and sd_attributes PVD files."
+)
+cli_using_argparse(parser)
+args = parser.parse_args()
+
+sd_productspvd = pvs.PVDReader(
+    registrationName="sd_products.pvd", FileName=args.sd_products_pvd
+)
+sd_attributespvd = pvs.PVDReader(
+    registrationName="sd_attributes.pvd", FileName=args.sd_attributes_pvd
+)
+
+setup = {
+    "renderView1": pvs.GetActiveViewOrCreate("RenderView"),
+    "sd_productspvdDisplay": pvs.Show(
+        sd_productspvd,
+        pvs.GetActiveViewOrCreate("RenderView"),
+        "UnstructuredGridRepresentation",
+    ),
+    "sd_attributespvdDisplay": pvs.Show(
+        sd_attributespvd,
+        pvs.GetActiveViewOrCreate("RenderView"),
+        "UnstructuredGridRepresentation",
+    ),
+    "rHlookup_table": pvs.GetColorTransferFunction("RH"),
+    "volumelookup_table": pvs.GetColorTransferFunction("volume"),
+}
+
+animation_setup = namedtuple("setup", setup.keys())(**setup)
+
+
+def configure_color_bar_and_display(
+    display, lookup_table, kind, *, anim_setup=animation_setup
+):
+    """
+    Configure color bar and display settings.
+    """
+    display.Representation = "Surface"
+    display.SetScalarBarVisibility(anim_setup.renderView1, True)
+    color_bar = pvs.GetScalarBar(lookup_table, anim_setup.renderView1)
+    color_bar.LabelColor = [0.0, 0.0, 0.0]
+    color_bar.DrawScalarBarOutline = 1
+    color_bar.ScalarBarOutlineColor = [0.0, 0.0, 0.0]
+    color_bar.TitleColor = [0.0, 0.0, 0.0]
+
+    color_bar.TitleFontSize = args.scalarbar_title_size
+    color_bar.LabelFontSize = args.scalarbar_label_size
+
+    if kind == "prod":
+        display.Opacity = 0.4
+        display.DisableLighting = 1
+        display.Diffuse = 0.76
+        lookup_table.RescaleTransferFunction(90.0, 101.0)
+        lookup_table.ApplyPreset("Black, Blue and White", True)
+        lookup_table.NanColor = [0.67, 1.0, 1.0]
+    else:
+        display.PointSize = 13.0
+        display.RenderPointsAsSpheres = 1
+        display.Interpolation = "PBR"
+        lookup_table.RescaleTransferFunction(1e-18, 1e-13)
+        lookup_table.ApplyPreset("Cold and Hot", True)
+        lookup_table.MapControlPointsToLogSpace()
+        lookup_table.UseLogScale = 1
+        lookup_table.NumberOfTableValues = 16
+        lookup_table.InvertTransferFunction()
+
+
+def configure_data_axes_grid(display, kind):
+    """
+    Configure data axes grid settings.
+    """
+    display.DataAxesGrid.GridAxesVisibility = 1
+    display.DataAxesGrid.XTitle = ""
+    display.DataAxesGrid.YTitle = ""
+    display.DataAxesGrid.XAxisUseCustomLabels = 1
+    display.DataAxesGrid.YAxisUseCustomLabels = 1
+
+    display.DataAxesGrid.XTitleFontSize = args.axes_title_size
+    display.DataAxesGrid.XLabelFontSize = args.axes_label_size
+    display.DataAxesGrid.YTitleFontSize = args.axes_title_size
+    display.DataAxesGrid.YLabelFontSize = args.axes_label_size
+
+    if kind == "prod":
+        display.DataAxesGrid.ZTitle = ""
+        display.DataAxesGrid.GridColor = [0.0, 0.0, 0.0]
+        display.DataAxesGrid.ShowGrid = 1
+        display.DataAxesGrid.LabelUniqueEdgesOnly = 0
+        display.DataAxesGrid.ZAxisUseCustomLabels = 1
+        display.DataAxesGrid.ZTitleFontSize = args.axes_title_size
+        display.DataAxesGrid.ZLabelFontSize = args.axes_label_size
+    else:
+        display.DataAxesGrid.ZTitle = "Z [m]"
+        display.DataAxesGrid.ZLabelColor = [0.0, 0.0, 0.0]
+        display.DataAxesGrid.ZTitleColor = [0.0, 0.0, 0.0]
+        display.DataAxesGrid.ZTitleFontSize = args.axes_title_size
+        display.DataAxesGrid.ZLabelFontSize = args.axes_label_size
+
+
+def configure_view_appearance(render_view):
+    """
+    Configure view appearance settings."""
+    render_view.OrientationAxesLabelColor = [0.0, 0.0, 0.0]
+    render_view.OrientationAxesOutlineColor = [0.0, 0.0, 0.0]
+    render_view.OrientationAxesXVisibility = 0
+    render_view.OrientationAxesYVisibility = 0
+    render_view.OrientationAxesZColor = [0.0, 0.0, 0.0]
+    render_view.UseColorPaletteForBackground = 0
+    render_view.Background = [1.0, 1.0, 1.0]
+
+
+def set_camera_view(render_view):
+    """
+    Set camera view settings.
+    """
+    layout1 = pvs.GetLayout()
+    layout1.SetSize(1592, 1128)
+    render_view.CameraPosition = [
+        1548.95,
+        -1349.49,
+        699.27,
+    ]
+    render_view.CameraFocalPoint = [
+        -1.37e-13,
+        3.18e-13,
+        505.00,
+    ]
+    render_view.CameraViewUp = [
+        -0.07,
+        0.06,
+        0.99,
+    ]
+    render_view.CameraParallelScale = 534.08
+
+
+def save_animation_and_screenshot(render_view, animation_path, screenshot_path):
+    """
+    Save animation and screenshot.
+    """
+    animation_scene = pvs.GetAnimationScene()
+    animation_scene.UpdateAnimationUsingDataTimeSteps()
+
+    pvs.SaveAnimation(animation_path, render_view, FrameRate=15)
+
+    if not screenshot_path:
+        return
+
+    time_steps = sd_productspvd.TimestepValues
+    if not time_steps:
+        return
+
+    last_time = time_steps[-1]
+    render_view.ViewTime = last_time
+
+    for reader in (sd_productspvd, sd_attributespvd):
+        reader.UpdatePipeline(last_time)
+
+    pvs.ExportView(
+        filename=str(pathlib.Path(screenshot_path)),
+        view=render_view,
+        Rasterize3Dgeometry=False,
+        GL2PSdepthsortmethod="BSP sorting (slow, best)",
+    )
+
+    pvs.RenderAllViews()
+
+
+configure_color_bar_and_display(
+    animation_setup.sd_productspvdDisplay, animation_setup.rHlookup_table, kind="prod"
+)
+configure_data_axes_grid(animation_setup.sd_productspvdDisplay, kind="prod")
+configure_view_appearance(animation_setup.renderView1)
+configure_color_bar_and_display(
+    animation_setup.sd_attributespvdDisplay,
+    animation_setup.volumelookup_table,
+    kind="attr",
+)
+configure_data_axes_grid(animation_setup.sd_attributespvdDisplay, kind="attr")
+set_camera_view(animation_setup.renderView1)
+save_animation_and_screenshot(
+    animation_setup.renderView1, args.output_animation_path, args.output_screenshot_path
+)

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/docs/pysdm_examples_landing.md

@@ -86,6 +86,7 @@ Example notebooks include:
   - `PySDM_examples.Yang_et_al_2018`: polydisperse particle spectrum, activation/deactivation cycles
   - `PySDM_examples.Abdul_Razzak_Ghan_2000`: polydisperse activation, comparison against <mark>GCM parameterisation</mark>
   - `PySDM_examples.Pyrcel`: polydisperse activation, mimicking example test case from <mark>Pyrcel</mark> documentation
+  - `PySDM_examples.Strzabala_2025_BEng`: ParaView visualisation example
   - `PySDM_examples.Lowe_et_al_2019`: externally mixed polydisperse size spectrum with <mark>surface-active organics</mark> case
   - `PySDM_examples.Grabowski_and_Pawlowska_2023`: polydisperse activation, focus on <mark>ripening</mark>
   - `PySDM_examples.Jensen_and_Nugent_2017`: polydisperse activation featuring <mark>giant CCN</mark>
@@ -97,6 +98,10 @@ Example notebooks include:
 
 The parcel environment is also featured in the <a href="https://open-atmos.github.io/PySDM/PySDM.html#tutorials">PySDM tutorials</a>.
 
+<center>
+  <img src="https://github.com/open-atmos/PySDM/releases/download/tip/parcel_animation_ubuntu-24.04.gif" style="width:80%" />
+</center>
+
 ## 0D box environment
 
 The box environment is void of any spatial or thermodynamic context, it constitutes the most basic framework.

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/pysdm_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm-examples
-Version: 3.0.0rc12
+Version: 3.0.0rc13
 Summary: PySDM usage examples reproducing results from literature and depicting how to use PySDM from Python Jupyter notebooks
 Home-page: https://github.com/open-atmos/PySDM
 Author: https://github.com/open-atmos/PySDM/graphs/contributors
@@ -15,7 +15,6 @@ Requires-Dist: PyMPDATA
 Requires-Dist: open-atmos-jupyter-utils
 Requires-Dist: pystrict
 Requires-Dist: matplotlib
-Requires-Dist: Pillow
 Requires-Dist: joblib
 Requires-Dist: ipywidgets
 Requires-Dist: seaborn
@@ -26,11 +25,10 @@ Requires-Dist: pyvinecopulib
 Requires-Dist: networkx
 Provides-Extra: ci-version-pins
 Requires-Dist: PySDM[CI_version_pins]; extra == "ci-version-pins"
-Requires-Dist: PyMPDATA==1.6.1; extra == "ci-version-pins"
+Requires-Dist: PyMPDATA==1.6.3; extra == "ci-version-pins"
 Requires-Dist: open-atmos-jupyter-utils==1.3.0; extra == "ci-version-pins"
 Requires-Dist: pystrict==1.3; extra == "ci-version-pins"
 Requires-Dist: matplotlib!=3.9.1; extra == "ci-version-pins"
-Requires-Dist: Pillow<11.3.0; extra == "ci-version-pins"
 Requires-Dist: joblib==1.5.1; extra == "ci-version-pins"
 Requires-Dist: ipywidgets==8.1.7; extra == "ci-version-pins"
 Requires-Dist: seaborn==0.13.2; extra == "ci-version-pins"
@@ -137,6 +135,7 @@ Example notebooks include:
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Yang_et_al_2018.html">Yang_et_al_2018</a>: polydisperse particle spectrum, activation/deactivation cycles
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Abdul_Razzak_Ghan_2000.html">Abdul_Razzak_Ghan_2000</a>: polydisperse activation, comparison against <mark>GCM parameterisation</mark>
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Pyrcel.html">Pyrcel</a>: polydisperse activation, mimicking example test case from <mark>Pyrcel</mark> documentation
+  - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Strzabala_2025_BEng.html">Strzabala_2025_BEng</a>: ParaView visualisation example
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Lowe_et_al_2019.html">Lowe_et_al_2019</a>: externally mixed polydisperse size spectrum with <mark>surface-active organics</mark> case
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Grabowski_and_Pawlowska_2023.html">Grabowski_and_Pawlowska_2023</a>: polydisperse activation, focus on <mark>ripening</mark>
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Jensen_and_Nugent_2017.html">Jensen_and_Nugent_2017</a>: polydisperse activation featuring <mark>giant CCN</mark>
@@ -148,6 +147,10 @@ Example notebooks include:
 
 The parcel environment is also featured in the <a href="https://open-atmos.github.io/PySDM/PySDM.html#tutorials">PySDM tutorials</a>.
 
+<center>
+  <img src="https://github.com/open-atmos/PySDM/releases/download/tip/parcel_animation_ubuntu-24.04.gif" style="width:80%" />
+</center>
+
 ## 0D box environment
 
 The box environment is void of any spatial or thermodynamic context, it constitutes the most basic framework.

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/pysdm_examples.egg-info/SOURCES.txt

@@ -127,6 +127,8 @@ PySDM_examples/Srivastava_1982/example.py
 PySDM_examples/Srivastava_1982/settings.py
 PySDM_examples/Srivastava_1982/simulation.py
 PySDM_examples/Stewart_1975/__init__.py
+PySDM_examples/Strzabala_2025_BEng/__init__.py
+PySDM_examples/Strzabala_2025_BEng/paraview_parcel_model.py
 PySDM_examples/Toon_et_al_1980/__init__.py
 PySDM_examples/Van_Hook_1968/__init__.py
 PySDM_examples/Ware_et_al_2025/__init__.py

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/pysdm_examples.egg-info/requires.txt

@@ -3,7 +3,6 @@ PyMPDATA
 open-atmos-jupyter-utils
 pystrict
 matplotlib
-Pillow
 joblib
 ipywidgets
 seaborn
@@ -15,11 +14,10 @@ networkx
 
 [CI_version_pins]
 PySDM[CI_version_pins]
-PyMPDATA==1.6.1
+PyMPDATA==1.6.3
 open-atmos-jupyter-utils==1.3.0
 pystrict==1.3
 matplotlib!=3.9.1
-Pillow<11.3.0
 joblib==1.5.1
 ipywidgets==8.1.7
 seaborn==0.13.2

{pysdm_examples-3.0.0rc12 → pysdm_examples-3.0.0rc13}/setup.py

@@ -28,7 +28,6 @@ setup(
         "open-atmos-jupyter-utils",
         "pystrict",
         "matplotlib",
-        "Pillow",
         "joblib",
         "ipywidgets",
         "seaborn",
@@ -41,11 +40,10 @@ setup(
     extras_require={
         "CI_version_pins": [
             "PySDM[CI_version_pins]",
-            "PyMPDATA==1.6.1",
+            "PyMPDATA==1.6.3",
             "open-atmos-jupyter-utils==1.3.0",
             "pystrict==1.3",
             "matplotlib!=3.9.1",
-            "Pillow<11.3.0",
             "joblib==1.5.1",
             "ipywidgets==8.1.7",
             "seaborn==0.13.2",