PySDM-examples 2.106__tar.gz → 2.108__tar.gz

{pysdm_examples-2.106 → pysdm_examples-2.108}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pysdm-examples
-Version: 2.106
+Version: 2.108
 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
@@ -83,7 +83,7 @@ Example notebooks:
 - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2015.html">Arabas_et_al_2015</a>
   - in-notebook GUI for setting up, running and interactively visualising the 2D kinematic simulations (with an option to export raw data to <mark>VTK</mark> and <mark>netCDF</mark> files, as well as to save plots to SVG or PDF):
   - "hello world" notebook depicting how to automate using Python the process of loading data and creating animations in <mark>Paraview</mark>
-- <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2023.html">Arabas_et_al_2023</a>: adaptation of the 2D kinematic setup for studying <mark>glaciation</mark> of the cloud deck by <mark>immersion freezing</mark>
+- <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2025.html">Arabas_et_al_2025</a>: adaptation of the 2D kinematic setup for studying <mark>glaciation</mark> of the cloud deck by <mark>immersion freezing</mark>
 
 ## 1D kinematic environment (prescribed-flow, single-column)
 
@@ -142,7 +142,7 @@ Example notebooks include:
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/deJong_Mackay_et_al_2023.html">deJong_Mackay_et_al_2023</a>: validation of the breakup scheme against analytical solutions from <a href="https://doi.org/10.1175/1520-0469(1982)039%3C1317:ASMOPC%3E2.0.CO;2">Srivastava 1982</a>
 - immersion freezing only:
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Alpert_and_Knopf_2016.html">Alpert_and_Knopf_2016</a>: stochastic immersion freezing with monodisperse vs. lognormal immersed surface areas
-  - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2023.html">Arabas_et_al_2023</a>: comparison of time-dependent and singular immersion freezing schemes
+  - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2025.html">Arabas_et_al_2025</a>: comparison of time-dependent and singular immersion freezing schemes
 
 The box environment is also featured in the <a href="https://open-atmos.github.io/PySDM/PySDM.html#tutorials">PySDM tutorials</a>.
 

{pysdm_examples-2.106/PySDM_examples/Arabas_et_al_2023 → pysdm_examples-2.108/PySDM_examples/Arabas_et_al_2025}/__init__.py

@@ -1,6 +1,6 @@
 """
 box-model and 2D prescribed-flow immersion-freezing examples based on
-[Arabas et al. 2023](https://doi.org/10.48550/arXiv.2308.05015)
+[Arabas et al. 2025](https://doi.org/10.1029/2024MS004770)
 
 aida.ipynb:
 .. include:: ./aida.ipynb.badges.md

{pysdm_examples-2.106/PySDM_examples/Arabas_et_al_2023 → pysdm_examples-2.108/PySDM_examples/Arabas_et_al_2025}/plots.py

@@ -1,8 +1,8 @@
 import matplotlib
 import numpy as np
 from matplotlib import pyplot
-from PySDM_examples.Arabas_et_al_2023.curved_text import CurvedText
-from PySDM_examples.Arabas_et_al_2023.frozen_fraction import FrozenFraction
+from PySDM_examples.Arabas_et_al_2025.curved_text import CurvedText
+from PySDM_examples.Arabas_et_al_2025.frozen_fraction import FrozenFraction
 
 from PySDM.physics import si
 

{pysdm_examples-2.106 → pysdm_examples-2.108}/PySDM_examples/Rozanski_and_Sonntag_1982/__init__.py

@@ -7,3 +7,4 @@ figs_4_5_6.ipynb:
 """
 
 # pylint: disable=invalid-name
+from PySDM_examples.Rozanski_and_Sonntag_1982.multibox import MultiBox

pysdm_examples-2.108/PySDM_examples/Rozanski_and_Sonntag_1982/multibox.py

@@ -0,0 +1,96 @@
+"""
+definition of a multi-box environment (parcel iteratively adjusting to a stationary state)
+plus helper equation for isotopic ratio evolution
+"""
+
+# pylint: disable=invalid-name
+
+import numpy as np
+
+from PySDM.environments import Parcel
+
+
+def Rv_prim(*, Rl, Nl, Rv, Nv, dNl, Rr, K, a):
+    """eq. (2) in [Rozanski and Sonntag 1982](https://doi.org/10.3402/tellusa.v34i2.10795)"""
+    return (Rl * Nl + Rv * Nv + dNl * Rr * K) / ((Nl + dNl * K) * a + Nv)
+
+
+class MultiBox(Parcel):
+    """iterative parcel model in which each new iteration operates with ambient isotopic profile
+    resultant from the previous iteration, leading to a stationary state
+    """
+
+    def __init__(
+        self,
+        *,
+        isotopes,
+        delta_nl,
+        rain_isotope_ratios,
+        nt,
+        autoconversion_mixrat_threshold,
+        isotope_exchange_factor,
+        **kwargs,
+    ):
+        super().__init__(
+            variables=[
+                f"{ratio}_{isotope}" for ratio in ("Rv", "Rr") for isotope in isotopes
+            ],
+            **kwargs,
+        )
+        self.isotopes = isotopes
+        self.delta_nl = delta_nl
+        self.rain_isotope_ratios = rain_isotope_ratios
+        self.nt = nt
+        self.autoconversion_mixrat_threshold = autoconversion_mixrat_threshold
+        self.isotope_exchange_factor = isotope_exchange_factor
+
+    def advance_parcel_vars(self):
+        """explicit Euler integration of isotope-ratio time derivative"""
+        assert self.delta_liquid_water_mixing_ratio >= 0
+        self._recalculate_temperature_pressure_relative_humidity(self._tmp)
+
+        alpha_old = {}
+        dRv__dt = {}
+        for isotope in self.isotopes:
+            alpha_fun = getattr(
+                self.particulator.formulae.isotope_equilibrium_fractionation_factors,
+                f"alpha_l_{isotope}",
+            )
+            alpha_old[isotope] = alpha_fun(self["T"][0])
+            alpha_new = alpha_fun(self._tmp["T"][0])
+
+            dRv__dt[isotope] = self[f"Rv_{isotope}"][
+                0
+            ] * self.particulator.formulae.isotope_ratio_evolution.d_Rv_over_Rv(
+                alpha=alpha_old[isotope],
+                d_alpha=(alpha_new - alpha_old[isotope]) / self.dt,
+                n_vapour=self["water_vapour_mixing_ratio"][0],
+                d_n_vapour=-self.delta_liquid_water_mixing_ratio / self.dt,
+                n_liquid=self.autoconversion_mixrat_threshold,  # TODO #1207
+            )
+
+        super().advance_parcel_vars()
+
+        for isotope in self.isotopes:
+            self.particulator.backend.explicit_euler(
+                self._tmp[f"Rv_{isotope}"], self.particulator.dt, dRv__dt[isotope]
+            )
+            level = self.particulator.n_steps
+            if self.delta_nl is not None:
+                self._tmp[f"Rv_{isotope}"][:] = Rv_prim(
+                    Rl=alpha_old[isotope] * self._tmp[f"Rv_{isotope}"][0],
+                    Nl=self.autoconversion_mixrat_threshold,
+                    Rv=self._tmp[f"Rv_{isotope}"][0],
+                    Nv=self["water_vapour_mixing_ratio"][0],
+                    dNl=np.sum(self.delta_nl[level:]),
+                    Rr=self.rain_isotope_ratios[isotope][
+                        min(
+                            level + 2, self.nt  # TODO #1207: this warrants a comment...
+                        )
+                    ],
+                    K=self.isotope_exchange_factor,
+                    a=alpha_old[isotope],
+                )
+            self._tmp[f"Rr_{isotope}"][:] = (
+                alpha_old[isotope] * self._tmp[f"Rv_{isotope}"][0]
+            )

{pysdm_examples-2.106 → pysdm_examples-2.108}/docs/pysdm_examples_landing.md

@@ -47,7 +47,7 @@ Example notebooks:
 - `PySDM_examples.Arabas_et_al_2015`
   - in-notebook GUI for setting up, running and interactively visualising the 2D kinematic simulations (with an option to export raw data to <mark>VTK</mark> and <mark>netCDF</mark> files, as well as to save plots to SVG or PDF):
   - "hello world" notebook depicting how to automate using Python the process of loading data and creating animations in <mark>Paraview</mark>
-- `PySDM_examples.Arabas_et_al_2023`: adaptation of the 2D kinematic setup for studying <mark>glaciation</mark> of the cloud deck by <mark>immersion freezing</mark>
+- `PySDM_examples.Arabas_et_al_2025`: adaptation of the 2D kinematic setup for studying <mark>glaciation</mark> of the cloud deck by <mark>immersion freezing</mark>
 
 ## 1D kinematic environment (prescribed-flow, single-column)
 
@@ -106,7 +106,7 @@ Example notebooks include:
   - `PySDM_examples.deJong_Mackay_et_al_2023`: validation of the breakup scheme against analytical solutions from <a href="https://doi.org/10.1175/1520-0469(1982)039%3C1317:ASMOPC%3E2.0.CO;2">Srivastava 1982</a>
 - immersion freezing only:
   - `PySDM_examples.Alpert_and_Knopf_2016`: stochastic immersion freezing with monodisperse vs. lognormal immersed surface areas
-  - `PySDM_examples.Arabas_et_al_2023`: comparison of time-dependent and singular immersion freezing schemes
+  - `PySDM_examples.Arabas_et_al_2025`: comparison of time-dependent and singular immersion freezing schemes
 
 The box environment is also featured in the <a href="https://open-atmos.github.io/PySDM/PySDM.html#tutorials">PySDM tutorials</a>.
 

{pysdm_examples-2.106 → pysdm_examples-2.108}/pyproject.toml

@@ -4,4 +4,4 @@ local_scheme = "no-local-version"
 version_scheme = "post-release"
 
 [build-system]
-requires = ['setuptools==75.8.2', 'setuptools-scm==8.2.0']
+requires = ['setuptools==76.0.0', 'setuptools-scm==8.2.0']

{pysdm_examples-2.106 → pysdm_examples-2.108}/pysdm_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pysdm-examples
-Version: 2.106
+Version: 2.108
 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
@@ -83,7 +83,7 @@ Example notebooks:
 - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2015.html">Arabas_et_al_2015</a>
   - in-notebook GUI for setting up, running and interactively visualising the 2D kinematic simulations (with an option to export raw data to <mark>VTK</mark> and <mark>netCDF</mark> files, as well as to save plots to SVG or PDF):
   - "hello world" notebook depicting how to automate using Python the process of loading data and creating animations in <mark>Paraview</mark>
-- <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2023.html">Arabas_et_al_2023</a>: adaptation of the 2D kinematic setup for studying <mark>glaciation</mark> of the cloud deck by <mark>immersion freezing</mark>
+- <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2025.html">Arabas_et_al_2025</a>: adaptation of the 2D kinematic setup for studying <mark>glaciation</mark> of the cloud deck by <mark>immersion freezing</mark>
 
 ## 1D kinematic environment (prescribed-flow, single-column)
 
@@ -142,7 +142,7 @@ Example notebooks include:
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/deJong_Mackay_et_al_2023.html">deJong_Mackay_et_al_2023</a>: validation of the breakup scheme against analytical solutions from <a href="https://doi.org/10.1175/1520-0469(1982)039%3C1317:ASMOPC%3E2.0.CO;2">Srivastava 1982</a>
 - immersion freezing only:
   - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Alpert_and_Knopf_2016.html">Alpert_and_Knopf_2016</a>: stochastic immersion freezing with monodisperse vs. lognormal immersed surface areas
-  - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2023.html">Arabas_et_al_2023</a>: comparison of time-dependent and singular immersion freezing schemes
+  - <a href="https://open-atmos.github.io/PySDM/PySDM_examples/Arabas_et_al_2025.html">Arabas_et_al_2025</a>: comparison of time-dependent and singular immersion freezing schemes
 
 The box environment is also featured in the <a href="https://open-atmos.github.io/PySDM/PySDM.html#tutorials">PySDM tutorials</a>.
 

{pysdm_examples-2.106 → pysdm_examples-2.108}/pysdm_examples.egg-info/SOURCES.txt

@@ -25,13 +25,13 @@ PySDM_examples/Arabas_et_al_2015/example.py
 PySDM_examples/Arabas_et_al_2015/example_benchmark.py
 PySDM_examples/Arabas_et_al_2015/settings.py
 PySDM_examples/Arabas_et_al_2015/spin_up.py
-PySDM_examples/Arabas_et_al_2023/__init__.py
-PySDM_examples/Arabas_et_al_2023/commons.py
-PySDM_examples/Arabas_et_al_2023/curved_text.py
-PySDM_examples/Arabas_et_al_2023/frozen_fraction.py
-PySDM_examples/Arabas_et_al_2023/make_particulator.py
-PySDM_examples/Arabas_et_al_2023/plots.py
-PySDM_examples/Arabas_et_al_2023/run_simulation.py
+PySDM_examples/Arabas_et_al_2025/__init__.py
+PySDM_examples/Arabas_et_al_2025/commons.py
+PySDM_examples/Arabas_et_al_2025/curved_text.py
+PySDM_examples/Arabas_et_al_2025/frozen_fraction.py
+PySDM_examples/Arabas_et_al_2025/make_particulator.py
+PySDM_examples/Arabas_et_al_2025/plots.py
+PySDM_examples/Arabas_et_al_2025/run_simulation.py
 PySDM_examples/Bartman_2020_MasterThesis/__init__.py
 PySDM_examples/Bartman_2020_MasterThesis/fig_4_adaptive_sdm.py
 PySDM_examples/Bartman_2020_MasterThesis/fig_5_SCIPY_VS_ADAPTIVE.py
@@ -94,6 +94,7 @@ PySDM_examples/Pyrcel/simulation.py
 PySDM_examples/Pyrcel/tutorial_settings.py
 PySDM_examples/Pyrcel/tutorial_simulation.py
 PySDM_examples/Rozanski_and_Sonntag_1982/__init__.py
+PySDM_examples/Rozanski_and_Sonntag_1982/multibox.py
 PySDM_examples/Shima_et_al_2009/__init__.py
 PySDM_examples/Shima_et_al_2009/error_measure.py
 PySDM_examples/Shima_et_al_2009/example.py