Update docs for first release

- update installation instructions
- update and rename install/update windows batch files
- update all screenshots, resolves #178

.github/workflows/wheel.yml

@@ -4,8 +4,7 @@ on:
   push:
     branches:
       - main
-    tags:
-      - "*.*.*"
+
 jobs:
   pypi:
     name: Upload wheel to github "latest" release

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

docs/developer/install.rst

@@ -1,18 +1,19 @@
-Installation
-============
+Developer installation
+======================
 
 Pre-requisites
 --------------
 
 The only dependency is `psychopy <https://www.psychopy.org/index.html>`_.
 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 <https://extras.wxpython.org/wxPython4/extras/linux/gtk3/>`_)
-   * 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 <https://discourse.psychopy.org/t/psychopy-keyboard-keyboard-psychhid-kbqueuestart-memory-fault/12005/6>`_
+   * 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
 -----------------

docs/quickstart/install.rst

@@ -4,9 +4,9 @@ Installation
 Windows with standalone Psychopy (recommended)
 ----------------------------------------------
 
-* Install `StandalonePsychoPy <https://github.com/psychopy/psychopy/releases/download/2022.2.4/StandalonePsychoPy-2022.2.4-win64.exe>`_
-* Download `UpdatePrototype.bat <https://github.com/ssciwr/vstt/releases/download/latest/UpdatePrototype.bat>`_ and double-click on it
-* Download `RunPrototype.bat <https://github.com/ssciwr/vstt/releases/download/latest/RunPrototype.bat>`_ and double-click on it
+* Install `StandalonePsychoPy <https://github.com/psychopy/psychopy/releases/download/2023.1.2/StandalonePsychoPy-2023.1.2-win64.exe>`_
+* Download `UpdateVSTT.bat <https://github.com/ssciwr/vstt/releases/download/latest/UpdateVSTT.bat>`_ and double-click on it
+* Download `VSTT.bat <https://github.com/ssciwr/vstt/releases/download/latest/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``

misc/UpdateVSTT.bat

@@ -0,0 +1,2 @@
+@ECHO OFF
+"C:\Program Files\PsychoPy\python.exe" -m pip install --upgrade vstt

src/vstt/__init__.py

@@ -5,4 +5,4 @@
     "__version__",
 ]
 
-__version__ = "0.24.0"
+__version__ = "0.25.0"