PySDM 2.123__tar.gz → 2.125__tar.gz

pysdm-2.125/.github/workflows/precommit.yml

@@ -0,0 +1,46 @@
+name: precommit and devops tests
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  # common options for pytest
+  pytest_options: "--durations=10 -v -s -We -p no:unraisableexception"
+
+on:
+  push:
+    branches: [ main ]
+    paths: ['docs/**', '**.md']
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 13 * * 4'
+
+jobs:
+  precommit:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4.1.6
+      - uses: actions/setup-python@v5.0.0
+        with:
+          python-version: 3.9
+      - run: |
+          pip install pre-commit
+          pre-commit clean
+          pre-commit autoupdate
+          pre-commit run --all-files
+      - if: ${{ failure() }}
+        run: git diff
+
+  devops:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4.1.6
+        with:
+          submodules: recursive
+          fetch-depth: 0  # https://github.com/pypa/setuptools_scm/issues/480
+      - run: pip install -r tests/devops_tests/requirements.txt
+      - env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: pytest  ${{ env.pytest_options }} -k "not test_run_notebooks" tests/devops_tests

{pysdm-2.123 → pysdm-2.125}/.github/workflows/readme_snippets.yml

@@ -73,6 +73,7 @@ jobs:
       - uses: matlab-actions/setup-matlab@v2.1.0
         with:
           release: R2022a
+          cache: true
       - uses: matlab-actions/run-command@v2.1.0
         with:
           command: readme

{pysdm-2.123 → pysdm-2.125}/.github/workflows/tests.yml

@@ -14,27 +14,13 @@ env:
 on:
   push:
     branches: [ main ]
+    paths-ignore: ['docs/**', '**.md']
   pull_request:
     branches: [ main ]
   schedule:
     - cron: '0 13 * * 4'
 
 jobs:
-  precommit:
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4.1.6
-      - uses: actions/setup-python@v5.0.0
-        with:
-          python-version: 3.9
-      - run: |
-          pip install pre-commit
-          pre-commit clean
-          pre-commit autoupdate
-          pre-commit run --all-files
-      - if: ${{ failure() }}
-        run: git diff
-
   pylint:
     runs-on: ubuntu-24.04
     steps:
@@ -64,20 +50,10 @@ jobs:
         # TODO #682
         nbqa pylint --unsafe-load-any-extension=y --disable=fixme,duplicate-code,invalid-name,trailing-whitespace,line-too-long,missing-function-docstring,wrong-import-position,missing-module-docstring,wrong-import-order,ungrouped-imports,no-member,too-many-locals,unnecessary-lambda-assignment $(git ls-files '*.ipynb')
 
-  devops:
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4.1.6
-        with:
-          submodules: recursive
-          fetch-depth: 0  # https://github.com/pypa/setuptools_scm/issues/480
-      - run: pip install -r tests/devops_tests/requirements.txt
-      - env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: pytest  ${{ env.pytest_options }} -k "not test_run_notebooks" tests/devops_tests
+  
 
   nojit_and_codecov:
-    needs: [precommit, pylint, devops]
+    needs: [pylint]
     runs-on: ubuntu-24.04
     env:
       NUMBA_DISABLE_JIT: 1
@@ -107,7 +83,7 @@ jobs:
       matrix:
         platform: [ubuntu-24.04, macos-13, macos-14, windows-latest]
         python-version: ["3.9", "3.12"]
-        test-suite: ["unit_tests/!(dynamics)", "unit_tests/dynamics/!(collisions)", "unit_tests/dynamics/collisions", "smoke_tests/no_env", "smoke_tests/box", "smoke_tests/parcel_a", "smoke_tests/parcel_b", "smoke_tests/parcel_c", "smoke_tests/parcel_d", "smoke_tests/kinematic_1d", "smoke_tests/kinematic_2d", "tutorials_tests"]
+        test-suite: ["unit_tests/!(dynamics)", "unit_tests/dynamics/!(condensation|collisions)", "unit_tests/dynamics/condensation", "unit_tests/dynamics/collisions","smoke_tests/no_env", "smoke_tests/box", "smoke_tests/parcel_a", "smoke_tests/parcel_b", "smoke_tests/parcel_c", "smoke_tests/parcel_d", "smoke_tests/kinematic_1d", "smoke_tests/kinematic_2d", "tutorials_tests"]
         exclude:
           - platform: "macos-14"
             python-version: "3.9"

{pysdm-2.123 → pysdm-2.125}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm
-Version: 2.123
+Version: 2.125
 Summary: Pythonic particle-based (super-droplet) warm-rain/aqueous-chemistry cloud microphysics package with box, parcel & 1D/2D prescribed-flow examples in Python, Julia and Matlab
 Author-email: "https://github.com/open-atmos/PySDM/graphs/contributors" <sylwester.arabas@agh.edu.pl>
 License-Expression: GPL-3.0-only
@@ -34,6 +34,7 @@ Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-timeout; extra == "tests"
 Requires-Dist: PySDM-examples; extra == "tests"
 Requires-Dist: open-atmos-jupyter-utils>=v1.2.0; extra == "tests"
+Requires-Dist: PyPartMC; extra == "tests"
 Requires-Dist: pyrcel; extra == "tests"
 Requires-Dist: jupyter-core<5.0.0; extra == "tests"
 Requires-Dist: ipywidgets!=8.0.3; extra == "tests"

{pysdm-2.123 → pysdm-2.125}/PySDM/formulae.py

@@ -23,7 +23,7 @@ from PySDM.dynamics.terminal_velocity import GunnKinzer1949, PowerSeries, Rogers
 from PySDM.dynamics.terminal_velocity.gunn_and_kinzer import TpDependent
 
 
-class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attributes
+class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attributes,too-many-statements
     def __init__(  # pylint: disable=too-many-locals
         self,
         *,
@@ -55,6 +55,7 @@ class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attr
         isotope_diffusivity_ratios: str = "Null",
         isotope_relaxation_timescale: str = "Null",
         isotope_temperature_inference: str = "Null",
+        isotope_ventilation_ratio: str = "Null",
         optical_albedo: str = "Null",
         optical_depth: str = "Null",
         particle_shape_and_density: str = "LiquidSpheres",
@@ -97,6 +98,7 @@ class Formulae:  # pylint: disable=too-few-public-methods,too-many-instance-attr
         self.isotope_diffusivity_ratios = isotope_diffusivity_ratios
         self.isotope_relaxation_timescale = isotope_relaxation_timescale
         self.isotope_temperature_inference = isotope_temperature_inference
+        self.isotope_ventilation_ratio = isotope_ventilation_ratio
         self.particle_shape_and_density = particle_shape_and_density
         self.air_dynamic_viscosity = air_dynamic_viscosity
         self.terminal_velocity = terminal_velocity

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/__init__.py

@@ -37,6 +37,7 @@ from . import (
     isotope_diffusivity_ratios,
     isotope_relaxation_timescale,
     isotope_temperature_inference,
+    isotope_ventilation_ratio,
     latent_heat_vapourisation,
     latent_heat_sublimation,
     optical_albedo,

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/constants_defaults.py

@@ -519,6 +519,8 @@ diffusion_thermics_K_G11_D = -3.9e-4 * si.W / si.m / si.K
 PRUPPACHER_RASMUSSEN_1979_XTHRES = 1.4 * si.dimensionless
 """
 [Pruppacher & Rasmussen 1979](https://doi.org/10.1175/1520-0469%281979%29036%3C1255:AWTIOT%3E2.0.CO;2)
+also in
+[Beard & Pruppacher 1971](https://doi.org/10.1175/1520-0469%281971%29028%3C1455:AWTIOT%3E2.0.CO;2)
 """  # pylint: disable=line-too-long
 PRUPPACHER_RASMUSSEN_1979_CONSTSMALL = 1.0 * si.dimensionless
 """ 〃 """

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/isotope_diffusivity_ratios/grahams_law.py

@@ -8,7 +8,7 @@ class GrahamsLaw:  # pylint: disable=too-few-public-methods
         pass
 
     @staticmethod
-    def ratio_2H(const, temperature):  # pylint: disable=unused-argument
+    def ratio_2H_heavy_to_light(const, temperature):  # pylint: disable=unused-argument
         return (
             (2 * const.M_1H + const.M_16O) / (const.M_2H + const.M_1H + const.M_16O)
         ) ** const.ONE_HALF

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/isotope_diffusivity_ratios/hellmann_and_harvey_2020.py

@@ -9,7 +9,7 @@ class HellmannAndHarvey2020:
         pass
 
     @staticmethod
-    def ratio_2H(const, temperature):
+    def ratio_2H_heavy_to_light(const, temperature):
         return (
             const.HELLMANN_HARVEY_EQ6_COEFF0
             + const.HELLMANN_HARVEY_EQ6_COEFF1
@@ -19,7 +19,7 @@ class HellmannAndHarvey2020:
         )
 
     @staticmethod
-    def ratio_17O(const, temperature):
+    def ratio_17O_heavy_to_light(const, temperature):
         return (
             const.HELLMANN_HARVEY_EQ7_COEFF0
             + const.HELLMANN_HARVEY_EQ7_COEFF1
@@ -29,7 +29,7 @@ class HellmannAndHarvey2020:
         )
 
     @staticmethod
-    def ratio_18O(const, temperature):
+    def ratio_18O_heavy_to_light(const, temperature):
         return (
             const.HELLMANN_HARVEY_EQ8_COEFF0
             + const.HELLMANN_HARVEY_EQ8_COEFF1

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/isotope_diffusivity_ratios/stewart_1975.py

@@ -17,7 +17,7 @@ class Stewart1975:
         pass
 
     @staticmethod
-    def ratio_2H(const, temperature):  # pylint: disable=unused-argument
+    def ratio_2H_heavy_to_light(const, temperature):  # pylint: disable=unused-argument
         return (
             (
                 (2 * const.M_1H + const.M_16O)
@@ -30,7 +30,7 @@ class Stewart1975:
         ) ** const.ONE_HALF
 
     @staticmethod
-    def ratio_18O(const, temperature):  # pylint: disable=unused-argument
+    def ratio_18O_heavy_to_light(const, temperature):  # pylint: disable=unused-argument
         return (
             ((2 * const.M_1H + const.M_16O) * (const.Md + 2 * const.M_1H + const.M_18O))
             / (

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/isotope_kinetic_fractionation_factors/craig_gordon.py

@@ -13,5 +13,5 @@ class CraigGordon:  # pylint: disable=too-few-public-methods
 
     @staticmethod
     def alpha_kinetic(*, relative_humidity, turbulence_parameter_n, delta_diff, theta):
-        """delta_diff = 1 - heavy_to_light_diffusivity_ratio"""
+        """delta_diff = 1 - diffusivity_ratio_heavy_to_light"""
         return 1 + theta * turbulence_parameter_n * delta_diff * (1 - relative_humidity)

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/isotope_kinetic_fractionation_factors/jouzel_and_merlivat_1984.py

@@ -10,12 +10,12 @@ class JouzelAndMerlivat1984:  # pylint: disable=too-few-public-methods
 
     @staticmethod
     def alpha_kinetic(
-        alpha_equilibrium, saturation_over_ice, heavy_to_light_diffusivity_ratio
+        alpha_equilibrium, saturation_over_ice, diffusivity_ratio_heavy_to_light
     ):
         """eq. (11)"""
         return saturation_over_ice / (
             alpha_equilibrium
-            / heavy_to_light_diffusivity_ratio
+            / diffusivity_ratio_heavy_to_light
             * (saturation_over_ice - 1)
             + 1
         )

pysdm-2.125/PySDM/physics/isotope_ventilation_ratio/__init__.py

@@ -0,0 +1,7 @@
+"""
+Isotope ventilation coefficient formulae
+"""
+
+from PySDM.impl.null_physics_class import Null
+from .neglect import Neglect
+from .brutsaert_1982 import Brutsaert1982

pysdm-2.125/PySDM/physics/isotope_ventilation_ratio/brutsaert_1982.py

@@ -0,0 +1,16 @@
+"""
+based on [Brutsaert 1982](https://doi.org/10.1007/978-94-017-1497-6) Springer Netherlands
+statement about ventilation coefficient for heavy isotopes on pp. 92-93.
+"""
+
+
+class Brutsaert1982:  # pylint: disable=too-few-public-methods
+    def __init__(self, _):
+        pass
+
+    @staticmethod
+    def ratio_heavy_to_light(ventilation_coefficient, diffusivity_ratio_heavy_to_light):
+        """heavy to light isotope ventilation ratio"""
+        return (
+            1 - diffusivity_ratio_heavy_to_light ** (1 / 3)
+        ) / ventilation_coefficient + diffusivity_ratio_heavy_to_light ** (1 / 3)

pysdm-2.125/PySDM/physics/isotope_ventilation_ratio/neglect.py

@@ -0,0 +1,12 @@
+"""assuming f'/f equals 1"""
+
+
+class Neglect:  # pylint: disable=too-few-public-methods
+    def __init__(self, _):
+        pass
+
+    @staticmethod
+    def ratio_heavy_to_light(
+        ventilation_coefficient, diffusivity_ratio_heavy_to_light
+    ):  # pylint: disable=unused-argument
+        return 1

{pysdm-2.123 → pysdm-2.125}/PySDM/physics/ventilation/pruppacher_rasmussen_1979.py

@@ -6,6 +6,10 @@ NB: this parameterization is only experimentally validated for Re < 2600
 but is hypothesized to be valid for spheres with Re < 8 × 10⁴
 based on theory (Pruppacher & Rasmussen, 1979).
 the parameterization also does not account for effects of air turbulence.
+
+For smaller droplets, such as 1.96 <= Re <= 158.76 previously published in
+[Beard and Pruppacher](https://doi.org/10.1175/1520-0469%281971%29028%3C1455:AWTIOT%3E2.0.CO;2)
+
 """  # pylint: disable=line-too-long
 
 import numpy as np

{pysdm-2.123 → pysdm-2.125}/docs/bibliography.json

@@ -800,6 +800,13 @@
     "title": "Environmental isotopes in lake studies",
     "label": "Gonfiantini 1986 (The Terrestrial Environment, B)"
   },
+  "https://doi.org/10.1007/978-94-017-1497-6": {
+    "usages": [
+      "PySDM/physics/isotope_ventilation_ratio/brutsaert_1982.py"
+    ],
+    "title": "Evaporation into the Atmosphere: Theory, History, and Applications",
+    "label": "Brutsaert 1982 (Springer Netherlands)"
+  },
   "https://doi.org/10.1029/JC080i009p01133": {
     "usages": [
       "PySDM/physics/isotope_diffusivity_ratios/stewart_1975.py",
@@ -840,6 +847,14 @@
     "title": "The Growth of Cloud Drops in Uniformly Cooled Air",
     "label": "Howell 1949 (J. Atmos. Sci.)"
   },
+  "https://doi.org/10.1175/1520-0469%281971%29028%3C1455:AWTIOT%3E2.0.CO;2": {
+    "usages": [
+      "PySDM/physics/constants_defaults.py",
+      "PySDM/physics/ventilation/pruppacher_rasmussen_1979.py"
+    ],
+    "title": "A Wind Tunnel Investigation of the Rate of Evaporation of Small Water Drops Falling at Terminal Velocity in Air",
+    "label": "Beard & Pruppacher 1971 (J. Atmos. Sci. 28)"
+  },
   "https://doi.org/10.1029/JD089iD07p11749": {
     "usages": [
       "PySDM/physics/isotope_kinetic_fractionation_factors/jouzel_and_merlivat_1984.py",

{pysdm-2.123 → pysdm-2.125}/examples/PySDM_examples/Fisher_1991/fig_2.ipynb

@@ -89,7 +89,7 @@
     "isotopes = (\"2H\", \"18O\")\n",
     "for isotope in isotopes:\n",
     "    alpha_eq[isotope] = getattr(formulae.isotope_equilibrium_fractionation_factors, f'alpha_i_{isotope}')\n",
-    "    diffusivity_ratio[isotope] = getattr(formulae.isotope_diffusivity_ratios, f'ratio_{isotope}')"
+    "    diffusivity_ratio[isotope] = getattr(formulae.isotope_diffusivity_ratios, f'ratio_{isotope}_heavy_to_light')"
    ],
    "id": "91bb290498429f53",
    "outputs": [],
@@ -107,7 +107,7 @@
     "def alpha_kin(iso, T):\n",
     "    return formulae.isotope_kinetic_fractionation_factors.alpha_kinetic(\n",
     "        alpha_equilibrium = alpha_eq[iso](T),\n",
-    "        heavy_to_light_diffusivity_ratio=diffusivity_ratio[iso](T),\n",
+    "        diffusivity_ratio_heavy_to_light=diffusivity_ratio[iso](T),\n",
     "        saturation_over_ice = ice_saturation_curve_4(const=const, T=T)\n",
     "    )"
    ],