Skip to content

Commit 9580f60

Browse files
author
neil-hamilton
authored
Merge pull request picotech#34 from JellyWX/jude-changes
Updated README. Changed setup.py to install numpy dependency
2 parents 88dab17 + 4f2e1a4 commit 9580f60

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,13 @@ 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

32+
If you are not using a virtualenv or are not elevated, use:
33+
=======
3134
For using the AS108 you will need to use the following as well:
3235

3336
python setupPicosynth.py install
@@ -37,13 +40,13 @@ On macOS and Linux you will either need to use `sudo` with this command, to
3740
install into the system folders, or to install for the current user only you
3841
can use:
3942

40-
python setup.py install --user
43+
pip install . --user
4144

4245
Within python, the library for `import` is called `picosdk`.
4346

4447
## Compatibility
4548

46-
This code is written to be compatible with both python 2.7 and python 3 (any version).
49+
This code is written to be compatible with both Python 2.7 and Python 3 (any version).
4750

4851
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,
4952
picosdk commit hash, etc.) and your error message(s).
@@ -72,7 +75,7 @@ The following drivers and devices are not yet supported:
7275

7376
### Dependencies
7477

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

7881
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)