Installation under Windows

These are the latest instructions for the QDSpy installation under Windows 11.
For installation instructions under Linux, see here.

Note: With v0.91 and higher, the latest release of pyglet version 1 (currently v.1.5.29) can be used. Previous releases of QDSpy require pyglet v1.4.10. If you use an older QDSpy release, change line for pyglet installation below accordingly.

Installation under Windows 11 using uv (recommended)

This version uses uv, a new and fast Python package and project manager, written in Rust. It assumes that you are using Windows powershell.

1. Install Python from python.org

2. Install uv:

   pip install uv
   

   If running uv results in an error, try replacing user with the username of the account under which you are logged in.

   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   $env:Path = "C:\Users\user\.local\bin;$env:Path"
   

3. 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
   

4. Start QDSpy:

   cd QDSpy
   uv run QDSpy_GUI_main.py
   

   Note that when using the command for the first time, uv will automatically create a virtual environment and install the required packages.

Installation under Windows 11 using pip (deprecated)

1. Install Python from python.org

2. Make sure that pip and virtualenv are up to date

   python.exe -m pip install --upgrade pip
   pip install virtualenv
   

3. 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
   

4. Change into that folder, create a new virtual environment, and activate it. The powershell command is only needed, if activating the environment fails due to safety restrictions.

   cd QDSpy
   python -m venv qdspy
   powershell -ExecutionPolicy Bypass
   .\qdspy\Scripts\activate
   

5. Install packages.

   pip install -r requirements.txt
   

6. Make sure that Windows knows the variable PYTHONPATH set to your QDSpy folder.
   To check, use:

   $env:PYTHONPATH
   

   To set the folder (e.g., for c:\qdspy), use:

   [System.Environment]::SetEnvironmentVariable("PYTHONPATH", $env:PYTHONPATH + ";c:\qdspy", [System.EnvironmentVariableTarget]::User)
   

7. Create a tailored shortcut to QDSpy. This automatically starts a powershell, changes to the QDSpy folder, and activates the Python virtual environment:

   • Create a shortcut on the Windows desktop, open "properties" via right-clicking on the icon
   • Under "target" enter the following line, starting with the path to powershell.exe on your system:

     C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -NoExit -ExecutionPolicy Bypass -Command "& { .\qdspy\Scripts\activate }"
     

     ... or, if the newer PowerShell 7 (pwsh.exe) is installed:

     "C:\Program Files\PowerShell\7\pwsh.exe" -NoExit -ExecutionPolicy Bypass -Command "& { .\qdspy\Scripts\activate }"
     

   • Under "Execute in" enter the path to your QDSpy folder (e.g., C:\Users\karle\QDSpy)
   • Optionally, you can change the shortcut's icon to that of QDSpy (in the QDSpy folder).
   • Save changes.