Running eDom


The following instructions will allow you to run the simple demo norming experiment that comes with the eDom software.  They can also be used to start eDom and run your own experiment after you have set up an experiment.  Before creating your own experiment, it may be worth testing eDom using the included demo experiment to ensure that the software has been installed correctly and functions on your system.

Running the Source Code Version



To run the source code in MATLAB, set the current directory to the root eDom (./eDom) directory either via the File menu in the GUI or using the cd() command,  then run ./eDom/src/eDom.m.  If you are prompted to change the current directory or add it to the current PATH, select add to PATH -- the current directory must be set to the root eDom directory for the relative pathing used by eDom to function correctly.


Running the Standalone Version


Important note on 'Errors' raised by the standalone Version of SOS

Differences in the details and sophistication of how the MATLAB runtime component is implemented on Windows/OSX/Linux sometimes cause different 'errors' to be raised in the console/command line interface.  This is particularly (but not exclusively) the case when using the graphical interface, which has been made into an integral part of the standalone version to ensure that all users have access to the broadest set of functionality as is possible.  For instance, users may encounter messages such as:

[On eDom startup]

??? Undefined function or variable

'internal.matlab.desktop.editor.breakpointsForAllFiles'.

 [When Using eDom]

??? Error using ==> eval

Undefined function or variable 'hfudge'.

Error in ==> movegui at 114

Error in ==> openfig at 109

Error in ==> gui_mainfcn>local_openfig at 286

Error in ==> gui_mainfcn at 234

Error in ==> eDomi at 74


These errors do not appear to be unique to eDom and are encountered with other similarly-complex standalone executables generated from MATLAB source code. Critically, however, the eDom software nevertheless runs properly and optimizations can be completed successfully by ignoring these messages.  To date, we have not discovered a better solution to these non-critical errors, but if one is discovered an updated version of the software will be created.

Windows

After the MATLAB component runtime has been installed, you may start eDom by launching the executable (eDom.exe) in the directory where the compressed files were extracted.  

Optionally, you may wish to start eDom from the command line. This may be done via Start-->Run-->'cmd' to start command line interface; then navigate to the eDom directory and type 'eDom.exe'.  This will allow for eDom's textual output to persist once the program exits and may be useful for debugging or logging purposes.


Linux and OSX users

From a console/terminal/command line interface, run the 'run_eDom_linux.sh' shell script located in the INSTALLDIR where the eDom archive was uncompressed (but see the note below if you have problems).  You should be able to do this directly in a shell such as BASH without forcing the use of a different shell.  If the file is not labeled as executable, you may need to 'chmod' it to allow this (type 'man chmod' in a console for help in doing this).  


If you receive a message indicating that you must pass in the <deployedMCRroot>, you will also need to supply this information when running eDom.  For instance, starting eDom might require a command such as the following, which assumes that the user is in INSTALLDIR and installed the MCR to '~/MCR':


./run_eDom.sh ~/MCR/v7141/

Note that this requires passing in the name of the subfolder ('v7141') in the base folder ('~/MCR') in which you may have installed the MCR.



Specifying the Participant Number


Once eDom has been initialized, it will prompt you to input a participant number and a directory in which to store a participant's data.  By convention the participant numbers should begin at 101 and increase sequentially.  Only integers are allowed (no text or .txt suffix).  Adherance to this convention is NECESSARY if using 'participantLists' so that an appropriate list for each participant can be loaded and to ensure equal sampling of all words in the population.  

Inputting the participant number

If a previous participant's data should be overridden for some reason, simply specify their participant number a second time and you will be prompted to confirm that the old data should be overridden.  


By convention, the participant's data should be stored in ./eDom/output.


Patience is a Virtue

Once a participant number has been specified, eDom will prepare all of the definition files for presentation during the experiment.  Note that if the population list is very large and/or eDom is run from a network drive, this may take more than a minute to complete.

Once the definitions have been loaded, the norming experiment begins automatically.  


Blair Armstrong, Natasha Tokowicz, David Plaut, 2011-