psychopy 2025.2.4__py3-none-any.whl

psychopy/app/Resources/routine_templates/readme.md

@@ -0,0 +1,14 @@
+# Routine templates
+
+These will show up as options that can be added to Experiments using New Routine in 
+either the Flow of the Experiment menu.
+
+You can add Routine Templates of your own by adding an experiment file to your PsychoPy
+preferences folder, typically:
+    - ~/.psychopy3/routine_templates  # on MacOS
+    - AppData\Roaming\psychopy3\routine_templates  # on Win10
+
+The name of the experiment file becomes the name of the Category and the name of the
+Routine within that file becomes the name of the template.
+
+Have fun making those wacky, reusable templates! 

psychopy/app/Resources/tips.txt

@@ -0,0 +1,45 @@
+Most dialogs have a help button that takes you to the relevant online documentation
+You can use "Ctrl + [" or "Ctrl + ]" to indent/outdent a block of code in Coder view
+Both in the Coder and Builder views have a demos menu with plenty of demos. There are more on Pavlovia.org
+From Builder you can use "Compile" to generate the Python script that controls your experiment, and view or edit it in the Coder. (Any edits are not reflected back in the Builder, however.)
+You should avoid snorting Pepsi
+Most buttons have helpful usage tips if you hover over them
+PsychoPy can handle many different units (degrees of visual angle, cm...) for your stimuli. But you need to tell it about your monitor first (see the online documentation on General > Units)
+Menu items show you the current key bindings (which can be configured in preferences)
+For brief stimuli, you should use frames rather than time to set the start/stop of your stimuli. Most monitor frame rates are precise to the microsecond!
+It's a really good idea to check your data are all being saved as you like BEFORE running all of your participants!
+Builder: right-clicking on any 'color' parameter will bring up the system's color-picker.
+The user forum is a great place to ask questions and receive updates, at https://discourse.psychopy.org
+If you do write to the forum, make it clear whether you're using Builder or Coder interfaces and which version/platform you use.
+You can add or remove Components to the Favorites by right-clicking on them. And you can control the maximum number of them in preferences.
+You can use the source. PsychoPy comes with all its source code included. If you know Python, you'd be surprised how easy it is to find your own bug-fixes.
+Degrees of visual angle are 'device independent'. Normalized units mean that your stimulus will be different on each different computer. Do you really want that?
+Chocolate probably won't help, but does that mean you shouldn't try it?
+For fMRI block designs you want to use non-slip timing (trials of pre-determined duration). Builder indicates these with a green icon in the Flow panel
+Builder: you can often right click on things to bring up a menu, e.g., to remove a trial.
+Coder: you can click the color-picker icon on the toolbar. The R,G,B color triplet will be saved to the clipboard (in PsychoPy's rgb color units, -1..+1 not 0..255), which you can then paste into a script.
+If you have a tip that you'd like to added here, email it to the users list.
+To flip an image stimulus, give it a negative 'size', in x, y or both
+PsychoPy is free. Please cite the most recent paper (Peirce et al 2019) if you use PsychoPy in published work
+Builder: To set stimulus position to your variables X and Y, you can use either $[X,Y] or [$X,Y]. (A $ anywhere indicates that the entire entry box is Python code)
+You should wear sunscreen. (Where does it say these tips have to be original?!)
+In Python, the values True and False must have capitals and really just stand for 1 and 0.
+Builder: The contents of the dialog box at the start of your experiment are controlled from the Experiment Settings button. You can use these values in your study by referring to the value in expInfo e.g. expInfo['participant']
+Coder: You can comment/uncomment entire blocks of code with Ctrl-' and Ctrl-Shift-'
+Did your stimulus not appear? Was it really tiny? Setting units='pix' and size=0.1 means it has a size of 0.1 pixels!
+The default color values in PsychoPy range from -1 to +1, with 0 being the mean grey of the screen. So black is like the maximum decrement from grey and white is an increment. Right?
+Data can be output in many different formats, but it's worth saving the 'psydat' (aka pickle) format as well as the others. Although this isn't "human readable" it stores more information than excel/csv files including an entire copy of your actual experiment!
+You can see how many people used PsychoPy this month at https://usage.psychopy.org
+Builder: You can increase or decrease the display size of the flow using "Ctrl + =" or "Ctrl + -" (like some web browsers). Similarly, you can change the display size of routines using "Ctrl + Shift + =" and "Ctrl + Shift + -". (Use "Cmd" on Mac, not "Ctrl".)
+In the Builder, you can display details about the trials and sequences of loops. Press "Ctrl + =" when at the largest view size. To turn off, press "Ctrl + -" from the smallest view size.
+Builder: To put a $ symbol in a stimulus, you need to use \$, like this: "You win \$5.00!". (This is only for input boxes, and not for code components.)
+You can use "Ctrl + Z" and "Ctrl + Shift + Z" to undo and redo many of the actions in the Builder, such as adding, deleting, or changing something.
+In Builder you can control what appears in the 'Experiment Info' dialog box in the Experiment Settings
+If you like PsychoPy spread the word
+Sometimes the correct response on a given trial is not to respond at all, such as in a go/no-go task. To score such responses properly, enter 'None' as the correct answer (no quotes) in the Builder dialog box.
+For the best audio timing you need to use the 'PTB' backend (set this in the app Preferences).
+The Keyboard class has better timing than event.getKeys() and also reports key duration when the key has been released.
+Get your department to buy a site licence for Pavlovia.org. You'll be helping fund PsychoPy development and you'll be able to run unlimited online studies.
+Coder: Can't remember arguments for a class or function? Use "Ctrl + Shift + Space" after the first brace to bring up a calltip. Press "Esc" or "Enter" to close it.
+Coder: Use "Ctrl + Space" to bring up a list of code completion suggestions. Press "Enter" to insert the selected suggestion into your code or "Esc" to cancel.
+Coder: The "Code Structure" pane shows an outline of classes and functions defined in the current file. Click on items to go to where they are defined.

psychopy/app/Resources/tips_ar_001.txt

@@ -0,0 +1,45 @@
+معظم صناديق الحوارات لديها زر مساعدة والذي سيأخذك إلى ملف المساعدة على شبكة الانترنت 
+You can use "Ctrl + [" or "Ctrl + ]" to indent/outdent a block of code in Coder view
+Both in the Coder and Builder views have a demos menu with plenty of demos. There are more on Pavlovia.org
+From Builder you can use "Compile" to generate the Python script that controls your experiment, and view or edit it in the Coder. (Any edits are not reflected back in the Builder, however.)
+You should avoid snorting Pepsi
+Most buttons have helpful usage tips if you hover over them
+PsychoPy can handle many different units (degrees of visual angle, cm...) for your stimuli. But you need to tell it about your monitor first (see the online documentation on General > Units)
+Menu items show you the current key bindings (which can be configured in preferences)
+For brief stimuli, you should use frames rather than time to set the start/stop of your stimuli. Most monitor frame rates are precise to the microsecond!
+It's a really good idea to check your data are all being saved as you like BEFORE running all of your participants!
+Builder: right-clicking on any 'color' parameter will bring up the system's color-picker.
+The user forum is a great place to ask questions and receive updates, at https://discourse.psychopy.org
+If you do write to the forum, make it clear whether you're using Builder or Coder interfaces and which version/platform you use.
+You can add or remove Components to the Favorites by right-clicking on them. And you can control the maximum number of them in preferences.
+You can use the source. PsychoPy comes with all its source code included. If you know Python, you'd be surprised how easy it is to find your own bug-fixes.
+Degrees of visual angle are 'device independent'. Normalized units mean that your stimulus will be different on each different computer. Do you really want that?
+Chocolate probably won't help, but does that mean you shouldn't try it?
+For fMRI block designs you want to use non-slip timing (trials of pre-determined duration). Builder indicates these with a green icon in the Flow panel
+Builder: you can often right click on things to bring up a menu, e.g., to remove a trial.
+Coder: you can click the color-picker icon on the toolbar. The R,G,B color triplet will be saved to the clipboard (in PsychoPy's rgb color units, -1..+1 not 0..255), which you can then paste into a script.
+If you have a tip that you'd like to added here, email it to the users list.
+To flip an image stimulus, give it a negative 'size', in x, y or both
+PsychoPy is free. Please cite the most recent paper (Peirce et al 2019) if you use PsychoPy in published work
+Builder: To set stimulus position to your variables X and Y, you can use either $[X,Y] or [$X,Y]. (A $ anywhere indicates that the entire entry box is Python code)
+You should wear sunscreen. (Where does it say these tips have to be original?!)
+In Python, the values True and False must have capitals and really just stand for 1 and 0.
+Builder: The contents of the dialog box at the start of your experiment are controlled from the Experiment Settings button. You can use these values in your study by referring to the value in expInfo e.g. expInfo['participant']
+Coder: You can comment/uncomment entire blocks of code with Ctrl-' and Ctrl-Shift-'
+Did your stimulus not appear? Was it really tiny? Setting units='pix' and size=0.1 means it has a size of 0.1 pixels!
+The default color values in PsychoPy range from -1 to +1, with 0 being the mean grey of the screen. So black is like the maximum decrement from grey and white is an increment. Right?
+Data can be output in many different formats, but it's worth saving the 'psydat' (aka pickle) format as well as the others. Although this isn't "human readable" it stores more information than excel/csv files including an entire copy of your actual experiment!
+You can see how many people used PsychoPy this month at https://usage.psychopy.org
+Builder: You can increase or decrease the display size of the flow using "Ctrl + =" or "Ctrl + -" (like some web browsers). Similarly, you can change the display size of routines using "Ctrl + Shift + =" and "Ctrl + Shift + -". (Use "Cmd" on Mac, not "Ctrl".)
+In the Builder, you can display details about the trials and sequences of loops. Press "Ctrl + =" when at the largest view size. To turn off, press "Ctrl + -" from the smallest view size.
+Builder: To put a $ symbol in a stimulus, you need to use \$, like this: "You win \$5.00!". (This is only for input boxes, and not for code components.)
+You can use "Ctrl + Z" and "Ctrl + Shift + Z" to undo and redo many of the actions in the Builder, such as adding, deleting, or changing something.
+In Builder you can control what appears in the 'Experiment Info' dialog box in the Experiment Settings
+If you like PsychoPy spread the word
+Sometimes the correct response on a given trial is not to respond at all, such as in a go/no-go task. To score such responses properly, enter 'None' as the correct answer (no quotes) in the Builder dialog box.
+For the best audio timing you need to use the 'PTB' backend (set this in the app Preferences).
+The Keyboard class has better timing than event.getKeys() and also reports key duration when the key has been released.
+Get your department to buy a site licence for Pavlovia.org. You'll be helping fund PsychoPy development and you'll be able to run unlimited online studies.
+Coder: Can't remember arguments for a class or function? Use "Ctrl + Shift + Space" after the first brace to bring up a calltip. Press "Esc" or "Enter" to close it.
+Coder: Use "Ctrl + Space" to bring up a list of code completion suggestions. Press "Enter" to insert the selected suggestion into your code or "Esc" to cancel.
+Coder: The "Code Structure" pane shows an outline of classes and functions defined in the current file. Click on items to go to where they are defined.

psychopy/app/Resources/tips_fr_FR.txt

@@ -0,0 +1,45 @@
+Most dialogs have a help button that takes you to the relevant online documentation
+You can use "Ctrl + [" or "Ctrl + ]" to indent/outdent a block of code in Coder view
+Both in the Coder and Builder views have a demos menu with plenty of demos. There are more on Pavlovia.org
+From Builder you can use "Compile" to generate the Python script that controls your experiment, and view or edit it in the Coder. (Any edits are not reflected back in the Builder, however.)
+You should avoid snorting Pepsi
+Most buttons have helpful usage tips if you hover over them
+PsychoPy can handle many different units (degrees of visual angle, cm...) for your stimuli. But you need to tell it about your monitor first (see the online documentation on General > Units)
+Menu items show you the current key bindings (which can be configured in preferences)
+For brief stimuli, you should use frames rather than time to set the start/stop of your stimuli. Most monitor frame rates are precise to the microsecond!
+It's a really good idea to check your data are all being saved as you like BEFORE running all of your participants!
+Builder: right-clicking on any 'color' parameter will bring up the system's color-picker.
+The user forum is a great place to ask questions and receive updates, at https://discourse.psychopy.org
+If you do write to the forum, make it clear whether you're using Builder or Coder interfaces and which version/platform you use.
+You can add or remove Components to the Favorites by right-clicking on them. And you can control the maximum number of them in preferences.
+You can use the source. PsychoPy comes with all its source code included. If you know Python, you'd be surprised how easy it is to find your own bug-fixes.
+Degrees of visual angle are 'device independent'. Normalized units mean that your stimulus will be different on each different computer. Do you really want that?
+Chocolate probably won't help, but does that mean you shouldn't try it?
+For fMRI block designs you want to use non-slip timing (trials of pre-determined duration). Builder indicates these with a green icon in the Flow panel
+Builder: you can often right click on things to bring up a menu, e.g., to remove a trial.
+Coder: you can click the color-picker icon on the toolbar. The R,G,B color triplet will be saved to the clipboard (in PsychoPy's rgb color units, -1..+1 not 0..255), which you can then paste into a script.
+If you have a tip that you'd like to added here, email it to the users list.
+To flip an image stimulus, give it a negative 'size', in x, y or both
+PsychoPy is free. Please cite the most recent paper (Peirce et al 2019) if you use PsychoPy in published work
+Builder: To set stimulus position to your variables X and Y, you can use either $[X,Y] or [$X,Y]. (A $ anywhere indicates that the entire entry box is Python code)
+You should wear sunscreen. (Where does it say these tips have to be original?!)
+In Python, the values True and False must have capitals and really just stand for 1 and 0.
+Builder: The contents of the dialog box at the start of your experiment are controlled from the Experiment Settings button. You can use these values in your study by referring to the value in expInfo e.g. expInfo['participant']
+Coder: You can comment/uncomment entire blocks of code with Ctrl-' and Ctrl-Shift-'
+Did your stimulus not appear? Was it really tiny? Setting units='pix' and size=0.1 means it has a size of 0.1 pixels!
+The default color values in PsychoPy range from -1 to +1, with 0 being the mean grey of the screen. So black is like the maximum decrement from grey and white is an increment. Right?
+Data can be output in many different formats, but it's worth saving the 'psydat' (aka pickle) format as well as the others. Although this isn't "human readable" it stores more information than excel/csv files including an entire copy of your actual experiment!
+You can see how many people used PsychoPy this month at https://usage.psychopy.org
+Builder: You can increase or decrease the display size of the flow using "Ctrl + =" or "Ctrl + -" (like some web browsers). Similarly, you can change the display size of routines using "Ctrl + Shift + =" and "Ctrl + Shift + -". (Use "Cmd" on Mac, not "Ctrl".)
+In the Builder, you can display details about the trials and sequences of loops. Press "Ctrl + =" when at the largest view size. To turn off, press "Ctrl + -" from the smallest view size.
+Builder: To put a $ symbol in a stimulus, you need to use \$, like this: "You win \$5.00!". (This is only for input boxes, and not for code components.)
+You can use "Ctrl + Z" and "Ctrl + Shift + Z" to undo and redo many of the actions in the Builder, such as adding, deleting, or changing something.
+In Builder you can control what appears in the 'Experiment Info' dialog box in the Experiment Settings
+If you like PsychoPy spread the word
+Sometimes the correct response on a given trial is not to respond at all, such as in a go/no-go task. To score such responses properly, enter 'None' as the correct answer (no quotes) in the Builder dialog box.
+For the best audio timing you need to use the 'PTB' backend (set this in the app Preferences).
+The Keyboard class has better timing than event.getKeys() and also reports key duration when the key has been released.
+Get your department to buy a site licence for Pavlovia.org. You'll be helping fund PsychoPy development and you'll be able to run unlimited online studies.
+Coder: Can't remember arguments for a class or function? Use "Ctrl + Shift + Space" after the first brace to bring up a calltip. Press "Esc" or "Enter" to close it.
+Coder: Use "Ctrl + Space" to bring up a list of code completion suggestions. Press "Enter" to insert the selected suggestion into your code or "Esc" to cancel.
+Coder: The "Code Structure" pane shows an outline of classes and functions defined in the current file. Click on items to go to where they are defined.

psychopy/app/Resources/tips_ja_JP.txt

@@ -0,0 +1,42 @@
+　ほとんどのダイアログにはヘルプボタンがあって、オンラインドキュメントを見ることができます。
+　Coderでは Ctrl + [ や Ctrl + ] を使って面倒くさいPythonのインデントの調節ができます。
+　CoderもBuilderもメニューの「デモ」からたくさんのデモを参照することができます。
+　Builderでは実験を「コンパイル」して、実験を制御するPythonのスクリプトを生成することができます。生成したスクリプトはCoderで確認したり編集したりできます。Coderで編集しても元になったBuilderの実験には反映されない点にご注意！
+　ほとんどのボタンやエディットボックスはマウスカーソルを重ねるとポップアップヘルプが表示されます。
+　PsychoPyでは刺激描画にさまざまな単位(deg、cm,...)を利用できます。ただし、その前にモニターの設定をする必要があります。詳しくはオンラインドキュメントのGeneral > Unitsをご覧ください。
+　メニューの右端にはショートカットキーが表示されています(PsychoPyの設定ダイアログで変更することができます)。
+　特に提示時間の短い刺激については、刺激の開始や終了タイミングの指定に時刻よりもフレームを使いましょう。多くのモニターのフレームレートはミリ秒単位の精度があります！
+　実験参加者を呼んで実験を始める前に、データが希望通りに保存されることを確認したほうがいいですよ！
+　Builderで色を指定する欄を右クリックするとカラーピッカー(色選択ダイアログ)が表示されます。
+　ユーザーフォーラムでは質問をしたり最新情報を受け取ったりするのにおすすめです。https://discourse.psychopy.org
+　フォーラムで質問する時は、BuilderとCoderのどちらを使用しているのか、PsychoPyのバージョンやOSの名称およびバージョン等をを明記してください。
+　Builderでコンポーネントペインのアイコンを右クリックするとお気に入りに登録したり登録解除したりできます。お気に入りに登録できるコンポーネントの個数は設定ダイアログで変更できます。
+　ソースを見ましょう。PsychoPyはそのソースを全て見ることが出来ます。Pythonを知っているのであれば、バグを修正するのはびっくりするほど簡単です。
+　視角などの単位は「デバイス非依存」です。normなどの「標準化された単位」を用いると、実行するコンピューターのモニターによって刺激の大きさが変化してしまします。
+　fMRIのブロックデザインなどでは試行の長さが一定であるほうが便利でしょう。長さが一定の試行はBuilderのFlow上で緑色のアイコンで示されています。
+　Builderでは右クリックでアイテムの削除などをおこなうポップアップメニューを表示することが出来ます。
+　Coderでツールバーのカラーピッカーをクリックして色を選択すると、クリップボードにその色のRGB値が保存されます。0～225ではなく-1.0～1.0の範囲です。コードに貼りつけて使用できます。
+　このTIPSに追加したい項目があったらメーリングリストに投稿してください。
+　負のサイズを入力することで画像刺激を上下、左右に反転することが出来ます。
+　PsychoPyはフリーソフトウェアです。PsychoPyを用いた実験を論文等で発表する場合は最新の論文(Peirce et al., 2019)を引用してください。
+　Builderで独自の変数X、Yを用いて位置を決定する場合、$[X,Y]とも[$X,$Y]と書くことも出来ます。$は文のどこに付けてもそのボックスに入力されている文字列がPythonの文であることを示します。
+　Pythonで真と偽を表すTrueとFalseは最初の文字を大文字で書かないといけません。
+　Builderで実験を開始した時に表示されるダイアログの内容は実験の設定ダイアログから変更できます。ダイアログに入力された値はexpInfo['participant']といったようにdictオブジェクトとして実験内部で利用できます。
+　CoderではCtrl-' and Ctrl-Shift-'でコードをコメント化、コメント化解除することが出来ます。
+　刺激が表示されなくて困っていませんか？ 刺激の単位をpixに変更したのにサイズを0.1のままにしていると大きさがたったの0.1ピクセルになってしまいますよ！
+　PsychoPyでは色のRGB値を-1.0から1.0で表します。RGB値がすべて0.0なら灰色、-1.0なら黒、1.0なら白です。
+　データはさまざまな形式で出力できますが、psydat(pickle形式)ファイルはPythonユーザーにとってはとても便利です。直接エディタで開いて読むことは出来ませんが、実験条件ファイルを含む実験の全ての情報のコピーが保存されています。
+　PsychoPyの月別利用者数を https://usage.psychopy.org で見ることが出来ます。
+　Builderでは Ctrl + = または Ctrl + -でFlowのアイコンの大きさを変更できます。同様に、Ctrl + Shift + =とCtrl + Shift + -でRoutineのアイコンの大きさを変更できます。(Macの人はCtrlの代わりにCmdキーを使いましょう)
+　Builderでフローの表示サイズが最大の時にCtrl + =を押すとループやルーチンの詳細が表示されます。表示サイズが最小の時にCtrl + -を押すと表示されなくなります。
+　Builderで"You win \$5.00!"のように$記号を含む文字列を表示したい場合は、$の前に\を付けて\$と書くに必要があります。ただしCodeコンポーネントでは必要ありません。
+　Builderでは、コンポーネントの追加、削除、変更といったいろいろな作業をCtrl + ZとCtrl + Shift + Zを押すことでやり直したり繰り返したりすることが出来ます。
+　PsychoPyが気に入ったらぜひ評判を広めてください。
+　Go/No-Go課題のように反応しないことを正答と記録したい場合は、正答にNoneを指定してください(Noneを' 'で囲んではいけません)。
+　Builderでの実験開始時に表示される実験情報ダイアログの項目は「実験の設定」ダイアログで変更できます。
+　オーディオ刺激でベストの時間精度を得るためにはPTBバックエンドを使用する必要があります(「設定」で指定できます)
+　Keyboardクラスはevent.getKeys()より時間精度に優れるうえ、キーを押していた時間や離した時刻も計測してくれます
+　所属部局にPavloviaのライセンスを購入してもらいましょう！ PsychoPy開発の支援になりますし、無制限にオンライン実験を実行できるようになります。
+　Coderを使用中に関数の引数を忘れてしまったことはないですか？ (を入力した後Ctrl + Shift + Spaceを押せばヘルプが表示されます。ESCかEnterを押すと閉じます。
+　CoderでCtrl + Spaceを押すとコードの補完候補が表示されます。候補を選択して挿入するにはEnterを、キャンセルするにはESCを押しましょう。
+　「コード構造」は現在のファイルで定義されているクラスと関数の概要を表示します。項目をクリックすると定義されている位置へジャンプします。

psychopy/app/Resources/tips_zh_CN.txt

@@ -0,0 +1,45 @@
+Most dialogs have a help button that takes you to the relevant online documentation
+You can use "Ctrl + [" or "Ctrl + ]" to indent/outdent a block of code in Coder view
+Both in the Coder and Builder views have a demos menu with plenty of demos. There are more on Pavlovia.org
+From Builder you can use "Compile" to generate the Python script that controls your experiment, and view or edit it in the Coder. (Any edits are not reflected back in the Builder, however.)
+You should avoid snorting Pepsi
+Most buttons have helpful usage tips if you hover over them
+PsychoPy can handle many different units (degrees of visual angle, cm...) for your stimuli. But you need to tell it about your monitor first (see the online documentation on General > Units)
+Menu items show you the current key bindings (which can be configured in preferences)
+For brief stimuli, you should use frames rather than time to set the start/stop of your stimuli. Most monitor frame rates are precise to the microsecond!
+It's a really good idea to check your data are all being saved as you like BEFORE running all of your participants!
+Builder: right-clicking on any 'color' parameter will bring up the system's color-picker.
+The user forum is a great place to ask questions and receive updates, at https://discourse.psychopy.org
+If you do write to the forum, make it clear whether you're using Builder or Coder interfaces and which version/platform you use.
+You can add or remove Components to the Favorites by right-clicking on them. And you can control the maximum number of them in preferences.
+You can use the source. PsychoPy comes with all its source code included. If you know Python, you'd be surprised how easy it is to find your own bug-fixes.
+Degrees of visual angle are 'device independent'. Normalized units mean that your stimulus will be different on each different computer. Do you really want that?
+Chocolate probably won't help, but does that mean you shouldn't try it?
+For fMRI block designs you want to use non-slip timing (trials of pre-determined duration). Builder indicates these with a green icon in the Flow panel
+Builder: you can often right click on things to bring up a menu, e.g., to remove a trial.
+Coder: you can click the color-picker icon on the toolbar. The R,G,B color triplet will be saved to the clipboard (in PsychoPy's rgb color units, -1..+1 not 0..255), which you can then paste into a script.
+If you have a tip that you'd like to added here, email it to the users list.
+To flip an image stimulus, give it a negative 'size', in x, y or both
+PsychoPy is free. Please cite the most recent paper (Peirce et al 2019) if you use PsychoPy in published work
+Builder: To set stimulus position to your variables X and Y, you can use either $[X,Y] or [$X,Y]. (A $ anywhere indicates that the entire entry box is Python code)
+You should wear sunscreen. (Where does it say these tips have to be original?!)
+In Python, the values True and False must have capitals and really just stand for 1 and 0.
+Builder: The contents of the dialog box at the start of your experiment are controlled from the Experiment Settings button. You can use these values in your study by referring to the value in expInfo e.g. expInfo['participant']
+Coder: You can comment/uncomment entire blocks of code with Ctrl-' and Ctrl-Shift-'
+Did your stimulus not appear? Was it really tiny? Setting units='pix' and size=0.1 means it has a size of 0.1 pixels!
+The default color values in PsychoPy range from -1 to +1, with 0 being the mean grey of the screen. So black is like the maximum decrement from grey and white is an increment. Right?
+Data can be output in many different formats, but it's worth saving the 'psydat' (aka pickle) format as well as the others. Although this isn't "human readable" it stores more information than excel/csv files including an entire copy of your actual experiment!
+You can see how many people used PsychoPy this month at https://usage.psychopy.org
+Builder: You can increase or decrease the display size of the flow using "Ctrl + =" or "Ctrl + -" (like some web browsers). Similarly, you can change the display size of routines using "Ctrl + Shift + =" and "Ctrl + Shift + -". (Use "Cmd" on Mac, not "Ctrl".)
+In the Builder, you can display details about the trials and sequences of loops. Press "Ctrl + =" when at the largest view size. To turn off, press "Ctrl + -" from the smallest view size.
+Builder: To put a $ symbol in a stimulus, you need to use \$, like this: "You win \$5.00!". (This is only for input boxes, and not for code components.)
+You can use "Ctrl + Z" and "Ctrl + Shift + Z" to undo and redo many of the actions in the Builder, such as adding, deleting, or changing something.
+In Builder you can control what appears in the 'Experiment Info' dialog box in the Experiment Settings
+If you like PsychoPy spread the word
+Sometimes the correct response on a given trial is not to respond at all, such as in a go/no-go task. To score such responses properly, enter 'None' as the correct answer (no quotes) in the Builder dialog box.
+For the best audio timing you need to use the 'PTB' backend (set this in the app Preferences).
+The Keyboard class has better timing than event.getKeys() and also reports key duration when the key has been released.
+Get your department to buy a site licence for Pavlovia.org. You'll be helping fund PsychoPy development and you'll be able to run unlimited online studies.
+Coder: Can't remember arguments for a class or function? Use "Ctrl + Shift + Space" after the first brace to bring up a calltip. Press "Esc" or "Enter" to close it.
+Coder: Use "Ctrl + Space" to bring up a list of code completion suggestions. Press "Enter" to insert the selected suggestion into your code or "Esc" to cancel.
+Coder: The "Code Structure" pane shows an outline of classes and functions defined in the current file. Click on items to go to where they are defined.

psychopy/app/__init__.py

@@ -0,0 +1,339 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Part of the PsychoPy library
+# Copyright (C) 2002-2018 Jonathan Peirce (C) 2019-2025 Open Science Tools Ltd.
+# Distributed under the terms of the GNU General Public License (GPL).
+
+"""Module for the PsychoPy GUI application.
+"""
+
+__all__ = [
+    'startApp',
+    'quitApp',
+    'restartApp',
+    'setRestartRequired',
+    'isRestartRequired',
+    'getAppInstance',
+    'getAppFrame',
+    'isAppStarted']
+
+import sys
+import os
+from .console import StdStreamDispatcher
+from .frametracker import openFrames
+
+# Handle to the PsychoPy GUI application instance. We need to have this mainly
+# to allow the plugin system to access GUI to allow for changes after startup.
+_psychopyAppInstance = None
+
+# Flag to indicate if the app requires a restart. This is set by the app when
+# it needs to restart after an update or plugin installation. We can check this
+# flag to determine if the app is in a state that it is recommended to restart.
+REQUIRES_RESTART = False
+
+
+# Adapted from
+# https://code.activestate.com/recipes/580767-unix-tee-like-functionality-via-a-python-class/
+# (BSD 3-Clause)
+class _Tee(object):
+    def __init__(self, fid):
+        self._other_fid = fid
+
+    def write(self, s):
+        sys.__stdout__.write(s)
+        self._other_fid.write(s)
+
+    def writeln(self, s):
+        self.write(s + '\n')
+
+    def close(self):
+        self._other_fid.close()
+
+    def flush(self):
+        self._other_fid.flush()
+        sys.__stdout__.flush()
+
+
+def startApp(
+        showSplash=True, 
+        testMode=False, 
+        safeMode=False, 
+        startView=None,
+        startFiles=None,
+        firstRun=False,
+        profiling=False,
+    ):
+    """Start the PsychoPy GUI.
+
+    This function is idempotent, where additional calls after the app starts
+    will have no effect unless `quitApp()` was previously called. After this
+    function returns, you can get the handle to the created `PsychoPyApp`
+    instance by calling :func:`getAppInstance` (returns `None` otherwise).
+
+    Errors raised during initialization due to unhandled exceptions with respect
+    to the GUI application are usually fatal. You can examine
+    'last_app_load.log' inside the 'psychopy3' user directory (specified by
+    preference 'userPrefsDir') to see the traceback. After startup, unhandled
+    exceptions will appear in a special dialog box that shows the error
+    traceback and provides some means to recover their work. Regular logging
+    messages will appear in the log file or GUI. We use a separate error dialog
+    here is delineate errors occurring in the user's experiment scripts and
+    those of the application itself.
+
+    Parameters
+    ----------
+    showSplash : bool
+        Show the splash screen on start.
+    testMode : bool
+        Must be `True` if creating an instance for unit testing.
+    safeMode : bool
+        Start PsychoPy in safe-mode. If `True`, the GUI application will launch
+        with without loading plugins.
+    startView : str, None
+        Name of the view to start the app with. Valid values are 'coder',
+        'builder' or 'runner'. If `None`, the app will start with the default
+        view or the view specifed with the `PSYCHOPYSTARTVIEW` environment
+        variable.
+
+    """
+    global _psychopyAppInstance
+
+    if isAppStarted():  # do nothing it the app is already loaded
+        return  # NOP
+
+    # Make sure logging is started before loading the bulk of the main
+    # application UI to catch as many errors as possible. After the app is
+    # loaded, messages are handled by the `StdStreamDispatcher` instance.
+    prefLogFilePath = None
+    if not testMode:
+        from psychopy.preferences import prefs
+        from psychopy.logging import console, DEBUG
+
+        # construct path to log file from preferences
+        userPrefsDir = prefs.paths['userPrefsDir']
+        prefLogFilePath = os.path.join(userPrefsDir, 'last_app_load.log')
+        lastRunLog = open(prefLogFilePath, 'w')  # open the file for writing
+        console.setLevel(DEBUG)
+
+        # NOTE - messages and errors cropping up before this point will go to
+        # console, afterwards to 'last_app_load.log'.
+        if sys.platform == 'win32' and sys.executable.endswith('pythonw.exe'):
+            sys.stderr = sys.stdout = lastRunLog
+        else:
+            sys.stderr = sys.stdout = _Tee(lastRunLog)  # redirect output to file
+
+    # Create the application instance which starts loading it.
+    # If `testMode==True`, all messages and errors (i.e. exceptions) will log to
+    # console.
+    from psychopy.app._psychopyApp import PsychoPyApp
+    _psychopyAppInstance = PsychoPyApp(
+        0, 
+        testMode=testMode, 
+        showSplash=showSplash, 
+        safeMode=safeMode, 
+        startView=startView,
+        startFiles=startFiles,
+        firstRun=firstRun,
+        profiling=profiling,
+    )
+
+    # After the app is loaded, we hand off logging to the stream dispatcher
+    # using the provided log file path. The dispatcher will write out any log
+    # messages to the extant log file and any GUI windows to show them to the
+    # user.
+
+    # ensure no instance was created before this one
+    if StdStreamDispatcher.getInstance() is not None:
+        raise RuntimeError(
+            '`StdStreamDispatcher` instance initialized outside of `startApp`, '
+            'this is not permitted.')
+
+    stdDisp = StdStreamDispatcher(_psychopyAppInstance, prefLogFilePath)
+    stdDisp.redirect()
+
+    if not testMode:
+        # Setup redirection of errors to the error reporting dialog box. We
+        # don't want this in the test environment since the box will cause the
+        # app to stall on error.
+        from psychopy.app.errorDlg import exceptionCallback
+
+        # After this point, errors will appear in a dialog box. Messages will
+        # continue to be written to the dialog.
+        sys.excepthook = exceptionCallback
+
+        # Allow the UI to refresh itself. Don't do this during testing where the
+        # UI is exercised programmatically.
+        _psychopyAppInstance.MainLoop()
+
+
+def quitApp():
+    """Quit the running PsychoPy application instance.
+
+    Will have no effect if `startApp()` has not been called previously.
+
+    """
+    if not isAppStarted():
+        return
+
+    global _psychopyAppInstance
+    if hasattr(_psychopyAppInstance, 'quit'):  # type check
+        _psychopyAppInstance.quit()
+        # PsychoPyApp._called_from_test = False  # reset
+        _psychopyAppInstance = None
+    else:
+        raise AttributeError('Object `_psychopyApp` has no attribute `quit`.')
+
+
+def restartApp():
+    """Restart the PsychoPy application instance.
+
+    This will write a file named '.restart' to the user preferences directory
+    and quit the application. The presence of this file will indicate to the
+    launcher parent process that the app should restart.
+
+    The app restarts with the same arguments as the original launch. This is
+    useful for updating the application or plugins without requiring the user
+    to manually restart the app.
+
+    The user will be prompted to save any unsaved work before the app restarts.
+
+    """
+    if not isAppStarted():
+        return
+
+    # write a restart file to the user preferences directory
+    from psychopy.preferences import prefs
+    restartFilePath = os.path.join(prefs.paths['userPrefsDir'], '.restart')
+
+    with open(restartFilePath, 'w') as restartFile:
+        restartFile.write('')  # empty file
+
+    quitApp()
+
+
+def setRestartRequired(state=True):
+    """Set the flag to indicate that the app requires a restart.
+
+    This function is used by the app to indicate that a restart is required
+    after an update or plugin installation. The flag is checked by the launcher
+    parent process to determine if the app should restart.
+
+    Parameters
+    ----------
+    state : bool
+        Set the restart flag. If `True`, the app will restart after quitting.
+
+    """
+    global REQUIRES_RESTART
+    REQUIRES_RESTART = bool(state)
+
+
+def isRestartRequired():
+    """Check if the app requires a restart.
+
+    Parts of the application may set this flag to indicate that a restart is
+    required after an update or plugin installation.
+
+    Returns
+    -------
+    bool
+        `True` if the app requires a restart else `False`.
+
+    """
+    return REQUIRES_RESTART
+
+
+def getAppInstance():
+    """Get a reference to the `PsychoPyApp` object.
+
+    This function will return `None` if PsychoPy has been imported as a library
+    or the app has not been fully realized.
+
+    Returns
+    -------
+    PsychoPyApp or None
+        Handle to the application instance. Returns `None` if the app has not
+        been started yet or the PsychoPy is being used without a GUI.
+
+    Examples
+    --------
+    Get the coder frame (if any)::
+
+        import psychopy.app as app
+        coder = app.getAppInstance().coder
+
+    """
+    return _psychopyAppInstance  # use a function here to protect the reference
+
+
+def setAppInstance(obj):
+    """
+    Define a reference to the current PsychoPyApp object.
+
+    Parameters
+    ----------
+    obj : psychopy.app._psychopyApp.PsychoPyApp
+        Current instance of the PsychoPy app
+    """
+    global _psychopyAppInstance
+    _psychopyAppInstance = obj
+
+
+def isAppStarted():
+    """Check if the GUI portion of PsychoPy is running.
+
+    Returns
+    -------
+    bool
+        `True` if the GUI is started else `False`.
+
+    """
+    return _psychopyAppInstance is not None
+
+
+def getAppFrame(frameName):
+    """Get the reference to one of PsychoPy's application frames. Returns `None`
+    if the specified frame has not been fully realized yet or PsychoPy is not in
+    GUI mode.
+
+    Parameters
+    ----------
+    frameName : str
+        Identifier for the frame to get a reference to. Valid names are
+        'coder', 'builder' or 'runner'.
+
+    Returns
+    -------
+    object or None
+        Reference to the frame instance (i.e. `CoderFrame`, `BuilderFrame` or
+        `RunnerFrame`). `None` is returned if the frame has not been created or
+        the app is not running. May return a list if more than one window is
+        opened.
+
+    """
+    if not isAppStarted():  # PsychoPy is not in GUI mode
+        return None
+
+    if frameName not in ('builder', 'coder', 'runner'):
+        raise ValueError('Invalid identifier specified as `frameName`.')
+
+    # open the requested frame if no yet loaded
+    frameRef = getattr(_psychopyAppInstance, frameName, None)
+    if frameRef is None:
+        if frameName == 'builder' and hasattr(_psychopyAppInstance, 'showBuilder'):
+            _psychopyAppInstance.showBuilder()
+        elif frameName == 'coder' and hasattr(_psychopyAppInstance, 'showCoder'):
+            _psychopyAppInstance.showCoder()
+        elif frameName == 'runner' and hasattr(_psychopyAppInstance, 'showRunner'):
+            _psychopyAppInstance.showRunner()
+        else:
+            raise AttributeError('Cannot load frame. Method not available.')
+
+        frameRef = getattr(_psychopyAppInstance, frameName, None)
+
+    return frameRef
+
+
+if __name__ == "__main__":
+    pass

psychopy/app/__main__.py

@@ -0,0 +1,3 @@
+from psychopy.app.psychopyApp import main
+
+main()