Merge prepared

LennartJKlein · Dec 15, 2017 · 989cea5 · 989cea5
1 parent bed9a7a
commit 989cea5
Show file tree

Hide file tree

Showing 51 changed files with 69 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -1,25 +1,38 @@
 # Pathfinder
 
-A program that uses wires to connect gates on a chip three-dimensionally and efficiently. Based on the case of [Chips & Circuits](http://heuristieken.nl/wiki/index.php?title=Chips_%26_Circuits)
+A program that uses wires to connect gates on a chip three-dimensionally and efficiently. Based on the case of [Chips & Circuits](http://heuristieken.nl/wiki/index.php?title=Chips_%26_Circuits).
 
-## Requirements
+Chips (or more precisely: integrated circuits) are found in your PC, MacBook, Android Phone and microwave oven where they perform a diversity of functions, ranging from timekeeping and motor control to arithmetic and logic. Basically a small plate of silicon, chips are usually designed logically and subsequentially transformed to a list of connectable gates. This list, commonly known as a net list is finally transformed into a 2-dimensional design on a silicon base.
 
-To run this program, you need the following:
+This last step however, the physical real-world process of connecting the gates, is highly volatile. Good arrangements on the base lead to short connections, leading to faster circuits, whereas poor arrangements lead to slower circuits. It leads to no doubt that a good arrangement of logical gates and good wiring between them is of vital essence to the performance of the IC as a whole (source: http://heuristieken.nl/wiki/index.php?title=Chips_%26_Circuits).
+
+The algorithms and content of the sample is ben setup to create paths from predefined net lists and two boards that can be found in sample/data. So in short, the aim is to connect the dots (gates) in a efficient manner.
+
+### Notable content:
+
+### Docs/html
+The [documentations](https://lennartjklein.github.io/pathfinder/) of the classes and helper functions used in sample. The documentations are made by Sphinx, a docstring converter.
 
-* Python 3.6
+### Experimtents
+One experiment is documented at the moment. We used a random netlist creator and random board creator to see how the used algorithms preformed.
 
-## Installation
+### Sample
+Sample is the core of our repository! \__main.\__.py is the core of the core. It makes use of classes.py and helpers.py to drive the algorithems to solve the case.
+Aditions are colors.py for adding terminal colors and settings.py. settings.py can be used to modify the program but more on that in de README.md in the sample directory.
 
-Clone this repository (containing the pathfinder module) to a folder of your preference. And run the setup:
 
-```
-python setup.py install
-```
+## Requirements
+To run this program, you need the following:
+
+* Python 3.6.3
+* [numpy](http://www.numpy.org/) 1.13.3
+* [matplotlib](https://matplotlib.org/index.html) 2.1.0
 
-## Documentation
-Learn how to install, test, use and integrate this program that finds efficient paths in the [documentation](docs/index.md).
+### Installation
 
-## Definitions:
+Clone or download this repository (containing the pathfinder module) to a folder of your preference. Make sure the requirements above are installed to be able to run the program.
+
+### Definitions:
 *Board*: The board a three dimensional grid with a presetted height, weight and depth.
 
 *Gate*: A gate is placed on the surface of the board and can be connected to another gate.
@@ -36,10 +49,9 @@ Learn how to install, test, use and integrate this program that finds efficient
 
 *Solvability of a board*: The average calculated percentage of a board with randomly placed gates and random netlists.
 
-
 ## Contributing
 
-This project is not open for contributing, for it being a school assignment.
+This project is not open for contributing at the moment, for it being a school assignment.
 
 ## Versioning
 
@@ -49,7 +61,7 @@ We use [SemVer](http://semver.org/) for semantic versioning. For the versions av
 
 * **Jurre Brandsen** - *Developer* - [www.jurrebrandsen.nl](http://www.jurrebrandsen.nl/)
 * **Lennart Klein** - *Webdeveloper and webdesigner* - [www.lennartklein.nl](http://www.lennartklein.nl/)
-* **Thomas de Lange** - *Initial work* - [www.long-coding.nl](http://www.long-coding.nl/)
+* **Thomas de Lange** - *Developer* - [www.long-coding.nl](http://www.long-coding.nl/)
 
 ## License
 
@@ -58,4 +70,3 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
 ## Acknowledgments
 
 * Thanks to Daan van den Berg for creating the "Chips and circuits" case (as specified on [this Wiki](http://heuristieken.nl/wiki/index.php?title=Chips_%26_Circuits)).
-* Thanks to Westly White for his [initial grid design](https://stackoverflow.com/questions/41619600/numbering-rows-and-columns-in-a-grid-board) in board.py.
diff --git a/docs/html/.buildinfo → docs/.buildinfo b/docs/html/.buildinfo → docs/.buildinfo
diff --git a/docs/html/.nojekyll → docs/.nojekyll b/docs/html/.nojekyll → docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+# Docs/html
+
+The [documentations](https://lennartjklein.github.io/pathfinder/) of the classes and helper functions used in sample. The documentations are made by [Sphinx](http://sphinx-doc.org) version  1.6.6. Sphinx world famous for making a white sheet documentation.
diff --git a/docs/html/_modules/classes.html → docs/_modules/classes.html b/docs/html/_modules/classes.html → docs/_modules/classes.html
diff --git a/docs/html/_modules/helpers.html → docs/_modules/helpers.html b/docs/html/_modules/helpers.html → docs/_modules/helpers.html
diff --git a/docs/html/_modules/index.html → docs/_modules/index.html b/docs/html/_modules/index.html → docs/_modules/index.html
diff --git a/docs/html/_sources/classes.rst.txt → docs/_sources/classes.rst.txt b/docs/html/_sources/classes.rst.txt → docs/_sources/classes.rst.txt
diff --git a/docs/html/_sources/colors.rst.txt → docs/_sources/colors.rst.txt b/docs/html/_sources/colors.rst.txt → docs/_sources/colors.rst.txt
diff --git a/docs/html/_sources/helpers.rst.txt → docs/_sources/helpers.rst.txt b/docs/html/_sources/helpers.rst.txt → docs/_sources/helpers.rst.txt
diff --git a/docs/html/_sources/index.rst.txt → docs/_sources/index.rst.txt b/docs/html/_sources/index.rst.txt → docs/_sources/index.rst.txt
@@ -24,22 +24,6 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-
-Requirements
-------------
-To run this program, you need the following:
-
-* Python 3.6
-
-Installation
-------------
-
-Clone this repository (containing the pathfinder module) to a folder of your preference. And run the setup:
-
-```
-python setup.py install
-```
-
 Authors
 -------
     - `Jurre Brandsen <http://www.jurrebrandsen.nl/>`_.

diff --git a/docs/html/_sources/settings.rst.txt → docs/_sources/settings.rst.txt b/docs/html/_sources/settings.rst.txt → docs/_sources/settings.rst.txt
diff --git a/docs/html/_static/LICENSE → docs/_static/LICENSE b/docs/html/_static/LICENSE → docs/_static/LICENSE
diff --git a/docs/html/_static/ajax-loader.gif → docs/_static/ajax-loader.gif b/docs/html/_static/ajax-loader.gif → docs/_static/ajax-loader.gif
diff --git a/docs/html/_static/alabaster.css → docs/_static/alabaster.css b/docs/html/_static/alabaster.css → docs/_static/alabaster.css
diff --git a/docs/html/_static/basic.css → docs/_static/basic.css b/docs/html/_static/basic.css → docs/_static/basic.css
diff --git a/docs/html/_static/comment-bright.png → docs/_static/comment-bright.png b/docs/html/_static/comment-bright.png → docs/_static/comment-bright.png
diff --git a/docs/html/_static/comment-close.png → docs/_static/comment-close.png b/docs/html/_static/comment-close.png → docs/_static/comment-close.png
diff --git a/docs/html/_static/comment.png → docs/_static/comment.png b/docs/html/_static/comment.png → docs/_static/comment.png
diff --git a/docs/html/_static/custom.css → docs/_static/custom.css b/docs/html/_static/custom.css → docs/_static/custom.css
diff --git a/docs/html/_static/doctools.js → docs/_static/doctools.js b/docs/html/_static/doctools.js → docs/_static/doctools.js
diff --git a/docs/html/_static/down-pressed.png → docs/_static/down-pressed.png b/docs/html/_static/down-pressed.png → docs/_static/down-pressed.png
diff --git a/docs/html/_static/down.png → docs/_static/down.png b/docs/html/_static/down.png → docs/_static/down.png
diff --git a/docs/html/_static/file.png → docs/_static/file.png b/docs/html/_static/file.png → docs/_static/file.png
diff --git a/docs/html/_static/jquery-3.1.0.js → docs/_static/jquery-3.1.0.js b/docs/html/_static/jquery-3.1.0.js → docs/_static/jquery-3.1.0.js
diff --git a/docs/html/_static/jquery.js → docs/_static/jquery.js b/docs/html/_static/jquery.js → docs/_static/jquery.js
diff --git a/docs/html/_static/minus.png → docs/_static/minus.png b/docs/html/_static/minus.png → docs/_static/minus.png
diff --git a/docs/html/_static/plus.png → docs/_static/plus.png b/docs/html/_static/plus.png → docs/_static/plus.png
diff --git a/docs/html/_static/pygments.css → docs/_static/pygments.css b/docs/html/_static/pygments.css → docs/_static/pygments.css
diff --git a/docs/html/_static/searchtools.js → docs/_static/searchtools.js b/docs/html/_static/searchtools.js → docs/_static/searchtools.js
diff --git a/docs/html/_static/underscore-1.3.1.js → docs/_static/underscore-1.3.1.js b/docs/html/_static/underscore-1.3.1.js → docs/_static/underscore-1.3.1.js
diff --git a/docs/html/_static/underscore.js → docs/_static/underscore.js b/docs/html/_static/underscore.js → docs/_static/underscore.js
diff --git a/docs/html/_static/up-pressed.png → docs/_static/up-pressed.png b/docs/html/_static/up-pressed.png → docs/_static/up-pressed.png
diff --git a/docs/html/_static/up.png → docs/_static/up.png b/docs/html/_static/up.png → docs/_static/up.png
diff --git a/docs/html/_static/websupport.js → docs/_static/websupport.js b/docs/html/_static/websupport.js → docs/_static/websupport.js
diff --git a/docs/html/classes.html → docs/classes.html b/docs/html/classes.html → docs/classes.html
diff --git a/docs/html/colors.html → docs/colors.html b/docs/html/colors.html → docs/colors.html
diff --git a/docs/html/genindex.html → docs/genindex.html b/docs/html/genindex.html → docs/genindex.html
diff --git a/docs/html/helpers.html → docs/helpers.html b/docs/html/helpers.html → docs/helpers.html
diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/docs/html/index.html → docs/index.html b/docs/html/index.html → docs/index.html
@@ -63,20 +63,6 @@ <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
 <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
 </ul>
 </div>
-<div class="section" id="requirements">
-<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
-<p>To run this program, you need the following:</p>
-<ul class="simple">
-<li>Python 3.6</li>
-</ul>
-</div>
-<div class="section" id="installation">
-<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
-<p>Clone this repository (containing the pathfinder module) to a folder of your preference. And run the setup:</p>
-<p><code class="docutils literal"><span class="pre">`</span>
-<span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span>
-<span class="pre">`</span></code></p>
-</div>
 <div class="section" id="authors">
 <h2>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
 <blockquote>

diff --git a/docs/html/objects.inv → docs/objects.inv b/docs/html/objects.inv → docs/objects.inv
diff --git a/docs/html/py-modindex.html → docs/py-modindex.html b/docs/html/py-modindex.html → docs/py-modindex.html
diff --git a/docs/html/search.html → docs/search.html b/docs/html/search.html → docs/search.html
diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/html/settings.html → docs/settings.html b/docs/html/settings.html → docs/settings.html
diff --git a/experiments/netlist-length/img/run55-score-regression.png b/experiments/netlist-length/img/run55-score-regression.png
diff --git a/experiments/netlist-length/img/run75-score-regression.png b/experiments/netlist-length/img/run75-score-regression.png
diff --git a/experiments/netlist-length/img/run85-score-regression.png b/experiments/netlist-length/img/run85-score-regression.png
diff --git a/requirements.txt b/requirements.txt
diff --git a/sample/README.md b/sample/README.md
@@ -0,0 +1,38 @@
+# Sample
+
+This is where the magic happens.
+
+# Notable content:
+
+## data
+
+The assignment contains 6 net lists and two gate files. Netlist 1-3 are used on gatees1, 4-6 for gates2. The gates are loaded into a Numby board.
+The netlist files are .txt and numbered from 1 to 6. 0 is a dummy list for debugging.
+Gates are numbered from 1 to 2. Also, the gates files have a dummy named gates0. The gates are comma separated files.
+
+## settings.py
+
+Before running the program, it is good to take a look at the settings. We wil explain the basics.
+PLOT_BEST, PLOT_SCORES and PLOT_RESULTS all take a Boolean value are quite self-explanatory, they will activate a plot of the result in a separate window.
+
+SHOW_NETLIST and SHOW_EACH_RESULT  also takes a Bool and will show in the terminal window. SHOW_EACH_PLOTSHOW_PROGRESS also a Bool and shows in a separate window.
+
+PATH_ALGORITHM gives the user the choice to use DIJSKTRA’s algorithm. Although we will use DIJKSTRA while looping for a bather result. To make sure to find the best solutions start off with the A* algorithm. The setting takes a string.
+
+MAX_NO_IMPROVE will kick in the moment a better solution must be found. We will loop and try to find an improvement. Only finding one is not a given thing, and to be sure to not run forever, giving a bound in with a integer is mandatory.
+
+Heuristics for A* are ways to tweak the A*. COST_PASSING_GATE and STEP_COST_PASSING_GATE both take a integer.
+
+To give the numpy board a 3d size use BOARD_WIDTH, BOARD_HEIGHT and BOARD_DEPTH with integer values.
+
+The netlist and gate files are read from the data directory, in the current setup they start with “netlist” and then a number. To use your one net list make sure to do the same. To change any of the predefined files use a integer, for the net lists in range 1-6 and for the gate files in rage 1-2. Mind using the correct netlist with the correct gates file.
+
+Finally SIGN_PATH_START and is a way of numbering the path in a Numpy board. It starts with 2 because gates are all numbered 1 (SIGN_GATE) and empty space has a 0. Changing this will probably break the program. But you can, by changing it into another integer.
+
+## colors.py
+
+Feel free to change it.
+
+## helpers.py and classes.py
+
+This files are documented [here](https://lennartjklein.github.io/pathfinder/).