# KCG - KAPTURE Control Gui

KCG is the Graphical Control Interface to the KAPTURE-Readout-Board.  

This version is for the KAPTURE-2 System!
(KAPTURE-1 support not testet)

## Prerequisites:


### Must be installed by system packagemanager

- python 2.7.x or python 3.6.x
- PyQt4
- paramiko (for ssh in CorrelationCorrection)

To install on debian e.g.:

- sudo apt-get install python
- sudo apt-get install python-qt4

### Will be installed via installing of KCG (if will be installed else those have to be installed seperately)

- pyqtgraph
- numpy

To manually install them use e.g. pip:

- pip install pyqtgraph
- pip install numpy

## Download

#### Stable Version

To get the latest stable version get the latest release.

#### Development Version

To get the latest development Version clone this repository 

*at ipe.git the master branch is the old version for KAPTURE-1*

*Some notes to those of you who want to test the newest features:  
Branches other than the kapture2 branch will hold some newer (and potentially completely untested) additions. Feel free to test them.*

**NOTE:** this might be unstable or not even work at all

## Install/Run

You can install KCG or run without intstallation

### Install

To install KCG (either system- or userwide) use (inside the repository) `pip install .` with optionally `--user` as flag to install 
only for current user.  To start KCG after installation simply run `kcg` from whereever you are.  
Upon first run you will be prompted to configure KCG this will set appropriate values and write them to ~/.kcg/config.cfg  

#### NOTE: 
If you chose to install for current user only you need to have $HOME/.local/bin in your $PATH in order to run kcg.

### Run without installation

You can run KCG directly without installation. To do so, simply run `./kcg` in the outer KCG directory.
    You will still be asked to configure KCG if it is the first run.


### Unintentional Features
If you find any unintentional features (bugs) or have questions please let me know.