PySDM-examples 2.66__tar.gz → 2.67__tar.gz

{PySDM-examples-2.66 → PySDM-examples-2.67}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM-examples
-Version: 2.66
+Version: 2.67
 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
@@ -222,6 +222,13 @@ Description: # PySDM-examples
             [![launch on mybinder.org](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PySDM.git/main?urlpath=lab/tree/examples/PySDM_examples/Jaruga_and_Pawlowska_2018/fig_3.ipynb)
             [![launch on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PySDM/blob/main/examples/PySDM_examples/Jaruga_and_Pawlowska_2018/fig_3.ipynb)  
         
+        ### 0D parcel-environment condensation/freezing example:
+        - [Abade & Albuquerque 2024](https://doi.org/10.1002/qj.4775) (Adiabatic parcel, liquid/solid phase partitioning):
+          - Fig 2: 
+            [![View notebook](https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub)](https://github.com/open-atmos/PySDM/blob/main/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)
+            [![launch on mybinder.org](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PySDM.git/main?urlpath=lab/tree/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)
+            [![launch on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PySDM/blob/main/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)   
+        
         ### OD parcel-environment iterative framework mimicking removal of precipitation
         - [Rozanski & Sonntag 1982](https://doi.org/10.1111/j.2153-3490.1982.tb01800.x):
           - Figs 4-6:

PySDM-examples-2.67/PySDM_examples/Abade_and_Albuquerque_2024/__init__.py

@@ -0,0 +1,8 @@
+# pylint: disable=invalid-name
+"""
+mixed-phase example using parcel environment based on
+[Abade & Albuquerque 2024 (QJRMS)](https://doi.org/10.1002/qj.4775)
+"""
+
+from .simulation import Simulation
+from .settings import Settings

PySDM-examples-2.67/PySDM_examples/Abade_and_Albuquerque_2024/settings.py

@@ -0,0 +1,48 @@
+from pystrict import strict
+
+from PySDM import Formulae
+from PySDM.physics import si
+from PySDM.initialisation.spectra import Lognormal
+
+
+@strict
+class Settings:
+    def __init__(self, *, n_sd: int, timestep: float):
+        self.n_sd = n_sd
+        self.timestep = timestep
+
+        self.initial_total_pressure = 1000 * si.hPa  # note: not given in the paper
+
+        # parameters from the paper
+        self.formulae = Formulae(
+            constants={"bulk_phase_partitioning_exponent": 0.1},
+            bulk_phase_partitioning="KaulEtAl2015",
+        )
+        self.initial_water_vapour_mixing_ratio = 1.5 * si.g / si.kg
+        self.parcel_linear_extent = 100 * si.m
+        self.updraft = 0.5 * si.m / si.s
+
+        thd_0 = self.formulae.state_variable_triplet.th_dry(
+            th_std=269 * si.K,
+            water_vapour_mixing_ratio=self.initial_water_vapour_mixing_ratio,
+        )
+        rhod_0 = self.formulae.state_variable_triplet.rho_d(
+            p=self.initial_total_pressure,
+            water_vapour_mixing_ratio=self.initial_water_vapour_mixing_ratio,
+            theta_std=thd_0,
+        )
+
+        self.mass_of_dry_air = rhod_0 * self.formulae.trivia.volume(
+            radius=self.parcel_linear_extent
+        )
+        self.soluble_aerosol = Lognormal(
+            norm_factor=200
+            / si.mg
+            * self.mass_of_dry_air,  # note: assuming per mg of dry air
+            m_mode=75 * si.nm,
+            s_geom=1.6,
+        )
+        self.kappa = 0.6
+        self.initial_temperature = self.formulae.state_variable_triplet.T(
+            rhod=rhod_0, thd=thd_0
+        )

PySDM-examples-2.67/PySDM_examples/Abade_and_Albuquerque_2024/simulation.py

@@ -0,0 +1,49 @@
+import numpy as np
+
+from PySDM_examples.utils import BasicSimulation
+
+from PySDM import Builder
+from PySDM.backends import CPU
+from PySDM.dynamics import Condensation, AmbientThermodynamics
+from PySDM.initialisation.sampling.spectral_sampling import ConstantMultiplicity
+from PySDM.products import AmbientTemperature, ParcelDisplacement, WaterMixingRatio
+from PySDM.environments import Parcel
+
+
+class Simulation(BasicSimulation):
+    def __init__(self, settings):
+        parcel = Parcel(
+            dt=settings.timestep,
+            mass_of_dry_air=settings.mass_of_dry_air,
+            p0=settings.initial_total_pressure,
+            initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
+            T0=settings.initial_temperature,
+            w=settings.updraft,
+        )
+        builder = Builder(
+            backend=CPU(settings.formulae, override_jit_flags={"parallel": False}),
+            n_sd=settings.n_sd,
+            environment=parcel,
+        )
+        builder.add_dynamic(AmbientThermodynamics())
+        builder.add_dynamic(Condensation())
+
+        r_dry, n_in_dv = ConstantMultiplicity(settings.soluble_aerosol).sample(
+            n_sd=settings.n_sd
+        )
+        attributes = parcel.init_attributes(
+            n_in_dv=n_in_dv, kappa=settings.kappa, r_dry=r_dry
+        )
+        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)),
+            ParcelDisplacement(name="height"),
+            AmbientTemperature(name="T"),
+        )
+        super().__init__(
+            particulator=builder.build(attributes=attributes, products=self.products)
+        )
+
+    def run(self, *, nt, steps_per_output_interval):
+        return self._run(nt=nt, steps_per_output_interval=steps_per_output_interval)

{PySDM-examples-2.66 → PySDM-examples-2.67}/PySDM_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM-examples
-Version: 2.66
+Version: 2.67
 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
@@ -222,6 +222,13 @@ Description: # PySDM-examples
             [![launch on mybinder.org](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PySDM.git/main?urlpath=lab/tree/examples/PySDM_examples/Jaruga_and_Pawlowska_2018/fig_3.ipynb)
             [![launch on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PySDM/blob/main/examples/PySDM_examples/Jaruga_and_Pawlowska_2018/fig_3.ipynb)  
         
+        ### 0D parcel-environment condensation/freezing example:
+        - [Abade & Albuquerque 2024](https://doi.org/10.1002/qj.4775) (Adiabatic parcel, liquid/solid phase partitioning):
+          - Fig 2: 
+            [![View notebook](https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub)](https://github.com/open-atmos/PySDM/blob/main/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)
+            [![launch on mybinder.org](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PySDM.git/main?urlpath=lab/tree/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)
+            [![launch on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PySDM/blob/main/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)   
+        
         ### OD parcel-environment iterative framework mimicking removal of precipitation
         - [Rozanski & Sonntag 1982](https://doi.org/10.1111/j.2153-3490.1982.tb01800.x):
           - Figs 4-6:

{PySDM-examples-2.66 → PySDM-examples-2.67}/PySDM_examples.egg-info/SOURCES.txt

@@ -8,6 +8,9 @@ PySDM_examples.egg-info/SOURCES.txt
 PySDM_examples.egg-info/dependency_links.txt
 PySDM_examples.egg-info/requires.txt
 PySDM_examples.egg-info/top_level.txt
+PySDM_examples/Abade_and_Albuquerque_2024/__init__.py
+PySDM_examples/Abade_and_Albuquerque_2024/settings.py
+PySDM_examples/Abade_and_Albuquerque_2024/simulation.py
 PySDM_examples/Abdul_Razzak_Ghan_2000/__init__.py
 PySDM_examples/Abdul_Razzak_Ghan_2000/aerosol.py
 PySDM_examples/Abdul_Razzak_Ghan_2000/data_from_ARG2000_paper.py

{PySDM-examples-2.66 → PySDM-examples-2.67}/README.md

@@ -211,6 +211,13 @@
     [![launch on mybinder.org](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PySDM.git/main?urlpath=lab/tree/examples/PySDM_examples/Jaruga_and_Pawlowska_2018/fig_3.ipynb)
     [![launch on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PySDM/blob/main/examples/PySDM_examples/Jaruga_and_Pawlowska_2018/fig_3.ipynb)  
 
+### 0D parcel-environment condensation/freezing example:
+- [Abade & Albuquerque 2024](https://doi.org/10.1002/qj.4775) (Adiabatic parcel, liquid/solid phase partitioning):
+  - Fig 2: 
+    [![View notebook](https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub)](https://github.com/open-atmos/PySDM/blob/main/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)
+    [![launch on mybinder.org](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PySDM.git/main?urlpath=lab/tree/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)
+    [![launch on Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PySDM/blob/main/examples/PySDM_examples/Abade_and_Albuquerque_2024/fig_2.ipynb)   
+
 ### OD parcel-environment iterative framework mimicking removal of precipitation
 - [Rozanski & Sonntag 1982](https://doi.org/10.1111/j.2153-3490.1982.tb01800.x):
   - Figs 4-6: