Merge pull request #91 from omshinde/fix-issue-87-51

Fixes issue #87

Author: cvvergara

REQUIREMENTS.txt

@@ -1,6 +1,4 @@
 Sphinx==1.6.5
-sphinx-intl==0.9.11
-transifex-client==0.13.4
-#twitter==1.10.2
-sphinxcontrib-images==0.7.0
-sphinx_bootstrap_theme==0.4
+sphinx-intl>=0.9.11
+sphinx_bootstrap_theme>=0.4
+wheel>=0.33.6

Readme.md

@@ -1,35 +1,33 @@
 # pgRouting Workshop
+## Requirements
 
-## Install
+* python
 
-For building HTML documentation you need the following packages:
+## Working virtual environment
 
-```bash
-sudo apt update
-sudo apt install cmake python-pip
-sudo pip install -r REQUIREMENTS.txt
-```
-
-For building the documentation as PDF the following packages need to be installed:
-
-```bash
-sudo apt install texlive-latex-extra
-```
+  ``` 
+  python3 -m venv py-env
+  source py-env/bin/activate
+  pip install -r REQUIREMENTS.txt
+  ```
+* If you are using Python 3, then you should already have the venv module from the standard library installed. If you don't have it then do:
 
-For translations (needs to be confirmed):
-
-```bash
-sudo apt install texinfo
-```
+  ``` sudo apt-get install python3-venv ```
 
 ## Build
 
-To build the workshop documentation with all further steps, go into `docs` directory and run::
+### Build the workshop:
 
 ```bash
 cd docs
 make html
 ```
+### Building PDF
+
+Install prerequisite:
+```bash
+sudo apt-get install texlive-latex-extra
+```
 
 To build the documentation as PDF:
 
@@ -48,3 +46,4 @@ This workshop is licensed under a [Creative Commons Attribution-Share Alike 3.0
 
 * [Georepublic](https://georepublic.info)
 * [iMaptools](http://imaptools.com)
+* [Paragon Corporation](https://www.paragoncorporation.com)

boost_example.rst

@@ -0,0 +1,91 @@
+..
+  ****************************************************************************
+  pgRouting Workshop Manual
+  Copyright(c) pgRouting Contributors
+
+  This documentation is licensed under a Creative Commons Attribution-Share
+  Alike 3.0 License: http://creativecommons.org/licenses/by-sa/3.0/
+  ****************************************************************************
+
+Boost Dijkstra Example
+===============================================================================
+
+Using, pgRouting you can translate `C++ dijkstra code <http://www.boost.org/doc/libs/1_59_0/libs/graph/example/dijkstra-example.cpp>`_ into SQL commands.
+
+.. rubric:: Boost Code
+
+.. code-block:: cpp
+
+  const int num_nodes = 5;
+  enum nodes { A, B, C, D, E }; = 1
+  char name[] = "ABCDE";
+  Edge edge_array[] = { Edge(A, C), Edge(B, B), Edge(B, D), Edge(B, E),
+    Edge(C, B), Edge(C, D), Edge(D, E), Edge(E, A), Edge(E, B)
+  };
+  int weights[] = { 1, 2, 1, 2, 7, 3, 1, 1, 1 };
+
+Here is the tranlasted SQL commands.
+
+.. rubric:: Translated Code
+
+.. code-block:: sql
+   
+   DROP TABLE IF EXISTS table1;
+   CREATE TABLE table1 (
+       id SERIAL,
+       source INTEGER,
+       target INTEGER,
+       source_name TEXT,
+       target_name TEXT,
+       cost FLOAT
+   );
+   DROP TABLE IF EXISTS table1_vertices;
+   CREATE TABLE table1_vertices (
+       vid SERIAL,
+       name TEXT
+   );
+   
+   INSERT INTO table1_vertices (name) VALUES ('A');
+   INSERT INTO table1_vertices (name) VALUES ('B');
+   INSERT INTO table1_vertices (name) VALUES ('C');
+   INSERT INTO table1_vertices (name) VALUES ('D');
+   INSERT INTO table1_vertices (name) VALUES ('E');
+   
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('A', 'C', 1);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('B', 'B', 2);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('B', 'D', 1);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('B', 'E', 2);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('C', 'B', 7);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('C', 'D', 3);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('D', 'E', 1);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('E', 'A', 1);
+   INSERT INTO table1 (source_name, target_name, cost) VALUES ('E', 'B', 1);
+   
+   UPDATE table1 
+     SET source = table1_vertices.vid
+   FROM table1_vertices
+   WHERE source_name = name;
+   
+   UPDATE table1 SET target = table1_vertices.vid
+   FROM table1_vertices
+   WHERE target_name = name;
+   
+   -- Their output starts with 0 so we subtract 1 to the vid
+   -- pgrouting: no paths or 0 length (aka I am there, so no path) are not included
+   SELECT end_vid-1, agg_cost FROM pgr_dijkstra(
+       'SELECT id, source, target, cost FROM table1',
+   1, ARRAY[1, 2, 3, 4, 5], true) where edge < 0 order by end_vid;
+
+Output from running the following SQL command:
+
+.. rubric:: Output
+
+.. code-block:: sql
+
+    ?column? | agg_cost 
+   ----------+----------
+           1 |        6
+           2 |        1
+           3 |        4
+           4 |        5
+   (4 rows)