Installing

This repository is meant to be used for installing the XAI package. A wheel dstribution of this package is present in the dist folder and may be installed within your virtual enviroonment. Just download this directly into your folder and install like any other pip package as:

pip3 install XAI-<version>-py3-none-any.whl

Git alternatively allows you to install packages directly from Github. Consider doing the following:

pip3 install git+https://github.com/Holmusk/XAI.git

This has been built upon a Unix system. If you use this for other systems, you may wish to consider building this library from source. If this is a private repo, or you use ssh, remember to use the following instead:

pip3 install git+ssh://git@github.com/Holmusk/XAI.git

Package Building

You may wish to make customize this package for your own use. For that, you need to build the system:

• Clone this repo to your computer

• Create a virtual enviromnent, and install the required packages

• Build the system

A Makefile has been provided for aiding with this process. The following commands should allow you do do the following

• make grantPermission: grants execute permission to all shell scripts in the bin folder

• make clean: clean unwanted and temporary files that are generated

• make build: This will allow you to build Wheel packages for your system