PySDM-examples 2.127__tar.gz → 2.129__tar.gz

{pysdm_examples-2.127 → pysdm_examples-2.129}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm-examples
-Version: 2.127
+Version: 2.129
 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.127 → pysdm_examples-2.129}/PySDM_examples/Abdul_Razzak_Ghan_2000/run_ARG_parcel.py

@@ -28,7 +28,7 @@ def run_parcel(
 ):
     products = (
         PySDM_products.WaterMixingRatio(unit="g/kg", name="liquid water mixing ratio"),
-        PySDM_products.PeakSupersaturation(name="S max"),
+        PySDM_products.PeakSaturation(name="S max"),
         PySDM_products.AmbientRelativeHumidity(name="RH"),
         PySDM_products.ParcelDisplacement(name="z"),
     )
@@ -54,7 +54,7 @@ def run_parcel(
     builder = Builder(backend=CPU(formulae), n_sd=n_sd, environment=env)
     builder.add_dynamic(AmbientThermodynamics())
     builder.add_dynamic(Condensation())
-    builder.request_attribute("critical supersaturation")
+    builder.request_attribute("critical saturation")
 
     attributes = {
         k: np.empty(0) for k in ("dry volume", "kappa times dry volume", "multiplicity")
@@ -87,7 +87,7 @@ def run_parcel(
         "multiplicity": tuple([] for _ in range(particulator.n_sd)),
         "volume": tuple([] for _ in range(particulator.n_sd)),
         "critical volume": tuple([] for _ in range(particulator.n_sd)),
-        "critical supersaturation": tuple([] for _ in range(particulator.n_sd)),
+        "critical saturation": tuple([] for _ in range(particulator.n_sd)),
     }
 
     for _ in range(n_steps):
@@ -109,7 +109,7 @@ def run_parcel(
         RHmax = np.nanmax(np.asarray(output["RH"]))
         for i, volume in enumerate(output_attributes["volume"]):
             if j * n_sd_per_mode <= i < (j + 1) * n_sd_per_mode:
-                if output_attributes["critical supersaturation"][i][-1] < RHmax:
+                if output_attributes["critical saturation"][i][-1] < RHmax:
                     activated_drops_j_S += output_attributes["multiplicity"][i][-1]
                 if output_attributes["critical volume"][i][-1] < volume[-1]:
                     activated_drops_j_V += output_attributes["multiplicity"][i][-1]

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Arabas_and_Shima_2017/simulation.py

@@ -62,14 +62,14 @@ class Simulation:
             PySDM_products.MeanRadius(name="radius_m1", unit="um"),
             PySDM_products.CondensationTimestepMin(name="dt_cond_min"),
             PySDM_products.ParcelDisplacement(name="z"),
-            PySDM_products.AmbientRelativeHumidity(name="RH", unit="%"),
+            PySDM_products.AmbientRelativeHumidity(name="RH"),
+            PySDM_products.PeakSaturation(name="S_max"),
             PySDM_products.Time(name="t"),
             PySDM_products.ActivatingRate(unit="s^-1 mg^-1", name="activating_rate"),
             PySDM_products.DeactivatingRate(
                 unit="s^-1 mg^-1", name="deactivating_rate"
             ),
             PySDM_products.RipeningRate(unit="s^-1 mg^-1", name="ripening_rate"),
-            PySDM_products.PeakSupersaturation(unit="%", name="S_max"),
         ]
 
         self.particulator = builder.build(attributes, products)
@@ -85,7 +85,7 @@ class Simulation:
             self.particulator.products["dt_cond_min"].get()[cell_id]
         )
         output["z"].append(self.particulator.products["z"].get()[cell_id])
-        output["S"].append(self.particulator.products["RH"].get()[cell_id] / 100 - 1)
+        output["RH"].append(self.particulator.products["RH"].get()[cell_id])
         output["t"].append(self.particulator.products["t"].get())
 
         for event in ("activating", "deactivating", "ripening"):
@@ -96,7 +96,7 @@ class Simulation:
     def run(self):
         output = {
             "r": [],
-            "S": [],
+            "RH": [],
             "z": [],
             "t": [],
             "dt_cond_min": [],

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Bartman_2020_MasterThesis/fig_5_SCIPY_VS_ADAPTIVE.py

@@ -75,12 +75,12 @@ def plot(plot_data, rtols, schemes, setups_num, show_plot, path=None):
             ax = axs[settings_idx, rtol_idx]
             for scheme in schemes:
                 datum = plot_data[scheme][_rtol][settings_idx]
-                S = datum["S"]
+                S = datum["RH"]
                 z = datum["z"]
                 dt = datum["dt_cond_min"]
                 if scheme == "SciPy":
-                    ax.plot(S, z, label=scheme, color="grey")
                     SCIPY_S = np.array(S)
+                    ax.plot(SCIPY_S - 1, z, label=scheme, color="grey")
                 else:
                     add_color_line(fig, ax, S, z, dt)
                     PySDM_S = np.array(S)

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Grabowski_and_Pawlowska_2023/simulation.py

@@ -38,8 +38,8 @@ class Simulation(BasicSimulation):
             Condensation(rtol_thd=settings.rtol_thd, rtol_x=settings.rtol_x)
         )
         for attribute in (
-            "critical supersaturation",
-            "equilibrium supersaturation",
+            "critical saturation",
+            "equilibrium saturation",
             "critical volume",
         ):
             builder.request_attribute(attribute)
@@ -80,12 +80,8 @@ class Simulation(BasicSimulation):
         self.output_attributes = {
             "volume": tuple([] for _ in range(self.particulator.n_sd)),
             "dry volume": tuple([] for _ in range(self.particulator.n_sd)),
-            "critical supersaturation": tuple(
-                [] for _ in range(self.particulator.n_sd)
-            ),
-            "equilibrium supersaturation": tuple(
-                [] for _ in range(self.particulator.n_sd)
-            ),
+            "critical saturation": tuple([] for _ in range(self.particulator.n_sd)),
+            "equilibrium saturation": tuple([] for _ in range(self.particulator.n_sd)),
             "critical volume": tuple([] for _ in range(self.particulator.n_sd)),
             "multiplicity": tuple([] for _ in range(self.particulator.n_sd)),
         }

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Jensen_and_Nugent_2017/simulation.py

@@ -6,7 +6,7 @@ from PySDM import Builder
 from PySDM.physics import si
 from PySDM.backends import CPU
 from PySDM.products import (
-    PeakSupersaturation,
+    PeakSaturation,
     ParcelDisplacement,
     Time,
     ActivatedMeanRadius,
@@ -52,7 +52,7 @@ class Simulation(BasicSimulation):
             ),
         )
 
-        additional_derived_attributes = ("radius", "equilibrium supersaturation")
+        additional_derived_attributes = ("radius", "equilibrium saturation")
         for additional_derived_attribute in additional_derived_attributes:
             builder.request_attribute(additional_derived_attribute)
 
@@ -93,7 +93,7 @@ class Simulation(BasicSimulation):
             builder.build(
                 attributes=attributes,
                 products=(
-                    PeakSupersaturation(name="S_max"),
+                    PeakSaturation(name="S_max"),
                     ParcelDisplacement(name="z"),
                     Time(name="t"),
                     ActivatedMeanRadius(

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Kreidenweis_et_al_2003/simulation.py

@@ -106,7 +106,7 @@ class Simulation(BasicSimulation):
             PySDM_products.TotalDryMassMixingRatio(
                 settings.DRY_RHO, name="q_dry", unit="ug/kg"
             ),
-            PySDM_products.PeakSupersaturation(unit="%", name="S_max"),
+            PySDM_products.PeakSaturation(unit="%", name="S_max_percent"),
             PySDM_products.ParticleSpecificConcentration(
                 radius_range=settings.cloud_radius_range, name="n_c_mg", unit="mg^-1"
             ),

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Lowe_et_al_2019/simulation.py

@@ -81,8 +81,8 @@ class Simulation(BasicSimulation):
         products = products or (
             PySDM_products.ParcelDisplacement(name="z"),
             PySDM_products.Time(name="t"),
-            PySDM_products.PeakSupersaturation(unit="%", name="S_max"),
-            PySDM_products.AmbientRelativeHumidity(unit="%", name="RH"),
+            PySDM_products.PeakSaturation(name="S_max"),
+            PySDM_products.AmbientRelativeHumidity(name="RH"),
             PySDM_products.ActivatedParticleConcentration(
                 name="CDNC_cm3",
                 unit="cm^-3",

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Pyrcel/profile_plotter.py

@@ -28,8 +28,12 @@ class ProfilePlotter:
     def plot_data(self, settings, output):
         _, axs = pyplot.subplots(1, 2, sharey=True, figsize=(10, 5))
         axS = axs[0]
+        if output["products"].get("S_max"):
+            SS_percent = (np.asarray(output["products"]["S_max"]) - 1) * 100
+        else:
+            SS_percent = np.asarray(output["products"]["S_max_percent"]) - 100
         axS.plot(
-            np.asarray(output["products"]["S_max"]) - 100,
+            SS_percent,
             output["products"]["z"],
             color="black",
         )
@@ -37,7 +41,7 @@ class ProfilePlotter:
         axS.set_xlabel("Supersaturation [%]")
         axS.set_xlim(0, 0.7)
         axS.set_ylim(0, 250)
-        axS.text(0.3, 52, f"max S = {np.nanmax(output['products']['S_max'])-100:.2f}%")
+        axS.text(0.3, 52, f"max SS = {np.nanmax(SS_percent):.2f}%")
         axS.grid()
 
         axT = axS.twiny()

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/Shipway_and_Hill_2012/simulation.py

@@ -148,7 +148,7 @@ class Simulation:
                     PySDM_products.RipeningRate(name="ripening"),
                     PySDM_products.ActivatingRate(name="activating"),
                     PySDM_products.DeactivatingRate(name="deactivating"),
-                    PySDM_products.PeakSupersaturation(unit="%"),
+                    PySDM_products.PeakSaturation(),
                     PySDM_products.ParticleSizeSpectrumPerVolume(
                         name="dry spectrum",
                         radius_bins_edges=settings.r_bins_edges_dry,

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/utils/kinematic_2d/make_default_product_collection.py

@@ -67,7 +67,7 @@ def make_default_product_collection(settings):
     if settings.processes["condensation"]:
         products.append(PySDM_products.CondensationTimestepMin(name="dt_cond_min"))
         products.append(PySDM_products.CondensationTimestepMax(name="dt_cond_max"))
-        products.append(PySDM_products.PeakSupersaturation(unit="%", name="S_max"))
+        products.append(PySDM_products.PeakSaturation(unit="%", name="S_max_percent"))
         products.append(PySDM_products.ActivatingRate())
         products.append(PySDM_products.DeactivatingRate())
         products.append(PySDM_products.RipeningRate())

{pysdm_examples-2.127 → pysdm_examples-2.129}/PySDM_examples/utils/pvanim.py

@@ -12,6 +12,12 @@ def cli_using_argparse(argp):
     argp.add_argument("product_path", help="path to pvd products file")
     argp.add_argument("attributes_path", help=" path to pvd attributes file")
     argp.add_argument("output_path", help="path where to write output files")
+    argp.add_argument(
+        "--mode",
+        choices=["light", "dark"],
+        default="dark",
+        help="Choose 'light' or 'dark' mode.",
+    )
     argp.add_argument(
         "--multiplicity_preset",
         default="Inferno (matplotlib)",
@@ -54,6 +60,13 @@ def cli_using_argparse(argp):
         default=0.77,
         help="Opacity for sd_attributes",
     )
+    argp.add_argument(
+        "--animation_size",
+        nargs=2,
+        type=int,
+        default=[800, 800],
+        help="Animation size [x,y]",
+    )
     argp.add_argument(
         "--animationframename",
         type=str,
@@ -86,12 +99,14 @@ setup = {
     "sd_productspvdDisplay": pvs.GetDisplayProperties(
         sd_productspvd, view=pvs.GetActiveViewOrCreate("RenderView")
     ),
+    "color": [1, 1, 1] if args.mode == "dark" else [0, 0, 0],
+    "inverted_color": [0.129, 0.145, 0.161] if args.mode == "dark" else [1, 1, 1],
 }
 
 setup = namedtuple("Setup", setup.keys())(**setup)
 
 setup.effectiveradiusLUT.RescaleTransferFunction(0.1380997175392798, 207.7063518856934)
-
+materialLibrary1 = pvs.GetMaterialLibrary()
 setup.renderView1.Update()
 
 
@@ -127,6 +142,10 @@ def scalar_bar(name, *, y, erLUT):
     scalarBar = pvs.GetScalarBar(erLUT.effectiveradiusLUT, y.renderView1)
     scalarBar.ComponentTitle = ""
     scalarBar.Title = name
+    scalarBar.TitleFontSize = 25
+    scalarBar.LabelFontSize = 25
+    scalarBar.LabelColor = setup.color
+    scalarBar.TitleColor = setup.color
     y.renderView1.Update()
 
 
@@ -139,6 +158,12 @@ def create_glyph(
     glyph.ScaleArray = [scale_array1, scale_array2]
     glyph.ScaleFactor = 100
     glyphDisplay.SetScalarBarVisibility(y.renderView1, True)
+    multiplicityLUT = pvs.GetColorTransferFunction("multiplicity")
+    multiplicityLUTColorBar = pvs.GetScalarBar(multiplicityLUT, y.renderView1)
+    multiplicityLUTColorBar.TitleFontSize = 25
+    multiplicityLUTColorBar.LabelFontSize = 25
+    multiplicityLUTColorBar.LabelColor = setup.color
+    multiplicityLUTColorBar.TitleColor = setup.color
     if color_by is True:
         glyphDisplay.ColorArrayName = ["POINTS", ""]
         pvs.ColorBy(glyphDisplay, None)
@@ -178,27 +203,31 @@ def apply_presets_logscale_opacity_and_update(*, y, attdisplay, erLUT, proddispl
 
 
 def get_layout(*, y):
+    pvs.SetViewProperties(
+        Background=setup.inverted_color, UseColorPaletteForBackground=0
+    )
+    pvs.Render(setup.renderView1)
     layout1 = pvs.GetLayout()
-    layout1.SetSize(1205, 739)
+    layout1.SetSize(args.animation_size)
+    layout1.PreviewMode = args.animation_size
     y.renderView1.Update()
 
 
 def set_current_camera_placement(*, y):
     y.renderView1.InteractionMode = "2D"
     y.renderView1.CameraPosition = [
-        836.5045867211775,
-        677.8909274570431,
-        -4098.0762113533165,
+        836,
+        677,
+        -4098,
     ]
-    y.renderView1.CameraFocalPoint = [836.5045867211775, 677.8909274570431, 0.0]
+    y.renderView1.CameraFocalPoint = [636, 1030, 0.0]
     y.renderView1.CameraViewUp = [1.0, 0.0, 0.0]
-    y.renderView1.CameraParallelScale = 1060.6601717798205
+    y.renderView1.CameraParallelScale = 1560
     y.renderView1.Update()
 
 
 def axes_settings(*, view):
-    view.ViewSize = [2000, 800]
-    view.Background = [1, 1, 1]
+    # setup.renderView1.Background = [1,0.5,0.2]
     view.CenterAxesVisibility = True
     view.OrientationAxesVisibility = False
     axesGrid = view.AxesGrid
@@ -216,10 +245,10 @@ def axes_settings(*, view):
     axesGrid.YTitleFontSize = 30
     axesGrid.YLabelFontSize = 30
 
-    axesGrid.XTitleColor = [1.0, 1.0, 1.0]
-    axesGrid.XLabelColor = [1.0, 1.0, 1.0]
-    axesGrid.YTitleColor = [1.0, 1.0, 1.0]
-    axesGrid.YLabelColor = [1.0, 1.0, 1.0]
+    axesGrid.XTitleColor = setup.color
+    axesGrid.XLabelColor = setup.color
+    axesGrid.YTitleColor = setup.color
+    axesGrid.YLabelColor = setup.color
     axesGrid.GridColor = [0.1, 0.1, 0.1]
     view.CenterAxesVisibility = False
     view.Update()
@@ -227,9 +256,14 @@ def axes_settings(*, view):
 
 def time_annotation(*, y):
     time = pvs.AnnotateTimeFilter(
-        guiName="AnnotateTimeFilter1", Format="Time:{time:f}s"
+        guiName="AnnotateTimeFilter1", Scale=1 / 60, Format="Time:{time:g}min"
     )
-    pvs.Show(time, y.renderView1)
+    timedisplay = pvs.Show(time, y.renderView1)
+    timedisplay.FontSize = 25
+    timedisplay.WindowLocation = "Any Location"
+    timedisplay.FontSize = 30
+    timedisplay.Position = [0.31, 0.9]
+    timedisplay.Color = setup.color
     y.renderView1.Update()
 
 
@@ -237,10 +271,10 @@ def text(text_in, position_y, *, view):
     sentence = pvs.Text()
     sentence.Text = text_in
     textDisplay = pvs.Show(sentence, view)
-    textDisplay.Color = [1.0, 1.0, 1.0]
+    textDisplay.Color = setup.color
     textDisplay.WindowLocation = "Any Location"
-    textDisplay.FontSize = 16
-    textDisplay.Position = [0.01, position_y]
+    textDisplay.FontSize = 28
+    textDisplay.Position = [0.17, position_y]
 
 
 def last_anim_frame(animation_frame_name):
@@ -290,9 +324,11 @@ get_layout(y=setup)
 set_current_camera_placement(y=setup)
 axes_settings(view=setup.renderView1)
 time_annotation(y=setup)
-text("Arrows scale with Courant number C=u*Δt/Δx,", 0.7, view=setup.renderView1)
-text("reflecting the grid spacing Δx and Δy.", 0.65, view=setup.renderView1)
-last_anim_frame(animation_frame_name=args.animationframename)
+text("Arrows scale with Courant", 0.15, view=setup.renderView1)
+text("number C=u·Δt/Δx, reflecting", 0.1, view=setup.renderView1)
+text("the grid spacing Δx and Δy.", 0.05, view=setup.renderView1)
+if args.animationframename is not None:
+    last_anim_frame(animation_frame_name=args.animationframename)
 scene = pvs.GetAnimationScene()
 scene.UpdateAnimationUsingDataTimeSteps()
 pvs.Render(setup.renderView1)

{pysdm_examples-2.127 → pysdm_examples-2.129}/pysdm_examples.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pysdm-examples
-Version: 2.127
+Version: 2.129
 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