From 2fc75aba072133e846ecd97fc76e77481406fb2b Mon Sep 17 00:00:00 2001 From: danielwilczak101 <44122838+danielwilczak101@users.noreply.github.com> Date: Tue, 26 Jan 2021 21:20:38 -0600 Subject: [PATCH] Structure change to make it easier for users to clone and use the repository. --- CHANGELOG.rst | 1 - src/EasyGA.py => EasyGA.py | 9 ++++--- README.md | 2 +- src/__init__.py => __init__.py | 0 src/attributes.py => attributes.py | 0 {src/crossover => crossover}/Crossover.py | 0 {src/crossover => crossover}/README.md | 0 {src/crossover => crossover}/__init__.py | 0 .../test_crossover_methods.py | 0 {src/database => database}/__init__.py | 0 .../database => database}/matplotlib_graph.py | 0 {src/database => database}/sql_database.py | 0 src/decorators.py => decorators.py | 0 .../examples => examples}/Fitness_Examples.py | 0 {src/examples => examples}/README.md | 0 {src/examples => examples}/__init__.py | 0 {src/examples => examples}/test_methods.py | 0 {src/mutation => mutation}/Mutation.py | 0 {src/mutation => mutation}/README.md | 0 {src/mutation => mutation}/__init__.py | 0 .../test_mutation_methods.py | 0 {src/parent => parent}/Parent.py | 0 {src/parent => parent}/README.md | 0 {src/parent => parent}/__init__.py | 0 .../test_parent_selection_methods.py | 0 setup.py => pypi/setup.py | 0 src/run.py => run.py | 0 src/README.md | 25 ------------------- {src/structure => structure}/README.md | 0 {src/structure => structure}/__init__.py | 0 {src/structure => structure}/chromosome.py | 0 {src/structure => structure}/gene.py | 0 {src/structure => structure}/population.py | 0 .../structure => structure}/test_struction.py | 0 {src/survivor => survivor}/README.md | 0 {src/survivor => survivor}/Survivor.py | 0 {src/survivor => survivor}/__init__.py | 0 .../test_survivor_methods.py | 0 {src/termination => termination}/README.md | 0 .../Termination.py | 0 {src/termination => termination}/__init__.py | 0 .../test_termination_methods.py | 0 src/test_EasyGA.py => test_EasyGA.py | 0 43 files changed, 7 insertions(+), 30 deletions(-) delete mode 100644 CHANGELOG.rst rename src/EasyGA.py => EasyGA.py (97%) rename src/__init__.py => __init__.py (100%) rename src/attributes.py => attributes.py (100%) rename {src/crossover => crossover}/Crossover.py (100%) rename {src/crossover => crossover}/README.md (100%) rename {src/crossover => crossover}/__init__.py (100%) rename {src/crossover => crossover}/test_crossover_methods.py (100%) rename {src/database => database}/__init__.py (100%) rename {src/database => database}/matplotlib_graph.py (100%) rename {src/database => database}/sql_database.py (100%) rename src/decorators.py => decorators.py (100%) rename {src/examples => examples}/Fitness_Examples.py (100%) rename {src/examples => examples}/README.md (100%) rename {src/examples => examples}/__init__.py (100%) rename {src/examples => examples}/test_methods.py (100%) rename {src/mutation => mutation}/Mutation.py (100%) rename {src/mutation => mutation}/README.md (100%) rename {src/mutation => mutation}/__init__.py (100%) rename {src/mutation => mutation}/test_mutation_methods.py (100%) rename {src/parent => parent}/Parent.py (100%) rename {src/parent => parent}/README.md (100%) rename {src/parent => parent}/__init__.py (100%) rename {src/parent => parent}/test_parent_selection_methods.py (100%) rename setup.py => pypi/setup.py (100%) rename src/run.py => run.py (100%) delete mode 100644 src/README.md rename {src/structure => structure}/README.md (100%) rename {src/structure => structure}/__init__.py (100%) rename {src/structure => structure}/chromosome.py (100%) rename {src/structure => structure}/gene.py (100%) rename {src/structure => structure}/population.py (100%) rename {src/structure => structure}/test_struction.py (100%) rename {src/survivor => survivor}/README.md (100%) rename {src/survivor => survivor}/Survivor.py (100%) rename {src/survivor => survivor}/__init__.py (100%) rename {src/survivor => survivor}/test_survivor_methods.py (100%) rename {src/termination => termination}/README.md (100%) rename {src/termination => termination}/Termination.py (100%) rename {src/termination => termination}/__init__.py (100%) rename {src/termination => termination}/test_termination_methods.py (100%) rename src/test_EasyGA.py => test_EasyGA.py (100%) diff --git a/CHANGELOG.rst b/CHANGELOG.rst deleted file mode 100644 index 8b13789..0000000 --- a/CHANGELOG.rst +++ /dev/null @@ -1 +0,0 @@ - diff --git a/src/EasyGA.py b/EasyGA.py similarity index 97% rename from src/EasyGA.py rename to EasyGA.py index 2a0b9c9..49008d0 100644 --- a/src/EasyGA.py +++ b/EasyGA.py @@ -97,13 +97,15 @@ class GA(Attributes): def update_population(self): - """Updates the population to the new population and resets the mating pool and new population.""" + """Updates the population to the new population and resets + the mating pool and new population.""" self.population.update() def reset_run(self): - """Resets a run by re-initializing the population and modifying counters.""" + """Resets a run by re-initializing the population + and modifying counters.""" self.initialize_population() self.current_generation = 0 @@ -111,7 +113,8 @@ class GA(Attributes): def active(self): - """Returns if the ga should terminate based on the termination implimented.""" + """Returns if the ga should terminate based on the + termination implimented.""" return self.termination_impl() diff --git a/README.md b/README.md index cbe84ca..6248d35 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ 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. -### Check out our [wiki](https://github.com/danielwilczak101/EasyGA/wiki) for more information. +## Check out our [wiki](https://github.com/danielwilczak101/EasyGA/wiki) for more information. ## Installation: diff --git a/src/__init__.py b/__init__.py similarity index 100% rename from src/__init__.py rename to __init__.py diff --git a/src/attributes.py b/attributes.py similarity index 100% rename from src/attributes.py rename to attributes.py diff --git a/src/crossover/Crossover.py b/crossover/Crossover.py similarity index 100% rename from src/crossover/Crossover.py rename to crossover/Crossover.py diff --git a/src/crossover/README.md b/crossover/README.md similarity index 100% rename from src/crossover/README.md rename to crossover/README.md diff --git a/src/crossover/__init__.py b/crossover/__init__.py similarity index 100% rename from src/crossover/__init__.py rename to crossover/__init__.py diff --git a/src/crossover/test_crossover_methods.py b/crossover/test_crossover_methods.py similarity index 100% rename from src/crossover/test_crossover_methods.py rename to crossover/test_crossover_methods.py diff --git a/src/database/__init__.py b/database/__init__.py similarity index 100% rename from src/database/__init__.py rename to database/__init__.py diff --git a/src/database/matplotlib_graph.py b/database/matplotlib_graph.py similarity index 100% rename from src/database/matplotlib_graph.py rename to database/matplotlib_graph.py diff --git a/src/database/sql_database.py b/database/sql_database.py similarity index 100% rename from src/database/sql_database.py rename to database/sql_database.py diff --git a/src/decorators.py b/decorators.py similarity index 100% rename from src/decorators.py rename to decorators.py diff --git a/src/examples/Fitness_Examples.py b/examples/Fitness_Examples.py similarity index 100% rename from src/examples/Fitness_Examples.py rename to examples/Fitness_Examples.py diff --git a/src/examples/README.md b/examples/README.md similarity index 100% rename from src/examples/README.md rename to examples/README.md diff --git a/src/examples/__init__.py b/examples/__init__.py similarity index 100% rename from src/examples/__init__.py rename to examples/__init__.py diff --git a/src/examples/test_methods.py b/examples/test_methods.py similarity index 100% rename from src/examples/test_methods.py rename to examples/test_methods.py diff --git a/src/mutation/Mutation.py b/mutation/Mutation.py similarity index 100% rename from src/mutation/Mutation.py rename to mutation/Mutation.py diff --git a/src/mutation/README.md b/mutation/README.md similarity index 100% rename from src/mutation/README.md rename to mutation/README.md diff --git a/src/mutation/__init__.py b/mutation/__init__.py similarity index 100% rename from src/mutation/__init__.py rename to mutation/__init__.py diff --git a/src/mutation/test_mutation_methods.py b/mutation/test_mutation_methods.py similarity index 100% rename from src/mutation/test_mutation_methods.py rename to mutation/test_mutation_methods.py diff --git a/src/parent/Parent.py b/parent/Parent.py similarity index 100% rename from src/parent/Parent.py rename to parent/Parent.py diff --git a/src/parent/README.md b/parent/README.md similarity index 100% rename from src/parent/README.md rename to parent/README.md diff --git a/src/parent/__init__.py b/parent/__init__.py similarity index 100% rename from src/parent/__init__.py rename to parent/__init__.py diff --git a/src/parent/test_parent_selection_methods.py b/parent/test_parent_selection_methods.py similarity index 100% rename from src/parent/test_parent_selection_methods.py rename to parent/test_parent_selection_methods.py diff --git a/setup.py b/pypi/setup.py similarity index 100% rename from setup.py rename to pypi/setup.py diff --git a/src/run.py b/run.py similarity index 100% rename from src/run.py rename to run.py diff --git a/src/README.md b/src/README.md deleted file mode 100644 index f86c26b..0000000 --- a/src/README.md +++ /dev/null @@ -1,25 +0,0 @@ -### ----- To run from the downloaded source code ----- -run.py - -#### ----- Main functionality files ----- -EasyGA.py -attributes.py - -#### ----- Decorators used to simply code ----- -decorators.py - -#### ----- Genetic Algorithm process ----- -crossover/ -mutation/ -parent/ -survivor/ -termination/ - -#### ----- Building blocks ----- -structure/ - -#### ----- Example code ----- -examples/ - -#### ----- Testing ----- -test_EasyGA.py diff --git a/src/structure/README.md b/structure/README.md similarity index 100% rename from src/structure/README.md rename to structure/README.md diff --git a/src/structure/__init__.py b/structure/__init__.py similarity index 100% rename from src/structure/__init__.py rename to structure/__init__.py diff --git a/src/structure/chromosome.py b/structure/chromosome.py similarity index 100% rename from src/structure/chromosome.py rename to structure/chromosome.py diff --git a/src/structure/gene.py b/structure/gene.py similarity index 100% rename from src/structure/gene.py rename to structure/gene.py diff --git a/src/structure/population.py b/structure/population.py similarity index 100% rename from src/structure/population.py rename to structure/population.py diff --git a/src/structure/test_struction.py b/structure/test_struction.py similarity index 100% rename from src/structure/test_struction.py rename to structure/test_struction.py diff --git a/src/survivor/README.md b/survivor/README.md similarity index 100% rename from src/survivor/README.md rename to survivor/README.md diff --git a/src/survivor/Survivor.py b/survivor/Survivor.py similarity index 100% rename from src/survivor/Survivor.py rename to survivor/Survivor.py diff --git a/src/survivor/__init__.py b/survivor/__init__.py similarity index 100% rename from src/survivor/__init__.py rename to survivor/__init__.py diff --git a/src/survivor/test_survivor_methods.py b/survivor/test_survivor_methods.py similarity index 100% rename from src/survivor/test_survivor_methods.py rename to survivor/test_survivor_methods.py diff --git a/src/termination/README.md b/termination/README.md similarity index 100% rename from src/termination/README.md rename to termination/README.md diff --git a/src/termination/Termination.py b/termination/Termination.py similarity index 100% rename from src/termination/Termination.py rename to termination/Termination.py diff --git a/src/termination/__init__.py b/termination/__init__.py similarity index 100% rename from src/termination/__init__.py rename to termination/__init__.py diff --git a/src/termination/test_termination_methods.py b/termination/test_termination_methods.py similarity index 100% rename from src/termination/test_termination_methods.py rename to termination/test_termination_methods.py diff --git a/src/test_EasyGA.py b/test_EasyGA.py similarity index 100% rename from src/test_EasyGA.py rename to test_EasyGA.py