Metadata-Version: 1.2
Name: chess-tuning-tools
Version: 0.1.0
Summary: A collection of tools for local and distributed tuning of chess engines.
Home-page: https://github.com/kiudee/chess-tuning-tools
Author: Karlson Pfannschmidt
Author-email: kiudee@mail.upb.de
License: Apache Software License 2.0
Description: ==================
        Chess Tuning Tools
        ==================
        
        
        .. image:: https://img.shields.io/pypi/v/chess-tuning-tools.svg
                :target: https://pypi.python.org/pypi/chess-tuning-tools
        
        .. image:: https://img.shields.io/travis/kiudee/chess-tuning-tools.svg
                :target: https://travis-ci.org/kiudee/chess-tuning-tools
        
        .. image:: https://readthedocs.org/projects/chess-tuning-tools/badge/?version=latest
                :target: https://chess-tuning-tools.readthedocs.io/en/latest/?badge=latest
                :alt: Documentation Status
        
        
        
        
        A collection of tools for local and distributed tuning of chess engines.
        
        
        * Free software: Apache Software License 2.0
        * Documentation: https://chess-tuning-tools.readthedocs.io.
        
        
        Features
        --------
        
        * TODO
        
        
        Starting the tuning client
        --------------------------
        In order to be able to start the tuning client, first create a python
        environment with the packages ``psycopg2`` and ``numpy``.
        Using anaconda this could be done by typing::
        
           conda create -n tuning -c conda-forge numpy psycopg2 pytz click emcee
           pip install git+https://github.com/kiudee/bayes-skopt
        
        Furthermore, you need to have `cutechess-cli <https://github.com/cutechess/cutechess>`_
        in the path. The tuning client will use it to run matches.
        
        Then after extracting the current .zip package into the folder
        ``chess-tuning-tools``, make sure that you have the following directory
        structure::
        
           chess-tuning-tools/
           |---- networks/
           |     |---- 58613
           |     |---- other networks
           |---- openings/
           |     |---- ...
           |     |---- openings-6ply-1000.pgn
           |     |---- ...
           |---- tune/
           |     |---- db_workers/
           |     |     |---- __init__.py
           |     |     |---- tuning_client.py
           |     |     |---- tuning_server.py
           |     |     |---- utils.py
           |     |---- __init__.py
           |     |---- io.py
           |---- dbconfig.json
           |---- lc0[.exe]
           |---- sf[.exe]
        
        Finally, the tuning client can be started as follows::
        
           cd path/to/chess-tuning-tools
           conda activate tuning
           python -m tune.cli run_client dbconfig.json
        
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2020-01-31)
        ------------------
        
        * First release on PyPI.
        
Keywords: chess,tuning,optimization,engine
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
