*****************
Quarchpy - Readme
*****************

Quarch automation package including standard API, drivers and related tools

Getting Started
###############

* Install quarchpy library
* Connect quarch module via USB, Serial or LAN
* Run basic communication tests

**> python -m quarchpy.run debug_info**


* `Code Samples <https://www.quarch.com/downloads/application-note/>`_ - Application notes with simple worked examples

Prerequisites
#############

* Python 3.x (3.7.x recommended). Most older examples will work with Python 2.x, but developement for this has halted
* Java 8 including Java FX (required for QIS and QPS use only, optional install)
* zeroconf (used for QCS automatic mDNS scan, optional install)

Installing
##########

Install quarchpy (or upgrade to the latest version)

> python -m pip install quarchpy

> python -m pip install quarchpy -- upgrade


Authors
#######

Quarch Technology Ltd


