PySDM-examples 2.72__tar.gz → 2.73__tar.gz

{PySDM-examples-2.72 → PySDM-examples-2.73}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM-examples
-Version: 2.72
+Version: 2.73
 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.72 → PySDM-examples-2.73}/PySDM_examples/Abade_and_Albuquerque_2024/simulation.py

@@ -12,18 +12,17 @@ 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,
+            environment=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.add_dynamic(AmbientThermodynamics())
         builder.add_dynamic(Condensation())
@@ -31,7 +30,7 @@ class Simulation(BasicSimulation):
         r_dry, n_in_dv = ConstantMultiplicity(settings.soluble_aerosol).sample(
             n_sd=settings.n_sd
         )
-        attributes = parcel.init_attributes(
+        attributes = builder.particulator.environment.init_attributes(
             n_in_dv=n_in_dv, kappa=settings.kappa, r_dry=r_dry
         )
         self.products = (

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Abdul_Razzak_Ghan_2000/run_ARG_parcel.py

@@ -65,7 +65,8 @@ def run_parcel(
         v_dry = builder.formulae.trivia.volume(radius=r_dry)
         specific_concentration = concentration / builder.formulae.constants.rho_STP
         attributes["multiplicity"] = np.append(
-            attributes["multiplicity"], specific_concentration * env.mass_of_dry_air
+            attributes["multiplicity"],
+            specific_concentration * builder.particulator.environment.mass_of_dry_air,
         )
         attributes["dry volume"] = np.append(attributes["dry volume"], v_dry)
         attributes["kappa times dry volume"] = np.append(
@@ -74,7 +75,7 @@ def run_parcel(
 
     r_wet = equilibrate_wet_radii(
         r_dry=builder.formulae.trivia.radius(volume=attributes["dry volume"]),
-        environment=env,
+        environment=builder.particulator.environment,
         kappa_times_dry_volume=attributes["kappa times dry volume"],
     )
     attributes["volume"] = builder.formulae.trivia.volume(radius=r_wet)

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Alpert_and_Knopf_2016/simulation.py

@@ -215,8 +215,11 @@ def simulation(
         constants=constants,
         particle_shape_and_density="MixedPhaseSpheres",
     )
-    env = Box(dt=time_step, dv=volume)
-    builder = Builder(n_sd=n_sd, backend=CPU(formulae=formulae), environment=env)
+    builder = Builder(
+        n_sd=n_sd,
+        backend=CPU(formulae=formulae),
+        environment=Box(dt=time_step, dv=volume),
+    )
     builder.add_dynamic(Freezing(singular=False))
 
     if hasattr(spectrum, "s_geom") and spectrum.s_geom == 1:
@@ -236,6 +239,7 @@ def simulation(
         TotalUnfrozenImmersedSurfaceArea(name="A_tot"),
     )
     particulator = builder.build(attributes=attributes, products=products)
+    env = particulator.environment
 
     env["T"] = initial_temperature
     env["a_w_ice"] = np.nan

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Arabas_et_al_2023/make_particulator.py

@@ -57,9 +57,9 @@ def make_particulator(
         ) = sampling.sample(backend=backend, n_sd=n_sd)
     attributes["multiplicity"] *= total_particle_number
 
-    env = Box(dt, volume)
-    builder = Builder(n_sd, backend, env)
+    builder = Builder(n_sd=n_sd, backend=backend, environment=Box(dt, volume))
 
+    env = builder.particulator.environment
     env["T"] = initial_temperature
     env["RH"] = A_VALUE_LARGER_THAN_ONE
     env["rhod"] = 1.0

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Bieli_et_al_2022/simulation.py

@@ -9,11 +9,12 @@ from PySDM.initialisation.sampling.spectral_sampling import ConstantMultiplicity
 def make_core(settings, coal_eff):
     backend = CPU
 
-    env = Box(dv=settings.dv, dt=settings.dt)
     builder = Builder(
-        n_sd=settings.n_sd, backend=backend(settings.formulae), environment=env
+        n_sd=settings.n_sd,
+        backend=backend(settings.formulae),
+        environment=Box(dv=settings.dv, dt=settings.dt),
     )
-    env["rhod"] = 1.0
+    builder.particulator.environment["rhod"] = 1.0
     attributes = {}
     attributes["volume"], attributes["multiplicity"] = ConstantMultiplicity(
         settings.spectrum

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Grabowski_and_Pawlowska_2023/simulation.py

@@ -19,20 +19,19 @@ class Simulation(BasicSimulation):
         scipy_solver=False,
         sampling_class=ConstantMultiplicity,
     ):
-        env = Parcel(
-            dt=settings.timestep,
-            p0=settings.initial_pressure,
-            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,
-        )
         builder = Builder(
             n_sd=settings.n_sd,
             backend=CPU(
                 formulae=settings.formulae, override_jit_flags={"parallel": False}
             ),
-            environment=env,
+            environment=Parcel(
+                dt=settings.timestep,
+                p0=settings.initial_pressure,
+                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,
+            ),
         )
         builder.add_dynamic(AmbientThermodynamics())
         builder.add_dynamic(
@@ -45,6 +44,7 @@ class Simulation(BasicSimulation):
         ):
             builder.request_attribute(attribute)
 
+        env = builder.particulator.environment
         volume = env.mass_of_dry_air / settings.initial_air_density
         attributes = {
             k: np.empty(0)

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Jensen_and_Nugent_2017/simulation.py

@@ -34,16 +34,6 @@ class Simulation(BasicSimulation):
             settings.p0 / settings.RH0 / pvs_Celsius(settings.T0 - const.T0) - 1
         )
 
-        env = Parcel(
-            dt=settings.dt,
-            mass_of_dry_air=666 * si.kg,
-            p0=settings.p0,
-            initial_water_vapour_mixing_ratio=initial_water_vapour_mixing_ratio,
-            T0=settings.T0,
-            w=settings.vertical_velocity,
-            z0=settings.z0,
-        )
-
         n_gccn = np.count_nonzero(table_3.NA) if gccn else 0
 
         builder = Builder(
@@ -51,7 +41,15 @@ class Simulation(BasicSimulation):
             backend=CPU(
                 formulae=settings.formulae, override_jit_flags={"parallel": False}
             ),
-            environment=env,
+            environment=Parcel(
+                dt=settings.dt,
+                mass_of_dry_air=666 * si.kg,
+                p0=settings.p0,
+                initial_water_vapour_mixing_ratio=initial_water_vapour_mixing_ratio,
+                T0=settings.T0,
+                w=settings.vertical_velocity,
+                z0=settings.z0,
+            ),
         )
 
         additional_derived_attributes = ("radius", "equilibrium supersaturation")
@@ -83,8 +81,10 @@ class Simulation(BasicSimulation):
         )
         rhod0 = settings.formulae.state_variable_triplet.rhod_of_pd_T(pd0, settings.T0)
 
-        attributes = env.init_attributes(
-            n_in_dv=n_in_unit_volume * env.mass_of_dry_air / rhod0,
+        attributes = builder.particulator.environment.init_attributes(
+            n_in_dv=n_in_unit_volume
+            * builder.particulator.environment.mass_of_dry_air
+            / rhod0,
             kappa=settings.kappa,
             r_dry=self.r_dry,
         )

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Kreidenweis_et_al_2003/simulation.py

@@ -12,24 +12,22 @@ from PySDM.physics import si
 
 class Simulation(BasicSimulation):
     def __init__(self, settings, products=None):
-        env = Parcel(
-            dt=settings.dt,
-            mass_of_dry_air=settings.mass_of_dry_air,
-            p0=settings.p0,
-            initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
-            T0=settings.T0,
-            w=settings.w,
-        )
-
         builder = Builder(
             n_sd=settings.n_sd,
             backend=CPU(
                 formulae=settings.formulae, override_jit_flags={"parallel": False}
             ),
-            environment=env,
+            environment=Parcel(
+                dt=settings.dt,
+                mass_of_dry_air=settings.mass_of_dry_air,
+                p0=settings.p0,
+                initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
+                T0=settings.T0,
+                w=settings.w,
+            ),
         )
 
-        attributes = env.init_attributes(
+        attributes = builder.particulator.environment.init_attributes(
             n_in_dv=settings.n_in_dv,
             kappa=settings.kappa,
             r_dry=settings.r_dry,

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Lowe_et_al_2019/simulation.py

@@ -12,21 +12,20 @@ from PySDM.initialisation.spectra import Sum
 
 class Simulation(BasicSimulation):
     def __init__(self, settings, products=None):
-        env = Parcel(
-            dt=settings.dt,
-            mass_of_dry_air=settings.mass_of_dry_air,
-            p0=settings.p0,
-            initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
-            T0=settings.T0,
-            w=settings.w,
-        )
         n_sd = settings.n_sd_per_mode * len(settings.aerosol.modes)
         builder = Builder(
             n_sd=n_sd,
             backend=CPU(
                 formulae=settings.formulae, override_jit_flags={"parallel": False}
             ),
-            environment=env,
+            environment=Parcel(
+                dt=settings.dt,
+                mass_of_dry_air=settings.mass_of_dry_air,
+                p0=settings.p0,
+                initial_water_vapour_mixing_ratio=settings.initial_water_vapour_mixing_ratio,
+                T0=settings.T0,
+                w=settings.w,
+            ),
         )
 
         attributes = {
@@ -67,7 +66,7 @@ class Simulation(BasicSimulation):
         )
         r_wet = equilibrate_wet_radii(
             r_dry=settings.formulae.trivia.radius(volume=attributes["dry volume"]),
-            environment=env,
+            environment=builder.particulator.environment,
             kappa_times_dry_volume=attributes["kappa times dry volume"],
             f_org=attributes["dry volume organic"] / attributes["dry volume"],
         )

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Pyrcel/simulation.py

@@ -15,26 +15,28 @@ class Simulation(BasicSimulation):
     def __init__(
         self, settings, products=None, scipy_solver=False, rtol_thd=1e-10, rtol_x=1e-10
     ):
-        env = Parcel(
-            dt=settings.timestep,
-            p0=settings.initial_pressure,
-            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,
-        )
         n_sd = sum(settings.n_sd_per_mode)
         builder = Builder(
             n_sd=n_sd,
             backend=CPU(
                 formulae=settings.formulae, override_jit_flags={"parallel": False}
             ),
-            environment=env,
+            environment=Parcel(
+                dt=settings.timestep,
+                p0=settings.initial_pressure,
+                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,
+            ),
         )
         builder.add_dynamic(AmbientThermodynamics())
         builder.add_dynamic(Condensation(rtol_thd=rtol_thd, rtol_x=rtol_x))
 
-        volume = env.mass_of_dry_air / settings.initial_air_density
+        volume = (
+            builder.particulator.environment.mass_of_dry_air
+            / settings.initial_air_density
+        )
         attributes = {
             k: np.empty(0)
             for k in ("dry volume", "kappa times dry volume", "multiplicity")
@@ -52,7 +54,7 @@ class Simulation(BasicSimulation):
             )
         r_wet = equilibrate_wet_radii(
             r_dry=settings.formulae.trivia.radius(volume=attributes["dry volume"]),
-            environment=env,
+            environment=builder.particulator.environment,
             kappa_times_dry_volume=attributes["kappa times dry volume"],
         )
         attributes["volume"] = settings.formulae.trivia.volume(radius=r_wet)

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Shipway_and_Hill_2012/simulation.py

@@ -34,7 +34,7 @@ class Simulation:
             size=(settings.z_max + settings.particle_reservoir_depth,),
         )
 
-        self.env = Kinematic1D(
+        env = Kinematic1D(
             dt=settings.dt,
             mesh=self.mesh,
             thd_of_z=settings.thd,
@@ -66,7 +66,7 @@ class Simulation:
         self.builder = Builder(
             n_sd=settings.n_sd,
             backend=backend(formulae=settings.formulae),
-            environment=self.env,
+            environment=env,
         )
         self.builder.add_dynamic(AmbientThermodynamics())
 
@@ -92,7 +92,7 @@ class Simulation:
             ),
         )
         self.builder.add_dynamic(displacement)
-        self.attributes = self.env.init_attributes(
+        self.attributes = self.builder.particulator.environment.init_attributes(
             spatial_discretisation=spatial_sampling.Pseudorandom(),
             spectral_discretisation=spectral_sampling.ConstantMultiplicity(
                 spectrum=settings.wet_radius_spectrum_per_mass_of_dry_air

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/Szumowski_et_al_1998/simulation.py

@@ -74,7 +74,11 @@ class Simulation:
             advectees = dict(
                 (
                     key,
-                    np.repeat(profile.reshape(1, -1), environment.mesh.grid[0], axis=0),
+                    np.repeat(
+                        profile.reshape(1, -1),
+                        builder.particulator.environment.mesh.grid[0],
+                        axis=0,
+                    ),
                 )
                 for key, profile in initial_profiles.items()
             )
@@ -141,7 +145,7 @@ class Simulation:
                 )
             )
 
-        attributes = environment.init_attributes(
+        attributes = builder.particulator.environment.init_attributes(
             spatial_discretisation=spatial_sampling.Pseudorandom(),
             dry_radius_spectrum=self.settings.spectrum_per_mass_of_dry_air,
             kappa=self.settings.kappa,

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/deJong_Azimi/simulation_0D.py

@@ -16,11 +16,12 @@ from PySDM.products.size_spectral import (
 
 
 def run_box(settings, backend_class=CPU):
-    env = Box(dv=settings.dv, dt=settings.dt)
     builder = Builder(
-        n_sd=settings.n_sd, backend=backend_class(settings.formulae), environment=env
+        n_sd=settings.n_sd,
+        backend=backend_class(settings.formulae),
+        environment=Box(dv=settings.dv, dt=settings.dt),
     )
-    env["rhod"] = settings.rhod
+    builder.particulator.environment["rhod"] = settings.rhod
     attributes = {}
     attributes["volume"], attributes["multiplicity"] = ConstantMultiplicity(
         settings.spectrum

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples/deJong_Mackay_et_al_2023/simulation_0D.py

@@ -27,11 +27,12 @@ from PySDM.products.size_spectral import (
 def run_box_breakup(
     settings, steps=None, backend_class=CPU, sample_in_radius=False, return_nv=False
 ):
-    env = Box(dv=settings.dv, dt=settings.dt)
     builder = Builder(
-        n_sd=settings.n_sd, backend=backend_class(settings.formulae), environment=env
+        n_sd=settings.n_sd,
+        backend=backend_class(settings.formulae),
+        environment=Box(dv=settings.dv, dt=settings.dt),
     )
-    env["rhod"] = 1.0
+    builder.particulator.environment["rhod"] = 1.0
     attributes = {}
     if sample_in_radius:
         diams, attributes["multiplicity"] = Logarithmic(settings.spectrum).sample(
@@ -90,11 +91,12 @@ def run_box_breakup(
 
 
 def run_box_NObreakup(settings, steps=None, backend_class=CPU):
-    env = Box(dv=settings.dv, dt=settings.dt)
     builder = Builder(
-        n_sd=settings.n_sd, backend=backend_class(settings.formulae), environment=env
+        n_sd=settings.n_sd,
+        backend=backend_class(settings.formulae),
+        environment=Box(dv=settings.dv, dt=settings.dt),
     )
-    env["rhod"] = 1.0
+    builder.particulator.environment["rhod"] = 1.0
     attributes = {}
     attributes["volume"], attributes["multiplicity"] = ConstantMultiplicity(
         settings.spectrum

{PySDM-examples-2.72 → PySDM-examples-2.73}/PySDM_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: PySDM-examples
-Version: 2.72
+Version: 2.73
 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