Skip to main content

Hyperion si155 and si255 Python API

Seth M.
Updated

As of 10/2/2024, The current version of Hyperion Python API on our website is 2.0.0.1. There is an issue in this file that prevents users from installing it on their machine. Attached to this article is version 2.0.3.1 which users can install using the method below.

Version 2.0.3.1 does not contain the simple examples. Users can still download 2.0.0.1 from our website and extract the file in order to get access to the simple examples.

 

NOTE: There is a known bug in version 2.0.3.1 that causes issues with custom software slowly tying up ports on the Hyperion. This will usually result in an error related to the instrument rejecting the connection and required the software or the Hyperion to be restarted before reconnecting. This is fairly easy to resolve by commenting out lines 210 and 211 of the hyperion.py file before installing it:

comment out lines Hyperion python API.png

 

Installing the API

If you are installing within a virtual environment, you can use the following:

python -m venv hyperion_api_env
source hyperion_api_env/bin/activate
tar xvf HyperionAPI-2.0.3.1.tar.gz
cd HyperionAPI-2.0.3.1
pip install numpy

python setup.py install
 

 

If you are trying to install it on the PC, you can use the following method:
 

  • Extract the zip file to a folder.
    • You should be able to find a tar.gz file and a simple examples file. Use 7-zip or a similar program to extract the tar.gz file. Depending on the program used to extract, you may have to go into the extracted folder and extract another file (a .gz file). Once you have extracted the files, you can use the Command Prompt to to install the module by using the setup.py file.
  • Navigate to the folder containing the setup file from the command line.
    • For Example:
      • cd C:\Users\username\Downloads\x55-HYPERION-Python-v3.5-API-v2.0.3.1\HyperionAPI-2.0.3.1.tar\dist\HyperionAPI-2.0.3.1\HyperionAPI-2.0.3.1
  • Install the API
    • On Windows, use:
      • python setup.py install

        • If you would like to install the module to your user profile instead of a global installation, you can again use the "--user" tag at the end.

          • Example:

    • If on Linux, use:
      • sudo python setup.py install

 

Related to

Related articles