Skip to content

Commit a1fa817

Browse files
committed
Update general docs for Psychtoolbox 3.0.20.0 release.
1 parent 2b45322 commit a1fa817

File tree

3 files changed

+224
-157
lines changed

3 files changed

+224
-157
lines changed

download.markdown

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ See section [Alternate Download below for how to download zip files instead.](#a
145145
##### After basic Linux installation - further tweaks:
146146

147147
Another recommendation is to install a low-latency Linux kernel for optimized
148-
timing, e.g., on Ubuntu flavors and probably also Debian flavors:
148+
timing, e.g., on Ubuntu flavors and maybe also Debian flavors:
149149

150150
sudo apt install linux-lowlatency
151151

@@ -156,6 +156,17 @@ to automatically create and install optimized xorg.conf configuration files
156156
for the X-Server. This is especially useful for hybrid graphics laptops and
157157
multi-display setups.
158158

159+
If you have older AMD graphics cards with DCE display engines, ie. AMD Polaris,
160+
AMD Vega, or earlier, and want to use Psychtoolbox low-level features for extra
161+
reliability and peace of mind for visual stimulation, or if you are using a
162+
NVidia graphics card with proprietary driver and want precise visual onset
163+
timestamping, Psychtoolbox needs low-level gpu access. This is generally only
164+
possible on modern Linux distributions with EFI secure boot disabled in your
165+
firmware settings, as EFI secure boot will trigger an additional security
166+
mechanism in Linux, called "kernel lockdown", which will prevent these low
167+
level features from working. Disabling secure boot may be also needed if
168+
you want to access some types of serial or parallel ports.
169+
159170
[Additional tips][using-on-linux] for installing and using Psychtoolbox on
160171
Linux.
161172

@@ -177,22 +188,32 @@ folders of your liking instead:
177188
opengl32.dll -- Otherwise hardware accelerated visual stimulation will not work.
178189

179190
2. [You may also need to install the Microsoft Runtime Libraries for MSVC 2015-2019 if
180-
you use Matlab instead of Octave and those have not been installed already by other
191+
you use Matlab instead of Octave, and those have not been installed already by other
181192
software on your system. For a few use cases you may even need those if you use Octave.
182193
You can find installers for these at Microsoft’s site beforehand. Otherwise, if our
183194
installer aborted half-ways, follow the instructions it prints to the console. Or simply
184195
click this link to get a copy bundled with Psychtoolbox][c++ runtime]
185196

197+
3. Psychtoolbox 3.0.20 and later will require a paid license key to function, except for
198+
a time-limited free trial period. Sales of these license keys will start early in the
199+
year 2025. The version will require consent to enabling of the software network license
200+
manager, but be freely usable until shortly after start of sales.
201+
186202
#### Mac {#Mac}
187203

188204
Execute step 1 and then [skip to Alternate Download below for how to download zip files instead.](#alternate-download)
189205

190206
1. If you intend to use multi-media functions, or if you want fast, high-quality,
191207
cross-platform, consistent text rendering with Matlab, you must install the 64-Bit
192-
GStreamer-1.18.5 or later runtime from [gstreamer.freedesktop.org][gstreamer-osx].
208+
GStreamer-1.18.5 or later runtime from [gstreamer.freedesktop.org][gstreamer-osx] on
209+
Intel based Macintosh computers, or GStreamer 1.22.0 or later on ARM based Macs.
193210
Make absolutely sure that you install all offered packages. [Read `help GStreamer`
194211
carefully for this purpose, *before downloading and installing GStreamer*.][docs-gstreamer]
195212

213+
2. Psychtoolbox 3.0.20 and later will require a paid license key to function, except for
214+
a time-limited free trial period. Sales of these license keys will start early in the
215+
year 2025. The version will require consent to enabling of the software network license
216+
manager, but be freely usable until shortly after start of sales.
196217

197218
Download of Psychtoolbox as a zip file {#alternate-download}
198219
------------------------------------------------------------
@@ -203,9 +224,9 @@ zip file (or tar.gz file). We provide "Source Code" zip or tar.gz files, which
203224
contain a given Psychtoolbox release, including the full source code. These are
204225
large, due to inclusion of the source code.
205226

206-
More often you'll want to download the smaller zip file with the version number
227+
More often you'll want to download the smaller zip file with the version number,
207228
for only the Psychtoolbox standard folder (ie. without source code), e.g.,
208-
something named like `3.0.19.7.zip`.
229+
something named like `3.0.20.0.zip`.
209230

210231
The "Assets" section of each Psychtoolbox GitHub release contains the download links.
211232

@@ -233,7 +254,8 @@ working directory to the Psychtoolbox folder (`cd` command) and then type
233254

234255
(see [SetupPsychtoolbox][docs-setup] or type `help SetupPsychtoolbox`). The
235256
`SetupPsychtoolbox` script will setup your local Psychtoolbox folder for use
236-
with Matlab or Octave.
257+
with Matlab or Octave. It will also allow for first time license manager setup
258+
on a users computer account on macOS and Windows.
237259

238260
Staying Up-to-Date {#upgrading}
239261
-------------------------------

0 commit comments

Comments
 (0)