Metadata-Version: 2.1
Name: mpipartition
Version: 0.2.1
Summary: MPI volume decomposition and particle distribution tools
Home-page: https://github.com/ArgonneCPAC/MPIPartition
License: MIT
Keywords: MPI,mpi4py
Author: Michael Buehlmann
Author-email: buehlmann.michi@gmail.com
Requires-Python: >=3.6.2,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: mpi4py (>=3.1.0,<4.0.0)
Requires-Dist: numpy (>=1.10,<2.0)
Project-URL: Documentation, https://argonnecpac.github.io/MPIPartition
Project-URL: Repository, https://github.com/ArgonneCPAC/MPIPartition
Description-Content-Type: text/x-rst

MPIPartition
============


.. image:: https://img.shields.io/pypi/v/mpipartition.svg
        :target: https://pypi.python.org/pypi/mpipartition



A python module for MPI volume decomposition and particle distribution


* Free software: MIT license
* Documentation: https://argonnecpac.github.io/MPIPartition


Features
--------

* Cartesian partitioning of a cubic volume among available MPI ranks
* distributing particle-data among ranks to the corresponding subvolume
* overloading particle-data at rank boundaries
* exchaning particle-data according to a "owner"-list of keys per rank


Installation
------------

Installing from the PyPI repository:

.. code-block:: bash

   pip install mpipartition

Installing the development version from the GIT repository

.. code-block:: bash

   git clone https://github.com/ArgonneCPAC/mpipartition.git
   cd mpipartition
   python setup.py develop

Requirements
------------

* `mpi4py <https://mpi4py.readthedocs.io/en/stable/>`_: MPI for Python
* `numpy <https://numpy.org/>`_: Python array library
