This folder should contain at least:

ReadMe.txt - this file.
run.command - to run VARD 2 on Mac OSX
run.sh - to run VARD 2 on Linux ("chmod a+x run.sh" first)
run.bat - to run VARD 2 on Windows. (May appear just as "run")
gui.jar - graphical interface, do not run directly, use run.command/run.bat.
clui.jar - command line interface, run from command prompt, see below.
model.jar - the background system for VARD, cannot be run directly.
scowl directory - dictionaries used by VARD.

If all of the above are not present please download VARD 2 again. http://www.comp.lancs.ac.uk/~barona/vard2/.


To run VARD 2 use "run.bat" in Windows or "run.command" in other operating systems. The java runtime environment will be needed to run the tool.
This is available for free at http://www.java.com/getjava/.

Alternatively, open a command prompt, locate the VARD directory and type the following command:

java -Xms256M -Xmx512M -jar gui.jar

This will open the graphical user interface. 256 and 512 indicate the memory allocated to the Java Virtual Machine. The default values should be
sufficient for most uses of VARD 2, however if your system only has 512MB of memory, these can be reduced to 128 and 256. It is not recommended lowering
these values any further than 128/256. The higher figure should be no more than half of your system memory, the lower value should usually be half of the 
higher value.


Alternatively, a command line interface of VARD 2 is available. To run this use the following command:

java -Xms256M -Xmx512M -jar clui.jar "<setup directory>" <threshold int> <f-score weight int or fraction> "<input directory>" "<output directory>"

Again the memory values can be changed to match your system, but 256/512 should be adequate for most applications. The <> brackets should be replaced
with your own values:

<setup directory>: This is the setup folder VARD will use, this is equivalent to that chosen during the user interface selection screen. If the setup folder does not exist it will be created and default settings used.

<threshold int>: Indicates the confidence rating required for a variant replacement to be made by VARD. This should be an integer value between 0 and 100.
Training the tool in the interactive version will allow for more accurate replacements and give you an understanding of what figure to use. It is not advisable to batch process your texts without any training.

<f-score weight int or fraction>: Indicates the f-score weight used when calculating replacement scores. This is a balance between precision and recall, you can see the effect of changing this value in the interactive mode. 1 indicates an equal balance between precision and recall, 1/2 indicates precision weight is twice as much as recall and 2 indicates recall weight is twice as much as precision. 1 is generally ok for most purposes, the threshold has a bigger effect on VARD's performance. For precision bias a score less than one should be given in the form of a fraction, the numerator and denominator should be whole numbers between 1 and 9 (inclusive). For recall bias a score greater than one should be given, this should be a whole number between 1 and 9 (inclusive).

<input directory>: This is the folder where texts will be read in. Ensure that the directory is surrounding by quotes (" "). By default VARD 2 will only read files from the immediate directory given. This can be changed in saved data/options.txt (created after first running the tool), by setting search_subfolders to true (separate with a tab) - VARD 2 will then read the entire directory tree rooted at the input directory given. All files not hidden are (attempted to be) read by VARD, regardless of extension or type.

<output directory>: This the folder where processed texts will be placed. 2 folders are created, one with tagged texts and one with normalised texts without tags, plus a stats file.
If search_subfolders is set to true the original directory structure will be maintained in the two folders. Again, ensure the directory is surrounded by quotes (" ").


Further instructions for using VARD 2 are available at http://www.comp.lancs.ac.uk/~barona/vard2/userguide.php.