From ad726312a7aa451fcc4df05db48fe4f066d3ae4e Mon Sep 17 00:00:00 2001 From: Jon Peirce Date: Thu, 15 Aug 2024 17:00:04 +0100 Subject: [PATCH] DOCS: updated install instructions for 2024.2.1 --- docs/source/conf.py | 3 +- docs/source/download.rst | 91 +++++++++++++++++++++++++++------------- installPsychoPy.py | 16 ++++++- 3 files changed, 79 insertions(+), 31 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 9076ba895d..17d70c22dd 100755 --- 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 index a4b99742d2..07002ec2db 100644 --- 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 **For all versions** see the `PsychoPy releases on github `_ diff --git a/installPsychoPy.py b/installPsychoPy.py index d272688e8f..a3b4315740 100644 --- 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