========================
Database for chess games
========================

.. contents::


Description
===========

This package provides a database for chess games.

When playing through a game a list of all games containing the current position is displayed.

Repertoire games can be defined.  When playing through a repertoire game a list of all games containing the current position is displayed.  Repertoire games are not included in this list.

Chess engines can be used to analyse positions while playing through games or repertoire games.  The analysis can be played through like the game score.  The analysis can be saved on the database for later reference.

Partial positions can be defined and a list of all games containing a position matching the partial position is displayed.

Games can be typed, or imported from files, in PGN `Import Format`_.

Games are indexed by the `seven standard tags`_ defined by the PGN standard.

Games can be edited or deleted.

Games can be output to PGN files in `Export Format`_, `Reduced Export Format`_, or an import format excluding comments and glyphs.


Installation Instructions
=========================

This package is available on PyPI so can be installed by typing

   python -m pip install --user chesstab

at the command prompt.

See `Python`_ and `pip`_ documentation for alternatives and platform-specific points.

If this installation replaces ChessTab-4.1.1 or earlier you should run:

python -m chesstab.tools.chesstab-4-1-1_castling-option-correction

to fix the incorrect position and analysis index keys generated for moves Rxa8, Rxh8, Rxa1, and Rxh1, where the captured piece is a rook and neither rook involved in the move, nor either king, has moved previously.

For the 233,765 games in twic920g.zip through twic999g.zip downloaded from https://theweekinchess.com the run takes about two hours.


Chess Engines
=============

Chess engines which support the `Universal Chess Interface`_ (UCI) can be used to analyse positions.  Wikipedia `UCI entry`_ links to the specification too.


Database Interfaces
===================

The default database interface is the sqlite3 module distributed with Python.

The `apsw`_ interface, if installed, to Sqlite 3 is used instead of the sqlite3 interface.

New databases are accessed using these alternative interfaces if installed.

* `berkeleydb`_ (replaces bsddb3 at Python 3.10)
* `bsddb3`_
* `dptdb`_ (Microsoft Windows only)

Chesstab will use dptdb if installed.

berkeleydb is available for Python 3.6 and later.  It is used instead of bsddb3 if both are installed and a version of `Berkeley DB`_ supported by berkeleydb is installed.

If bsddb3 is used, a version of `Berkeley DB`_ supported by bsddb3 must be installed.


Fonts
=====

The unicode chess pieces are used by default.

The chesstab package incudes the Chess Merida, Chess Cases, Chess Motif, and Chess Lucena fonts by Armando H Marroquin.

These are available from `www.enpassant.dk/chess/fonteng.htm`_ and the relevant files have been included in this package for convenience.

Install if you prefer them to the unicode chess pieces.


Run
===

The command to run this package is:

   python -m chesstab.chessgames

You may need to give the path and version of Python depending on your system's configuration:

   <path to python>/python<version> -m chesstab.chessgames

   For example

      C:\\Python36\\python -m chesstab.chessgames

         on Microsoft Windows or

      python3.6 -m chesstab.chessgames

         on Unix-like systems.

Or use the facilities of your desktop (Microsoft Windows, GNOME, KDE, ...) to set up a convenient way of starting chessgames. 

At least one database engine supported by the `solentware-base`_ package must be installed.


Notes
=====

A database of about 1.5 million games will occupy between 10 and 15 Gbytes.

Importing 1.5 million games will take at least a few hours.  For example about 12 hours on a 1.8GHz CPU with 2Gb 667MHz DDR2 SDRAM, and about 30 hours on a 1.7GHz CPU with 1Gb DDR266 RAM.

These figures were obtained using the Enormous database from:

`ftp://ftp.cis.uab.edu/pub/hyatt/pgn`_.

Partial position searches are always much quicker using the `dptdb`_ database interface.

When using the sqlite3, apsw, or `bsddb3`_ database interfaces, you may notice better response times on partial position searches if the `bitarray`_ module is installed.

The sqlite3 and apsw database interfaces are equivalent, but all other pairings are incompatible.


.. _Import Format: http://www6.chessclub/help/PGN-spec
.. _seven standard tags: http://www6.chessclub/help/PGN-spec
.. _Export Format: http://www6.chessclub/help/PGN-spec
.. _Reduced Export Format: http://www6.chessclub/help/PGN-spec
.. _Python: https://python.org
.. _pip: https://packaging.python.org/installing
.. _www.enpassant.dk/chess/fonteng.htm: http://enpassant.dk/chess/fonteng.htm
.. _ftp://ftp.cis.uab.edu/pub/hyatt/pgn: ftp://ftp.cis.uab.edu/pub/hyatt/pgn
.. _bitarray: https://pypi.python.org/pypi/bitarray
.. _bsddb3: https://pypi.python.org/pypi/bsddb3
.. _berkeleydb: https://pypi.org/project/berkeleydb
.. _dptdb: http://solentware.co.uk/download.html
.. _Berkeley DB: http://oracle.com
.. _Universal Chess Interface: http://www.shredderchess.com/div/uci.zip
.. _UCI entry: https://en.wikipedia.org/wiki/Universal_Chess_Interface
.. _apsw: https://github.com/rogerbinns/apsw
.. _solentware-base: http://solentware.co.uk/components.html