fixing up, deployed to pip

100 · Jun 19, 2017 · a11d215 · a11d215
1 parent da64af7
commit a11d215
Show file tree

Hide file tree

Showing 19 changed files with 45 additions and 11 deletions.
diff --git a/MANIFEST b/MANIFEST
@@ -0,0 +1,11 @@
+# file GENERATED by distutils, do NOT edit
+setup.cfg
+setup.py
+Solid/EvolutionaryAlgorithm.py
+Solid/GeneticAlgorithm.py
+Solid/HarmonySearch.py
+Solid/ParticleSwarm.py
+Solid/SimulatedAnnealing.py
+Solid/StochasticHillClimb.py
+Solid/TabuSearch.py
+Solid/__init__.py
diff --git a/README.md b/README.md
@@ -1,4 +1,12 @@
-# Metaheuristics-library-placeholder
+# Solid
+
+## *Solid* is a simple library for gradient-free optimization.
+
+#### It contains basic versions of many of the most common algorithms, and allows for very rapid development using them.
+
+#### It's a very versatile library that's great for learning, modifying, and of course, using out-of-the-box.
+
+<hr>
 
 ## Current Features:
 * Genetic Algorithm
@@ -12,10 +20,10 @@
 <hr>
 
 ## Usage:
-* ```pip install``` 
+* ```pip install solidpy``` 
 * Import the relevant algorithm
 * Create a class that inherits from that algorithm, and that implements the necessary abstract methods
-* Call its ```.run()``` method
+* Call its ```.run()``` method, which always returns the best solution and its objective function value
 
 <hr>
 
@@ -24,7 +32,7 @@
 ```python
 from random import choice, randint, random
 from string import lowercase
-from library.EvolutionaryAlgorithm import EvolutionaryAlgorithm
+from Solid import EvolutionaryAlgorithm
 
 
 class Algorithm(EvolutionaryAlgorithm):

diff --git a/library/EvolutionaryAlgorithm.py → Solid/EvolutionaryAlgorithm.py b/library/EvolutionaryAlgorithm.py → Solid/EvolutionaryAlgorithm.py
diff --git a/library/GeneticAlgorithm.py → Solid/GeneticAlgorithm.py b/library/GeneticAlgorithm.py → Solid/GeneticAlgorithm.py
diff --git a/library/HarmonySearch.py → Solid/HarmonySearch.py b/library/HarmonySearch.py → Solid/HarmonySearch.py
diff --git a/library/ParticleSwarm.py → Solid/ParticleSwarm.py b/library/ParticleSwarm.py → Solid/ParticleSwarm.py
diff --git a/library/SimulatedAnnealing.py → Solid/SimulatedAnnealing.py b/library/SimulatedAnnealing.py → Solid/SimulatedAnnealing.py
diff --git a/library/StochasticHillClimb.py → Solid/StochasticHillClimb.py b/library/StochasticHillClimb.py → Solid/StochasticHillClimb.py
diff --git a/library/TabuSearch.py → Solid/TabuSearch.py b/library/TabuSearch.py → Solid/TabuSearch.py
diff --git a/library/__init__.py → Solid/__init__.py b/library/__init__.py → Solid/__init__.py
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,2 @@
+[metadata]
+description-file = README.md
diff --git a/setup.py b/setup.py
@@ -0,0 +1,13 @@
+from distutils.core import setup
+setup(
+  name = 'solidpy',
+  packages = ['Solid'],
+  version = '0.1',
+  description = 'A comprehensive gradient-free optimization library',
+  author = 'Devin Soni',
+  author_email = 'devinsoni1010@gmail.com',
+  url = 'https://github.com/100/Solid',
+  download_url = 'https://github.com/100/Solid/archive/0.1.tar.gz',
+  keywords = ['metaheuristic', 'optimization', 'algorithm', 'artificial intelligence', 'machine learning'],
+  classifiers = ['Programming Language :: Python :: 2.7'],
+)
diff --git a/tests/test_evolutionary_algorithm.py b/tests/test_evolutionary_algorithm.py
@@ -1,6 +1,6 @@
 from random import choice, randint, random
 from string import lowercase
-from library.EvolutionaryAlgorithm import EvolutionaryAlgorithm
+from Solid.EvolutionaryAlgorithm import EvolutionaryAlgorithm
 
 
 class Algorithm(EvolutionaryAlgorithm):

diff --git a/tests/test_genetic_algorithm.py b/tests/test_genetic_algorithm.py
@@ -1,5 +1,5 @@
 from random import choice
-from library.GeneticAlgorithm import GeneticAlgorithm
+from Solid.GeneticAlgorithm import GeneticAlgorithm
 
 
 class Algorithm(GeneticAlgorithm):

diff --git a/tests/test_harmony_search.py b/tests/test_harmony_search.py
@@ -1,5 +1,5 @@
 from random import uniform
-from library.HarmonySearch import HarmonySearch
+from Solid.HarmonySearch import HarmonySearch
 
 
 class Algorithm(HarmonySearch):

diff --git a/tests/test_particle_swarm.py b/tests/test_particle_swarm.py
@@ -1,4 +1,4 @@
-from library.ParticleSwarm import ParticleSwarm
+from Solid.ParticleSwarm import ParticleSwarm
 
 
 class Algorithm(ParticleSwarm):

diff --git a/tests/test_simulated_annealing.py b/tests/test_simulated_annealing.py
@@ -1,5 +1,5 @@
 from random import uniform
-from library.SimulatedAnnealing import SimulatedAnnealing
+from Solid.SimulatedAnnealing import SimulatedAnnealing
 from numpy import array
 
 

diff --git a/tests/test_stochastic_hill_climb.py b/tests/test_stochastic_hill_climb.py
@@ -1,5 +1,5 @@
 from random import uniform
-from library.StochasticHillClimb import StochasticHillClimb
+from Solid.StochasticHillClimb import StochasticHillClimb
 from numpy import array
 
 

diff --git a/tests/test_tabu_search.py b/tests/test_tabu_search.py
@@ -1,6 +1,6 @@
 from random import choice, randint, random
 from string import lowercase
-from library.TabuSearch import TabuSearch
+from Solid.TabuSearch import TabuSearch
 from copy import deepcopy