README FILE

scinstr (SCientific INSTRrument)
Benoit Dubois
March 31th, 2025


CONTENTS OF THIS FILE
---------------------

* Introduction
* Requirements
* Installation


INTRODUCTION
------------

A package dedicated to handle various scientific instruments (digital multimeter,
frequency counter, digital acquisition unit...)


REQUIREMENTS
------------

Preferably a Linux system with a Debian distribution (not tested with others OS
nor others distributions).
The program requires the folowing packages:
  * Python 3 (Normally already installed on a Debian system)
          $ [sudo] apt-get install python3

Required package:
  * pyserial
  * pyusb
  * python-usbtmc
  * pymodbus

Optional package
  * signalslot


INSTALLATION
------------

Preferential installation in a virtual environment or for a single user.

1. If required, iInstall optional Python packages:
          $ python3 -m pip install [--user] signalslot

2. Install scinstr:
   * PyPi (recommended)
          $ python3 -m pip install [--user] scinstr

   * From source
          $ python3 -m pip install [--user] scinstr-x.x.tar.gz
