WCGtools Wiki

Software geared to World Community Grid, e.g. to retrieve statistics.

Brought to you by: adriverhoef

Configuration

Authors:

There is a newer version of this page. You can find it here.

Configuration

There are two ways to configure the programs.

Via the file ~/.wcginitrc
Via the individual programs

We'll discuss these two possiblities now.

Via the file ~/.wcginitrc

To put this to use, you need to supply several variables (and their values, of course) and store these items into that file.

wcgformat

For wcgformat there is no special variable to configure.
However …
This is a good moment to create the file ~/.wcginitrc and to limit access to it as it may contain vulnerable information:

$ touch ~/.wcginitrc && chmod 600 ~/.wcginitrc

wcglog

For wcglog there are two special variables to configure:

Variable-name	Default value	Explanation
SEARCHDIRS	.BOINC BOINC WCG wcg www tmp	This variable indicates the subdirectories to search when trying to locate the logfile
SEARCHNAMS	WCG wcg

Note: The final location and name of the logfile is constructed from one of the individual values of $SEARCHDIRS/$SEARCHNAMS, e.g. "tmp/wcg". The individual values, like "WCG" and "wcg", are separated by spaces only.

wcgmembercmp

For wcgmembercmp there are two special variables to configure:

Variable-name	Default value	Explanation
USERNAME	(none)	This variable indicates the name of your account with which you're crunching
TEAMNAME	(none)	This variable indicates the name of the team in which you're participating

wcgresults

For wcgresults there are at least two special variables to configure:

Variable-name	Default value	Explanation
MEMBER	(none)	This variable is used to specify the name of your account with which you're crunching
VERIFY	(none)	This variable is used to specify your verificationcode

wcgstats

For wcgstats there are at least two special variables to configure, in addition you can also add variables for your device(s):

Variable-name	Default value	Explanation
MAILADDR	(none)	This variable is used to specify your e-mailaddress
PASSWORD	(none)	This variable is used to specify the password of your account
DEVICE_ID[1]	(none)	This variable indicates the numerical ID of your first device
DEVICENAME[1]	(none)	This variable indicates the name of your first device
DEVICES	0	This variable indicates the number of devices that you have configured

Note: Once you have configured the variables MAILADDR and PASSWORD successfully, you'll be able to generate a list of your devices, like so as an example:

$ wcgstats -ZZZ
DEVICES=0; let n=0; # Start counting the number of devices.
let n++; DEVICE_ID[$n]=1234567; DEVICENAME[$n]="desktop"
let n++; DEVICE_ID[$n]=2345678; DEVICENAME[$n]="laptop"
let n++; DEVICE_ID[$n]=3456789; DEVICENAME[$n]="smartphone"
DEVICES=$n  # The total number of devices.

This will also give you the opportunity to add the output to your configuration file:

$ wcgstats -ZZZ >> ~/.wcginitrc

Final note: the special variable-names are in capitals only.

In the end, the contents of your file ~/.wcginitrc may look something like this:

SEARCHDIRS="BOINC data logdir misc"
SEARCHNAMS="WCG wcg results"
USERNAME=my_username
TEAMNAME=my_teamname
MEMBER=my_username
VERIFY=c0de1234567890987654321ed0c
MAILADDR=my_address@example.com
PASSWORD=Impossible2Guess
DEVICES=0; let n=0; # Start counting the number of devices.
let n++; DEVICE_ID[$n]=1234567; DEVICENAME[$n]="desktop"
let n++; DEVICE_ID[$n]=2345678; DEVICENAME[$n]="laptop"
let n++; DEVICE_ID[$n]=3456789; DEVICENAME[$n]="smartphone"
DEVICES=$n  # The total number of devices.

Via the individual programs

In this case you will have to edit each individual program that you want to put to good use.
There is a section designated by the word "CONFIGURE" surrounded by hashtags in each program where you can edit the values of the variables.
It might also be a good idea to limit access to the individual programs, e.g. like so:

$ chmod 700 ~/bin/wcgstats

After configuring each individual program there is no need to do this again when you download a newer version of the program. Each program that needs configuring has an option -U to update the old version of the program to the new version.