PyJISA

Python package for easily setting up JISA for use in a CPython (i.e. normal Python) environment using JPype.

Installation

You can install this package by using PIP like so:

pip install pyjisa

or, to get the latest version direct from this repository:

pip install git+https://github.com/OE-FET/PyJISA.git

Importing and Use

Now whenever you want to use JISA in Python, simply import pyjisa.autoload, like so:

import pyjisa.autoload

The first time you do this, it will download the JISA.jar file (which may take a few seconds). Also, if pyjisa is unable to find one installed on your system, it may also download a Java Runtime Environment (JRE):

>>> import pyjisa.autoload
Downloading latest JISA.jar library... Done.
No Java Runtime Environment found on system, downloading JRE 11... Done.
>>> _

After this, you're good to import JISA classes as if they were written in Python. For instance, the following "Hello World!" script should act as a good test of whether all is working as it should:

import pyjisa.autoload
from jisa.gui import GUI

GUI.infoAlert("Hello World!")

and, of course, you should be able to connect to and control your instruments:

# Initialise JISA library
import pyjisa.autoload

# Import JISA classes
from jisa.devices.smu import K2612B
from jisa.addresses import TCPIPAddress

# Connect to Keithley 2612B dual-channel SMU over TCP-IP
keithley = K2612B(TCPIPAddress("192.168.0.5", 5656))

# Exctract each channel as its own SMU object
channelA = keithley.getSMU(0)
channelB = keithley.getSMU(1)

# Configure channel A and tell it to source 5.0 V
channelA.useAutoRanges()
channelA.setIntegrationTime(20e-3)
channelA.setFourProbeEnabled(False)
channelA.setVoltage(5.0)

# Configure channel B and tell it to source 0.5 A
channelB.useAutoRanges()
channelB.setIntegrationTime(20e-3)
channelB.setFourProbeEnabled(False)
channelB.setCurrent(500e-3)

# Enable their outputs
channelA.turnOn()
channelB.turnOn()

GUI Elements

If you have GUI elements open and are hopeing to have your program continue running until said elements are closed, you may need to make use of GUI.waitForExit() like so:

import pyjisa.autoload

from jisa.gui import GUI, Plot

plot = Plot("Title", "X", "Y")
plot.setExitOnClose(True)
plot.show()

# If we don't do this, python will quit and close the GUI immediately
GUI.waitForExit()

This is because when reaching the end of a script, Python will exit even though the GUI thread is till running, as it cannot see running Java threads.

Manually Select Java Runtime

To manually select which Java installation to use, just import pyjisa (not pyjisa.autoload), and call pyjisa.load(...) directly, supplying the path like so:

import pyjisa
pyjisa.load("/usr/lib/jvm/java-13-openjdk-amd64")

or

import pyjisa
pyjisa.load("C:\\Program Files\\AdoptOpenJDK\\jdk-13.0.2.8-hotspot")

Updating JISA.jar

You can tell pyjisa to download the latest version of the JISA.jar library by only importing pyjisa and calling pyjisa.updateJISA():

>>> import pyjisa
>>> pyjisa.updateJISA()
Downloading latest JISA.jar library... Done.
>>> _