Qwalkeko user study

Installation instructions

  1. If you haven't already, install the Eclipse IDE. The installer application will first ask which Eclipse variant it should download. Please choose the second option, "Eclipse IDE for Java EE Developers".)
  2. Start Eclipse, and install the "Counterclockwise" plugin:
    1. Go to Help > Eclipse marketplace...
    2. Search for "Counterclockwise"
    3. Click "Install".
  3. Next, install the Ekeko/X plugin (We only need this for its AST browser.):
    1. Go to Help > Install new software...
    2. In the "Work with:" text box, enter the URL: http://soft.vub.ac.be/~cderoove/eclipse
    3. Only add a checkbox next to Ekeko-based program transformation > Ekeko/X
    4. Click "Next" and follow the usual installation steps.
  4. Download the following file: http://soft.vub.ac.be/~tmoldere/qwalkeko/Qwalkeko-UserStudy-2.zip
  5. The .zip file contains a number of Eclipse projects; we'll now import them all:
    1. Go to File > General > "Existing projects into workspace"
    2. Select the .zip file ("Browse" button next to "Select archive file:").
    3. Ensure all projects are selected, and click "Finish". (Wait a few seconds for the compilation process to finish.)

Getting started

  1. To start Qwalkeko:
    1. In Eclipse, look for the EkekoPlugin.launch file in the damp.ekeko.plugin project.
    2. Right-click it > Run as > EkekoPlugin.
    3. A new Eclipse instance (with the Qwalkeko plugin enabled) will now start. (It will automatically create its own workspace directory at ../qwalkeko-runtime-workspace)
  2. In the new Eclipse instance:
    1. Go to: Ekeko (menu bar) > Qwalkeko > Convert git repository
    2. Select the .git directory inside ~/eclipse-oxygen-workspace/QwalkekoWriting.
      (If you can't see the .git folder on a Mac, press Cmd+Shift+. to show hidden files.)
    3. A new project will appear. Right-click it and select Configure > Include in Ekeko queries
  3. Start a REPL via Ekeko > Start nREPL (A dialog box will open as a confirmation; click OK to close it.)
  4. Go back to your original Eclipse instance. In the console you'll see a message "Started Ekeko-hosted nREPL server: nrepl://localhost:xxxxx". Click on the nrepl:// link to access the REPL.
  5. In the project damp.qwalkeko.plugin, open the file src/qwalkeko/experiments/userstudy.clj
  6. Go to: Clojure (menu bar) > Load file in REPL (You'll get get one warning that "==" is being redefined; this is normal.)
  7. You're now ready to start writing queries.