| Name | arrayfire-binary-python-wrapper JSON |
| Version |
0.7.0
JSON |
| download |
| home_page | None |
| Summary | ArrayFire Python Wrapper |
| upload_time | 2024-04-17 23:17:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | BSD 3-Clause License Copyright (c) 2023, ArrayFire Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
arrayfire
c
python
wrapper
parallel
computing
gpu
cpu
opencl
oneapi
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# arrayfire-binary-python-wrapper
[ArrayFire](https://github.com/arrayfire/arrayfire) is a high performance library for parallel computing with an easy-to-use API. It enables users to write scientific computing code that is portable across CUDA, OpenCL and CPU devices.
This project is meant to provide thin Python bindings for the ArrayFire C library. It also decouples releases of the main C/C++ library from the Python library by acting as a intermediate library and only wrapping the provided C calls.
This allows the building of large binary wheels only when the underlying ArrayFire version is increased, and the fully-featured Python library can be developed atop independently. The package is not intended to be used directly and merely exposes the
C functionality required by downstream implementations. This package can exist in two forms, with a bundled binary distribution, or merely as a loader that will load the ArrayFire library from a system or user level install.
# Installing
The arrayfire-binary-python-wrapper can be installed from a variety of sources. [Pre-built wheels](https://repo.arrayfire.com/python/wheels/3.9.0/) are available for a number of systems and toolkits. These will include a binary distribution of the ArrayFire libraries. Installing from PyPI directly will only include a wrapper-only, source distribution that will not contain binaries. In this case, wrapper-only installations will require a separate installation of the ArrayFire C/C++ libraries.
You can get the ArrayFire C/C++ library from the following sources:
- [Download and install binaries](https://arrayfire.com/download)
- [Build and install from source](https://github.com/arrayfire/arrayfire)
**Install the last stable version of python wrapper:**
```
pip install arrayfire-binary-python-wrapper
```
**Install a pre-built wheel:**
```
pip install arrayfire-binary-python-wrapper -f https://repo.arrayfire.com/python/wheels/3.9.0/
```
# Building
The arrayfire-binary-python-wrapper can build wheels in packaged-binary or in system-wrapper modes.
[scikit-build-core](https://github.com/scikit-build/scikit-build-core) is used to provide the python build backend.
The minimal, wrapper-only mode that relies on a system install will be built by default though the regular python build process. For example:
```
pipx run build --wheel
```
Building a full pre-packaged local binary is an involved process that will require referencing the regular ArrayFire [build](https://github.com/arrayfire/arrayfire/wiki/Build-Instructions-for-Linux) [procedures](https://github.com/arrayfire/arrayfire/wiki/Build-Instructions-for-Windows).
Besides the regular ArrayFire CMake configuration, building the binaries is an opt-in process that is set by an environment variable `AF_BUILD_LOCAL_LIBS=1`. Once that environment variable is set, scikit-build-core will take care of cloning ArrayFire, building, and including the necessary binaries.
# Contributing
The community of ArrayFire developers invites you to build with us if you are
interested and able to write top-performing tensor functions. Together we can
fulfill [The ArrayFire
Mission](https://github.com/arrayfire/arrayfire/wiki/The-ArrayFire-Mission-Statement)
for fast scientific computing for all.
Contributions of any kind are welcome! Please refer to [the
wiki](https://github.com/arrayfire/arrayfire/wiki) and our [Code of
Conduct](33) to learn more about how you can get involved with the ArrayFire
Community through
[Sponsorship](https://github.com/arrayfire/arrayfire/wiki/Sponsorship),
[Developer
Commits](https://github.com/arrayfire/arrayfire/wiki/Contributing-Code-to-ArrayFire),
or [Governance](https://github.com/arrayfire/arrayfire/wiki/Governance).
# Citations and Acknowledgements
If you redistribute ArrayFire, please follow the terms established in [the
license](LICENSE).
ArrayFire development is funded by AccelerEyes LLC and several third parties,
please see the list of [acknowledgements](ACKNOWLEDGEMENTS.md) for an
expression of our gratitude.
# Support and Contact Info
* [Slack Chat](https://join.slack.com/t/arrayfire-org/shared_invite/MjI4MjIzMDMzMTczLTE1MDI5ODg4NzYtN2QwNGE3ODA5OQ)
* [Google Groups](https://groups.google.com/forum/#!forum/arrayfire-users)
* ArrayFire Services: [Consulting](http://arrayfire.com/consulting) | [Support](http://arrayfire.com/download) | [Training](http://arrayfire.com/training)
# Trademark Policy
The literal mark "ArrayFire" and ArrayFire logos are trademarks of AccelerEyes
LLC (dba ArrayFire). If you wish to use either of these marks in your own
project, please consult [ArrayFire's Trademark
Policy](http://arrayfire.com/trademark-policy/)
Raw data
{
"_id": null,
"home_page": null,
"name": "arrayfire-binary-python-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "ArrayFire <technical@arrayfire.com>",
"keywords": "arrayfire c python wrapper parallel computing gpu cpu opencl oneapi",
"author": null,
"author_email": "ArrayFire <technical@arrayfire.com>, Anton Chernyatevich <chernyatevich.a@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fe/90/7b27549981b3947676056e19defe1b20b85ada46ffcc89e0c18ff1c3f661/arrayfire_binary_python_wrapper-0.7.0.tar.gz",
"platform": null,
"description": "# arrayfire-binary-python-wrapper\n\n[ArrayFire](https://github.com/arrayfire/arrayfire) is a high performance library for parallel computing with an easy-to-use API. It enables users to write scientific computing code that is portable across CUDA, OpenCL and CPU devices. \n\nThis project is meant to provide thin Python bindings for the ArrayFire C library. It also decouples releases of the main C/C++ library from the Python library by acting as a intermediate library and only wrapping the provided C calls. \n\nThis allows the building of large binary wheels only when the underlying ArrayFire version is increased, and the fully-featured Python library can be developed atop independently. The package is not intended to be used directly and merely exposes the \nC functionality required by downstream implementations. This package can exist in two forms, with a bundled binary distribution, or merely as a loader that will load the ArrayFire library from a system or user level install.\n\n# Installing\n\nThe arrayfire-binary-python-wrapper can be installed from a variety of sources. [Pre-built wheels](https://repo.arrayfire.com/python/wheels/3.9.0/) are available for a number of systems and toolkits. These will include a binary distribution of the ArrayFire libraries. Installing from PyPI directly will only include a wrapper-only, source distribution that will not contain binaries. In this case, wrapper-only installations will require a separate installation of the ArrayFire C/C++ libraries.\nYou can get the ArrayFire C/C++ library from the following sources:\n\n- [Download and install binaries](https://arrayfire.com/download)\n- [Build and install from source](https://github.com/arrayfire/arrayfire)\n\n\n**Install the last stable version of python wrapper:**\n```\npip install arrayfire-binary-python-wrapper\n```\n\n**Install a pre-built wheel:**\n```\npip install arrayfire-binary-python-wrapper -f https://repo.arrayfire.com/python/wheels/3.9.0/\n```\n\n# Building\nThe arrayfire-binary-python-wrapper can build wheels in packaged-binary or in system-wrapper modes.\n[scikit-build-core](https://github.com/scikit-build/scikit-build-core) is used to provide the python build backend.\nThe minimal, wrapper-only mode that relies on a system install will be built by default though the regular python build process. For example:\n```\npipx run build --wheel\n```\nBuilding a full pre-packaged local binary is an involved process that will require referencing the regular ArrayFire [build](https://github.com/arrayfire/arrayfire/wiki/Build-Instructions-for-Linux) [procedures](https://github.com/arrayfire/arrayfire/wiki/Build-Instructions-for-Windows).\nBesides the regular ArrayFire CMake configuration, building the binaries is an opt-in process that is set by an environment variable `AF_BUILD_LOCAL_LIBS=1`. Once that environment variable is set, scikit-build-core will take care of cloning ArrayFire, building, and including the necessary binaries.\n\n\n# Contributing\n\nThe community of ArrayFire developers invites you to build with us if you are\ninterested and able to write top-performing tensor functions. Together we can\nfulfill [The ArrayFire\nMission](https://github.com/arrayfire/arrayfire/wiki/The-ArrayFire-Mission-Statement)\nfor fast scientific computing for all.\n\nContributions of any kind are welcome! Please refer to [the\nwiki](https://github.com/arrayfire/arrayfire/wiki) and our [Code of\nConduct](33) to learn more about how you can get involved with the ArrayFire\nCommunity through\n[Sponsorship](https://github.com/arrayfire/arrayfire/wiki/Sponsorship),\n[Developer\nCommits](https://github.com/arrayfire/arrayfire/wiki/Contributing-Code-to-ArrayFire),\nor [Governance](https://github.com/arrayfire/arrayfire/wiki/Governance).\n\n# Citations and Acknowledgements\n\nIf you redistribute ArrayFire, please follow the terms established in [the\nlicense](LICENSE).\n\nArrayFire development is funded by AccelerEyes LLC and several third parties,\nplease see the list of [acknowledgements](ACKNOWLEDGEMENTS.md) for an\nexpression of our gratitude.\n\n# Support and Contact Info\n\n* [Slack Chat](https://join.slack.com/t/arrayfire-org/shared_invite/MjI4MjIzMDMzMTczLTE1MDI5ODg4NzYtN2QwNGE3ODA5OQ)\n* [Google Groups](https://groups.google.com/forum/#!forum/arrayfire-users)\n* ArrayFire Services: [Consulting](http://arrayfire.com/consulting) | [Support](http://arrayfire.com/download) | [Training](http://arrayfire.com/training)\n\n# Trademark Policy\n\nThe literal mark \"ArrayFire\" and ArrayFire logos are trademarks of AccelerEyes\nLLC (dba ArrayFire). If you wish to use either of these marks in your own\nproject, please consult [ArrayFire's Trademark\nPolicy](http://arrayfire.com/trademark-policy/)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2023, ArrayFire Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "ArrayFire Python Wrapper",
"version": "0.7.0",
"project_urls": {
"General documentation": "https://arrayfire.org/docs/index.htm",
"Website": "http://arrayfire.com"
},
"split_keywords": [
"arrayfire",
"c",
"python",
"wrapper",
"parallel",
"computing",
"gpu",
"cpu",
"opencl",
"oneapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "38088fc405850c48b5eecfff316120434711fc44e17fa21c23516a71062eb813",
"md5": "c5e59d0e7b17d2927e3c710f2031b6b6",
"sha256": "4dbbb9f9a15a7c618140b093037681b2568da7855a85b2a45fe8cc3c9d9951e4"
},
"downloads": -1,
"filename": "arrayfire_binary_python_wrapper-0.7.0-py3-none-manylinux_2_28_x86_64.whl",
"has_sig": false,
"md5_digest": "c5e59d0e7b17d2927e3c710f2031b6b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 77252,
"upload_time": "2024-04-17T23:17:16",
"upload_time_iso_8601": "2024-04-17T23:17:16.633661Z",
"url": "https://files.pythonhosted.org/packages/38/08/8fc405850c48b5eecfff316120434711fc44e17fa21c23516a71062eb813/arrayfire_binary_python_wrapper-0.7.0-py3-none-manylinux_2_28_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fe907b27549981b3947676056e19defe1b20b85ada46ffcc89e0c18ff1c3f661",
"md5": "ad23ee1e61730587ee60280742f9b3d5",
"sha256": "af550fe6001147610aa67188c5e076c01a736386181a45c963db80a8b08df493"
},
"downloads": -1,
"filename": "arrayfire_binary_python_wrapper-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "ad23ee1e61730587ee60280742f9b3d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 67094,
"upload_time": "2024-04-17T23:17:18",
"upload_time_iso_8601": "2024-04-17T23:17:18.528213Z",
"url": "https://files.pythonhosted.org/packages/fe/90/7b27549981b3947676056e19defe1b20b85ada46ffcc89e0c18ff1c3f661/arrayfire_binary_python_wrapper-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 23:17:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "arrayfire-binary-python-wrapper"
}
