Installation under Windows

For detailed instructions, see manual.
For a newer (quicker) installation procedure, see below.

Quick installation under Windows (beta)

This is for Windows only; for instructions how to experimentally (!) install QDSpy under Linux, see further below. The following instructions assume that you are using a fairly recent Anaconda distribution. The advantage of this installation procedure is that it uses a virtual (conda) environment and therefore does not touch your current Python installation.

1. Clone the branch of choice to a new location on your drive:

   git clone https://github.com/eulerlab/QDSpy.git
   

   or

   git clone -b experimental https://github.com/eulerlab/QDSpy.git
   

2. Change into that folder and create a new conda environment, defining the Python version that you have installed:

   cd qdspy
   conda create -n qdspy python=3.8
   

   To check if successful, run:

   conda env list
   

3. Activating this conda environment under Windows does not always work reliably. Therefore, run the "conda prompt" from your start menu and then go there back into your QDSpy folder.
4. In the conda prompt window, activate the conda environment and install there the packages QDSpy needs:

   conda activate qdspy
   pip install -r requirements.txt
   

To remove the conda environment and start over, run:

conda deactivate
conda env remove -n qdspy

Installation under Linux (experimental)

If running Raspberry Pi OS (standard Linux) on a RPi, use pip3.

hidapi (e.g. Ubuntu):

sudo apt-get install python-dev libusb-1.0-0-dev libudev-dev
sudo pip install --upgrade setuptools
sudo pip install hidapi

Download the respective wheel file from pypi.org and extract it into .../QDSpy/Devices.

hidapi (Raspberry Pi OS):

sudo apt install libhidapi-hidraw0
sudo apt install libhidapi-libusb0
sudo pip3 install hidapi hid

pip3 install --ugrade numpy