Prepare renaming of repository

* Restructured repo

Author: HaaLeo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -5,7 +5,7 @@ about: Create a report to help us improve
 ---
 
 <!-- Please fulfill the table below-->
-| Python Version | aco4tsp Version |
+| Python Version | swarmlib Version |
 | -------------- | --------------- |
 |                |                 |
 

.travis.yml

@@ -8,7 +8,7 @@ stages:
   - test
   - bundle
   - name: deploy
-    if: tag =~ /^v\d+\.\d+\.\d+$/ AND repo = HaaLeo/aco4tsp
+    if: tag =~ /^v\d+\.\d+\.\d+$/ AND repo = HaaLeo/swarmlib
 
 install:
   - pip install -r requirements-dev.txt

.vscode/launch.json

@@ -2,14 +2,16 @@
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "Python: Main",
+            "name": "Python: aco4tsp",
             "type": "python",
             "request": "launch",
-            "program": "${workspaceFolder}/src/main.py",
+            "program": "${workspaceFolder}/swarmlib/main.py",
+            "preLaunchTask": "Bundle and Install",
             "console": "none",
             "args": [
+                "ants",
                 "${workspaceFolder}/resources/burma14.tsp",
-                14
+                "14"
             ]
         }
     ]

.vscode/settings.json

@@ -16,7 +16,8 @@
         "Stuetzle",
         "optimisation",
         "TSPLIB",
-        "paypal"
+        "paypal",
+        "swarmlib"
     ],
     "files.insertFinalNewline": true,
     "files.trimFinalNewlines": true,

.vscode/tasks.json

@@ -0,0 +1,12 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "Bundle and Install",
+            "type": "shell",
+            "windows": {
+                "command": "Remove-Item -Recurse -Force dist; py -3 setup.py sdist bdist_wheel; Get-Childitem –Path ./dist/*whl | Select-Object -ExpandProperty Name -outvariable package; pip3 install ./dist/$package --user --upgrade"
+            },
+        }
+    ]
+}

CHANGELOG.md

@@ -1,10 +1,7 @@
 # Changelog
-All notable changes to the "aco4tsp" pypi package will be documented in this file.  
+All notable changes to the "swarmlib" pypi package will be documented in this file.  
 This project follows [semantic versioning](https://semver.org/).
 
-## 2018-11-21 - v0.0.2
-* **Fixed** representation on [pypi](https://pypi.org/project/aco4tsp/)
-
-## 2018-11-21 - v0.0.1
+## 2018-11-23 - v0.0.1
 * **Initial Release**
 * **Added** a feature that enables solving the Traveling Salesman Problem using the Ant Colony Optimization approach and plots the result afterwards

README.md

@@ -1,56 +1,59 @@
-# aco4tsp — ant colony optimization
+# swarmlib
 
-[![Pypi](https://img.shields.io/pypi/v/aco4tsp.svg?style=flat-square)](https://pypi.python.org/pypi/aco4tsp) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aco4tsp.svg?style=flat-square)](https://pypi.python.org/pypi/aco4tsp) [![Stars](https://img.shields.io/github/stars/HaaLeo/aco4tsp.svg?label=Stars&logo=github&style=flat-square)](https://github.com/HaaLeo/aco4tsp/stargazers)  
-[![PyPI - License](https://img.shields.io/pypi/l/aco4tsp.svg?style=flat-square)](https://pypi.python.org/pypi/aco4tsp) 
-[![Build Status](https://img.shields.io/travis/HaaLeo/aco4tsp/master.svg?style=flat-square)](https://travis-ci.org/HaaLeo/aco4tsp) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)  
+[![Pypi](https://img.shields.io/pypi/v/swarmlib.svg?style=flat-square)](https://pypi.python.org/pypi/swarmlib) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/swarmlib.svg?style=flat-square)](https://pypi.python.org/pypi/swarmlib) [![Stars](https://img.shields.io/github/stars/HaaLeo/swarmlib.svg?label=Stars&logo=github&style=flat-square)](https://github.com/HaaLeo/swarmlib/stargazers)  
+[![PyPI - License](https://img.shields.io/pypi/l/swarmlib.svg?style=flat-square)](https://pypi.python.org/pypi/swarmlib) 
+[![Build Status](https://img.shields.io/travis/HaaLeo/swarmlib/master.svg?style=flat-square)](https://travis-ci.org/HaaLeo/swarmlib) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)  
 [![Donate](https://img.shields.io/badge/-Donate-blue.svg?logo=paypal&style=flat-square)](https://www.paypal.me/LeoHanisch)
 
 ## Description
 
-This repository implements an ant colony optimization algorithm for the traveling salesman problem (TSP) like Marco Dorigo, Mauro Birattari, and Thomas Stuetzle introduced in the [IEEE Computational Intelligence Magazine](https://ieeexplore.ieee.org/document/4129846) in November 2006 (DOI: 10.1109/MCI.2006.329691).  
-The implementation was part of the course [Natural computing for learning and optimisation](https://is.cuni.cz/studium/eng/predmety/index.php?do=predmet&kod=NPFL107) at Charles University Prague in winter 2018/2019.
-
-## Features
+This repository implements several optimization algorithms.
 
-Enables to apply the ant colony optimization algorithm to a TSP using a [TSPLIB95](https://www.iwr.uni-heidelberg.de/groups/comopt/software/TSPLIB95/index.html) file and plots the result.
-
-![Sample](https://raw.githubusercontent.com/HaaLeo/aco4tsp/master/doc/Sample.png)
-
-The algorithm solves the TSP and plots the result all _n_ iterations.  
-The nodes are plot according to their coordinates read from the TSPLIB95 file. The _widths_ of the edges indicate the _amount of pheromone_ that is associated with this edge. If an edge is _blue_, it is part of the _best found path_.
+>Currently only the ant colony optimization is included.
 
 ## Installation
 
-You can install the package with `pip` from [pypi](https://pypi.org/project/aco4tsp):
+You can install the package with `pip` from [pypi](https://pypi.org/project/swarmlib):
 
 ```
-pip3 install aco4tsp
+pip3 install swarmlib
 
-aco4tsp --version
+swarm --version
 ```
 
 ## Usage
 
-### Client
-
-To print all available options:
+To print all available algorithms:
 
 ```
-aco4tsp --help
+swarm --help
 ```
 
-Example:
+## Ant Colony Optimization
+This repository includes an ant colony optimization algorithm for the traveling salesman problem (TSP) like Marco Dorigo, Mauro Birattari, and Thomas Stuetzle introduced in the [IEEE Computational Intelligence Magazine](https://ieeexplore.ieee.org/document/4129846) in November 2006 (DOI: 10.1109/MCI.2006.329691).  
+The implementation was part of the course [Natural computing for learning and optimisation](https://is.cuni.cz/studium/eng/predmety/index.php?do=predmet&kod=NPFL107) at Charles University Prague in winter 2018/2019.
+
+### Features
+
+Enables to apply the ant colony optimization algorithm to a TSP using a [TSPLIB95](https://www.iwr.uni-heidelberg.de/groups/comopt/software/TSPLIB95/index.html) file and plots the result.
+
+![Sample](https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/ACO_Sample.png)
+
+The algorithm solves the TSP and plots the result all _n_ iterations.  
+The nodes are plot according to their coordinates read from the TSPLIB95 file. The _widths_ of the edges indicate the _amount of pheromone_ that is associated with this edge. If an edge is _blue_, it is part of the _best found path_.
+
+To print all available options execute:
 
 ```
-aco4tsp resources/burma14.tsp 14
+swarm ants -h
 ```
 
 ### API
 
 In addition to the client you can also use the API:
 
 ```python
-from aco4tsp.aco_problem import ACOProblem
+from swarmlib.aco4tsp.aco_problem import ACOProblem
 
 problem = ACOProblem('/path/to/my/tsp-file.tsp', 10)
 if problem.solve():
@@ -59,9 +62,9 @@ if problem.solve():
 
 ## Contribution
 
-If you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/aco4tsp/issues/new/choose).  
+If you found a bug or are missing a feature do not hesitate to [file an issue](https://github.com/HaaLeo/swarmlib/issues/new/choose).  
 Pull Requests are welcome!
 
 ## Support
-When you like this package make sure to [star the repository](https://github.com/HaaLeo/aco4tsp/stargazers). I am always looking for new ideas and feedback.  
+When you like this package make sure to [star the repository](https://github.com/HaaLeo/swarmlib/stargazers). I am always looking for new ideas and feedback.  
 In addition, it is possible to [donate via paypal](https://www.paypal.me/LeoHanisch).

aco4tsp/_version.py

@@ -7,17 +7,17 @@
 with open(path.join(path.abspath(path.dirname(__file__)), 'README.md'), 'r') as rf:
     LONG_DESCRIPTION = rf.read()
 
-with open(path.join(path.abspath(path.dirname(__file__)), 'aco4tsp/_version.py'), 'r') as f:
+with open(path.join(path.abspath(path.dirname(__file__)), 'swarmlib/_version.py'), 'r') as f:
     exec(f.read())
 
 setup(
-    name='aco4tsp',  # PEP8: Packages should also have short, all-lowercase names, the use of underscores is discouraged
+    name='swarmlib',  # PEP8: Packages should also have short, all-lowercase names, the use of underscores is discouraged
     version=__version__,
     packages=find_packages(exclude=['*test']),
-    description='Implementation of Ant Colony Optimization for the Traveling Salesman Problem.',
+    description='Implementation and visualization of different swarm optimization algorithms.',
     long_description=LONG_DESCRIPTION,
     long_description_content_type='text/markdown',
-    url='https://github.com/HaaLeo/aco4tsp',
+    url='https://github.com/HaaLeo/swarmlib',
     author='Leo Hanisch',
     license='BSD 3-Clause License',
     install_requires=[
@@ -26,8 +26,8 @@
         'networkx==2.1'  # Required by tsplib95 0.3.2
     ],
     project_urls={
-        'Issue Tracker': 'https://github.com/HaaLeo/aco4tsp/issues',
-        'Changelog': 'https://github.com/HaaLeo/aco4tsp/blob/master/CHANGELOG.md'
+        'Issue Tracker': 'https://github.com/HaaLeo/swarmlib/issues',
+        'Changelog': 'https://github.com/HaaLeo/swarmlib/blob/master/CHANGELOG.md'
     },
     python_requires='>=3.6',
     keywords=[
@@ -62,7 +62,7 @@
     ],
     entry_points={
         'console_scripts': [
-            'aco4tsp=aco4tsp.main:main'
+            'swarm=swarmlib.main:run_swarm'
         ]
     }
 )

aco4tsp/main.py

@@ -0,0 +1 @@
+__version__ = '0.0.1'