colinoflynn / pico-python

PicoScope Python Interface
Other
101 stars 80 forks source link

pico-python

Build Status

This is a Python 2.7+ library for the Pico Scope. It uses the provided DLL for actual communications with the instrument. There have been a few examples around, but this one tries to improve on them via:

System has support for:

Note the 'A' series covers a different ground than the non-A series! Check the programming manuals posted at http://www.picotech.com/document/ for details.

Installation

You need to install the Python module as well as the Picoscope libraries for your Operating system.

Module installation

PyPi

pip install picoscope

Git

If you are developping the library, or need some feature that we haven't pushed to PyPi yet, use git clone to put the directory somewhere. Then use the setup.py script to install the library in development mode:

git clone git@github.com:colinoflynn/pico-python.git
cd pico-python
python setup.py develop

OS specific

Windows

You will require the PicoScope DLLs for this package to work. The easiest method is to install the latest PicoScope software or SDK from https://www.picotech.com/downloads .

You may need to add the PicoScope install directory to the path, especially if changing between versions. Be sure you have installed a matching 32-bit or 64-bit version for your Python install.

import os
picoinstallpath = os.path.normpath(r"C:\Program Files\Pico Technology\PicoScope 7 T&M Early Access")
if picoinstallpath not in os.environ['PATH']:
    print("Adding Pico Install to Path")
    os.environ['PATH'] = picoinstallpath + os.pathsep + os.environ['PATH']
else:
    print("Pico Install Already on Path")

Linux

Install the PicoScope Beta for Linux version of PicoScope as describe under Getting DLL's (above). Currently this is the only way to install the shared libraries (SDK)

Once you have PicoScope running you need to add your login account to the pico group in order to access the USB. The examples will crash if you don't have permission to use the USB. This is true for use of the shared libraries in general, even if you're not using pico-python.

useradd -G pico $USER

Mac OSX

You either want to add this every time before you start python or IPython, but I think it is best to add this line to .bash_profile (or the Mac Equivalent ????).

export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:/Applications/PicoScope6.app/Contents/Resources/lib

Recently, this directory has moved to a new location See Issue #143

export DYLD_LIBRARY_PATH="$DYLD_LIBRARY_PATH:/Applications/PicoScope 6.app/Contents/Resources/lib"

See Issue 80 for more information on how this was found.

You should also add yourself to the pico group so that your user has access to the picoscope as a USB device

# Create the new pico group :
sudo dseditgroup -o create pico
# Add the current user to the pico group :
sudo dseditgroup -o edit -a $USER -t user pico

Using Anaconda/Conda

Seems like Anaconda has an issue with ctypes. See the comment here imdatacenters says to:

If you are using a special version of Python [like Anaconda] and you can't fix it. Navigate to line 362 of lib/ctypes/init.py and change it to: self._handle = _dlopen(str(self._name), mode)

Similar Projects

PicoPy uses Cython to interface with a PicoScope 3000A https://github.com/hgomersall/PicoPy

Picoscope offers their official wrappers, https://github.com/picotech/picosdk-python-wrappers

Authors, Copyright, and Thanks

pico-python is Copyright (C) 2013 By:

All rights reserved. See LICENSE.md for license terms.

Inspired by Patrick Carle's code at http://www.picotech.com/support/topic11239.html which was adapted from http://www.picotech.com/support/topic4926.html

Contributing

  1. Fork.
  2. Make a new branch.
  3. Commit to your new branch.
  4. Add yourself to the authors/acknowledgments (whichever you find appropriate).
  5. Submit a pull request.

Alternatively, you can follow more thorough instructions here.

Developer notes

Commit and create a new tag with git

git commit
git tag -a X.Y.Z -m "Short descriptive message"

Push the tags to the repo

git push origin X.Y.Z

or to push all tags

git push --tags

versioneer takes care of updating the version. New tags will be pushed to PyPi automatically by Travis.