| Name | pylops-mpi JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Python library implementing linear operators with MPI |
| upload_time | 2024-04-13 13:13:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License. "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version". The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. |
| keywords |
algebra
inverse problems
large-scale optimization
distributed computing
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/PyLops/pylops-mpi/actions/workflows/build.yml)
[](https://github.com/PyLops/pylops-mpi/actions/workflows/pages/pages-build-deployment)
[](https://pylops.slack.com)
## PyLops MPI
pylops-mpi is a Python library built on top of [PyLops](https://pylops.readthedocs.io/en/stable/), designed to enable distributed and parallel processing of
large-scale linear algebra operations and computations.
## Installation
To install pylops-mpi, you need to have MPI (Message Passing Interface) installed on your system.
1. **Download and Install MPI**: Visit the official MPI website to download an appropriate MPI implementation for your system.
Follow the installation instructions provided by the MPI vendor.
- [Open MPI](https://www.open-mpi.org/software/ompi/v1.10/)
- [MPICH](https://www.mpich.org/downloads/)
- [Intel MPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html#gs.10j8fx)
2. **Verify MPI Installation**: After installing MPI, verify its installation by opening a terminal or command prompt
and running the following command:
```
mpiexec --version
```
3. **Install pylops-mpi**: Once MPI is installed and verified, you can proceed to install `pylops-mpi`.
You can install with `pip`:
```
pip install pylops-mpi
```
You can install with `make` and `conda`:
```
make install_conda
```
## Run Pylops-MPI
Once you have installed the prerequisites and pylops-mpi, you can run pylops-mpi using the `mpiexec` command.
Here's an example on how to run the command:
```
mpiexec -n <NUM_PROCESSES> python <script_name>.py
```
## Example
The DistributedArray can be used to either broadcast or scatter the NumPy array across different
ranks or processes.
```python
from pylops_mpi import DistributedArray, Partition
global_shape = (10, 5)
# Initialize a DistributedArray with partition set to Broadcast
dist_array_broadcast = DistributedArray(global_shape=global_shape,
partition=Partition.BROADCAST)
# Initialize a DistributedArray with partition set to Scatter
dist_array_scatter = DistributedArray(global_shape=global_shape,
partition=Partition.SCATTER)
```
Additionally, the DistributedArray can be used to scatter the array along any
specified axis.
```python
# Partition axis = 0
dist_array_0 = DistributedArray(global_shape=global_shape,
partition=Partition.SCATTER, axis=0)
# Partition axis = 1
dist_array_1 = DistributedArray(global_shape=global_shape,
partition=Partition.SCATTER, axis=1)
```
The DistributedArray class provides a `to_dist` class method that accepts a NumPy array as input and converts it into an
instance of the `DistributedArray` class. This method is used to transform a regular NumPy array into a DistributedArray that can be distributed
and processed across multiple nodes or processes.
```python
import numpy as np
np.random.seed(42)
dist_arr = DistributedArray.to_dist(x=np.random.normal(100, 100, global_shape),
partition=Partition.SCATTER, axis=0)
```
The DistributedArray also provides fundamental mathematical operations, like element-wise addition, subtraction, and multiplication,
as well as dot product and the [`np.linalg.norm`](https://numpy.org/doc/stable/reference/generated/numpy.linalg.norm.html) function in a distributed fashion,
thus utilizing the efficiency of the MPI protocol. This enables efficient computation and processing of large-scale distributed arrays.
## Running Tests
The test scripts are located in the tests folder.
Use the following command to run the tests:
```
mpiexec -n <NUM_PROCESSES> pytest --with-mpi
```
The `--with-mpi` option tells pytest to enable the `pytest-mpi` plugin,
allowing the tests to utilize the MPI functionality.
## Documentation
The official documentation of Pylops-MPI is available [here](https://pylops.github.io/pylops-mpi/).
Visit the official docs to learn more about pylops-mpi.
## Contributors
* Rohan Babbar, rohanbabbar04
* Matteo Ravasi, mrava87
Raw data
{
"_id": null,
"home_page": null,
"name": "pylops-mpi",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "algebra, inverse problems, large-scale optimization, distributed computing",
"author": null,
"author_email": "Rohan Babbar <rohanbabbar0408@gmail.com>, Matteo Ravasi <matteoravasi@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/37/06/8a14d47ac4546bc3ed588502f94f80a2c49c21e36039a8e61cb3fef8cdbd/pylops-mpi-0.1.0.tar.gz",
"platform": null,
"description": "\n\n[](https://github.com/PyLops/pylops-mpi/actions/workflows/build.yml)\n[](https://github.com/PyLops/pylops-mpi/actions/workflows/pages/pages-build-deployment)\n\n[](https://pylops.slack.com)\n\n## PyLops MPI\npylops-mpi is a Python library built on top of [PyLops](https://pylops.readthedocs.io/en/stable/), designed to enable distributed and parallel processing of \nlarge-scale linear algebra operations and computations. \n\n## Installation\nTo install pylops-mpi, you need to have MPI (Message Passing Interface) installed on your system.\n1. **Download and Install MPI**: Visit the official MPI website to download an appropriate MPI implementation for your system. \nFollow the installation instructions provided by the MPI vendor.\n - [Open MPI](https://www.open-mpi.org/software/ompi/v1.10/)\n - [MPICH](https://www.mpich.org/downloads/)\n - [Intel MPI](https://www.intel.com/content/www/us/en/developer/tools/oneapi/mpi-library.html#gs.10j8fx)\n2. **Verify MPI Installation**: After installing MPI, verify its installation by opening a terminal or command prompt \nand running the following command:\n ```\n mpiexec --version\n ```\n 3. **Install pylops-mpi**: Once MPI is installed and verified, you can proceed to install `pylops-mpi`. \n \n You can install with `pip`:\n ```\n pip install pylops-mpi\n ```\n \n You can install with `make` and `conda`:\n ```\n make install_conda\n ```\n \n## Run Pylops-MPI\nOnce you have installed the prerequisites and pylops-mpi, you can run pylops-mpi using the `mpiexec` command. \nHere's an example on how to run the command:\n```\nmpiexec -n <NUM_PROCESSES> python <script_name>.py\n```\n\n## Example\nThe DistributedArray can be used to either broadcast or scatter the NumPy array across different \nranks or processes.\n```python\nfrom pylops_mpi import DistributedArray, Partition\n\nglobal_shape = (10, 5)\n\n# Initialize a DistributedArray with partition set to Broadcast\ndist_array_broadcast = DistributedArray(global_shape=global_shape,\n partition=Partition.BROADCAST)\n\n# Initialize a DistributedArray with partition set to Scatter\ndist_array_scatter = DistributedArray(global_shape=global_shape,\n partition=Partition.SCATTER)\n```\n\nAdditionally, the DistributedArray can be used to scatter the array along any\nspecified axis.\n\n```python\n# Partition axis = 0\ndist_array_0 = DistributedArray(global_shape=global_shape, \n partition=Partition.SCATTER, axis=0)\n\n# Partition axis = 1\ndist_array_1 = DistributedArray(global_shape=global_shape, \n partition=Partition.SCATTER, axis=1)\n```\n\nThe DistributedArray class provides a `to_dist` class method that accepts a NumPy array as input and converts it into an \ninstance of the `DistributedArray` class. This method is used to transform a regular NumPy array into a DistributedArray that can be distributed \nand processed across multiple nodes or processes.\n\n```python\nimport numpy as np\nnp.random.seed(42)\n\ndist_arr = DistributedArray.to_dist(x=np.random.normal(100, 100, global_shape), \n partition=Partition.SCATTER, axis=0)\n```\nThe DistributedArray also provides fundamental mathematical operations, like element-wise addition, subtraction, and multiplication, \nas well as dot product and the [`np.linalg.norm`](https://numpy.org/doc/stable/reference/generated/numpy.linalg.norm.html) function in a distributed fashion, \nthus utilizing the efficiency of the MPI protocol. This enables efficient computation and processing of large-scale distributed arrays.\n\n## Running Tests\nThe test scripts are located in the tests folder.\nUse the following command to run the tests:\n```\nmpiexec -n <NUM_PROCESSES> pytest --with-mpi\n```\nThe `--with-mpi` option tells pytest to enable the `pytest-mpi` plugin, \nallowing the tests to utilize the MPI functionality.\n\n## Documentation \nThe official documentation of Pylops-MPI is available [here](https://pylops.github.io/pylops-mpi/).\nVisit the official docs to learn more about pylops-mpi.\n\n## Contributors\n* Rohan Babbar, rohanbabbar04\n* Matteo Ravasi, mrava87\n",
"bugtrack_url": null,
"license": "GNU LESSER GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below. 0. Additional Definitions. As used herein, \"this License\" refers to version 3 of the GNU Lesser General Public License, and the \"GNU GPL\" refers to version 3 of the GNU General Public License. \"The Library\" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below. An \"Application\" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library. A \"Combined Work\" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the \"Linked Version\". The \"Minimal Corresponding Source\" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version. The \"Corresponding Application Code\" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work. 1. Exception to Section 3 of the GNU GPL. You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL. 2. Conveying Modified Versions. If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version: a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy. 3. Object Code Incorporating Material from Library Header Files. The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following: a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the object code with a copy of the GNU GPL and this license document. 4. Combined Works. You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following: a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License. b) Accompany the Combined Work with a copy of the GNU GPL and this license document. c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document. d) Do one of the following: 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source. 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version. e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.) 5. Combined Libraries. You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License. b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 6. Revised Versions of the GNU Lesser General Public License. The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License \"or any later version\" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation. If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library. ",
"summary": "Python library implementing linear operators with MPI",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"algebra",
" inverse problems",
" large-scale optimization",
" distributed computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6da4fd37699fb1e3cbe7f0a4b297e29f9ae291a90e4e5e21b82c032718b8bc00",
"md5": "1124a809b6f5143866094db8fc82f1a7",
"sha256": "f80e4d2957bd518c4dc356bdf1b7b50b991c2399eacf16faf89c202918b1e738"
},
"downloads": -1,
"filename": "pylops_mpi-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1124a809b6f5143866094db8fc82f1a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 189907,
"upload_time": "2024-04-13T13:13:40",
"upload_time_iso_8601": "2024-04-13T13:13:40.814890Z",
"url": "https://files.pythonhosted.org/packages/6d/a4/fd37699fb1e3cbe7f0a4b297e29f9ae291a90e4e5e21b82c032718b8bc00/pylops_mpi-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37068a14d47ac4546bc3ed588502f94f80a2c49c21e36039a8e61cb3fef8cdbd",
"md5": "4674eca5d8f7fb79a32695bac99c3f4e",
"sha256": "907c0de9885bf5b5402de33d9ea9ba2151a214cdbe80b9c4cfd3ba5d8275b841"
},
"downloads": -1,
"filename": "pylops-mpi-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4674eca5d8f7fb79a32695bac99c3f4e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 165496,
"upload_time": "2024-04-13T13:13:42",
"upload_time_iso_8601": "2024-04-13T13:13:42.755793Z",
"url": "https://files.pythonhosted.org/packages/37/06/8a14d47ac4546bc3ed588502f94f80a2c49c21e36039a8e61cb3fef8cdbd/pylops-mpi-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 13:13:42",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pylops-mpi"
}
