GEN DAQ API - Python Driver

Setup, control and acquire data from the Genesis Highspeed systems via python.

The GEN DAQ API can be used to control the HBM GEN Series tethered mainframes.

Requirements

Python 3.10+

Installation

Use the package manager pip to install GEN DAQ API - Python Driver package.

pip install ghs-gendaqapi-py

Usage

Refer examples for detailed use cases. Refer documentation for detailed API documentation

from ghsapi import ghsapi

# create Gen Daq API's object
gen = ghsapi.GHS()

# connect to mainframe
gen.ghs_connect(IP_ADDRESS, PORT_NO)

# disconnect from mainframe
gen.ghs_disconnect()

Development environment setup

Below are the steps to follow to setup devlopement enviroment for system integration and testing.

Requirements

• Python 3.10+
• Anaconda/Miniconda

Clone repo

git clone https://github.com/hbkworld/ghs-gendaqapi-python.git

Virtual Environment

Option 1 : Create Environment Using Conda

Run the following command to create environment from the specification file

conda create --name <venv_name> --file spec-file.txt
conda activate <venv_name>

Option 2 : Create Environment Using Python

Navigate to the root of the repository to create virtual environment

py -m venv <venv_name>
<venv_name>\Scripts\activate

Install dependencies

pip install -r requirements.txt

Run example files

Edit files in examples to enter mainframe IP and Port number

python examples\FILENAME

Testing

Edit files in functionaltest to enter mainframe IP and Port number

Unit test

python unittest\FILENAME

Functional test

python functionaltest\FILENAME