Next: , Previous: , Up: Top   [Contents]


4 Usage

The recommended frontend for Arbitools is Emacs. It is the most GNU way of managing a tournament. For some time, you will also be able to use the command line interface.

4.1 Emacs environment

As I said before, the most logical way to use “Chess Arbiter Tools” is through Emacs. It combines the possibility of directly edit the tournament files, run the arbitool commands and launch a pairing engine. To do this, you have to install the “arbitools.el” package. Instructions in the “Instalation” section (See Installation).

You can use all the power of Emacs to manage the file, plus the different Arbitools functions and the pairing engines. You will find the menu entry “Arbitools”, with the functions available. It also is possible to search and replace text, to copy and paste, etc. arbitoolsel

The functions available are: “New Tournament”, “Insert Player”, “Delete Player”, “Do Pairings”, “Insert Result”, etc. Some of them require external programs that are detailed above.

It is possible to manage a tournament enterily with arbitools, although is not a very user-friendly experience. Unless you are familiar with Emacs, of course.

4.1.1 Creating the initial file.

First of all, you have to create an empty FIDE file and write manually the information of the tournament. You can do this either manually, in your favourite editor, or with Arbitools, using the function “New Tournament”.

Then you need to add the players. The recommended way is to insert everything manually, checking with the FIDE list. The option “Insert Player” will prompt you for the information that is needed for each player. Remember you will be able to edit anything, since is a text file. Just remember to use “overwrite” because the position of each character in the file should remain untouched. Also, if you see something went wrong you can always click on “Undo”.

Alternatively you can use other chess tournament software to create the trf file to work with arbitools.

4.1.2 Do the pairings

Now you can do the pairings for each round. You do this with the option “Do Pairings”. Remember to click on “Calculate Points”. The pairing engine will not work if the points column doesn’t match the results. You will be prompted to insert the number of the round. It refers to the last round with points to calculate. After this you may insert any byes with the option “Insert bye”. You will be prompted for the player, the round and the type of bye, being “H” a half-point bye and “F” a full-point bye, according to the FIDE standards.

In the first round, “bbpPairings” require a line “XXC” to exist, with the posible values of “white1” or “black1”. If your trf file doesn’t have one, it will not work. Also, the program requires a “XXR” line, with the number of rounds in the tournament. You can remove these lines before sending the report if you wish.

You can also print the pairing clicking on “List Pairings”, telling the program what round to print and going to the “Pairing list” buffer from the “Buffers” menu.

4.1.3 Write the results

After pairing, you can add the results clicking on “Add Result”. This option will ask you for the round, the ranking number of each player and the result. Introduce “1” for white wins, “0” for black wins, “=” for draw, “-” for black forfeits or “+” for white forfeits. Again, these codes comply with the FIDE standards.

4.1.4 Writing the report

When the tournamet is finished, you don’t need to create the FIDE export file, because you already worked on it. You can generate the IT3 report by clicking on the option. You will get a pdf file in which you have to edit some data. You can do this with your favourite software, but I recommend editing the tex file created in the same folder and compile it with “pdflatex”. Additionally, you can create the FEDA rating file, if the tournament is in Spain and use it to include and your tournament report.

And that’s it.

4.1.5 Additional functions

-Updating the ratings on a csv file.

-Delete a player who didn’t play any games

-Delete the results of a round

.And a couple more.

4.2 Graphical Interface

Although it should work just fine, this interface is not maintained anymore. It may not work properly. Invoking the graphical interface is easy. Just run “arbitools-gui.py”. Choose your file, your options and press the button withe function you want to perform. The main screen looks like this: arbitools

The interface is really easy to understand.

4.2.1 Update data

- Browse the tournament file in the “input file” box.

- Select an ELO list from the list. Some of the options may not be available until you download the corresponding files.

- Select a search method from the list.

- Click the data you want to update.

- Click the “Update data” button.

You will get the results in a file:

If you used a .veg file, a backup of the original file is renamed with the “_old” suffix.

If you used a .csv file, a file with the “_update” suffix is created with the updated data, the original file remains untouched.

If you used a .txt file, a file with the “_export” suffix is created with the updated data, the original file remains untouched.

4.2.2 Add players to an existing tournament

- Browse the tournament file in the “input file” box.

- Browse the file with additional players in “file with new data”.

- Click “Add data from file”.

4.2.3 Get the standings.

- Browse the tournament file in the “input file” box.

- Click “Get standings”.

This action produces the standings for a tournament. You will get the files:

- A file with the “_standings.txt” suffix with the standings in a text file.

- A file with the “_standings.tex” suffix with the standings in a LaTeX file, ready for pdflatex.

- A file with the “_ARPO.csv” suffix, with tiebreaks information. The library PyRP.py and _PyRP.py by Julio Gonzalez And Jose Carlos Diaz is used.

- A file with the “Rating_admin_” preffis, with the FEDA rating information for the Spanish Federation.

- A .tex file, with the suffix “IT3”, that you can edit and compile to get a Tournament Report Form.

- If there is a latex environment installed, you will also get a .pdf file with the Tournament Report Form.

4.3 Command Line

Most of the features are available through the command line interface. In the first version of arbitools there were different commands for each function. The newer “arbitools-run.py”, provides all the functions in just one comand. The older commands are referred to as “obsolete”.

4.3.1 arbitools-run.py

This is the newest script that provides the access to the different Arbitools functions. The syntax is: arbitools-run.py <command> <argument(s)>

Possible commands:

it3 <filename> Get the it3 report form for “filename”.

fedarating <filename> Get the FEDA RatingAdmin file for “filename”.

update <filename> Update the elo of “filename”. If you use the option -l, you can specify fide or feda lists. If you dont use this, the custom file will be used. You need to have in your home directory the files “elo_feda.xls”, “players_list_xml.xml” if you want to use the fide or feda lists. I recommend that you create a “custom_elo.csv” as described later.

4.3.2 arbitools-update.py(obsolete)

Updates the players information stored in a file. It is a very useful function when a new list is published and you had already set up the tournament.

-i This argument takes the name of the input file. This is the file with the information we want to update.

You can use .veg files, .txt (FIDE Krause) or .csv. For details See File Formats.

-l Write the name of the elo list here. “fide” uses the official fide list from the file “players_list_xml.xml”. It won’t work if you don’t have that file in your folder. You can download it from www.fide.com. “feda” uses the feda list from the file “elo_feda.xls”. You have to rename the file from www.feda.org. “fidefeda” uses the file “FIDE-FEDA Vega.csv”. You can download it from www.jemchess.com. By default, it uses your personal “custom_elo.csv” file.

If you used a .veg file, a backup of the original file is renamed with the “_old” suffix.

If you used a .csv or a .xls file, a new file with the “_update” suffix is created with the updated data, the original file remains untouched.

If you used a .fegaxa file, a new file with the “_update” suffix is created with the updated data. Arbitools will try to produce a xls format file, but most likely a csv is going to be. Be careful about this, because if you want to use the produced file to be upgraded again, it has to be a xls file. What you can do is open with LibreOffice and save is as xls.

If you used a .txt file, a file with the “_export” suffix is created with the updated data, the original file remains untouched.

You can see a report of the updated actions in arbitools-report.log

4.3.3 arbitools-add.py(obsolete)

Adds extra players to an existing file.

-i This argument takes the name of the input file. This is the file with the information we want to update.

You can use .veg files, .txt (FIDE Krause) or .csv. For details See File Formats.

-a This argument takes the name of the file with the extra players you want to add. It should be a .csv file with the structure described in “File Formats” (See File Formats).

You can use .veg files, .txt (FIDE Krause) or .csv. For details See File Formats.

4.3.4 arbitools-standings.py(obsolete)

Produces the standings for a tournament. You will get the files:

- A file with the “_standings.txt” suffix with the standings in a text file.

- A file with the “_standings.tex” suffix with the standings in a LaTeX file, ready for pdflatex.

- A file with the “_ARPO.csv” suffix, with tiebreaks information. The library PyRP.py and _PyRP.py by Julio Gonzalez And Jose Carlos Diaz is used.

- A file with the “Rating_admin_” preffis, with the FEDA rating information for the Spanish Federation.

- A .tex file, with the suffix “IT3”, that you can edit and compile to get a Tournament Report Form.

- If there is a latex environment installed, you will also get a .pdf file with the Tournament Report Form.

-i This argument takes the name of the input file. It will only work witn .txt (FIDE Krause) or .veg. Other formats don’t contain the tournament’s information needed to produce the standings.

You can write a file “.arbitools”, and define the tiebreak methods for ARPO. The structure of the file is as follows:

Methods:<methods>

Sort:<methods>

Either in the “Methods” or the “Sort” line you can choose: Name, Points, Bucholz, ARPO, and some more (see PyRP.py).


Next: , Previous: , Up: Top   [Contents]