Difference between revisions of "TotalRecall"

From Computational Memory Lab
Jump to: navigation, search
 
(80 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
+
[[File:TotalRecall_screenshot.png|thumb|400px|TotalRecall in action. Click to embiggen.]]
<!-- #acl yuvi:read,write Known:read -->
+
An easy-to-use tool for quickly annotating audio files
  
<<html(<h1>Penn [[TotalRecall]]</h1>)>>
+
== Overview ==
 
+
Penn TotalRecall is designed for precise scoring and timing of participant responses during verbal tasks, especially Free Recall. However, it can be used for many kinds of audio annotation. TotalRecall displays an audio recording as a self-scrolling waveform that automatically keeps up with audio playback.
An easy-to-use tool for quickly annotating audio files.
+
 
+
<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/mac_screenshot.png" alt="screenshot" width=800>)>>
+
 
+
<<[[TableOfContents]](3)>>
+
 
+
= Overview =
+
TotalRecall is designed for precise scoring and timing of participant responses during verbal tasks, especially Free Recall. However, it can be used for many kinds of audio annotation. TotalRecall displays an audio recording as a self-scrolling waveform that automatically keeps up with audio playback.
+
  
 
TotalRecall is used on a daily basis by many in the Computational Memory Lab. Support and maintenance will continue indefinitely with new features being added as needed.
 
TotalRecall is used on a daily basis by many in the Computational Memory Lab. Support and maintenance will continue indefinitely with new features being added as needed.
  
= Download =
+
== Download ==
{| border="1" cellpadding="2" cellspacing="0"
+
{| cellpadding="5" cellspacing="0"
 
|   
 
|   
 
| '''Operating System'''
 
| '''Operating System'''
 
| '''Type'''
 
| '''Type'''
| '''Stable'''
 
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/mac_icon.png" alt="mac icon">|)>>
+
|[[File:mac_icon.png]]
| Mac OSX
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PTR.app.tar.gz Mac OSX]
 
| Mac OSX App
 
| Mac OSX App
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.dmg download v0.52]
 
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/ubuntu_icon.png" alt="ubuntu icon">|)>>
+
|[[File:ubuntu_icon.png]]
| Linux
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.deb Linux]
 
| Debian Package
 
| Debian Package
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.deb download v0.53]
 
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/windows_icon.png" alt="windows icon">|)>>
+
|[[File:windows_icon.png]]
| Windows
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall_Setup.exe Windows]
 
| Windows Installer
 
| Windows Installer
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall_Setup.exe download v0.54]
 
 
|-
 
|-
|<<html(<img src="http://memory.psych.upenn.edu/files/software/TotalRecall/images/zip_icon.png" alt="zip icon" width=32>|)>>
+
|[[File:github_icon.png|32px]]
| Other
+
| [http://github.com/memlab/Penn-TotalRecall Source Code]
| Source Code
+
| [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/PennTotalRecall.zip download v0.54]
+
 
|}
 
|}
  
/* == Launch with Java Web Start == */
+
== Getting started ==
/* <<html(<a href="http://memory.psych.upenn.edu/files/software/TotalRecall/JavaWebStartAppPage.html"> <img src="http://memory.psych.upenn.edu/files/software/TotalRecall/webstart.png"/></a>)>> */
+
 
+
= Getting started =
+
 
Download the file for your platform.
 
Download the file for your platform.
  
 
Install:
 
Install:
  
* Mac: double click the .dmg file and drag PennTotalRecall.app into the Applications folder.
+
* Mac: Unzip PTR.app.tar.gz. This should automatically happen when you click it in your downloads. Then move PTR.app into the Applications folder.
* Linux: double click the .deb file and click Install Package.
+
** [[#10.7_.28Lion.29_and_later|See below]] for special Gatekeeper issues.
* Windows: double click the .exe file and follow the instructions.
+
* Linux: Double click the .deb file and click Install Package.
 +
* Windows: Double click the .exe file and follow the instructions.
  
 
Now try running the program:
 
Now try running the program:
  
* Mac: search for Penn [[TotalRecall]] in Spotlight, or double click PennTotalRecall.app in Finder by going to the Applications folder.
+
* Mac: search for Penn TotalRecall in Spotlight, or double click PennTotalRecall.app in Finder by going to the Applications folder.
* Linux: on Ubuntu you can find Penn [[TotalRecall]] in the Applications --> Accessories menu.
+
* Linux: on Ubuntu you can find Penn TotalRecall in the Applications --> Accessories menu.
* Windows: you can find Penn [[TotalRecall]] in the start menu as usual. There should also be an icon on your desktop.
+
* Windows: you can find Penn TotalRecall in the start menu as usual. There should also be an icon on your desktop.
  
 
Try opening the wave file provided in this [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/sample.zip samples folder].
 
Try opening the wave file provided in this [http://memory.psych.upenn.edu/files/software/TotalRecall/downloads/stable/sample.zip samples folder].
Line 65: Line 49:
 
Check the menu items for actions and keybindings available to the user. Also check Help --> Key Bindings.
 
Check the menu items for actions and keybindings available to the user. Also check Help --> Key Bindings.
  
= Annotation guide =
+
<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
 +
=== 10.7 (Lion) and later ===
 +
<div class="mw-collapsible-content">
 +
The [http://support.apple.com/kb/ht5290 "Gatekeeper"] function in OS X is designed to keep your system safe from potentially harmful software. Unfortunately, they may also prevent you from opening "unsigned" applications like TotalRecall.
  
A [http://memory.psych.upenn.edu/TotalRecall/AnnotationGuide full guide to annotation] provided. It explains proper use of the program along with our internal annotation standards.
+
If you are unable to open TotalRecall on your Mac OS X system, please do the following:
  
= System requirements =
+
# Go into '''System Preferences''', then click '''Security & Privacy'''.
TotalRecall currently runs on Mac OSX, Linux and Windows. We plan to test and support [http://memory.psych.upenn.edu/TotalRecall/Development#Supportedconfigurations these] configurations, but the program may work on others.
+
#; [[File:Gatekeeper1.png|300px]]''(click to enlarge)''
 +
# Click the '''General''' tab, and select '''Anywhere''' under '''Allow applications downloaded from'''.
 +
#; [[File:Gatekeeper2.png|300px]]''(click to enlarge)''
 +
#: '''Note:''' You may need to authenticate as an administrator.
 +
# Open the TotalRecall application package. You may be warned about opening it for the first time.
 +
# After it opens for the first time, you may return the setting that you changed in Step 2 above to its previous selection if desired.
 +
 
 +
''Special thanks to [http://psych.colorado.edu/~mollison/ '''Matt Mollison'''] for noticing this problem, and finding a solution.''
 +
</div>
 +
</div>
 +
 
 +
== Video tutorials and written annotation guide ==
 +
 
 +
Our [[AnnotationGuide|full guide to annotation]] and [[Annotation tutorial videos|video tutorials]] explain proper use of TotalRecall, along with our internal annotation methods.
 +
 
 +
== System requirements ==
 +
TotalRecall currently runs on Mac OSX, Linux and Windows. We plan to test and support [[TotalRecall_Development#Supported_configurations|these]] configurations, but the program may work on others.
  
 
TotalRecall requires a Java Runtime Environment, version 5 or higher. Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements.
 
TotalRecall requires a Java Runtime Environment, version 5 or higher. Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements.
 
If it turns out you don't have Java, you can download it free [http://www.java.com/getjava/ here].
 
If it turns out you don't have Java, you can download it free [http://www.java.com/getjava/ here].
  
= Support, contact, and bug reports =
+
== Support, contact, and bug reports ==
Please submit bug reports and feature requests to our [http://github.com/ymasory/Penn-TotalRecall/issues issue tracking system] on GitHub.
+
Please feel free to contact us at: memory - software @ psych . upenn . edu (remove all the spaces).
* Click "Create Issue" toward the top left of the page. You will be prompted to sign in.
+
* Click "Pricing and Signup" and make a free account. You can leave the "SSH Public Key" field empty.
+
* Now return to the issue tracking page linked to above.
+
 
+
For other support or feedback please send emails to: memory - software @ psych . upenn . edu (remove all the spaces).
+
  
 
'''Thank you for taking the time to improve Penn TotalRecall!'''
 
'''Thank you for taking the time to improve Penn TotalRecall!'''
  
= Development =
+
== Data analysis ==
Please visit our [http://memory.psych.upenn.edu/TotalRecall/Development development page].
+
We also provide our [[behavioral_toolbox|Behavioral Toolbox]], a collection of MATLAB functions useful for analyzing the output of TotalRecall.
 +
 
 +
== Development ==
 +
Please visit our [[TotalRecall_Development|development page]].
 +
 
 +
For developers, please also visit our [[TotalRecall/Build]] page.
 +
 
 +
[[Category:TotalRecall]]

Latest revision as of 19:05, 26 March 2019

TotalRecall in action. Click to embiggen.

An easy-to-use tool for quickly annotating audio files

Overview

Penn TotalRecall is designed for precise scoring and timing of participant responses during verbal tasks, especially Free Recall. However, it can be used for many kinds of audio annotation. TotalRecall displays an audio recording as a self-scrolling waveform that automatically keeps up with audio playback.

TotalRecall is used on a daily basis by many in the Computational Memory Lab. Support and maintenance will continue indefinitely with new features being added as needed.

Download

Operating System Type
Mac icon.png Mac OSX Mac OSX App
Ubuntu icon.png Linux Debian Package
Windows icon.png Windows Windows Installer
Github icon.png Source Code

Getting started

Download the file for your platform.

Install:

  • Mac: Unzip PTR.app.tar.gz. This should automatically happen when you click it in your downloads. Then move PTR.app into the Applications folder.
  • Linux: Double click the .deb file and click Install Package.
  • Windows: Double click the .exe file and follow the instructions.

Now try running the program:

  • Mac: search for Penn TotalRecall in Spotlight, or double click PennTotalRecall.app in Finder by going to the Applications folder.
  • Linux: on Ubuntu you can find Penn TotalRecall in the Applications --> Accessories menu.
  • Windows: you can find Penn TotalRecall in the start menu as usual. There should also be an icon on your desktop.

Try opening the wave file provided in this samples folder.

Check the menu items for actions and keybindings available to the user. Also check Help --> Key Bindings.

10.7 (Lion) and later

The "Gatekeeper" function in OS X is designed to keep your system safe from potentially harmful software. Unfortunately, they may also prevent you from opening "unsigned" applications like TotalRecall.

If you are unable to open TotalRecall on your Mac OS X system, please do the following:

  1. Go into System Preferences, then click Security & Privacy.
    Gatekeeper1.png(click to enlarge)
  2. Click the General tab, and select Anywhere under Allow applications downloaded from.
    Gatekeeper2.png(click to enlarge)
    Note: You may need to authenticate as an administrator.
  3. Open the TotalRecall application package. You may be warned about opening it for the first time.
  4. After it opens for the first time, you may return the setting that you changed in Step 2 above to its previous selection if desired.

Special thanks to Matt Mollison for noticing this problem, and finding a solution.

Video tutorials and written annotation guide

Our full guide to annotation and video tutorials explain proper use of TotalRecall, along with our internal annotation methods.

System requirements

TotalRecall currently runs on Mac OSX, Linux and Windows. We plan to test and support these configurations, but the program may work on others.

TotalRecall requires a Java Runtime Environment, version 5 or higher. Most computers come with Java pre-installed, so you can probably download and run the program without worrying about system requirements. If it turns out you don't have Java, you can download it free here.

Support, contact, and bug reports

Please feel free to contact us at: memory - software @ psych . upenn . edu (remove all the spaces).

Thank you for taking the time to improve Penn TotalRecall!

Data analysis

We also provide our Behavioral Toolbox, a collection of MATLAB functions useful for analyzing the output of TotalRecall.

Development

Please visit our development page.

For developers, please also visit our TotalRecall/Build page.