DOCS: updated install instructions for 2024.2.1

peircej · Aug 15, 2024 · ad72631 · ad72631
1 parent f9bdc5d
commit ad72631
Show file tree

Hide file tree

Showing 3 changed files with 79 additions and 31 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -33,7 +33,8 @@
               'sphinx.ext.mathjax',
               'sphinx.ext.napoleon',
               'sphinx.ext.intersphinx',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode',
+              'sphinx_design', 'sphinx_copybutton']
 
 autoclass_content = 'both'
 autosummary_generate = True

diff --git a/docs/source/download.rst b/docs/source/download.rst
@@ -8,39 +8,72 @@ Download
 
 For the easiest installation download and install the Standalone package.
 
+.. tab-set::
+
+    .. tab-item:: Windows
+
+      For the easiest installation download and install the Standalone package.
+
+      .. button-link:: https://github.com/psychopy/psychopy/releases/download/2024.2.1/StandalonePsychoPy-2024.2.1post4-win64-py310.exe 
+          :color: primary
+
+          PsychoPy |version| modern (py3.10)
+
+      .. button-link:: https://github.com/psychopy/psychopy/releases/download/2024.2.1/StandalonePsychoPy-2024.2.1-win64-py3.8.exe
+          :color: primary
+
+          PsychoPy |version| compatibility+ (py3.8)
+
+      The *Compatibility+* version is for users who need to run older scripts that are not compatible with the newer versions of Python (PsychoPy has supported Python 3.10 since 2022.2.0).
+
+    .. tab-item:: MacOS
+
+      For the easiest installation download and install the Standalone package.
+
+      .. button-link:: https://github.com/psychopy/psychopy/releases/download/2024.2.1/StandalonePsychoPy-2024.2.1-macOS-py3.10.dmg
+          :color: primary
+
+          PsychoPy |version| modern (py3.10)
+
+      .. button-link:: https://github.com/psychopy/psychopy/releases/download/2024.2.1/StandalonePsychoPy-2024.2.1-macOS-py3.8.dmg
+          :color: primary
+
+          PsychoPy |version| compatibility+ (py3.8)
+
+      The *Compatibility+* version is for users who need to run older scripts that are not compatible with the newer versions of Python (PsychoPy has supported Python 3.10 since 2022.2.0).
+
+      The *modern* version uses a more recent version of Python and cannot run experiments that use PsychoPy<2023.2.0
+
+    .. tab-item:: Linux
+
+        The following will install PsychoPy into 
+
+        .. code-block:: bash
+
+            # create a virtual environment and activate it
+            python3.10 -m venv ~/.psychopy_py310  
+            source ~/.psychopy_py310/bin/activate  
+            
+            # fetch and run install script
+            python -c "$(curl -fsSL https://raw.githubusercontent.com/psychopy/psychopy/dev/installPsychoPy.py)"
+
 .. raw:: html
 
    <script src="https://cdn.jsdelivr.net/npm/ua-parser-js@1/dist/ua-parser.min.js"></script>
    <script>
-
-    let filename;
-    let url;
-    let version='2024.1.5';
-
-    let clientInfo = UAParser(navigator.userAgent);
-    var osLabel;
-    var arch = clientInfo.cpu.architecture;
-    // create the platform dependent strings
-    if (navigator.platform == 'Win32' && clientInfo.cpu.architecture == 'amd64') {
-      osLabel = clientInfo.os.name+" "+clientInfo.cpu.architecture;
-      filename = '  Standalone PsychoPy<sup>®</sup> '+version+' for 64bit Windows (using Python3.8)';
-      url = 'https://github.com/psychopy/psychopy/releases/download/'+version+'/StandalonePsychoPy-'+version+'-win64.exe';
-    }
-    else if (clientInfo.os.name == 'Mac OS') {
-      osLabel = 'macOS';
-      filename = '  Standalone PsychoPy '+version+' for macOS';
-      url = 'https://github.com/psychopy/psychopy/releases/download/'+version+'/StandalonePsychoPy-'+version+'-macOS.dmg';
-    }
-    else {
-      osLabel = clientInfo.os.name+" ("+clientInfo.cpu.architecture+")";
-      filename = 'installing using pip';
-      url = '#linux';
-    }
-
-    document.write( "<br><center>To install PsychoPy on <strong>"+osLabel+"</strong> we recommend<br>");
-    document.write( "<button class='btn-primary btn-lg' onclick='window.location.href=url'>" +
-        "<i class='fa fa-download'></i>" + filename + "</button></center><br>" );
-
+      let clientInfo = UAParser(navigator.userAgent);
+      var osLabel;
+      var arch = clientInfo.cpu.architecture;
+      // create the platform dependent strings
+      if (navigator.platform == 'Win32' && clientInfo.cpu.architecture == 'amd64') {
+         document.getElementById("sd-tab-item-0").checked = true; // Windows
+      }
+      else if (clientInfo.os.name == 'Mac OS') {
+         document.getElementById("sd-tab-item-1").checked = true; // MacOS
+      }
+      else {
+         document.getElementById("sd-tab-item-2").checked = true; // Linux
+      }
    </script>
 
 **For all versions** see the `PsychoPy releases on github <https://github.com/psychopy/psychopy/releases>`_

diff --git a/installPsychoPy.py b/installPsychoPy.py
@@ -1,4 +1,18 @@
-## python script to install psychopy including dependencies
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Part of the PsychoPy library
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2024 Open Science Tools Ltd.
+# Distributed under the terms of the GNU General Public License (GPL).
+"""
+Python script to install psychopy including dependencies
+
+NB: At present, for windows and MacOS you may as well just use `pip install psychopy` but
+in the future we may add some additional functionality here, like adding application 
+shortcuts, checking/recommending virtual envs etc.
+"""
+
+# Author: Jonathan Peirce, based on work of Flavio Bastos and Florian Osmani
 
 import os, sys
 import pathlib