From 700f4d4b42e556a3abdc013829bd14321a82f44e Mon Sep 17 00:00:00 2001 From: Max Turner Date: Wed, 12 Jul 2023 16:00:53 -0700 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2f3c870..a92d288 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +# Flystim is now deprecated and unsupported +We recommend switching to [stimpack](https://github.com/ClandininLab/stimpack), which includes and expands flystim functionality. + # flystim [![Build Status](https://travis-ci.com/ClandininLab/flystim.svg?branch=master)](https://travis-ci.com/ClandininLab/flystim) @@ -33,6 +36,13 @@ On Linux, you'll also need to install a few packages via **apt-get**: If you get a permissions error when running the **pip** command, you can try adding the **--user** flag. This will cause **pip** to install packages in your user directory rather than to a system-wide location. +Flystim depends on PyQt5. We have seen performance issues running flystim on Linux machines depending on the specific version of PyQt5 installed. Best performance is found using PyQt5==5.11.2. If you have trouble installing this specific version, you can try: +``` +pip install PyQt5==5.11.2 --no-deps +``` + +For this and other reasons, we recommend upgrading to [stimpack](https://github.com/ClandininLab/stimpack), which uses PyQt6 and is much more stable. + # Running the Example Code In a terminal tab, navigate to the examples directory and run one of the sample programs, such as **show_all.py**.