abhinav7sinha / python-chessnet

Model the game of chess as a large complex network

python-chessnet

Model the game of chess as a large complex network

1. Introduction
2. Dependencies
3. Features

1. Introduction

python-chess-network is a library for the study of the game of chess as a large complex network.

2. Dependencies

• Python3 - Download and Install Python3. You can also use your system's package manager to install the latest stable version of python3.
• Now Install the following packages:
  
  1. networkx

     pip install networkx

  2. python-chess

     pip install chess

3. Features

• provides a utility to generate a graph (unweighted and directed) from a PGN file containing games of chess
  • individual board positions represented by FENs are nodes in the graph
  • a move in the game is represented by a directed edge between 2 nodes.

  import gml # assumes you have gml.py in the same directory, or you know how to handle python modules.
  
  input_pgn_file='pgn-base/carlsen-caruana-2018.pgn'
  gmlCoverter=gml.GraphMLUtil()
  
  # generate graph object from pgn file
  diGraph=gmlCoverter.generateGamesNetwork(input_pgn_file)
  
  # generate graphml file from the graph object
  # (if no destination is provided - file is stored in gml-base directory 
  # with default file name)
  dest='gml-base/test-output.gml'
  gmlCoverter.generateGameGml(diGraph, dest)

python-chessnet's Issues

Write unit tests

Update logic to compare value of nodes in graph - or update the vaule itself

Currently, we're using the full FEN as the node value. Change needs to be made to this logic - so that any two equal positions are considered the same node. We could possibly ignore the half-move and full-move numbers.

Improve readme

Add documentation and improve readme -

• How to contribute section
• Add shields/badges in GitHub readme

Implement CI pipeline

• Review existing CI tools
• Set up CI to run automated tests against builds
• Set up code merge rules

Write a utility to create graphML files from PGNs

• Initial utility to create a directed unweighted graph from a single game of chess (like a linked list)
• create gml files from a graph containing multiple games of chess

Create a readme