Skip to content

Commit 337269e

Browse files
committed
Updated README. Changed setup.py to install numpy dependency
1 parent 8e87f8f commit 337269e

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,21 +24,20 @@ libraries.
2424
## Installing the python driver bindings
2525

2626
A `distutils` installer is provided. After you have installed the PicoSDK
27-
driver package (see above), the Python installer can be used as follows:
27+
driver package (see above), the Python package can be installed using the
28+
following command in the top-level directory:
2829

29-
python setup.py install
30+
pip install .
3031

31-
On macOS and Linux you will either need to use `sudo` with this command, to
32-
install into the system folders, or to install for the current user only you
33-
can use:
32+
If you are not using a virtualenv or are not elevated, use:
3433

35-
python setup.py install --user
34+
pip install . --user
3635

3736
Within python, the library for `import` is called `picosdk`.
3837

3938
## Compatibility
4039

41-
This code is written to be compatible with both python 2.7 and python 3 (any version).
40+
This code is written to be compatible with both Python 2.7 and Python 3 (any version).
4241

4342
If you find a compatibility problem please raise an [Issue](https://www.picotech.com/tech-support), listing all the versions you can find (python, numpy,
4443
picosdk commit hash, etc.) and your error message(s).
@@ -68,7 +67,7 @@ The following drivers and devices are not yet supported:
6867

6968
### Dependencies
7069

71-
As well as depending on the C libraries, the Pythonic wrappers use some python libraries like `numpy`. Many of the
70+
As well as depending on the C libraries, the Python wrappers use some Python libraries like `numpy`. Many of the
7271
examples scripts also use the `matplotlib` plotting library. You can install these dependencies with pip as follows:
7372

7473
pip install -r requirements.txt

setup.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,5 @@
3232
author='Pico Technology Ltd',
3333
author_email='[email protected]',
3434
url='https://www.picotech.com',
35-
packages=['picosdk'])
35+
packages=['picosdk'],
36+
install_requires=['numpy>=1.12.1'])

0 commit comments

Comments
 (0)