diff --git a/.github/workflows/wheel.yml b/.github/workflows/wheel.yml index 4aeb5012..3338eaf4 100644 --- a/.github/workflows/wheel.yml +++ b/.github/workflows/wheel.yml @@ -4,8 +4,7 @@ on: push: branches: - main - tags: - - "*.*.*" + jobs: pypi: name: Upload wheel to github "latest" release diff --git a/docs/conf.py b/docs/conf.py index f5c916b3..799ea828 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,9 +15,9 @@ # -- Project information ----------------------------------------------------- -project = "vstt" -copyright = "xxx" -author = "xxx" +project = "Visuomotor Serial Targeting Task" +copyright = "2022" +author = "SSC" # -- General configuration --------------------------------------------------- diff --git a/docs/developer/install.rst b/docs/developer/install.rst index 0a5d2b31..924a9aaa 100644 --- a/docs/developer/install.rst +++ b/docs/developer/install.rst @@ -1,5 +1,5 @@ -Installation -============ +Developer installation +====================== Pre-requisites -------------- @@ -7,12 +7,13 @@ Pre-requisites The only dependency is `psychopy `_. Unfortunately, psychopy itself has a lot of dependencies, some of which are system libraries. -* on Ubuntu 22.04 with Python 3.9 I needed to do +* on Ubuntu 22.04 with Python 3.9 * ``sudo apt-get install swig libasound2-dev portaudio19-dev libpulse-dev libusb-1.0-0-dev libsndfile1-dev libportmidi-dev liblo-dev libgtk-3-dev`` * ``pip install wxPython`` (which took a long time to complete - alternative is to install a `pre-built wheel `_) - * additionally, at runtime PTB/psychtoolbox needs extra permissions on linux to run - * short term fix: ``sudo setcap cap_sys_nice=eip /path/to/python/binary`` - * see `this issue `_ + * additionally, at runtime psychtoolbox needs permission on linux to set its priority: + * ``sudo setcap cap_sys_nice+ep `python -c "import os; import sys; print(os.path.realpath(sys.executable))"`` + * alternatively simply remove psychtoolbox (it is an optional psychopy dependency): + * ``pip uninstall psychtoolbox`` Developer install ----------------- diff --git a/docs/quickstart/images/display-options.png b/docs/quickstart/images/display-options.png index c51a25a6..3654914b 100644 Binary files a/docs/quickstart/images/display-options.png and b/docs/quickstart/images/display-options.png differ diff --git a/docs/quickstart/images/gui.png b/docs/quickstart/images/gui.png index 05d33085..0252401f 100644 Binary files a/docs/quickstart/images/gui.png and b/docs/quickstart/images/gui.png differ diff --git a/docs/quickstart/images/meta.png b/docs/quickstart/images/meta.png index d2fe0d38..03528d11 100644 Binary files a/docs/quickstart/images/meta.png and b/docs/quickstart/images/meta.png differ diff --git a/docs/quickstart/images/results-list.png b/docs/quickstart/images/results-list.png index 857f5117..84263d16 100644 Binary files a/docs/quickstart/images/results-list.png and b/docs/quickstart/images/results-list.png differ diff --git a/docs/quickstart/images/results.png b/docs/quickstart/images/results.png index 6973e077..710c713e 100644 Binary files a/docs/quickstart/images/results.png and b/docs/quickstart/images/results.png differ diff --git a/docs/quickstart/images/splash.png b/docs/quickstart/images/splash.png index 792db7c8..1e424784 100644 Binary files a/docs/quickstart/images/splash.png and b/docs/quickstart/images/splash.png differ diff --git a/docs/quickstart/images/trial-conditions.png b/docs/quickstart/images/trial-conditions.png index 51841c8e..66ed62ad 100644 Binary files a/docs/quickstart/images/trial-conditions.png and b/docs/quickstart/images/trial-conditions.png differ diff --git a/docs/quickstart/images/trial-screen.png b/docs/quickstart/images/trial-screen.png index e7fb1b0e..4da524a1 100644 Binary files a/docs/quickstart/images/trial-screen.png and b/docs/quickstart/images/trial-screen.png differ diff --git a/docs/quickstart/install.rst b/docs/quickstart/install.rst index fd71e1d7..85a46e47 100644 --- a/docs/quickstart/install.rst +++ b/docs/quickstart/install.rst @@ -4,9 +4,9 @@ Installation Windows with standalone Psychopy (recommended) ---------------------------------------------- -* Install `StandalonePsychoPy `_ -* Download `UpdatePrototype.bat `_ and double-click on it -* Download `RunPrototype.bat `_ and double-click on it +* Install `StandalonePsychoPy `_ +* Download `UpdateVSTT.bat `_ and double-click on it +* Download `VSTT.bat `_ and double-click on it .. note:: * Your browser might warn you about downloading batch files @@ -15,29 +15,25 @@ Windows with standalone Psychopy (recommended) * The first time you run it you might get a "Windows protected your PC" message * This is also normal for a .bat file * Click more info -> run anyway - * What does `UpdatePrototype.bat` do? - * This installs the latest version of the prototype into your Psychopy Python environment using pip - * It runs this command: ``"C:\Program Files\PsychoPy\python.exe" -m pip install https://github.com/ssciwr/vstt/releases/download/latest/vstt-latest-py3-none-any.whl`` - * What does `RunPrototype.bat` do? - * This runs the prototype using your Psychopy Python environment + * What does `UpdateVSTT.bat` do? + * This installs the latest version of VSTT into your Psychopy Python environment using pip + * It runs this command: ``"C:\Program Files\PsychoPy\python.exe" -m pip install --upgrade vstt`` + * What does `VSTT.bat` do? + * This runs VSTT using your Psychopy Python environment * It runs this command: ``"C:\Program Files\PsychoPy\python.exe" -m vstt`` * If in doubt you can always open the .bat file in notepad to see what commands it will run * If you have installed Psychopy in a non-default location you will need to update the paths in these batch files to point to the psychopy-installed python.exe. -Alternative pip install ------------------------ +Pip install +----------- -If you already have a Python environment and git you can install using pip: +VSTT can also be installed using pip: -``pip install git+https://github.com/ssciwr/vstt`` +``pip install vstt`` .. note:: - On linux you will also need to give your Python executable permission - to set its own priority: ``sudo setcap cap_sys_nice=eip /path/to/python/binary``. - -.. note:: - This method also installs the psychopy library with pip, which may need additional - system libraries and configuration steps to work properly, - which is probably why they provide standalone installers for - Psychopy on Windows and Mac which bundle all the requirements. + On linux the optional psychtoolbox dependency needs permission to set its priority. To allow this: + * ``sudo setcap cap_sys_nice+ep `python -c "import os; import sys; print(os.path.realpath(sys.executable))"`` + Alternatively you can simply remove psychtoolbox + * ``pip uninstall psychtoolbox`` diff --git a/misc/UpdatePrototype.bat b/misc/UpdatePrototype.bat deleted file mode 100644 index bc993dd2..00000000 --- a/misc/UpdatePrototype.bat +++ /dev/null @@ -1,2 +0,0 @@ -@ECHO OFF -"C:\Program Files\PsychoPy\python.exe" -m pip install https://github.com/ssciwr/vstt/releases/download/latest/vstt-latest-py3-none-any.whl diff --git a/misc/UpdateVSTT.bat b/misc/UpdateVSTT.bat new file mode 100644 index 00000000..9a72d8df --- /dev/null +++ b/misc/UpdateVSTT.bat @@ -0,0 +1,2 @@ +@ECHO OFF +"C:\Program Files\PsychoPy\python.exe" -m pip install --upgrade vstt diff --git a/misc/RunPrototype.bat b/misc/VSTT.bat similarity index 100% rename from misc/RunPrototype.bat rename to misc/VSTT.bat diff --git a/src/vstt/__init__.py b/src/vstt/__init__.py index 106b6039..f41734dd 100644 --- a/src/vstt/__init__.py +++ b/src/vstt/__init__.py @@ -5,4 +5,4 @@ "__version__", ] -__version__ = "0.24.0" +__version__ = "0.25.0"