Files
EasyGA/README.md
Daniel Wilczak 4a18a96902 Update README.md
2020-10-23 15:37:04 -04:00

3.0 KiB

EasyGA - A general solution to Genetic Algorithms

EasyGA is a python package designed to provide an easy-to-use Genetic Algorithm. The package is designed to work right out of the box, while also allowing the user to customize features as they see fit.

Installation:

Run the rolling to install:

pip3 install EasyGA

Getting started with EasyGA:

import EasyGA

# Create the Genetic algorithm
ga = EasyGA.GA()

# Evolve the whole genetic algorithm until termination has been reached
ga.evolve()

# Print out the current generation and the population
ga.print_generation()
ga.print_population()

Output:

Current Generation      : 15
Current population:
Chromosome - 0 [7][4][4][5][3][5][5][8][3][7] / Fitness = 3
Chromosome - 1 [7][4][4][5][3][5][5][8][3][7] / Fitness = 3
Chromosome - 2 [7][4][4][5][3][5][5][8][3][7] / Fitness = 3
Chromosome - 3 [7][4][4][5][3][5][5][8][3][7] / Fitness = 3
Chromosome - 4 [7][2][4][5][3][5][5][8][3][7] / Fitness = 3
Chromosome - 5 [7][2][4][5][3][5][5][8][3][7] / Fitness = 3
Chromosome - 6 [5][8][8][6][10][10][5][7][2][7] / Fitness = 2
Chromosome - 7 [5][8][8][6][10][10][5][7][2][7] / Fitness = 2
Chromosome - 8 [5][8][8][6][10][10][5][7][2][7] / Fitness = 2
Chromosome - 9 [7][2][8][10][3][5][5][8][1][7] / Fitness = 2

How Testing works

Getting started with testing

pip3 install pytest

Navigate to your EasyGA folder and run:

python3 -m pytest

Output

============================================= test session starts ===================================
platform darwin -- Python 3.8.6rc1, pytest-6.0.2, py-1.9.0, pluggy-0.13.1
rootdir: /Users/danielwilczak/github/EasyGA
collected 2 items                                                                                              

test_EasyGA.py ..                                                                         [100%]

============================================== 2 passed in 0.04s ====================================

This is only an example and we will create hundreds of tests so this list will become bigger and bigger.

Developing EasyGA:

If you know how to use Github and git ignore this section.

Getting started with development

To work together we plan on using github and the git framework. This is made easy with the Atom software.

Download Atom for whatever OS you have. https://atom.io/

Use the github tab to pull the github repository. Its self explanitory.

Use the run_testing.py file inside the src folder to run your code and test while we build the package.

Other options

Download the repository to some folder - If you never used git. Look up a youtube tutorial. It will all make sense.

git clone https://github.com/danielwilczak101/EasyGA.git

Or download as a zip file.

https://github.com/danielwilczak101/EasyGA/archive/master.zip

Use the run_testing.py file inside the src folder to run your code and test while we build the package.