diff --git a/README.md b/README.md index 218e6f528aac7d9b73d868fb05dab17486a6bc4f..90d18980a4b56b627e37430902d9e86b1ea40543 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,54 @@ # Packing_Polygons_Pycharm +Installation + +- Python 3.8 is required + +Windows +1) download the repository +2) open terminal +3) navigate to the repository +4) venv\Scripts\activate +5) pip install -r packing_polygons_pycharm\mysite\requirements\base.txt + +--------------------------------------------------------------------------------- +Linux +1) git clone https://git.imp.fu-berlin.de/tolgayurt/packing_polygons_pycharm.git +2) ./packing_polygons_pycharm/mysite/venv/Scripts/activate +3) pip install -r packing_polygons_pycharm/mysite/requirements/base.txt +4) python packing_polygons_pycharm/mysite/manage.py runserver + + + +Start your browser to use the Server and navigate to the url http://127.0.0.1:8000/ + +--------------------------------------------------------------------------------- +Working Concept. + +1. Create Data for the drawtool, +draw or edit polygons with the buttons in top right legend + - in the PolyDrawTool tab on (https://docs.bokeh.org/en/latest/docs/user_guide/tools.html#edit-tools) is animated guide + - in the PolyEditTool tab on the same site are explination for adding or deleting vertices + - in some browser the delete button is not working for the draw tool because the website is accepting the input, you need to turn it off + - to delete vertices +1.2 With the polygon creator button + 1.3 Or write your Polygons into the polygon.txt file, path: packing_polygons_pycharm/mysite/plots/polygon.txt, + an example how to write the polygons to polygons.txt file is already included + every line is representing one polygon + +2. The polygons which got created need to be loaded into the storage + 2.1 With the button load all polygon which are visible in the drawtool will be loaded to the storage + 2.2 With clear delete all loaded from storage + +3. Choose one of the packing variants to pack the stored polygons + - axis-aligned rectangular container + - best axis-aligned rectangular container from 0, 90, 180, 270 packed containers + - recatngular container + + +---------------------------------------------------------------------------- +Repository structure relevant files: + +The implemented polygon aglortihm is in the file packing_algo.py (mysite/plots/packing_algo.py) +The AVLTree structure is in the avl_tree.py (packing_polygons_pycharm/mysite/plots/avl_tree.py) +The data_creator algorithm are in (packing_polygons_pycharm/mysite/plots/polygon_creator.py)