Skip to content

Commit 90ba8f9

Browse files
authored
Update README.md
1 parent 74efc7d commit 90ba8f9

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

β€ŽREADME.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# arrayfire-binary-python-wrapper (WIP)
1+
# arrayfire-binary-python-wrapper
22

33
<p align="center"><a href="http://arrayfire.com/"><img src="http://arrayfire.com/logos/arrayfire_logo_whitebkgnd.png" width="800"></a></p>
44

@@ -15,8 +15,8 @@ The ArrayFire Python Project is separated into 3 different parts:
1515
arrayfire-py -> arrayfire-binary-python-wrapper -> ArrayFire C Libraries
1616
```
1717
This means that arrayfire with python each of these parts is needed:
18-
- [`arrayfire-py`](https://github.com/arrayfire/arrayfire-py) is the `thin` wrapper that provides the numpy-like interface to do math and array operations. *** This is the intended User Interface ***
19-
- [`arrayfire-binary-python-wrapper`](https://github.com/arrayfire/arrayfire-binary-python-wrapper) is the `binary` wrapper that provides rough direct access to the functions in the C library. Its purpose is to do the handling of finding the C libraries and handling the communication between Python and C datatypes. 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.
18+
- [`arrayfire-py`](https://github.com/arrayfire/arrayfire-py) is the ***intended User Interface*** that provides a numpy-like layer to execute math and array operations with ArrayFire.
19+
- [`arrayfire-binary-python-wrapper`](https://github.com/arrayfire/arrayfire-binary-python-wrapper) is the thin `binary` wrapper that provides rough direct access to the functions in the C library. Its purpose is to do the handling of finding the C libraries and handling the communication between Python and C datatypes. 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.
2020
- [`ArrayFire C Libraries`](https://github.com/arrayfire/arrayfire) are the binaries obtained from compiling the [ArrayFire C/C++ Project](https://github.com/arrayfire/arrayfire)
2121

2222
# Installing
@@ -29,12 +29,15 @@ You can get the ArrayFire C/C++ library from the following sources:
2929

3030

3131
**Install the last stable version of the binary python wrapper:**
32-
```
33-
pip install arrayfire_binary_python_wrapper-0.8.0+af3.10.0-py3-none-linux_x86_64.whl # install required binary wrapper with the 3.10 ArrayFire binaries included
32+
```sh
33+
# install binary wrapper from PyPI without binaries
34+
# assumes ArrayFire binaries will be installed on the system in some other manner
35+
pip install arrayfire_binary_python_wrapper
3436
```
3537

3638
**Install a pre-built wheel:**
37-
```
39+
```sh
40+
# install binary wrapper with the 3.10 ArrayFire binaries pre-built and included
3841
pip install arrayfire-binary-python-wrapper -f https://repo.arrayfire.com/python/wheels/3.10.0/
3942
```
4043

0 commit comments

Comments
 (0)