PySDM 2.80__tar.gz → 2.82__tar.gz

{PySDM-2.80 → pysdm-2.82}/.github/workflows/tests+artifacts+pypi.yml

@@ -67,7 +67,7 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-python@v5.0.0
         with:
-          python-version: 3.9
+          python-version: "3.12"
       - run: |
           pip install pdoc nbformat
           pip install -e .
@@ -131,7 +131,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-13, macos-14, windows-latest]
-        python-version: ["3.9", "3.11"]
+        python-version: ["3.9", "3.12"]
         test-suite: ["unit_tests/!(dynamics)", "unit_tests/dynamics/!(condensation)", "unit_tests/dynamics/condensation", "smoke_tests/no_env", "smoke_tests/box", "smoke_tests/parcel_a", "smoke_tests/parcel_b", "smoke_tests/parcel_c", "smoke_tests/kinematic_1d", "smoke_tests/kinematic_2d", "tutorials_tests"]
         exclude:
           - platform: "macos-14"
@@ -197,7 +197,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-24.04, macos-13, windows-latest]
-        python-version: ["3.9", "3.11"]
+        python-version: ["3.9", "3.12"]
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v4.1.6
@@ -233,7 +233,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-24.04, macos-13, windows-latest]
-        python-version: ["3.9", "3.11"]
+        python-version: ["3.9", "3.12"]
         test-suite: [ "chemistry_freezing_isotopes", "condensation_a", "condensation_b", "coagulation", "breakup", "multi-process_a", "multi-process_b"]
       fail-fast: false
     runs-on: ${{ matrix.platform }}
@@ -318,7 +318,7 @@ jobs:
           fetch-depth: 0  # https://github.com/pypa/setuptools_scm/issues/480
       - uses: actions/setup-python@v5.0.0
         with:
-          python-version: "3.11"
+          python-version: "3.12"
 
       - run: pip install twine build
 
@@ -326,7 +326,11 @@ jobs:
           unset CI
           cd ${{ matrix.packages-dir }}
           python -m build 2>&1 | tee build.log
-          exit `fgrep -i warning build.log | grep -v impl_numba/warnings.py | grep -v "no previously-included files matching" | wc -l`
+          exit `fgrep -i warning build.log | grep -v impl_numba/warnings.py \
+            | grep -v "no previously-included files matching" \
+            | grep -v "version of {dist_name} already set" \
+            | grep -v -E "UserWarning: version of PySDM(-examples)? already set" \
+            | wc -l`
           twine check --strict dist/*
 
       - uses: actions/upload-artifact@v4
@@ -338,7 +342,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-13, macos-14, windows-latest]
-        python-version: ["3.9", "3.11"]
+        python-version: ["3.9", "3.12"]
         exclude:
           - platform: macos-14
             python-version: "3.9"

pysdm-2.82/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.1
+Name: PySDM
+Version: 2.82
+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
+Home-page: https://github.com/open-atmos/PySDM
+Author: https://github.com/open-atmos/PySDM/graphs/contributors
+Author-email: sylwester.arabas@agh.edu.pl
+License: GPL-3.0
+Project-URL: Tracker, https://github.com/open-atmos/PySDM/issues
+Project-URL: Documentation, https://open-atmos.github.io/PySDM
+Project-URL: Source, https://github.com/open-atmos/PySDM
+Keywords: physics-simulation,monte-carlo-simulation,gpu-computing,atmospheric-modelling,particle-system,numba,thrust,nvrtc,pint,atmospheric-physics
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ThrustRTC==0.3.20
+Requires-Dist: CURandRTC>=0.1.2
+Requires-Dist: numba>=0.51.2
+Requires-Dist: numpy
+Requires-Dist: Pint
+Requires-Dist: chempy
+Requires-Dist: scipy
+Requires-Dist: pyevtk
+Requires-Dist: flexparser<0.4
+Provides-Extra: tests
+Requires-Dist: matplotlib; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-timeout; extra == "tests"
+Requires-Dist: pyrcel; extra == "tests"
+Requires-Dist: jupyter-core<5.0.0; extra == "tests"
+Requires-Dist: ipywidgets!=8.0.3; extra == "tests"
+
+# <img src="https://raw.githubusercontent.com/open-atmos/PySDM/main/.github/pysdm_logo.png" width=100 height=146 alt="pysdm logo">
+
+[![Python 3](https://img.shields.io/static/v1?label=Python&logo=Python&color=3776AB&message=3)](https://www.python.org/)
+[![LLVM](https://img.shields.io/static/v1?label=LLVM&logo=LLVM&color=gold&message=Numba)](https://numba.pydata.org)
+[![CUDA](https://img.shields.io/static/v1?label=CUDA&logo=nVidia&color=87ce3e&message=ThrustRTC)](https://pypi.org/project/ThrustRTC/)
+[![Linux OK](https://img.shields.io/static/v1?label=Linux&logo=Linux&color=yellow&message=%E2%9C%93)](https://en.wikipedia.org/wiki/Linux)
+[![macOS OK](https://img.shields.io/static/v1?label=macOS&logo=Apple&color=silver&message=%E2%9C%93)](https://en.wikipedia.org/wiki/macOS)
+[![Windows OK](https://img.shields.io/static/v1?label=Windows&logo=Windows&color=white&message=%E2%9C%93)](https://en.wikipedia.org/wiki/Windows)
+[![Jupyter](https://img.shields.io/static/v1?label=Jupyter&logo=Jupyter&color=f37626&message=%E2%9C%93)](https://jupyter.org/)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/open-atmos/PySDM/graphs/commit-activity)
+[![OpenHub](https://www.openhub.net/p/atmos-cloud-sim-uj-PySDM/widgets/project_thin_badge?format=gif)](https://www.openhub.net/p/atmos-cloud-sim-uj-PySDM)
+[![status](https://joss.theoj.org/papers/62cad07440b941f73f57d187df1aa6e9/status.svg)](https://joss.theoj.org/papers/62cad07440b941f73f57d187df1aa6e9)
+[![DOI](https://zenodo.org/badge/199064632.svg)](https://zenodo.org/badge/latestdoi/199064632)    
+[![EU Funding](https://img.shields.io/static/v1?label=EU%20Funding%20by&color=103069&message=FNP&logoWidth=25&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC4AAAAeCAYAAABTwyyaAAAEzklEQVRYw9WYS2yUVRiGn3P5ZzozpZ3aUsrNgoKlKBINmkhpCCwwxIAhsDCpBBIWhmCMMYTEhSJ4i9EgBnSBEm81MRrFBhNXEuUSMCopiRWLQqEGLNgr085M5//POS46NNYFzHQ6qGc1i5nzP/P973m/9ztCrf7A8T9csiibCocUbvTzfxLcAcaM3cY3imXz25lT3Y34G7gQYAKV3+bFAHcATlBTPogJNADG92iY28FHW97kyPbnuW/W7xgzAhukQ9xe04PJeOT0HkQRwK0TlEeGWb/kOO9v3kdD3a8YK9GhDMfa6mg9fxunOm/lWPtcpDI4K7n/jnN8+uQbrFrUSiwU/DtSEUB/MsKKBT+zYslJqiYNgVE4JwhHkzy86wlWvrKVWDSZ/YFjZlU39yw4y/rGoyQGowWB67zl4QQue+jssMdXrQvZ/00jyeHwqCgDKwnsiJjSvkYAxsG5K9WsenYbJdqAtAjhCIxCSZt/4fK1w5A2WCvxrUAKCHwNVoA2aGmvq11jJQQapEXrgMBKqmJJugejKGWLIxXrBPFoigfv/omd675gRkU/xgqUDlAhH3UDaAAlLSqUQekAYyVTyhLs3tDMsvntlIYzOFcEcOcEGd9jx9oDbGs6QO0t/Tijxi9S4bhzxiWaVh5m94Zm0n7oui4ybo0raUlcncQnxx+g+WgDF/vLoYDmoqSl/dJUnt7XRCoTZjij0Z6Pc2LiNS4EBBkNvoeOJXN+yPWWSZeANOhwJq/98nKVwNdoL8B5AROxBKBL0gjh8DMhdCh3eJnrA0yqhLpplwmyup6IajvAOIGfKGVx3VmCRGnOMpe5QAdG0bT8CAeeep0d6z6nqjSJnQiZWEllLMWrmz6k+fE9rGk8MVqYgsGv5ZH2i1Opr+9kajzB5d74hKQ+KS3d/WVMLhtgdu1lriRiOR/4nDVunaR24x7qp3UV5Cb/fJvC83nv26W81LIK58SYNFmwq4hsGx/5BwKlzYRma2NUthgOJSew4i7ru9nJYCQF5tApb2yvjiDQKJV/IfJKh0o6qssSLKv/jcAoRKHQQzE2Lj2OMV5OkWFc4MZIpsev8uXWXRx6ZicbGk8QZLxxgwe+x/rlR3h3816+f2E7lbEU+ZDn3vKVpePCdFovzCISHqbl5EIoQOteKMPB1rto65zNyfOz+KOrGl06lHPQyi/WOohH0/T0l1MZH6A3GUEKl7Pmr2la6wBrBWWRDP2DUcqjKVKBGom9RZmABAykwnglafpSJSPQvsfiOR0EQ7ExVmazA8cY6N4K1iw6RdAXRwi4mgrheT5Dvs4LeuS81a15Ll/3dQisFVSVpnj7sf1sX/sZvhAc+6UOrQyBVUQ8gx/orFmDsZqtaw/y1qZ9zKjp5vDpenyjcNe+cLNmTiUdf/bEOddVQ0VpgsOn54ET+EYxvWKALSu+5tGG76it7MNaiZKGQ23zCIcMfUMxBnrjN3fmHHvCAlp+vJcXWx6itqoXpAEnUNLx8iMfo5Xh1i17R3PJYCpC2cZ3qK3sQ8WGEDDuXlAQuFKGHzpmopXhTNfk0bmxs7uC1w6uJul79AxFkMIiBJy5UoUWjrZLU5DCFdTARDHuDqVw+OkSwI0MCEW4gtNF2BPrBCo8fKNbtILWX9aUDqFqHnn7AAAAAElFTkSuQmCC)](https://www.fnp.org.pl/en/)
+[![PL Funding](https://img.shields.io/static/v1?label=PL%20Funding%20by&color=d21132&message=NCN&logoWidth=25&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAANCAYAAACpUE5eAAAABmJLR0QA/wD/AP+gvaeTAAAAKUlEQVQ4jWP8////fwYqAiZqGjZqIHUAy4dJS6lqIOMdEZvRZDPcDQQAb3cIaY1Sbi4AAAAASUVORK5CYII=)](https://www.ncn.gov.pl/?language=en)
+[![US Funding](https://img.shields.io/static/v1?label=US%20DOE%20Funding%20by&color=267c32&message=ASR&logoWidth=25&logo=image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB4AAAAQCAMAAAA25D/gAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAASFBMVEVOTXyyIjRDQnNZWINZWITtzdFUU4BVVIFVVYHWiZM9PG/KZnNXVoJaWYT67/FKSXhgX4hgX4lcW4VbWoX03uHQeIN2VXj///9pZChlAAAAAWJLR0QXC9aYjwAAAAd0SU1FB+EICRMGJV+KCCQAAABdSURBVBjThdBJDoAgEETRkkkZBBX0/kd11QTTpH1/STqpAAwWBkobSlkGbt0o5xmEfqxDZJB2Q6XMoBwnVSbTylWp0hi42rmbwTOYPDfR5Kc+07IIUQQvghX9THsBHcES8/SiF0kAAAAldEVYdGRhdGU6Y3JlYXRlADIwMTctMDgtMDlUMTk6MDY6MzcrMDA6MDCX1tBgAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDE3LTA4LTA5VDE5OjA2OjM3KzAwOjAw5oto3AAAAABJRU5ErkJggg==)](https://asr.science.energy.gov/)
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
+
+[![Github Actions Build Status](https://github.com/open-atmos/PySDM/workflows/tests+artifacts+pypi/badge.svg?branch=main)](https://github.com/open-atmos/PySDM/actions)
+[![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)
+[![Coverage Status](https://codecov.io/gh/open-atmos/PySDM/branch/main/graph/badge.svg)](https://app.codecov.io/gh/open-atmos/PySDM)    
+[![PyPI version](https://badge.fury.io/py/PySDM.svg)](https://pypi.org/project/PySDM)
+[![API docs](https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg)](https://open-atmos.github.io/PySDM/)
+
+PySDM is a package for simulating the dynamics of population of particles. 
+It is intended to serve as a building block for simulation systems modelling
+  fluid flows involving a dispersed phase,
+  with PySDM being responsible for representation of the dispersed phase.
+Currently, the development is focused on atmospheric cloud physics
+  applications, in particular on modelling the dynamics of particles immersed in moist air 
+  using the particle-based (a.k.a. super-droplet) approach 
+  to represent aerosol/cloud/rain microphysics.
+The package features a Pythonic high-performance implementation of the 
+  Super-Droplet Method (SDM) Monte-Carlo algorithm for representing collisional growth 
+  ([Shima et al. 2009](https://rmets.onlinelibrary.wiley.com/doi/abs/10.1002/qj.441)), hence the name. 
+
+There is a growing set of example Jupyter notebooks exemplifying how to perform 
+  various types of calculations and simulations using PySDM.
+Most of the example notebooks reproduce results and plot from literature, see below for 
+  a list of examples and links to the notebooks (which can be either executed or viewed 
+  "in the cloud").
+
+There are also a growing set of [tutorials](https://github.com/open-atmos/PySDM/tree/main/tutorials), also in the form of Jupyter notebooks.
+These tutorials are intended for teaching purposes and include short explanations of cloud microphysical 
+  concepts paired with widgets for running interactive simulations using PySDM.
+Each tutorial also comes with a set of questions at the end that can be used as homework problems.
+Like the examples, these tutorials can be executed or viewed "in the cloud" making it an especially 
+  easy way for students to get started.
+
+PySDM has two alternative parallel number-crunching backends 
+  available: multi-threaded CPU backend based on [Numba](http://numba.pydata.org/) 
+  and GPU-resident backend built on top of [ThrustRTC](https://pypi.org/project/ThrustRTC/).
+The [`Numba`](https://open-atmos.github.io/PySDM/PySDM/backends/numba.html) backend (aliased ``CPU``) features multi-threaded parallelism for 
+  multi-core CPUs, it uses the just-in-time compilation technique based on the LLVM infrastructure.
+The [`ThrustRTC`](https://open-atmos.github.io/PySDM/PySDM/backends/thrust_rtc.html) backend (aliased ``GPU``) offers GPU-resident operation of PySDM
+  leveraging the [SIMT](https://en.wikipedia.org/wiki/Single_instruction,_multiple_threads) 
+  parallelisation model. 
+Using the ``GPU`` backend requires nVidia hardware and [CUDA driver](https://developer.nvidia.com/cuda-downloads).
+
+For an overview of PySDM features (and the preferred way to cite PySDM in papers), please refer to our JOSS papers:
+- [Bartman et al. 2022](https://doi.org/10.21105/joss.03219) (PySDM v1).
+- [de Jong, Singer et al. 2023](https://doi.org/10.21105/joss.04968) (PySDM v2).
+  
+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).   
+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).
+
+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) 
+
+## Example Jupyter notebooks (reproducing results from literature):
+
+See [PySDM-examples README](https://github.com/open-atmos/PySDM/blob/main/examples/README.md).
+
+![animation](https://github.com/open-atmos/PySDM/wiki/files/kinematic_2D_example.gif)
+
+## Dependencies and Installation
+
+PySDM dependencies are: [Numpy](https://numpy.org/), [Numba](http://numba.pydata.org/), [SciPy](https://scipy.org/), 
+[Pint](https://pint.readthedocs.io/), [chempy](https://pypi.org/project/chempy/), 
+[pyevtk](https://pypi.org/project/pyevtk/),
+[ThrustRTC](https://fynv.github.io/ThrustRTC/) and [CURandRTC](https://github.com/fynv/CURandRTC).
+
+To install PySDM using ``pip``, use: ``pip install PySDM`` 
+(or ``pip install git+https://github.com/open-atmos/PySDM.git`` to get updates
+beyond the latest release).
+
+Conda users may use ``pip`` as well, see the [Installing non-conda packages](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html#installing-non-conda-packages) section in the conda docs. Dependencies of PySDM are available at the following conda channels:
+- numba: [numba](https://anaconda.org/numba/numba)
+- conda-forge: [pyevtk](https://anaconda.org/conda-forge/pyevtk), [pint](https://anaconda.org/conda-forge/pint) and []()
+- fyplus: [ThrustRTC](https://anaconda.org/fyplus/thrustrtc), [CURandRTC](https://anaconda.org/fyplus/curandrtc)
+- bjodah: [chempy](https://anaconda.org/bjodah/chempy)
+- nvidia: [cudatoolkit](https://anaconda.org/nvidia/cudatoolkit)
+
+For development purposes, we suggest cloning the repository and installing it using ``pip -e``.
+Test-time dependencies can be installed with ``pip -e .[tests]``.
+
+PySDM examples constitute the [``PySDM-examples``](https://github.com/open-atmos/PySDM-examples) package.
+The examples have additional dependencies listed in [``PySDM_examples`` package ``setup.py``](https://github.com/open-atmos/PySDM/blob/main/examples/setup.py) file.
+Running the example Jupyter notebooks requires the ``PySDM_examples`` package to be installed.
+The suggested install and launch steps are:
+```
+git clone https://github.com/open-atmos/PySDM.git
+pip install -e PySDM
+pip install -e PySDM/examples
+jupyter-notebook PySDM/examples/PySDM_examples
+```
+Alternatively, one can also install the examples package from pypi.org by 
+using ``pip install PySDM-examples`` (note that this does not apply to notebooks itself,
+only the supporting .py files).
+
+## Contributing, reporting issues, seeking support 
+
+#### Our technologicial stack:   
+[![Python 3](https://img.shields.io/static/v1?label=+&logo=Python&color=darkred&message=Python)](https://www.python.org/)
+[![Numba](https://img.shields.io/static/v1?label=+&logo=Numba&color=orange&message=Numba)](https://numba.pydata.org)
+[![LLVM](https://img.shields.io/static/v1?label=+&logo=LLVM&color=gold&message=LLVM)](https://llvm.org)
+[![CUDA](https://img.shields.io/static/v1?label=+&logo=nVidia&color=darkgreen&message=ThrustRTC/CUDA)](https://pypi.org/project/ThrustRTC/)
+[![NumPy](https://img.shields.io/static/v1?label=+&logo=numpy&color=blue&message=NumPy)](https://numpy.org/)
+[![pytest](https://img.shields.io/static/v1?label=+&logo=pytest&color=purple&message=pytest)](https://pytest.org/)   
+[![Colab](https://img.shields.io/static/v1?label=+&logo=googlecolab&color=darkred&message=Colab)](https://colab.research.google.com/)
+[![Codecov](https://img.shields.io/static/v1?label=+&logo=codecov&color=orange&message=Codecov)](https://codecov.io/)
+[![PyPI](https://img.shields.io/static/v1?label=+&logo=pypi&color=gold&message=PyPI)](https://pypi.org/)
+[![GithubActions](https://img.shields.io/static/v1?label=+&logo=github&color=darkgreen&message=GitHub&nbsp;Actions)](https://github.com/features/actions)
+[![Jupyter](https://img.shields.io/static/v1?label=+&logo=Jupyter&color=blue&message=Jupyter)](https://jupyter.org/)
+[![PyCharm](https://img.shields.io/static/v1?label=+&logo=pycharm&color=purple&message=PyCharm)](https:///)
+
+Submitting new code to the project, please preferably use [GitHub pull requests](https://github.com/open-atmos/PySDM/pulls) - it helps to keep record of code authorship, 
+track and archive the code review workflow and allows to benefit
+from the continuous integration setup which automates execution of tests 
+with the newly added code. 
+
+Code contributions are assumed to imply transfer of copyright.
+Should there be a need to make an exception, please indicate it when creating
+a pull request or contributing code in any other way. In any case, 
+the license of the contributed code must be compatible with GPL v3.
+
+Developing the code, we follow [The Way of Python](https://www.python.org/dev/peps/pep-0020/) and 
+the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle).
+The codebase has greatly benefited from [PyCharm code inspections](https://www.jetbrains.com/help/pycharm/code-inspection.html)
+and [Pylint](https://pylint.org), [Black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/)
+code analysis (which are all part of the CI workflows).
+
+We also use [pre-commit hooks](https://pre-commit.com). 
+In our case, the hooks modify files and re-format them.
+The pre-commit hooks can be run locally, and then the resultant changes need to be staged before committing.
+To set up the hooks locally, install pre-commit via `pip install pre-commit` and
+set up the git hooks via `pre-commit install` (this needs to be done every time you clone the project).
+To run all pre-commit hooks, run `pre-commit run --all-files`.
+The `.pre-commit-config.yaml` file can be modified in case new hooks are to be added or
+  existing ones need to be altered.  
+
+Further hints addressed at PySDM developers are maintained in the [open-atmos/python-dev-hints Wiki](https://github.com/open-atmos/python-dev-hints/wiki).
+
+Issues regarding any incorrect, unintuitive or undocumented bahaviour of
+PySDM are best to be reported on the [GitHub issue tracker](https://github.com/open-atmos/PySDM/issues/new).
+Feature requests are recorded in the "Ideas..." [PySDM wiki page](https://github.com/open-atmos/PySDM/wiki/Ideas-for-new-features-and-examples).
+
+We encourage to use the [GitHub Discussions](https://github.com/open-atmos/PySDM/discussions) feature
+(rather than the issue tracker) for seeking support in understanding, using and extending PySDM code.
+
+We look forward to your contributions and feedback.
+
+## Licensing:
+
+copyright: [Jagiellonian University](https://en.uj.edu.pl/en) (2019-2023) & [AGH University of Krakow](https://agh.edu.pl/en) (2023-...)    
+licence: [GPL v3](https://www.gnu.org/licenses/gpl-3.0.html)
+
+  

{PySDM-2.80 → pysdm-2.82}/PySDM/backends/impl_numba/methods/displacement_methods.py

@@ -152,7 +152,7 @@ class DisplacementMethods(BackendMethods):
         def body(
             cell_origin,
             position_in_cell,
-            volume,
+            water_mass,
             multiplicity,
             idx,
             length,
@@ -160,7 +160,7 @@ class DisplacementMethods(BackendMethods):
             precipitation_counting_level_index,
             displacement,
         ):
-            rainfall = 0.0
+            rainfall_mass = 0.0
             flag = len(idx)
             for i in range(length):
                 position_within_column = (
@@ -173,10 +173,10 @@ class DisplacementMethods(BackendMethods):
                     # and crossed precip-counting level
                     position_within_column < precipitation_counting_level_index
                 ):
-                    rainfall += volume[idx[i]] * multiplicity[idx[i]]  # TODO #599
+                    rainfall_mass += abs(water_mass[idx[i]]) * multiplicity[idx[i]]
                     idx[i] = flag
                     healthy[0] = 0
-            return rainfall
+            return rainfall_mass
 
         return body
 
@@ -204,9 +204,10 @@ class DisplacementMethods(BackendMethods):
     # pylint: disable=too-many-arguments
     def flag_precipitated(
         self,
+        *,
         cell_origin,
         position_in_cell,
-        volume,
+        water_mass,
         multiplicity,
         idx,
         length,
@@ -214,10 +215,12 @@ class DisplacementMethods(BackendMethods):
         precipitation_counting_level_index,
         displacement,
     ) -> float:
+        """return a scalar value corresponding to the mass of water (all phases) that crossed
+        the bottom boundary of the entire domain"""
         return self._flag_precipitated_body(
             cell_origin.data,
             position_in_cell.data,
-            volume.data,
+            water_mass.data,
             multiplicity.data,
             idx.data,
             length,

{PySDM-2.80 → pysdm-2.82}/PySDM/backends/impl_thrust_rtc/methods/displacement_methods.py

@@ -73,16 +73,19 @@ class DisplacementMethods(ThrustRTCBackendMethods):
                 "healthy",
                 "cell_origin",
                 "position_in_cell",
-                "volume",
+                "water_mass",
                 "multiplicity",
-                "rainfall",
+                "rainfall_mass",
             ),
             "i",
             """
             auto origin = cell_origin[n_sd * (n_dims-1) + idx[i]];
             auto pic = position_in_cell[n_sd * (n_dims-1) + idx[i]];
             if (origin + pic < 0) {
-                atomicAdd((real_type*) &rainfall[0], multiplicity[idx[i]] * volume[idx[i]]);
+                atomicAdd(
+                    (real_type*) &rainfall_mass[0],
+                    multiplicity[idx[i]] * abs(water_mass[idx[i]])
+                );
                 idx[i] = n_sd;
                 healthy[0] = 0;
             }
@@ -118,7 +121,7 @@ class DisplacementMethods(ThrustRTCBackendMethods):
         *,
         cell_origin,
         position_in_cell,
-        volume,
+        water_mass,
         multiplicity,
         idx,
         length,
@@ -130,8 +133,8 @@ class DisplacementMethods(ThrustRTCBackendMethods):
             raise NotImplementedError()
         n_sd = trtc.DVInt64(cell_origin.shape[1])
         n_dims = trtc.DVInt64(len(cell_origin.shape))
-        rainfall = trtc.device_vector(self._get_c_type(), 1)
-        trtc.Fill(rainfall, self._get_floating_point(0))
+        rainfall_mass = trtc.device_vector(self._get_c_type(), 1)
+        trtc.Fill(rainfall_mass, self._get_floating_point(0))
         self.__flag_precipitated_body.launch_n(
             length,
             (
@@ -141,12 +144,12 @@ class DisplacementMethods(ThrustRTCBackendMethods):
                 healthy.data,
                 cell_origin.data,
                 position_in_cell.data,
-                volume.data,
+                water_mass.data,
                 multiplicity.data,
-                rainfall,
+                rainfall_mass,
             ),
         )
-        return rainfall.to_host()[0]
+        return rainfall_mass.to_host()[0]
 
     @staticmethod
     def flag_out_of_column(  # pylint: disable=unused-argument

{PySDM-2.80 → pysdm-2.82}/PySDM/dynamics/displacement.py

@@ -32,7 +32,7 @@ class Displacement:  # pylint: disable=too-many-instance-attributes
         self.courant = None
         self.displacement = None
         self.temp = None
-        self.precipitation_in_last_step = 0
+        self.precipitation_mass_in_last_step = 0
         self.precipitation_counting_level_index = precipitation_counting_level_index
 
         self.adaptive = adaptive
@@ -102,14 +102,14 @@ class Displacement:  # pylint: disable=too-many-instance-attributes
         cell_origin = self.particulator.attributes["cell origin"]
         position_in_cell = self.particulator.attributes["position in cell"]
 
-        self.precipitation_in_last_step = 0.0
+        self.precipitation_mass_in_last_step = 0.0
         for _ in range(self._n_substeps):
             self.calculate_displacement(
                 self.displacement, self.courant, cell_origin, position_in_cell
             )
             self.update_position(position_in_cell, self.displacement)
             if self.enable_sedimentation:
-                self.precipitation_in_last_step += self.particulator.remove_precipitated(
+                self.precipitation_mass_in_last_step += self.particulator.remove_precipitated(
                     displacement=self.displacement,
                     precipitation_counting_level_index=self.precipitation_counting_level_index,
                 )

{PySDM-2.80 → pysdm-2.82}/PySDM/impl/mesh.py

@@ -3,11 +3,13 @@ spatial mesh representation (incl. memory strides)
 """
 
 import numpy as np
+from PySDM.physics import si
 
 
 class Mesh:
     # pylint: disable=too-many-arguments
     def __init__(self, grid, size, n_cell=None, dv=None, n_dims=None, strides=None):
+        """sizes of dimensions not specified in grid/size are assumed to be of 1 m"""
         self.grid = grid
         self.size = size
         self.strides = strides or Mesh.__strides(grid)
@@ -27,6 +29,14 @@ class Mesh:
     def dim(self):
         return self.n_dims
 
+    @property
+    def domain_bottom_surface_area(self):
+        assert self.n_dims > 0
+        return {
+            1: 1 * si.m**2,
+            2: 1 * si.m * self.size[0],
+        }[self.n_dims]
+
     @staticmethod
     def mesh_0d(dv=None):
         return Mesh(

{PySDM-2.80 → pysdm-2.82}/PySDM/particulator.py

@@ -396,10 +396,10 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
     def remove_precipitated(
         self, *, displacement, precipitation_counting_level_index
     ) -> float:
-        res = self.backend.flag_precipitated(
+        rainfall_mass = self.backend.flag_precipitated(
             cell_origin=self.attributes["cell origin"],
             position_in_cell=self.attributes["position in cell"],
-            volume=self.attributes["volume"],
+            water_mass=self.attributes["water mass"],
             multiplicity=self.attributes["multiplicity"],
             idx=self.attributes._ParticleAttributes__idx,
             length=self.attributes.super_droplet_count,
@@ -408,7 +408,7 @@ class Particulator:  # pylint: disable=too-many-public-methods,too-many-instance
             displacement=displacement,
         )
         self.attributes.sanitize()
-        return res
+        return rainfall_mass
 
     def flag_out_of_column(self):
         self.backend.flag_out_of_column(

{PySDM-2.80 → pysdm-2.82}/PySDM/products/displacement/surface_precipitation.py

@@ -1,5 +1,6 @@
 """
-water volume flux derived from sizes of particles crossing bottom domain boundary
+water (equivalent) volume flux derived from sizes of particles crossing bottom domain boundary
+(computed from mass of both liquid and ice water)
 """
 
 from PySDM.products.impl import Product, register_product
@@ -10,12 +11,11 @@ class SurfacePrecipitation(Product):
     def __init__(self, name=None, unit="m/s"):
         super().__init__(unit=unit, name=name)
         self.displacement = None
-        self.dv = None
-        self.dz = None
+        self.domain_bottom_surface_area = None
         self._reset_counters()
 
     def _reset_counters(self):
-        self.accumulated_rainfall = 0.0
+        self.accumulated_rainfall_mass = 0.0
         self.elapsed_time = 0.0
 
     def register(self, builder):
@@ -23,23 +23,25 @@ class SurfacePrecipitation(Product):
         self.particulator.observers.append(self)
         self.shape = ()
         self.displacement = self.particulator.dynamics["Displacement"]
-        self.dv = self.particulator.mesh.dv
-        self.dz = self.particulator.mesh.dz
+        self.domain_bottom_surface_area = (
+            self.particulator.mesh.domain_bottom_surface_area
+        )
 
     def _impl(self, **kwargs) -> float:
         if self.elapsed_time == 0.0:
             return 0.0
 
-        # TODO #708
         result = (
-            self.formulae.constants.rho_w
-            * self.accumulated_rainfall
+            self.accumulated_rainfall_mass
+            / self.formulae.constants.rho_w
             / self.elapsed_time
-            / (self.dv / self.dz)
+            / self.domain_bottom_surface_area
         )
         self._reset_counters()
         return result
 
     def notify(self):
-        self.accumulated_rainfall += self.displacement.precipitation_in_last_step
+        self.accumulated_rainfall_mass += (
+            self.displacement.precipitation_mass_in_last_step
+        )
         self.elapsed_time += self.displacement.particulator.dt