Installation

Using pip

CHAP is available over PyPI and can be installed with:

pip install ChessAnalysisPipeline

Using conda

CHAP is also available over conda-forge, allowing installation with, e.g.:

conda install -c conda-forge chessanalysispipeline

From source

1. Clone the CHAP repository:

   git clone https://github.com/CHESSComputing/ChessAnalysisPipeline.git
   

2. Change to the CHAP repository directory:

   cd ChessAnalysisPipeline
   

3. Set a valid version number. In setup.py, replace:

   version = 'v0.0.17.dev8'
   

   with

   version = 'v0.0.17.dev8'
   

4. Create the virtual environment:

   python -m venv venv
   

5. Activate the virtual environment:

   source venv/bin/activate
   

6. Use the setup script to install the package:

   python setup.py install
   

7. Try running:

   install/bin/CHAP --help
   

   to confirm the package was installed correctly.

If you need to install it in your local installation area via pip, run steps 1 to 3 from above and then run the following steps:

1. Install the wheel package:

   pip install wheel
   

2. Build your local package:

   python setup.py clean sdist bdist_wheel
   

3. Look-up your local package in dist area:

   ls -1 dist
   

   which should return:

   ChessAnalysisPipeline-0.0.16-py3-none-any.whl
   ChessAnalysisPipeline-0.0.16.tar.gz
   

4. Install your package from the local dist area:

   pip install --no-index --find-links=dist/ ChessAnalysisPipeline
   

5. Verify that you package is installed:

   pip list | grep Chess
   

   which should return:

   ChessAnalysisPipeline 0.0.16
   

6. Try running:

   install/bin/CHAP --help
   

   to confirm the package was installed correctly.