README FILE

scinstr (SCientific INSTRrument)
Benoit Dubois
April 7th, 2023


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

* Introduction
* Requirements
* Installation


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

A package providing various driver 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

Optional package:
  * pyserial ((virtual-)serial interface)
  * python-usbtmc (usbtsmc interface)


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

1. Install Python packages.
          $ python3 -m pip install --user pyserial
          $ python3 -m pip install --user python-usbtmc

2. Install scinstr.
   * PyPi
          $ python3 -m pip install --user scinstr

   * from source
          $ python3 -m pip install --user scinstr-x.x.tar.gz
