moku 3.3.1

Python scripting interface to the Liquid Instruments Moku hardware

Moku

A Python library for the command, control and monitoring of the Liquid Instruments Moku:Go. API documentation can be found at ReadTheDocs.

Getting Started

1. Requirements

• Python installed. We support Python >= 3.5.
• Zeroconf to browse for Moku's on network
• Your Moku connected to the same network as your computer.
• Internet access.

1. Install Moku

Open a command-line terminal and type

pip install --upgrade moku

If you wish to build and train models for the Moku Neural Network instrument, install optional machine learning dependencies with

pip install moku[neuralnetwork]

The IP address of your Moku:Go device can be found with

moku list

3. Start scripting

You are now ready to control your Moku:Go using Python! You can find a few example scripts in the examples/ folder. Here is a basic example of how to connect to a Moku:Go, deploy the Oscilloscope and fetch a single hi-res data trace. Open python and run the following code

from moku.instruments import Oscilloscope

# Connect to your Moku by its ip Oscilloscope('192.168.###.###')
# or by its serial m = Oscilloscope(serial=123)
i = Oscilloscope('192.168.###.###', force_connect=False)

try:
    # Span from -1s to 1s i.e. trigger point centred
    i.set_timebase(-1, 1)

    # Get and print a single frame worth of data (time series
    # of voltage per channel)
    data = i.get_data()
    print(data['ch1'], data['ch2'], data['time'])
except Exception as e:
    print(f'Exception occurred: {e}')
finally:
    i.relinquish_ownership()

Troubleshooting

moku: command not found

Ensure moku has been successfully installed in your Python distrubution by open a python shell and running

import moku

No error indicates a successful install.

You may need to add python binaries to your PATH. This varies with operating system and python version but as an example

export PATH=$PATH:/home/user/.local/bin

ImportError: No Module named moku

Make sure you are running the version of Python you installed moku to. Often a system will have multiple Python installations. Try substituting pip with python -m pip in the installation. If you installed moku inside an Environment (i.e. via virtualenv or conda-env), ensure that Environment is activated. You can check that moku is installed in your currently running environment using

(myenv)$ pip list

Issue Tracking

Please report issues at https://www.liquidinstruments.com/support/contact/