PyPartMC 1.3.13__cp38-cp38-macosx_13_0_x86_64.whl → 2.0.0rc3__cp38-cp38-macosx_13_0_x86_64.whl

PyPartMC/__init__.py

@@ -1,13 +1,18 @@
 """
-.. include::../README.md
+.. include::../../README.md
 """
 
+#  pylint: disable=invalid-name
+import importlib.metadata
+
 # pylint: disable=invalid-name,wrong-import-position
 import os
 from collections import namedtuple
 from contextlib import contextmanager
 from pathlib import Path
 
+import nanobind
+
 
 # https://github.com/diegoferigo/cmake-build-extension/blob/master/src/cmake_build_extension/__init__.py
 @contextmanager
@@ -69,10 +74,13 @@ si = __generate_si()
     SI-prefix-aware unit multipliers, resulting in e.g.: `p = 1000 * si.hPa`
     notation. Note: no dimensional analysis is done! """
 
-with __build_extension_env():
-    import _PyPartMC
-    from _PyPartMC import *
-    from _PyPartMC import __all__ as _PyPartMC_all  # pylint: disable=no-name-in-module
-    from _PyPartMC import __version__, __versions_of_build_time_dependencies__
+from ._PyPartMC import *  # pylint: disable=import-error
+from ._PyPartMC import (  # pylint: disable=import-error
+    __versions_of_build_time_dependencies__,
+)
+
+__version__ = importlib.metadata.version(__package__)
 
-    __all__ = tuple([*_PyPartMC_all, "si"])
+# walkaround for MATLAB bindings
+# pylint: disable=undefined-variable
+setattr(nanobind, "nb_type_0", type(_PyPartMC.AeroData))

{PyPartMC-1.3.13.dist-info → pypartmc-2.0.0rc3.dist-info}/METADATA

@@ -1,23 +1,28 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: PyPartMC
-Version: 1.3.13
+Version: 2.0.0rc3
 Summary: Python interface to PartMC
-Author: PyPartMC team (see https://github.com/open-atmos/PyPartMC/graphs/contributors)
-Author-email: nriemer@illinois.edu
-License: GPL-3.0
-Project-URL: Tracker, https://github.com/open-atmos/PyPartMC/issues
+Author-Email: "https://github.com/open-atmos/PyPartMC/graphs/contributors" <nriemer@illinois.edu>
+License-Expression: GPL-3.0
 Project-URL: Documentation, https://open-atmos.github.io/PyPartMC
 Project-URL: Source, https://github.com/open-atmos/PyPartMC/
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
+Project-URL: Tracker, https://github.com/open-atmos/PyPartMC/issues
+Requires-Python: >=3.8
 Requires-Dist: numpy
+Requires-Dist: nanobind
 Provides-Extra: tests
 Requires-Dist: pytest; extra == "tests"
 Requires-Dist: pytest-order; extra == "tests"
-Requires-Dist: fastcore!=1.5.8; extra == "tests"
-Requires-Dist: ghapi; extra == "tests"
-Requires-Dist: scipy; extra == "tests"
+Provides-Extra: examples
+Requires-Dist: matplotlib!=3.10.0; extra == "examples"
+Requires-Dist: ipywidgets; extra == "examples"
+Requires-Dist: voila; extra == "examples"
+Requires-Dist: open-atmos-jupyter-utils; extra == "examples"
+Requires-Dist: PySDM; extra == "examples"
+Requires-Dist: PyMieScatt; extra == "examples"
+Requires-Dist: SciPy; extra == "examples"
+Requires-Dist: dustpy; platform_system != "Windows" and extra == "examples"
+Description-Content-Type: text/markdown
 
 ![logo](https://raw.githubusercontent.com/wiki/open-atmos/PyPartMC/logo.svg)
 
@@ -32,6 +37,7 @@ Additionally, the ability to easily package examples, simple simulations, and re
   allows PyPartMC to support the efforts of many members of the scientific community, including researchers,
   instructors, and students, with nominal software and hardware requirements.
 
+Documentation of PyPartMC is hosted at https://open-atmos.github.io/PyPartMC.
 PyPartMC is implemented in C++ and it also constitutes a C++ API to the PartMC Fortran internals.
 The Python API can facilitate using PartMC from other environments - see, e.g., Julia and Matlab examples below.
 
@@ -43,14 +49,13 @@ If interested in contributing to PyPartMC, please have a look a the [notes for d
    
 [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.html)
 [![Copyright](https://img.shields.io/static/v1?label=Copyright&color=249fe2&message=UIUC&)](https://atmos.illinois.edu/)
-[![Github Actions Build Status](https://github.com/open-atmos/PyPartMC/workflows/tests+pypi/badge.svg?branch=main)](https://github.com/open-atmos/PyPartMC/actions)
+[![tests+pypi](https://github.com/open-atmos/PyPartMC/actions/workflows/buildwheels.yml/badge.svg)](https://github.com/open-atmos/PyPartMC/actions/workflows/buildwheels.yml)
 [![API docs](https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg)](https://open-atmos.github.io/PyPartMC/)
 [![codecov](https://codecov.io/gh/open-atmos/PyPartMC/graph/badge.svg?token=27IK9ZIQXE)](https://codecov.io/gh/open-atmos/PyPartMC)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7662635.svg)](https://doi.org/10.5281/zenodo.7662635)
 [![PyPI version](https://badge.fury.io/py/PyPartMC.svg)](https://pypi.org/p/PyPartMC)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
-
-## TL;DR (try in a Jupyter notebook)
+[![pyOpenSci Peer-Reviewed](https://pyopensci.org/badges/peer-reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/179)
 
 [![Python 3](https://img.shields.io/static/v1?label=Python&logo=Python&color=3776AB&message=3)](https://www.python.org/)
 [![Linux OK](https://img.shields.io/static/v1?label=Linux&logo=Linux&color=yellow&message=%E2%9C%93)](https://en.wikipedia.org/wiki/Linux)
@@ -58,9 +63,11 @@ If interested in contributing to PyPartMC, please have a look a the [notes for d
 [![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/)
 
-```python
-! pip install PyPartMC
-import PyPartMC
+## Installation 
+
+### Using the command-line `pip` tool (also applies to conda environments)
+```bash
+pip install PyPartMC
 ```
 
 Note that, depending on the environment (OS, hardware, Python version), the pip-install invocation 
@@ -69,9 +76,21 @@ In the latter case, a Fortran compiler and some development tools includiong CMa
   are required (while all non-Python dependencies are included in the PyPartMC source archive).
 In both cases, all Python dependencies will be resolved by pip.
 
+### In a Jupyter notebook cell (also on Colab or jupyter-hub instances)
+
+```python
+! pip install PyPartMC
+import PyPartMC
+```
+
 #### Jupyter notebooks with examples 
 Note: clicking the badges below redirects to cloud-computing platforms. The mybinder.org links allow anonymous execution, Google Colab requires logging in with a Google account, ARM JupyerHub requires logging in with an ARM account (and directing Jupyter to a particular notebook within the `examples` folder).
 
+The example notebooks feature additional dependencies that can be installed with:
+```bash
+pip install PyPartMC[examples]
+```
+
 - Urban plume scenario demo (as in [PartMC](https://github.com/compdyn/partmc/tree/master/scenarios/1_urban_plume)):    
 [![View notebook](https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub)](https://github.com/open-atmos/PyPartMC/blob/main/examples/particle_simulation.ipynb) 
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/particle_simulation.ipynb) 
@@ -98,6 +117,11 @@ Note: clicking the badges below redirects to cloud-computing platforms. The mybi
 [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/cloud_parcel.ipynb)
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/cloud_parcel.ipynb)
 [![ARM JupyterHub](https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub)](https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath=)
+- Coagulation model intercomparison for additive (Golovin) kernel with: PyPartMC, [PySDM](https://open-atmos.github.io/PySDM), [Droplets.jl](https://github.com/emmacware/droplets.jl) and [dustpy](https://stammler.github.io/dustpy/):    
+[![View notebook](https://img.shields.io/static/v1?label=render%20on&logo=github&color=87ce3e&message=GitHub)](https://github.com/open-atmos//PyPartMC/blob/main/examples/additive_coag_comparison.ipynb) 
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/open-atmos/PyPartMC/blob/main/examples/additive_coag_comparison.ipynb) 
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/open-atmos/PyPartMC.git/main?urlpath=lab/tree/examples/additive_coag_comparison.ipynb)
+[![ARM JupyterHub](https://img.shields.io/static/v1?label=launch%20in&logo=jupyter&color=lightblue&message=ARM+JupyterHub)](https://jupyterhub.arm.gov/hub/user-redirect/git-pull?repo=https%3A//github.com/open-atmos/PyPartMC&branch=main&urlPath=)   
 
 ## Features
 
@@ -145,9 +169,7 @@ aero_dist = ppmc.AeroDist(
             "num_conc": 3200 / si.cm**3,
             "geom_mean_diam": 8.64 * si.nm,
             "log10_geom_std_dev": 0.28,
-        }
-    },
-    {
+        },
         "diesel": {
             "mass_frac": [{"OC": [0.3]}, {"BC": [0.7]}],
             "diam_type": "geometric",
@@ -189,9 +211,7 @@ aero_dist = ppmc.AeroDist(aero_data, (
       "num_conc" => 3200 / si.cm^3,
       "geom_mean_diam" => 8.64 * si.nm,
       "log10_geom_std_dev" => .28,
-    )
-  ),
-  Dict( 
+    ),
     "diesel" => Dict(
       "mass_frac" => (Dict("OC" => (.3,)), Dict("BC" => (.7,))),
       "diam_type" => "geometric",
@@ -200,7 +220,7 @@ aero_dist = ppmc.AeroDist(aero_data, (
       "geom_mean_diam" => 50 * si.nm,
       "log10_geom_std_dev" => .24,
     )
-  )
+  ),
 ))
 
 n_part = 100
@@ -214,7 +234,6 @@ print(aero_state.masses()'aero_state.num_concs, "# kg/m3")
 notes (see the [PyPartMC Matlab CI workflow](https://github.com/open-atmos/PyPartMC/blob/main/.github/workflows/readme_listings.yml) for an example on how to achieve it on Ubuntu 20):
 - Matlab ships with convenience copies of C, C++ and Fortran runtime libraries which are `dlopened()` by default; one way to make PyPartMC OK with it is to [pip-]install by compiling from source using the very same version of GCC that Matlab borrowed these libraries from (e.g., [GCC 9 for Matlab R2022a, etc](https://www.mathworks.com/support/requirements/supported-compilers-linux.html));
 - Matlab needs to [use the same Python interpretter/venv](https://www.mathworks.com/support/requirements/python-compatibility.html) as the pip invocation used to install PyPartMC;
-- a single-line `pybind11_builtins.py` file with just `pybind11_type=type` inside needs to be placed within Matlab's `PYTHONPATH` to sort out a [Matlab-pybind11 incompatibility](https://github.com/pybind/pybind11/issues/3945). 
 
 ````Matlab
 ppmc = py.importlib.import_module('PyPartMC');
@@ -234,9 +253,7 @@ aero_dist = ppmc.AeroDist(aero_data, py.tuple({ ...
       "num_conc", 3200 / si.cm^3, ...
       "geom_mean_diam", 8.64 * si.nm, ...
       "log10_geom_std_dev", .28 ...
-    )) ...
-  )), ...
-  py.dict(pyargs( ... 
+    )), ...
     "diesel", py.dict(pyargs( ...
       "mass_frac", py.tuple({ ...
         py.dict(pyargs("OC", py.tuple({.3}))), ...
@@ -263,6 +280,17 @@ fprintf('%g # kg/m3\n', dot([masses{:}], [num_concs{:}]))
 
 PyPartMC is used within the [test workflow of the PySDM project](https://github.com/atmos-cloud-sim-uj/PySDM/tree/main/tests/smoke_tests/box/partmc).
 
+## Other packages with relevant feature scope
+
+- [aerosolGDEFoam](https://openaerosol.sourceforge.io/): OpenFOAM CFD-coupled aerosol dynamics including nucleation, coagulation, and surface growth 
+- [AIOMFAC and AIOMFAC-web](http://www.aiomfac.caltech.edu/): Fortran-implemented aerosol thermodynamic model for calculation of activity coefficients in organic-inorganic mixtures – from simple binary solutions to complex multicomponent systems
+- [DustPy](https://stammler.github.io/dustpy/): Python package for modelling dust evolution in protoplanetary disks (differences: focus on astrophysical applications vs. atmospheric aerosol)
+- [multilayerpy](https://github.com/tintin554/multilayerpy): kinetic multi-layer model for aerosol particles and films 
+- [PyBox](https://pybox.readthedocs.io): aerosol simulation model featuring gas and particle chamistry (differences: PyBox focuses on chemical mechanisms; PyPartMC is an interface to PartMC which focuses on physics - e.g., collisions of aerosol particles - while chemical processes are handled with external software, e.g., CAMP or MOSAIC)
+- [PyCHAM](https://github.com/simonom/PyCHAM): CHemistry with Aerosol Microphysics in Python Box Model for modelling of indoor environments, including aerosol chambers
+- [PySDM](https://open-atmos.github.io/PySDM): particle-based Monte-Carlo aerosol-cloud simulation package (differences: PySDM focuses on growth and breakup processes relevant to cloud droplets; PyPartMC focuses on processes relevant to air pollutants and their chemical and physical transformations)
+- [SSH-aerosol](https://github.com/sshaerosol/ssh-aerosol): C++/Fortran package for simulating evolution of primary and secondary atmospheric aerosols
+
 ## FAQ
 - Q: How to install PyPartMC with MOSAIC enabled?    
   A: Installation can be done using `pip`, however, `pip` needs to be instructed not to use binary packages available at pypi.org but rather to compile from source (pip will download the source from pip.org), and the path to compiled MOSAIC library needs to be provided at compile-time; the following command should convey it:
@@ -304,6 +332,47 @@ Could not find NC_M4 using the following names: m4, m4.exe
 ```
 Try installing `m4` (e.g., using [MSYS2](https://packages.msys2.org/package/m4?repo=msys&variant=x86_64) on Windows).
 
+## Acknowledgement and citations
+
+We would greatly appreciate citation of the PartMC model description paper (Riemer et al., 2009) 
+and the PyPartMC description paper (D’Aquino et al., 2024) if PyPartMC was used in your study.
+The citations are:
+- Riemer, N., M. West, R. A. Zaveri, R. C. Easter: Simulating the evolution of soot 
+  mixing-state with a particle-resolved aerosol model    
+  J. Geophys. Res., 114, D09202, 2009, DOI: [10.1029/2008JD011073](https://doi.org/10.1029/2008JD011073)
+- D’Aquino, Z., S. Arabas, J. H. Curtis, A. Vaishnav, N. Riemer, M. West: PyPartMC: A 
+  pythonic interfact to a particle-resolved, Monte Carlo aerosol simulation framework   
+  SoftwareX, 25, 101613, 2024, DOI: [10.1016/j.softx.2023.101613](https://doi.org/10.1016/j.softx.2023.101613)
+
+The following paragraph provides a more substantial description of PartMC (text released into the public domain and can be freely copied by anyone for any purpose):
+
+> PartMC is a stochastic, particle-resolved aerosol box model. It tracks the 
+composition of many computational particles (10<sup>4</sup> to 10<sup>6</sup>) within a well-mixed air 
+volume, each represented by a composition vector that evolves based on physical 
+and chemical processes. The physical processes—including Brownian coagulation, 
+new particle formation, emissions, dilution, and deposition—are simulated using a 
+stochastic Monte Carlo approach via a Poisson process while chemical processes are
+simulated deterministically for each computational particle. The weighted flow 
+algorithm (DeVille, Riemer, and West, 2011, 2019) enhances efficiency and reduces 
+ensemble variance. Detailed numerical methods are described in Riemer et al. 
+(2009), DeVille et al. (2011, 2019), and Curtis et al. (2016). PartMC is open-source 
+under the GNU GPL v2 and available at 
+[github.com/compdyn/partmc](https://github.com/compdyn/partmc).
+>
+> References:
+> - Curtis, J. H., M. D. Michelotti, N. Riemer, M. T. Heath, M. West: Accelerated 
+simulation of stochastic particle removal processes in particle-resolved aerosol 
+models, J. Computational Phys., 322, 21-32, 2016, DOI: [10.1016/j.jcp.2016.06.029](https://doi.org/10.1016/j.jcp.2016.06.029)
+> - DeVille, L., N. Riemer, M. West, Convergence of a generalized weighted flow 
+algorithm for stochastic particle coagulation, J. Computational Dynamics, 6, 69-94, 
+2019, DOI: [10.3934/jcd.2019003](https://doi.org/10.3934/jcd.2019003)
+> - DeVille, R. E. L., N. Riemer, M. West, The Weighted Flow Algorithm (WFA) for 
+stochastic particle coagulation, J. Computational Phys., 230, 8427-8451, 2011, 
+DOI: [10.1016/j.jcp.2011.07.027](https://doi.org/10.1016/j.jcp.2011.07.027)
+> - Riemer, N., M. West, R. A. Zaveri, R. C. Easter, Simulating the evolution of soot 
+mixing-state with a particle-resolved aerosol model, J. Geophys. Res., 114, D09202, 
+2009., DOI: [10.1029/2008JD011073](https://doi.org/10.1029/2008JD011073)
+
 ## Credits
 
 #### PyPartMC:

pypartmc-2.0.0rc3.dist-info/RECORD

@@ -0,0 +1,9 @@
+pypartmc-2.0.0rc3.dist-info/RECORD,,
+pypartmc-2.0.0rc3.dist-info/WHEEL,sha256=QYFdNGzXwuBjBNCy_HhT_OkFdKSB_RjbuJI9OL8ME3Q,113
+pypartmc-2.0.0rc3.dist-info/METADATA,sha256=4aUTawjPsb6pM4Ri_j8vmVSsCzx-O8mdi8jichPcoSs,26630
+pypartmc-2.0.0rc3.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+PyPartMC/__init__.py,sha256=e1ngb8Sodfqneb__Vmf_K5eIOoOY11gvrSHmlIZbruM,2349
+PyPartMC/_PyPartMC.cpython-38-darwin.so,sha256=tM4uERBnCARVwKhlu01YrEU-7jsWYcesQv1FmEtFh9k,8484928
+PyPartMC/.dylibs/libgfortran.5.dylib,sha256=uZj18mk7PGjzH0FQclHZLMRAcsG4TETIRZt_8CGlEpg,3988672
+PyPartMC/.dylibs/libquadmath.0.dylib,sha256=19PcPx5n69p9h9xP2dOhLmhRI2hzljSQcJBXLyFC2go,379200
+PyPartMC/.dylibs/libgcc_s.1.1.dylib,sha256=mW61tfzTB6d8xKZxf5SR2V03z7kbDW950dagh_mLK_U,266112

{PyPartMC-1.3.13.dist-info → pypartmc-2.0.0rc3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.3.0)
+Generator: scikit-build-core 0.11.5
 Root-Is-Purelib: false
 Tag: cp38-cp38-macosx_13_0_x86_64
 

PyPartMC-1.3.13.dist-info/RECORD

@@ -1,7 +0,0 @@
-_PyPartMC.cpython-38-darwin.so,sha256=3nyuUig-m2u4eb8sWRPdoE772t_8NKWUjfkofgr0jXg,8563080
-PyPartMC/__init__.py,sha256=VAqwePpJZEFJ7YieM1GbUvfluRhUyWXciP89pY9xIH4,2217
-PyPartMC-1.3.13.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-PyPartMC-1.3.13.dist-info/METADATA,sha256=55XZpDN4ldmVIvGE412KtsGHu__WRuk3Yq8UDjfIj0g,20422
-PyPartMC-1.3.13.dist-info/WHEEL,sha256=OzbVqQDGgCN-oj-FNGUZi3Dga71LFiZj1IqKmk_Y6R4,108
-PyPartMC-1.3.13.dist-info/top_level.txt,sha256=PJxy22pTnxcBhqrb6r4AIL32rkxA61gzw7ohlzybgSM,19
-PyPartMC-1.3.13.dist-info/RECORD,,

PyPartMC-1.3.13.dist-info/top_level.txt

@@ -1,2 +0,0 @@
-PyPartMC
-_PyPartMC