PySDM-examples 2.109__tar.gz → 2.111__tar.gz

{pysdm_examples-2.109 → pysdm_examples-2.111}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pysdm-examples
-Version: 2.109
+Version: 2.111
 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

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Abade_and_Albuquerque_2024/settings.py

@@ -7,9 +7,18 @@ from PySDM.initialisation.spectra import Lognormal
 
 @strict
 class Settings:
-    def __init__(self, *, n_sd: int, timestep: float):
+    def __init__(
+        self,
+        *,
+        n_sd: int,
+        timestep: float,
+        enable_immersion_freezing: bool = True,
+        enable_vapour_deposition_on_ice: bool = True,
+    ):
         self.n_sd = n_sd
         self.timestep = timestep
+        self.enable_immersion_freezing = enable_immersion_freezing
+        self.enable_vapour_deposition_on_ice = enable_vapour_deposition_on_ice
 
         self.initial_total_pressure = 1000 * si.hPa  # note: not given in the paper
 
@@ -17,6 +26,8 @@ class Settings:
         self.formulae = Formulae(
             constants={"bulk_phase_partitioning_exponent": 0.1},
             bulk_phase_partitioning="KaulEtAl2015",
+            particle_shape_and_density="MixedPhaseSpheres",
+            diffusion_coordinate="WaterMassLogarithm",
         )
         self.initial_water_vapour_mixing_ratio = 1.5 * si.g / si.kg
         self.parcel_linear_extent = 100 * si.m

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Abade_and_Albuquerque_2024/simulation.py

@@ -4,9 +4,20 @@ from PySDM_examples.utils import BasicSimulation
 
 from PySDM import Builder
 from PySDM.backends import CPU
-from PySDM.dynamics import Condensation, AmbientThermodynamics
+from PySDM.dynamics import (
+    Condensation,
+    AmbientThermodynamics,
+    VapourDepositionOnIce,
+    Freezing,
+)
 from PySDM.initialisation.sampling.spectral_sampling import ConstantMultiplicity
-from PySDM.products import AmbientTemperature, ParcelDisplacement, WaterMixingRatio
+from PySDM.products import (
+    AmbientTemperature,
+    AmbientWaterVapourMixingRatio,
+    ParcelDisplacement,
+    WaterMixingRatio,
+    SpecificIceWaterContent,
+)
 from PySDM.environments import Parcel
 
 
@@ -22,23 +33,44 @@ class Simulation(BasicSimulation):
                 initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
                 T0=settings.initial_temperature,
                 w=settings.updraft,
+                mixed_phase=True,
             ),
         )
         builder.add_dynamic(AmbientThermodynamics())
         builder.add_dynamic(Condensation())
 
+        if settings.enable_immersion_freezing:
+            builder.add_dynamic(Freezing())
+        if settings.enable_vapour_deposition_on_ice:
+            builder.add_dynamic(VapourDepositionOnIce())
+
         r_dry, n_in_dv = ConstantMultiplicity(settings.soluble_aerosol).sample(
             n_sd=settings.n_sd
         )
         attributes = builder.particulator.environment.init_attributes(
             n_in_dv=n_in_dv, kappa=settings.kappa, r_dry=r_dry
         )
+        attributes["signed water mass"] = (
+            builder.particulator.formulae.particle_shape_and_density.volume_to_mass(
+                attributes["volume"]
+            )
+        )
+        del attributes["volume"]
+
+        # TODO #1524
+        if settings.enable_immersion_freezing:
+            attributes["freezing temperature"] = np.full(
+                shape=(settings.n_sd,), fill_value=250
+            )
+
         self.products = (
             WaterMixingRatio(name="water", radius_range=(0, np.inf)),
-            WaterMixingRatio(name="ice", radius_range=(-np.inf, 0)),
-            WaterMixingRatio(name="total", radius_range=(-np.inf, np.inf)),
+            SpecificIceWaterContent(name="ice"),
             ParcelDisplacement(name="height"),
             AmbientTemperature(name="T"),
+            AmbientWaterVapourMixingRatio(
+                name="vapour", var="water_vapour_mixing_ratio"
+            ),
         )
         super().__init__(
             particulator=builder.build(attributes=attributes, products=self.products)

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Arabas_and_Shima_2017/settings.py

@@ -18,7 +18,7 @@ class Settings:
     ):
         self.formulae = Formulae(
             saturation_vapour_pressure="AugustRocheMagnus",
-            condensation_coordinate=coord,
+            diffusion_coordinate=coord,
         )
         const = self.formulae.constants
         self.p0 = 1000 * si.hectopascals

pysdm_examples-2.111/PySDM_examples/Bolin_1958/__init__.py

@@ -0,0 +1,8 @@
+"""
+Table 1 from [Bolin 1958](https://digitallibrary.un.org/record/3892725)
+
+table_1.ipynb:
+.. include:: ./table_1.ipynb.badges.md
+"""
+
+# pylint: disable=invalid-name

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Lowe_et_al_2019/settings.py

@@ -27,7 +27,7 @@ class Settings:
             constants=LOWE_CONSTS,
             diffusion_kinetics="LoweEtAl2019",
             diffusion_thermics="LoweEtAl2019",
-            latent_heat="Lowe2019",
+            latent_heat_vapourisation="Lowe2019",
             saturation_vapour_pressure="Lowe1977",
             optical_albedo="Bohren1987",
             optical_depth="Stephens1978",

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Morrison_and_Grabowski_2007/cumulus.py

@@ -48,7 +48,7 @@ class Cumulus(Common):
 
     def __rhod_of_z(self, T_of_z, p_of_z, q_of_z, z_of_p, z_points):
         def drhod_dz(z, _):
-            lv = self.formulae.latent_heat.lv(T_of_z(z))
+            lv = self.formulae.latent_heat_vapourisation.lv(T_of_z(z))
             return self.formulae.hydrostatics.drho_dz(
                 p_of_z(z), T_of_z(z), q_of_z(z), lv
             )

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Shipway_and_Hill_2012/settings.py

@@ -120,7 +120,7 @@ class Settings:
             p = self.formulae.state_variable_triplet.p(
                 rhod[0], T, water_vapour_mixing_ratio
             )
-            lv = self.formulae.latent_heat.lv(T)
+            lv = self.formulae.latent_heat_vapourisation.lv(T)
             return self.formulae.hydrostatics.drho_dz(
                 p, T, water_vapour_mixing_ratio, lv
             ) / (

{pysdm_examples-2.109 → pysdm_examples-2.111}/PySDM_examples/Yang_et_al_2018/simulation.py

@@ -17,7 +17,7 @@ class Simulation:
         while dt_output / self.n_substeps >= settings.dt_max:
             self.n_substeps += 1
         self.formulae = Formulae(
-            condensation_coordinate=settings.coord,
+            diffusion_coordinate=settings.coord,
             saturation_vapour_pressure="AugustRocheMagnus",
         )
         self.bins_edges = self.formulae.trivia.volume(settings.r_bins_edges)

{pysdm_examples-2.109 → pysdm_examples-2.111}/pyproject.toml

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

{pysdm_examples-2.109 → pysdm_examples-2.111}/pysdm_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: pysdm-examples
-Version: 2.109
+Version: 2.111
 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