numba-mpi 1.0.0__tar.gz → 1.0.1__tar.gz

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/.github/workflows/tests+pypi.yml

@@ -64,15 +64,15 @@ jobs:
       - uses: mpi4py/setup-mpi@v1
       - name: Build
         run: |
-          pip install pdoc3
+          pip install pdoc
           pip install -e .
-          python -We -m pdoc --html numba_mpi
+          PDOC_ALLOW_EXEC=1 python -We -m pdoc -o html numba_mpi
       - name: Deploy
         if: github.ref == 'refs/heads/main'
         uses: JamesIves/github-pages-deploy-action@4.1.1
         with:
           BRANCH: pdoc
-          FOLDER: html/numba_mpi
+          FOLDER: html
           CLEAN: true
 
   zenodo_json:

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/.zenodo.json

@@ -1,6 +1,6 @@
 {
   "title": "numba-mpi",
-  "description": "Numba @njittable wrappers for MPI C API tested on Linux, macOS and Windows",
+  "description": "Numba @jittable wrappers for MPI C API tested on Linux, macOS and Windows",
   "creators": [
     {
       "affiliation": "Jagiellonian University, Kraków, Poland",

numba_mpi-1.0.1/CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+title: "numba-mpi"
+url: "https://github.com/numba-mpi/numba-mpi"
+preferred-citation:
+  type: article
+  authors:
+  - family-names: "Derlatka"
+    given-names: "Kacper"
+  - family-names: "Manna"
+    given-names: "Maciej"
+  - family-names: "Bulenok"
+    given-names: "Oleksii"
+  - family-names: "Zwicker"
+    given-names: "David"
+  - family-names: "Arabas"
+    given-names: "Sylwester"
+  doi: "10.48550/arXiv.2407.13712"
+  journal: "arXiv"
+  title: " Enabling MPI communication within Numba/LLVM JIT-compiled Python code using numba-mpi v1.0 "
+  year: 2024

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: numba-mpi
-Version: 1.0.0
-Summary: Numba @njittable MPI wrappers tested on Linux, macOS and Windows
+Version: 1.0.1
+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
 License: GPL v3
@@ -19,7 +19,7 @@ Provides-Extra: tests
 Requires-Dist: pytest<8.0.0; extra == "tests"
 Requires-Dist: py-pde; extra == "tests"
 
-# <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.svg" style="height:50pt" alt="numba-mpi logo"> numba-mpi
+# <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
 
 [![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)
@@ -35,7 +35,7 @@ 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) (@njit mode).
+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).
 
 Support is provided for a subset of MPI routines covering: `size`/`rank`, `send`/`recv`, `allreduce`, `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`.
@@ -66,7 +66,7 @@ Features that are not implemented yet include (help welcome!):
 ```python
 import numba, numba_mpi, numpy
 
-@numba.njit()
+@numba.jit()
 def hello():
     src = numpy.array([1., 2., 3., 4., 5.])
     dst_tst = numpy.empty_like(src)

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/README.md

@@ -1,4 +1,4 @@
-# <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.svg" style="height:50pt" alt="numba-mpi logo"> numba-mpi
+# <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.svg" width=128 height=142 alt="numba-mpi logo"> numba-mpi
 
 [![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)
@@ -14,7 +14,7 @@
 [![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) (@njit mode).
+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).
 
 Support is provided for a subset of MPI routines covering: `size`/`rank`, `send`/`recv`, `allreduce`, `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`.
@@ -45,7 +45,7 @@ Features that are not implemented yet include (help welcome!):
 ```python
 import numba, numba_mpi, numpy
 
-@numba.njit()
+@numba.jit()
 def hello():
     src = numpy.array([1., 2., 3., 4., 5.])
     dst_tst = numpy.empty_like(src)

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/numba_mpi.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: numba-mpi
-Version: 1.0.0
-Summary: Numba @njittable MPI wrappers tested on Linux, macOS and Windows
+Version: 1.0.1
+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
 License: GPL v3
@@ -19,7 +19,7 @@ Provides-Extra: tests
 Requires-Dist: pytest<8.0.0; extra == "tests"
 Requires-Dist: py-pde; extra == "tests"
 
-# <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.svg" style="height:50pt" alt="numba-mpi logo"> numba-mpi
+# <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
 
 [![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)
@@ -35,7 +35,7 @@ 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) (@njit mode).
+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).
 
 Support is provided for a subset of MPI routines covering: `size`/`rank`, `send`/`recv`, `allreduce`, `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`.
@@ -66,7 +66,7 @@ Features that are not implemented yet include (help welcome!):
 ```python
 import numba, numba_mpi, numpy
 
-@numba.njit()
+@numba.jit()
 def hello():
     src = numpy.array([1., 2., 3., 4., 5.])
     dst_tst = numpy.empty_like(src)

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/numba_mpi.egg-info/SOURCES.txt

@@ -1,10 +1,12 @@
 .gitignore
 .pre-commit-config.yaml
 .zenodo.json
+CITATION.cff
 CODE_OF_CONDUCT.md
 LICENSE
 README.md
 setup.py
+.github/numba_mpi_logo.png
 .github/numba_mpi_logo.svg
 .github/workflows/readme_snippets.yml
 .github/workflows/stale.yml

{numba_mpi-1.0.0 → numba_mpi-1.0.1}/setup.py

@@ -7,6 +7,9 @@ def get_long_description():
     """returns contents of README.md file"""
     with open("README.md", "r", encoding="utf8") as file:
         long_description = file.read()
+    long_description = long_description.replace(
+        "numba_mpi_logo.svg", "numba_mpi_logo.png"
+    )
     return long_description
 
 
@@ -21,7 +24,7 @@ setup(
     python_requires=">=3.8",
     setup_requires=["setuptools_scm"],
     license="GPL v3",
-    description="Numba @njittable MPI wrappers tested on Linux, macOS and Windows",
+    description="Numba @jittable MPI wrappers tested on Linux, macOS and Windows",
     install_requires=("numba", "numpy", "mpi4py", "psutil"),
     extras_require={"tests": ("pytest<8.0.0", "py-pde")},  # TODO #122
     long_description=get_long_description(),