PySDM 2.71__py3-none-any.whl → 2.72__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: PySDM
3
- Version: 2.71
3
+ Version: 2.72
4
4
  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
5
5
  Home-page: https://github.com/open-atmos/PySDM
6
6
  Author: https://github.com/open-atmos/PySDM/graphs/contributors
@@ -62,7 +62,7 @@ Requires-Dist: ipywidgets!=8.0.3; extra == "tests"
62
62
  [![Appveyor Build status](http://ci.appveyor.com/api/projects/status/github/open-atmos/PySDM?branch=main&svg=true)](https://ci.appveyor.com/project/slayoo/pysdm/branch/main)
63
63
  [![Coverage Status](https://codecov.io/gh/open-atmos/PySDM/branch/main/graph/badge.svg)](https://app.codecov.io/gh/open-atmos/PySDM)
64
64
  [![PyPI version](https://badge.fury.io/py/PySDM.svg)](https://pypi.org/project/PySDM)
65
- [![API docs](https://img.shields.io/badge/API_docs-pdoc3-blue.svg)](https://open-atmos.github.io/PySDM/)
65
+ [![API docs](https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg)](https://open-atmos.github.io/PySDM/)
66
66
 
67
67
  PySDM is a package for simulating the dynamics of population of particles.
68
68
  It is intended to serve as a building block for simulation systems modelling
@@ -92,9 +92,9 @@ Like the examples, these tutorials can be executed or viewed "in the cloud" maki
92
92
  PySDM has two alternative parallel number-crunching backends
93
93
  available: multi-threaded CPU backend based on [Numba](http://numba.pydata.org/)
94
94
  and GPU-resident backend built on top of [ThrustRTC](https://pypi.org/project/ThrustRTC/).
95
- The [`Numba`](https://open-atmos.github.io/PySDM/PySDM/backends/numba/numba.html) backend (aliased ``CPU``) features multi-threaded parallelism for
95
+ The [`Numba`](https://open-atmos.github.io/PySDM/PySDM/backends/numba.html) backend (aliased ``CPU``) features multi-threaded parallelism for
96
96
  multi-core CPUs, it uses the just-in-time compilation technique based on the LLVM infrastructure.
97
- The [`ThrustRTC`](https://open-atmos.github.io/PySDM/PySDM/backends/thrustRTC/thrustRTC.html) backend (aliased ``GPU``) offers GPU-resident operation of PySDM
97
+ The [`ThrustRTC`](https://open-atmos.github.io/PySDM/PySDM/backends/thrust_rtc.html) backend (aliased ``GPU``) offers GPU-resident operation of PySDM
98
98
  leveraging the [SIMT](https://en.wikipedia.org/wiki/Single_instruction,_multiple_threads)
99
99
  parallelisation model.
100
100
  Using the ``GPU`` backend requires nVidia hardware and [CUDA driver](https://developer.nvidia.com/cuda-downloads).
@@ -106,7 +106,7 @@ For an overview of PySDM features (and the preferred way to cite PySDM in papers
106
106
  PySDM includes an extension of the SDM scheme to represent collisional breakup described in [de Jong, Mackay et al. 2023](10.5194/gmd-16-4193-2023).
107
107
  For a list of talks and other materials on PySDM as well as a list of published papers featuring PySDM simulations, see the [project wiki](https://github.com/open-atmos/PySDM/wiki).
108
108
 
109
- A [pdoc-generated](https://pdoc3.github.io/pdoc) documentation of PySDM public API is maintained at: [https://open-atmos.github.io/PySDM](https://open-atmos.github.io/PySDM)
109
+ A [pdoc-generated](https://pdoc.dev/) documentation of PySDM public API is maintained at: [https://open-atmos.github.io/PySDM](https://open-atmos.github.io/PySDM)
110
110
 
111
111
  ## Example Jupyter notebooks (reproducing results from literature):
112
112
 
@@ -216,8 +216,8 @@ In order to depict the PySDM API with a practical example, the following
216
216
  listings provide sample code roughly reproducing the
217
217
  Figure 2 from [Shima et al. 2009 paper](http://doi.org/10.1002/qj.441)
218
218
  using PySDM from Python, Julia and Matlab.
219
- It is a [`Coalescence`](https://open-atmos.github.io/PySDM/PySDM/dynamics/coalescence.html)-only set-up in which the initial particle size
220
- spectrum is [`Exponential`](https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra.html#PySDM.initialisation.spectra.Exponential) and is deterministically sampled to match
219
+ It is a [`Coalescence`](https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/sollision.html#Coalescence)-only set-up in which the initial particle size
220
+ spectrum is [`Exponential`](https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra/exponential.html#Exponential) and is deterministically sampled to match
221
221
  the condition of each super-droplet having equal initial multiplicity:
222
222
  <details>
223
223
  <summary>Julia (click to expand)</summary>
@@ -271,9 +271,9 @@ attributes['volume'], attributes['multiplicity'] = ConstantMultiplicity(initial_
271
271
  ```
272
272
  </details>
273
273
 
274
- The key element of the PySDM interface is the [``Particulator``](https://open-atmos.github.io/PySDM/PySDM/particulator.html)
274
+ The key element of the PySDM interface is the [``Particulator``](https://open-atmos.github.io/PySDM/PySDM/particulator.html#Particulator)
275
275
  class instances of which are used to manage the system state and control the simulation.
276
- Instantiation of the [``Particulator``](https://open-atmos.github.io/PySDM/PySDM/particulator.html) class is handled by the [``Builder``](https://open-atmos.github.io/PySDM/PySDM/builder.html)
276
+ Instantiation of the [``Particulator``](https://open-atmos.github.io/PySDM/PySDM/particulator.html#Particulator) class is handled by the [``Builder``](https://open-atmos.github.io/PySDM/PySDM/builder.html#Builder)
277
277
  as exemplified below:
278
278
  <details>
279
279
  <summary>Julia (click to expand)</summary>
@@ -343,18 +343,18 @@ particulator = builder.build(attributes, products)
343
343
  The ``backend`` argument may be set to ``CPU`` or ``GPU``
344
344
  what translates to choosing the multi-threaded backend or the
345
345
  GPU-resident computation mode, respectively.
346
- The employed [`Box`](https://open-atmos.github.io/PySDM/PySDM/environments/box.html) environment corresponds to a zero-dimensional framework
346
+ The employed [`Box`](https://open-atmos.github.io/PySDM/PySDM/environments/box.html#Box) environment corresponds to a zero-dimensional framework
347
347
  (particle positions are not considered).
348
348
  The vectors of particle multiplicities ``n`` and particle volumes ``v`` are
349
349
  used to initialise super-droplet attributes.
350
- The [`Coalescence`](https://open-atmos.github.io/PySDM/PySDM/dynamics/coalescence.html)
350
+ The [`Coalescence`](https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision.html#Coalescence)
351
351
  Monte-Carlo algorithm (Super Droplet Method) is registered as the only
352
352
  dynamic in the system.
353
- Finally, the [`build()`](https://open-atmos.github.io/PySDM/PySDM/builder.html#PySDM.builder.Builder.build) method is used to obtain an instance
354
- of [`Particulator`](https://open-atmos.github.io/PySDM/PySDM/particulator.html#PySDM.particulator.Particulator) which can then be used to control time-stepping and
353
+ Finally, the [`build()`](https://open-atmos.github.io/PySDM/PySDM/builder.html#Builder.build) method is used to obtain an instance
354
+ of [`Particulator`](https://open-atmos.github.io/PySDM/PySDM/particulator.html#Particulator) which can then be used to control time-stepping and
355
355
  access simulation state.
356
356
 
357
- The [`run(nt)`](https://open-atmos.github.io/PySDM/PySDM/particulator.html#PySDM.particuparticulatorr.Particulator.run) method advances the simulation by ``nt`` timesteps.
357
+ The [`run(nt)`](https://open-atmos.github.io/PySDM/PySDM/particulator.html#Particulator.run) method advances the simulation by ``nt`` timesteps.
358
358
  In the listing below, its usage is interleaved with plotting logic
359
359
  which displays a histogram of particle mass distribution
360
360
  at selected timesteps:
@@ -471,16 +471,16 @@ The component submodules used to create this simulation are visualized below:
471
471
  SPECTRUM_INIT["ParticleVolumeVersusRadiusLogarithmSpectrum.__init__()"] -->|instantiates| SPECTRUM
472
472
  SPECTRUM[":ParticleVolumeVersusRadiusLogarithmSpectrum"] -->|added as element of| PRODUCTS
473
473
 
474
- click COAL "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision.html"
474
+ click COAL "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision.html#Coalescence"
475
475
  click BUILDER_INSTANCE "https://open-atmos.github.io/PySDM/PySDM/builder.html"
476
476
  click BUILDER_INIT "https://open-atmos.github.io/PySDM/PySDM/builder.html"
477
477
  click BUILDER_ADD_DYN "https://open-atmos.github.io/PySDM/PySDM/builder.html"
478
- click ENV_INIT "https://open-atmos.github.io/PySDM/PySDM/environments/index.html"
479
- click ENV "https://open-atmos.github.io/PySDM/PySDM/environments/index.html"
480
- click KERNEL_INIT "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision_kernels/index.html"
481
- click KERNEL "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision_kernels/index.html"
482
- click EXP_INIT "https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra/index.html"
483
- click IS "https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra/index.html"
478
+ click ENV_INIT "https://open-atmos.github.io/PySDM/PySDM/environments.html"
479
+ click ENV "https://open-atmos.github.io/PySDM/PySDM/environments.html"
480
+ click KERNEL_INIT "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision_kernels.html"
481
+ click KERNEL "https://open-atmos.github.io/PySDM/PySDM/dynamics/collisions/collision_kernels.html"
482
+ click EXP_INIT "https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra.html"
483
+ click IS "https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra.html"
484
484
  click CM_INIT "https://open-atmos.github.io/PySDM/PySDM/initialisation/sampling/spectral_sampling.html"
485
485
  click CM_INSTANCE "https://open-atmos.github.io/PySDM/PySDM/initialisation/sampling/spectral_sampling.html"
486
486
  click SAMPLE "https://open-atmos.github.io/PySDM/PySDM/initialisation/sampling/spectral_sampling.html"
@@ -496,7 +496,7 @@ The component submodules used to create this simulation are visualized below:
496
496
 
497
497
  In the following example, a condensation-only setup is used with the adiabatic
498
498
  [`Parcel`](https://open-atmos.github.io/PySDM/PySDM/environments/parcel.html) environment.
499
- An initial [`Lognormal`](https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra.html#PySDM.initialisation.spectra.Lognormal)
499
+ An initial [`Lognormal`](https://open-atmos.github.io/PySDM/PySDM/initialisation/spectra/lognormal.html#Lognormal)
500
500
  spectrum of dry aerosol particles is first initialised to equilibrium wet size for the given
501
501
  initial humidity.
502
502
  Subsequent particle growth due to [`Condensation`](https://open-atmos.github.io/PySDM/PySDM/dynamics/condensation.html) of water vapour (coupled with the release of latent heat)
@@ -506,7 +506,7 @@ Results of the simulation are plotted against vertical
506
506
  and depict the evolution of
507
507
  [`PeakSupersaturation`](https://open-atmos.github.io/PySDM/PySDM/products/condensation/peak_supersaturation.html),
508
508
  [`EffectiveRadius`](https://open-atmos.github.io/PySDM/PySDM/products/size_spectral/effective_radius.html),
509
- [`ParticleConcentration`](https://open-atmos.github.io/PySDM/PySDM/products/size_spectral/particle_concentration.html#PySDM.products.particles_concentration.ParticleConcentration)
509
+ [`ParticleConcentration`](https://open-atmos.github.io/PySDM/PySDM/products/size_spectral/particle_concentration.html#ParticleConcentration)
510
510
  and the
511
511
  [`WaterMixingRatio `](https://open-atmos.github.io/PySDM/PySDM/products/size_spectral/water_mixing_ratio.html).
512
512
 
@@ -380,8 +380,8 @@ PySDM/products/size_spectral/size_standard_deviation.py,sha256=A7fSj_keQi_bHW41P
380
380
  PySDM/products/size_spectral/total_particle_concentration.py,sha256=K7sO2jgUpYOwWvBK3jXp9KUxLRXk_Ve6ooOdY5q5jd0,470
381
381
  PySDM/products/size_spectral/total_particle_specific_concentration.py,sha256=isLZt5j2vJGr-FrzYFcUNPHZqMKhOtl51za1Hogh6hQ,476
382
382
  PySDM/products/size_spectral/water_mixing_ratio.py,sha256=PP54hfMy4SPDQDJgV4RNzVP03lmL1THZPa2KXrdgoQ4,1324
383
- PySDM-2.71.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
384
- PySDM-2.71.dist-info/METADATA,sha256=m-hDt12uj8be-Em3TZyXZwLDbCoazHHk6LMZ28lciNA,45915
385
- PySDM-2.71.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
386
- PySDM-2.71.dist-info/top_level.txt,sha256=6NYaDAhUnaYMD7ebD_dQ7HlhiJS7NMuKEXb0ck7Wcsg,6
387
- PySDM-2.71.dist-info/RECORD,,
383
+ PySDM-2.72.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
384
+ PySDM-2.72.dist-info/METADATA,sha256=rA6ETsPRKxUPlQxxpZA8DZPIJLKbkhVi8vR9tHn2y-0,45823
385
+ PySDM-2.72.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
386
+ PySDM-2.72.dist-info/top_level.txt,sha256=6NYaDAhUnaYMD7ebD_dQ7HlhiJS7NMuKEXb0ck7Wcsg,6
387
+ PySDM-2.72.dist-info/RECORD,,
File without changes
File without changes