numba-mpi 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

numba_mpi/api/requests.py

@@ -1,5 +1,5 @@
-""" Utilities for handling MPI_Requests with respective Wait and Test function
-    wrappers.
+"""Utilities for handling MPI_Requests with respective Wait and Test function
+wrappers.
 """
 
 import ctypes

{numba_mpi-1.1.1.dist-info → numba_mpi-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: numba-mpi
-Version: 1.1.1
+Version: 1.1.3
 Summary: Numba @jittable MPI wrappers tested on Linux, macOS and Windows
 Home-page: https://github.com/numba-mpi/numba-mpi
 Author: https://github.com/numba-mpi/numba-mpi/graphs/contributors
@@ -16,8 +16,18 @@ Requires-Dist: numpy
 Requires-Dist: mpi4py
 Requires-Dist: psutil
 Provides-Extra: tests
-Requires-Dist: pytest <8.0.0 ; extra == 'tests'
-Requires-Dist: py-pde ; extra == 'tests'
+Requires-Dist: pytest<8.0.0; extra == "tests"
+Requires-Dist: py-pde; extra == "tests"
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.png" width=128 height=142 alt="numba-mpi logo"> numba-mpi
 
@@ -35,31 +45,32 @@ Requires-Dist: py-pde ; extra == 'tests'
 [![DOI](https://zenodo.org/badge/316911228.svg)](https://zenodo.org/badge/latestdoi/316911228)
 
 ### Overview
-numba-mpi provides Python wrappers to the C MPI API callable from within [Numba JIT-compiled code](https://numba.readthedocs.io/en/stable/user/jit.html) (@jit mode). For an outline of the project, rationale, architecture, and features, refer to: [numba-mpi arXiv e-print](https://doi.org/10.48550/arXiv.2407.13712) (please cite if numba-mpi is used in your research).
+numba-mpi provides Python wrappers to the C MPI API callable from within [Numba JIT-compiled code](https://numba.readthedocs.io/en/stable/user/jit.html) (@jit mode). For an outline of the project, rationale, architecture, and features, refer to: [numba-mpi paper in SoftwareX (open access)](https://www.sciencedirect.com/science/article/pii/S235271102400267X) (please cite if numba-mpi is used in your research).
 
 Support is provided for a subset of MPI routines covering: `size`/`rank`, `send`/`recv`, `allreduce`, `reduce`, `bcast`, `scatter`/`gather` & `allgather`, `barrier`, `wtime`
 and basic asynchronous communication with `isend`/`irecv` (only for contiguous arrays); for request handling including `wait`/`waitall`/`waitany` and `test`/`testall`/`testany`.
 
-The API uses NumPy and supports both numeric and character datatypes (e.g., `broadcast`). 
+The API uses NumPy and supports both numeric and character datatypes (e.g., `broadcast`).
 Auto-generated docstring-based API docs are published on the web: https://numba-mpi.github.io/numba-mpi
 
-Packages can be obtained from 
-  [PyPI](https://pypi.org/project/numba-mpi), 
-  [Conda Forge](https://anaconda.org/conda-forge/numba-mpi), 
+Packages can be obtained from
+  [PyPI](https://pypi.org/project/numba-mpi),
+  [Conda Forge](https://anaconda.org/conda-forge/numba-mpi),
   [Arch Linux](https://aur.archlinux.org/packages/python-numba-mpi)
   or by invoking `pip install git+https://github.com/numba-mpi/numba-mpi.git`.
 
 numba-mpi is a pure-Python package.
 The codebase includes a test suite used through the GitHub Actions workflows ([thanks to mpi4py's setup-mpi](https://github.com/mpi4py/setup-mpi)!)
-for automated testing on: Linux ([MPICH](https://www.mpich.org/), [OpenMPI](https://www.open-mpi.org/doc/) 
-& [Intel MPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html)), 
-macOS ([MPICH](https://www.mpich.org/) & [OpenMPI](https://www.open-mpi.org/doc/)) and 
-Windows ([MS MPI](https://docs.microsoft.com/en-us/message-passing-interface/microsoft-mpi)).
+for automated testing on: Linux ([MPICH](https://www.mpich.org/), [OpenMPI](https://www.open-mpi.org/doc/)
+& [Intel MPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html)),
+macOS ([MPICH](https://www.mpich.org/) & [OpenMPI](https://www.open-mpi.org/doc/)) and
+Windows ([MS MPI](https://docs.microsoft.com/en-us/message-passing-interface/microsoft-mpi)). Note, that some of those
+combinations may not be fully supported yet - see [Known Issues](#known-issues) for more information.
 
 Features that are not implemented yet include (help welcome!):
 - support for non-default communicators
 - support for `MPI_IN_PLACE` in `[all]gather`/`scatter` and `allreduce`
-- support for `MPI_Type_create_struct` (Numpy structured arrays) 
+- support for `MPI_Type_create_struct` (Numpy structured arrays)
 - ...
 
 ### Hello world send/recv example:
@@ -82,21 +93,21 @@ hello()
 ### Example comparing numba-mpi vs. mpi4py performance:
 
 The example below compares `Numba`+`mpi4py` vs. `Numba`+`numba-mpi` performance.
-The sample code estimates $\pi$ by numerical integration of $\int_0^1 (4/(1+x^2))dx=\pi$ 
-dividing the workload into `n_intervals` handled by separate MPI processes 
+The sample code estimates $\pi$ by numerical integration of $\int_0^1 (4/(1+x^2))dx=\pi$
+dividing the workload into `n_intervals` handled by separate MPI processes
 and then obtaining a sum using `allreduce` (see, e.g., analogous [Matlab docs example](https://www.mathworks.com/help/parallel-computing/numerical-estimation-of-pi-using-message-passing.html)).
 The computation is carried out in a JIT-compiled function `get_pi_part()` and is repeated
-`N_TIMES`. The repetitions and the MPI-handled reduction are done outside or 
+`N_TIMES`. The repetitions and the MPI-handled reduction are done outside or
 inside of the JIT-compiled block for `mpi4py` and `numba-mpi`, respectively.
 Timing is repeated `N_REPEAT` times and the minimum time is reported.
 The generated plot shown below depicts the speedup obtained by replacing `mpi4py`
-with `numba_mpi`, plotted as a function of `N_TIMES / n_intervals` - the number of MPI calls per 
+with `numba_mpi`, plotted as a function of `N_TIMES / n_intervals` - the number of MPI calls per
 interval. The speedup, which stems from avoiding roundtrips between JIT-compiled
 and Python code is significant (150%-300%) in all cases. The more often communication
-is needed (smaller `n_intervals`), the larger the measured speedup. Note that nothing 
+is needed (smaller `n_intervals`), the larger the measured speedup. Note that nothing
 in the actual number crunching (within the `get_pi_part()` function) or in the employed communication logic
 (handled by the same MPI library) differs between the `mpi4py` or `numba-mpi` solutions.
-These are the overhead of `mpi4py` higher-level abstractions and the overhead of 
+These are the overhead of `mpi4py` higher-level abstractions and the overhead of
 repeatedly entering and leaving the JIT-compiled block if using `mpi4py`, which can be
 eliminated by using `numba-mpi`, and which the measured differences in execution time
 stem from.
@@ -156,6 +167,14 @@ if numba_mpi.rank() == 0:
 
 ![plot](https://github.com/numba-mpi/numba-mpi/releases/download/tip/readme_plot.png)
 
+### Known Issues
+
+**NOTE**: Issues listed below only relate to combinations of platforms and MPI distributions that we target to support, but due to various reason are currently not working and are temporarily excluded from automated testing:
+
+- tests on Ubuntu 2024.4 that use MPICH are not run due to failures caused by newer version of MPICH (`4.2.0`); note, that previous tests ran
+using version `4.0.2` of MPICH (that is installed by default on Ubuntu 2022.4 using `apt`) were passing (see [related issue](https://github.com/numba-mpi/numba-mpi/issues/162) - TODO #162),
+- tests on Intel MacOS (v13) that use OpenMPI are currently not run due to failures being under investigation (see [related issue](https://github.com/numba-mpi/numba-mpi/issues/163)  - TODO #163),
+- `numba-mpi` currently does not support ARM-based MacOS, due to required code improvement (see [related issue](https://github.com/numba-mpi/numba-mpi/issues/164) - TODO #164).
 
 ### MPI resources on the web:
 
@@ -177,11 +196,10 @@ if numba_mpi.rank() == 0:
 
 ### Acknowledgements:
 
-We thank [all contributors](https://github.com/numba-mpi/numba-mpi/graphs/contributors) and users who reported feedback to the project 
+We thank [all contributors](https://github.com/numba-mpi/numba-mpi/graphs/contributors) and users who reported feedback to the project
   through [GitHub issues](https://github.com/numba-mpi/numba-mpi/issues).
 
 Development of numba-mpi has been supported by the [Polish National Science Centre](https://ncn.gov.pl/en) (grant no. 2020/39/D/ST10/01220),
-  the [Max Planck Society](https://www.mpg.de/en) and the [European Union](https://erc.europa.eu/) (ERC, EmulSim, 101044662). 
-We further acknowledge Poland’s high-performance computing infrastructure [PLGrid](https://plgrid.pl) (HPC Centers: [ACK Cyfronet AGH](https://www.cyfronet.pl/en)) 
+  the [Max Planck Society](https://www.mpg.de/en) and the [European Union](https://erc.europa.eu/) (ERC, EmulSim, 101044662).
+We further acknowledge Poland’s high-performance computing infrastructure [PLGrid](https://plgrid.pl) (HPC Centers: [ACK Cyfronet AGH](https://www.cyfronet.pl/en))
   for providing computer facilities and support within computational grant no. PLG/2023/016369.
-

{numba_mpi-1.1.1.dist-info → numba_mpi-1.1.3.dist-info}/RECORD

@@ -12,13 +12,13 @@ numba_mpi/api/operator.py,sha256=3VTPZAdOP05bxdqt3lA0hRDICM-iaBMa4m-krEdO91s,342
 numba_mpi/api/rank.py,sha256=1xZvHUclsK20aMtK07JzXYxW5F4Er8HZgOmcf495sjo,597
 numba_mpi/api/recv.py,sha256=YsYK-q7PNfi3zt0ftVddM363VsnJ4XFfmgMq8aeCr-o,1260
 numba_mpi/api/reduce.py,sha256=ug8WctzXRuxD3IrvrXN4sAfWdjJ1vvMhwykTgF8nn1s,3233
-numba_mpi/api/requests.py,sha256=5EhgFyeQCGP8YclSPwxP95c2AhBo19CLlShK0TxCR2U,9114
+numba_mpi/api/requests.py,sha256=-9KstEnuP4i7udDMXojKt-xaoEgl5Xk4D_7vo93AGQY,9109
 numba_mpi/api/scatter_gather.py,sha256=goZn4BxMKakWQHjfXIOdjzK3DJ-lTeaiQQwgnyQeZ_s,2410
 numba_mpi/api/send.py,sha256=jn1hPw0YHBHOaeJop_ZbjaBChaqgfw3nM1xGhW9sabI,909
 numba_mpi/api/size.py,sha256=-RX-FtcIH4qDxCoGOhZjjgEWXpytt79vsH0YX9dtZuY,597
 numba_mpi/api/wtime.py,sha256=qrTqlefW7K7hqnAQKkGYm8kgdiRGuSAGiHmPcTrhLzE,279
-numba_mpi-1.1.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-numba_mpi-1.1.1.dist-info/METADATA,sha256=a9ZEpxFg6RO9FMIz7vUdn52cQYcK6hiuLMVf-2sYIA0,9897
-numba_mpi-1.1.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-numba_mpi-1.1.1.dist-info/top_level.txt,sha256=yb_ktLmrfuhOZS0rjS81FFNC-gK_4c19WbLG2ViP73g,10
-numba_mpi-1.1.1.dist-info/RECORD,,
+numba_mpi-1.1.3.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+numba_mpi-1.1.3.dist-info/METADATA,sha256=cBFNRsbMKWsQVU0TA3q9VNGBQlxzCmTzHjP4W5Mo_TU,11215
+numba_mpi-1.1.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+numba_mpi-1.1.3.dist-info/top_level.txt,sha256=yb_ktLmrfuhOZS0rjS81FFNC-gK_4c19WbLG2ViP73g,10
+numba_mpi-1.1.3.dist-info/RECORD,,

{numba_mpi-1.1.1.dist-info → numba_mpi-1.1.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.5.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any