Installing

EvoKit can be installed with pip. If an error occurs during installation, update pip then try again.

If you do not wish to install EvoKit globally, please consider using a virtual environment. An official tutorial can be found here.

The build script uses the build module. Please install the module or update it by running the following script:

pip install build --upgrade

Install from PiPy

To install EvoKit directly from PyPi, run the following command:

pip install evokit

Install from Source

To install EvoKit directly from source, run the following command at the root directory:

pip install .

Build Documentation

The directory docs/ contains everything related to building documentations.

  • Run make.bat to rebuild the documentation.

  • Run update.bat to update API references in source/ then rebuild the documentation.

  • source/ contains all configuration files, including conf.py.

Trial Run

After installing the package, check if it is working by running

python -m evokit.evolvables.binstring

or, inside a Python program or an interactive Python terminal, run

import evokit.evolvables.binstring as binstring
binstring.trial_run()

The output should be a string of tuples with non-decreasing (and hopefully increasing) values. A sample of the output follows.

  • If the values are non-decreasing, then the elitist selector has not failed to retain the best individual. Otherwise, the elitist selector is not behaving expected: either the package or the installation is erroneous.

  • If the values are increasing, then the variator has successfully improved the population. If this does not happen, try rerunning the program a few times.

(15,)
(15,)
(15,)
(15,)
(17,)
(17,)
(17,)
(17,)
(17,)
(17,)