Installation Instructions First Pilots

From wiki.gpii
Jump to: navigation, search


Note: The instructions in this page are specific to the first pilot phase in Cloud4all (which ran in 2013). For Cloud4all's second pilot phase, see Cloud4all Pilot 2 - Set up and installation. For a set-up that can be used for development, see Setting Up Your Development Environment and Core (real-time) Framework v0.2 - Installation Instructions.


Hardware Requirements

The hardware requirements are based on the needs for the matchmakers (as documented in the experimental plans).

  • 1 gigahertz (GHz) or faster 32-bit (x86) or 64-bit (x64) processor.
  • 1 gigabyte (GB) RAM (32-bit) or 2 GB RAM (64-bit).
  • For matchmaker testing: 660 MB available hard disk space (150 MB for the Architecture + 126 MB for Java SE Runtime Environment + 100 MB for rule-based MM + 2 MB for statistical MB + 50 MB for NVDA + 200 MB for Firefox + some space for the installers, which can be removed after the installation process)
  • Internet access (because the Preferences Server will not be running locally).
  • speakers (for speech output by the screen readers).
  • Braille display, if available at the test site; check in advance whether it can be used with both NVDA and Orca.

Note: The processor and memory requirements are based on Windows 7. The requirements for Fedora 18 are less heavy:

  • 400MHz or faster processor.
  • at least 768 MB memory (RAM), 1 GB recommended.
  • at least 10 GB hard drive space.

Pilots Branch on Windows 7

Setting up your Environment

GPII Framework Dependencies

(These dependencies are also listed in the framework installation page.)

  • Node:
  • Microsoft Hotfix for issue KB2516889 (this issue prevents the application of the "High Contrast" desktop profile on all modern versions of Windows, i.e. versions 7 and 8):

Matchmaker Dependencies

In addition to the dependencies for the core framework, the rule-based matchmaker also requires a Java runtime environment (JRE). Check that your Windows system has a JRE by opening a command-line window and entering the command "java -version". If no JRE is found, or if the JRE is older than version 1.6, please download and install an up-to-date JRE.

If after installation, the java -version command is still not working, you need to add Java to your path. To do this, first find out where your Java installation is. Inside that directory, there should be a folder called bin, which should contain java.exe (e.g. C:\Program Files\Java\jre7\bin). Add the address of that bin directory to your PATH variable (right-click My Computer > Properties > Advanced > Environment Variables). After adding this directory to the PATH variable, you will need to restart the command line - but then the "java -version" command should work.

For the matchmaker tests on Windows, it is also necessary to install Firefox (Fedora contains Firefox by default) and NVDA (Fedora has Orca by default). After installing NVDA, you should start and stop it before performing the first tests.

In the Firefox options, disable the option to store passwords, in order to prevent dialogs that ask the user whether he/she wants to store the password for the test web site that is used during the matchmaker testing.

Building and Starting

Preparation

Create a new directory; for example: c://gpii_pilots

Download all repositories (use git terminal)

  • Open git terminal and go to the directory created above for example: cd c:\gpii_pilots
  • Run command: git clone git://github.com/GPII/windows.git -b pilot

Build GPII (use git terminal)

  • Go to the windows dir: cd c:\gpii_pilots\windows
  • Run command: build.cmd

Troubleshooting

  • If you have problems running the git clone commands due to the git:// protocol (eg. because of firewalls or the like) you can run the following command:
git config --global url."https://".insteadOf git://

Create a shortcut and start GPII

Run GPII in conjunction with RB-MM or SS-MM

  • Go to windows dir, press alt and drag files start_RB.cmd and start_ST.cmd to your desktop to create a shortcut. (If you like, you can rename these shortcuts to "Rule-based MM" and "Statistical MM": select the shortcut, press F2 and type a new name.)
  • Doubleclicking on the shortcut start_RB.cmd on your desktop will run the GPII in conjunction with the rule-based matchmaker.
  • Doubleclicking on the shortcut start_ST.cmd on your desktop will run the GPII in conjunction with the statistical matchmaker.

Run GPII in default mode

  • Go to windows dir, press alt and drag file start.cmd to your desktop to create a shortcut.
  • Double click on the shortcut start.cmd, you have created on your desktop, will run the GPII in default mode.

User login and logout (user token is the id that you gave a user in the N/P gathering tool)

  • Log the user in with: http://localhost:8081/user/USER TOKEN/login
  • Log the user out with: http://localhost:8081/user/USER TOKEN/logout

Update the latest version of code (use git terminal)

  • Go to the gpii/windows directory and run the following commands:
    • git fetch origin
    • git pull origin pilot
  • Then go to gpii/node_modules/universal and run the following commands:
    • git fetch origin
    • git pull origin pilot

Note: If you installed the framework before 31 May 2013, the above update instructions are not sufficient (due to changed references to external libraries in the gpii/node_modules/universal/package.json file). After the git updates, follow these steps:

  • Go to the directory gpii/node_modules/universal and delete the subdirectory node_modules (e.g. type del /s /q node_modules).
  • Then, while still in the directory gpii/node_modules/universal, run npm install.

Troubleshooting

  • Problem with High Contrast on Windows 7 64-bit

Screencasting on Windows

Use, for example, SMRecorder.

When installing SMRecorder, choose "custom installation" in order to avoid the installation of browser plugins, Smart Suggestor and many "special offers" (sometimes you need to uncheck a checkbox, sometimes you need to use a "Skip" button to avoid the unnecessary extras).

Pilots branch on Fedora 18

Notes about the RPM packages

These RPMs are specific builds for the 1st Cloud4all pilots iteration. These RPMs provide a concrete version of Node.js (0.9.5). This will avoid any issue with upcoming Node.js versions on Fedora's 'updates' repo. The GPII framework does not auto-start at GNOME session user login time.

Preparation and addition of the Pilots2013 repo to your system

If you are NOT using a fresh installation of Fedora 18, be sure to uninstall the node.js and related packages by running the following command in a terminal window:

  • sudo yum remove nodejs v8 libuv

If you are using a fresh installation of Fedora 18 (or already removed nodejs in the previous step), you should add the repository by running the following command in a terminal window:

  • sudo yum-config-manager --add-repo=http://download.opensuse.org/repositories/home:/javihernandez:/GPII:/Cloud4all:/Pilots2013/Fedora_18/home:javihernandez:GPII:Cloud4all:Pilots2013.repo

To avoid updates, disable all updates repositories by running the following command in a terminal window:

  • sudo yum-config-manager --disable updates*
  • Note: don't forget the asterisk at the end. This makes sure that fedora-updates and fedora-updates-testing are disabled.

Install GPII (use terminal)

  • Run the following command in a terminal window: sudo yum install gpii-linux gpii-linux-rfid-listener

Start GPII

  • Press Super key (or windows key) and start typing the word "gpii". Then you'll see three application launchers
    • GPII Development Mode - This launcher will run GPII in default mode
    • GPII Rule Based - This launcher will run GPII in conjunction with RB-MM
    • GPII Statistical - This launcher will run GPII in conjunction with ST-MM

Note that by launching the GPII a terminal window will appear. Do not close it, only close it when you want to stop the GPII framework.

User login and logout (user token is the id that you gave a user in the N/P gathering tool)

  • Log the user in with: http://localhost:8081/user/USER TOKEN/login
  • Log the user out with: http://localhost:8081/user/USER TOKEN/logout

Additional notes

Installing required software for the Pilots

  • Run command: sudo yum install gnome-tweak-tool dconf-editor

Installing additional software on Fedora

If you need to install other software (and did not disabled the updates repository), be sure to add the "--disablerepo=updates*" option to yum, ie:

  • Run command: sudo yum install package1 package2 package3 --disablerepo=updates*

Updating the RPM packages of the GPII personalization framework

  • Run command: sudo yum update gpii-linux gpii-core gpii-linux-rfid-listener

Before starting the tests

  • Be sure that the Orca Screen Reader is "talking" properly.
  • If you want to use Firefox with Orca, be sure to start Orca before Firefox!!

Screencasting on Fedora

  • recordMyDesktop is a command-line tool that outputs screencasts to Ogg Vorbis. It is available by default in Fedora 18.
  • gtk-recordMyDesktop is a GUI front end for recordMyDesktop.
    • To install it, press the Super key or the Windows key, enter "software" and press Enter. In this GUI search for "gtk-recordmydesktop", select the package in the search results and press the "Apply Changes" button to install it. (Alternatively, you can also install the GUI front end by typing sudo yum install gtk-recordmydesktop --disablerepo=updates* in a terminal window.)
    • To run gtk-recordmydesktop, press the Super key or the Windows key, enter "gtk-recordmydesktop" and press Enter. You can choose the video and audio quality of the recording and the directory and file name where the recording should be saved. (You can also check a tutorial for both recordMyDesktop and gtk-recordMyDesktop on Fedora and this tutorial for gtk-recordMyDesktop on Ubuntu.)

NPGatheringTool

Matchmaker Logs

The log files have names that use the naming convention yyyy-mm-dd__hh-mm-ss_xxxxMM_phase:

  • yyyy-mm-dd stands for the date (year-month-day),
  • hh-mm-ss stands for the time (hours-minutes-seconds) adapted to the local time zone,
  • xxxxMM stands for the matchmaker: ruleMM for the rule-based matchmaker, statMM for the statistical matchmaker,
  • phase stands for the phase in the matchmaking process: ante refers to the input that the matchmaker received, while post (or intermediate for the rule-based matchmaker) refers to what the matchmaker outputs.

The log file containing the final settings uses the same date and time convention but ends with the string post_lifecycleManager.

Under Windows, the log files created by the matchmakers can be found under C:\logs (assuming that you installed the matchmaker code in the C partition of your hard disk). This directory is created by the matchmaker if it does not already exist.

Under Fedora, logs are supposed to go to /logs, but the matchmaker has no permissions to create that folder. In order to get logs in that directory, do the following in the terminal:

  • Go to the root of the file system by typing cd /.
  • Create a directory called logs using the following command: sudo mkdir logs. Now there is the directory, but the matchmaker does not have permission to write to it.
  • Enable write access for the matchmaker using the following command: sudo chmod 777 /logs. (As a consequence of this, "the whole world" — anyone with access to the PC — has write access to this directory. After the tests, the directory should be removed, or its original permissions should be restored with the command sudo chmod 755 /logs.)