Workshop improvements and fixes (#2008)

* Clarify that user must make greyhound.json file if it does not exist * Fix typos * Fix typo * Fix inlined attributes.vrt for new GDAL behavior, change relative to absolute path * Fix typo * Actually fix inline VRT * Fix formatting issue * Clarify that user must edit files to change references to C:\Users\hobu\ * Instruct user to install QGIS during installation of OSGeo4W * Describe the last few steps of OSGeo4W installation * Explicitly tell user to cd into translation folder * Remove caret so command matches picture Remove line continuation so that the command text matches the picture. The command will not work as written, because the whitespace causes 'jq' to be interpretted as ' jq', which causes the entire command to fail * Fix typo * Remind user to edit JSON with correct path Remind user to open JSON file and replace all occurances of 'c:\Users\hobu\' with their own path * Fix typo
PDAL · May 10, 2018 · 2214bdd · verma · Jan 15, 2020 · 2214bdd
1 parent d164163
commit 2214bdd
Show file tree

Hide file tree

Showing 13 changed files with 64 additions and 25 deletions.
diff --git a/doc/workshop/exercises/analysis/boundary/boundary.rst b/doc/workshop/exercises/analysis/boundary/boundary.rst
@@ -8,7 +8,7 @@ Finding the boundary
 .. index:: boundary, QGIS, OGR
 
 
-This exercise uses PDAL to find a tight-fighting boundary of an aerial scan.
+This exercise uses PDAL to find a tight-fitting boundary of an aerial scan.
 Printing the coordinates of the boundary for the file is quite simple using a
 single ``pdal info`` call, but visualizing the boundary is more complicated. To
 complete this exercise, we are going to use :ref:`qgis` to view the

diff --git a/doc/workshop/exercises/analysis/clipping/attributes.vrt b/doc/workshop/exercises/analysis/clipping/attributes.vrt
@@ -1,9 +1,10 @@
-    <OGRVRTDataSource>
-        <OGRVRTWarpedLayer>
-            <OGRVRTLayer name="OGRGeoJSON">
-                <SrcDataSource>c:/Users/hobu/PDAL/exercises/analysis/clipping/attributes.json</SrcDataSource>
-                <LayerSRS>EPSG:4326</LayerSRS>
-            </OGRVRTLayer>
-            <TargetSRS>+proj=lcc +lat_1=43 +lat_2=45.5 +lat_0=41.75 +lon_0=-120.5 +x_0=399999.9999999999 +y_0=0 +ellps=GRS80 +units=ft +no_defs</TargetSRS>
-        </OGRVRTWarpedLayer>
-    </OGRVRTDataSource>
+<OGRVRTDataSource>
+    <OGRVRTWarpedLayer>
+        <OGRVRTLayer name="OGRGeoJSON">
+            <SrcDataSource>c:/Users/hobu/PDAL/exercises/analysis/clipping/attributes.json</SrcDataSource>
+            <SrcLayer>attributes</SrcLayer>
+            <LayerSRS>EPSG:4326</LayerSRS>
+        </OGRVRTLayer>
+        <TargetSRS>+proj=lcc +lat_1=43 +lat_2=45.5 +lat_0=41.75 +lon_0=-120.5 +x_0=399999.9999999999 +y_0=0 +ellps=GRS80 +units=ft +no_defs</TargetSRS>
+    </OGRVRTWarpedLayer>
+</OGRVRTDataSource>
diff --git a/doc/workshop/exercises/analysis/clipping/clipping.rst b/doc/workshop/exercises/analysis/clipping/clipping.rst
@@ -44,7 +44,8 @@ capability to reproject the data for us on-the-fly:
     <OGRVRTDataSource>
         <OGRVRTWarpedLayer>
             <OGRVRTLayer name="OGRGeoJSON">
-                <SrcDataSource>attributes.json</SrcDataSource>
+                <SrcDataSource>c:/Users/hobu/PDAL/exercises/analysis/clipping/attributes.json</SrcDataSource>
+                <SrcLayer>attributes</SrcLayer>
                 <LayerSRS>EPSG:4326</LayerSRS>
             </OGRVRTLayer>
             <TargetSRS>+proj=lcc +lat_1=43 +lat_2=45.5 +lat_0=41.75 +lon_0=-120.5 +x_0=399999.9999999999 +y_0=0 +ellps=GRS80 +units=ft +no_defs</TargetSRS>
@@ -54,7 +55,11 @@ capability to reproject the data for us on-the-fly:
 .. note::
 
     This VRT file is available in your workshop materials in the
-    ``./exercises/analysis/clipping/attributes.json`` file. A GDAL or OGR VRT
+    ``./exercises/analysis/clipping/attributes.vrt`` file. You will need to
+    open this file, go to line 4 and replace ``c:/Users/hobu/PDAL/`` with
+    the correct path for your machine.
+
+    A GDAL or OGR VRT
     is a kind of "virtual" data source definition type that combines a
     definition of data and a processing operation into a single, readable data
     stream.
@@ -80,7 +85,9 @@ Pipeline breakdown
 .. note::
 
     This pipeline is available in your workshop materials in the
-    ``./exercises/analysis/clipping/clipping.json`` file.
+    ``./exercises/analysis/clipping/clipping.json`` file. Remember
+    to replace each of the three occurrences of ``c:/Users/Hobu/PDAL/``
+    in this file with the correct location for your machine.
 
 1. Reader
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -103,10 +110,10 @@ The attributes in the ``attributes.json`` file include polygons with values
 ``2``, ``5``, and ``6``. We will use :ref:`filters.range` to keep points with
 ``Classification`` values in the range of ``6:6``.
 
-3. Writer
+4. Writer
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-* We will write our content back out using an :ref:`writers.las`.
+We will write our content back out using a :ref:`writers.las`.
 
 Execution
 ................................................................................

diff --git a/doc/workshop/exercises/analysis/colorization/colorization.rst b/doc/workshop/exercises/analysis/colorization/colorization.rst
@@ -27,6 +27,13 @@ to define it.
 .. literalinclude:: ./colorize.json
     :linenos:
 
+.. note::
+
+    This JSON file is available in your workshop materials in the
+    ``./exercises/analysis/colorization/colorize.json`` file. Remember to
+    open this file and replace each occurrence of ``c:/Users/hobu/PDAL/``
+    with the correct path for your machine.
+
 Pipeline breakdown
 ................................................................................
 
@@ -99,8 +106,7 @@ add a few options to have finer control over what is written. These include:
 Execution
 ................................................................................
 
-Invoke the following command, substituting accordingly, in your `Docker
-Quickstart Terminal`:
+Invoke the following command, substituting accordingly, in your |Terminal|:
 
 
 .. literalinclude:: ./colorization-run-command.txt

diff --git a/doc/workshop/exercises/translation/greyhound-cd-command.txt b/doc/workshop/exercises/translation/greyhound-cd-command.txt
@@ -0,0 +1 @@
+cd C:\Users\hobu\PDAL\exercises\translation
diff --git a/doc/workshop/exercises/translation/greyhound-info-command.txt b/doc/workshop/exercises/translation/greyhound-info-command.txt
@@ -1,2 +1 @@
-pdal info just-ground.las | ^
-    jq .stats.bbox.native
+pdal info just-ground.laz | jq .stats.bbox.native
diff --git a/doc/workshop/exercises/translation/greyhound.rst b/doc/workshop/exercises/translation/greyhound.rst
@@ -22,7 +22,14 @@ http://potree.entwine.io/data/dublin.html
 .. index:: Potree
 
 
-1. View the ``greyhound.json`` file in your editor
+1. In your |Terminal|, navigate to the ``C:\Users\hobu\PDAL\exercises\translation``
+   folder.
+
+
+    .. literalinclude:: ./greyhound-cd-command.txt
+
+2. View the ``greyhound.json`` file in your editor. If the file does not exist, create
+   it and paste the following JSON into it:
 
 
     .. literalinclude:: ./greyhound.json
@@ -34,7 +41,7 @@ http://potree.entwine.io/data/dublin.html
         browser making requests against the Greyhound server at
         http://data.greyhound.io
 
-2. Issue the following command in your |Terminal|.
+3. Issue the following command in your |Terminal|.
 
 
     .. literalinclude:: ./greyhound-command.txt
@@ -44,15 +51,15 @@ http://potree.entwine.io/data/dublin.html
 
 .. _`Developer Console`: https://developers.google.com/web/tools/chrome-devtools/console/
 
-3. Verify that the data look ok:
+4. Verify that the data look ok:
 
     .. literalinclude:: ./greyhound-info-command.txt
 
     .. image:: ../../images/greyhound-info-verify.png
         :target: ../../../_images/greyhound-info-verify.png
 
 
-4. Visualize the data in http://plas.io
+5. Visualize the data in http://plas.io
 
     .. image:: ../../images/greyhound-view.png
         :target: ../../../_images/greyhound-view.png

diff --git a/doc/workshop/exercises/translation/reprojection-command-1.txt b/doc/workshop/exercises/translation/reprojection-command-1.txt
@@ -1,4 +1,4 @@
-pdal translate ^
+pdal translate c:/Users/hobu/PDAL/exercises/analysis/ground/CSite1_orig-utm.laz ^
     c:/Users/hobu/PDAL/exercises/translation/csite-dd.laz ^
     reprojection ^
     --filters.reprojection.out_srs="EPSG:4326"
diff --git a/doc/workshop/images/osgeo4w-dep-selection.png b/doc/workshop/images/osgeo4w-dep-selection.png
diff --git a/doc/workshop/images/osgeo4w-license-selection.png b/doc/workshop/images/osgeo4w-license-selection.png
diff --git a/doc/workshop/images/osgeo4w-qgis-selection.png b/doc/workshop/images/osgeo4w-qgis-selection.png
diff --git a/doc/workshop/includes/substitutions.rst b/doc/workshop/includes/substitutions.rst
@@ -21,7 +21,7 @@
 .. |Docker| replace:: `Docker <https://www.docker.com/>`__
 .. |LiDAR| replace:: `LiDAR <https://en.wikipedia.org/wiki/Lidar>`__
 .. |CRREL| replace:: `CRREL <http://www.erdc.usace.army.mil/Locations/ColdRegionsResearchandEngineeringLaboratory.aspx>`__
-.. |Hobu| replace:: `Hobu <httsp://hobu.co/>`__
+.. |Hobu| replace:: `Hobu <https://hobu.co/>`__
 .. |Optech| replace:: `Optech <http://www.teledyneoptech.com/>`__
 .. |RIEGL| replace:: `RIEGL <http://riegl.com/>`__
 .. |Greyhound| replace:: `Greyhound <http://greyhound.io/>`__

diff --git a/doc/workshop/osgeo4w.rst b/doc/workshop/osgeo4w.rst
@@ -61,3 +61,21 @@ Installing OSGeo4W
    section and choose the ``PDAL`` package.
 
    .. image:: ./images/osgeo4w-pdal-selection.png
+
+5. Search for "QGIS" in the search box or drill down through the Desktop
+   section and choose the ``QGIS`` package. This will be used in a later
+   section of the workshop.
+
+   .. image:: ./images/osgeo4w-qgis-selection.png
+
+6. You will probably get a screen telling you that you have unmet dependencies.
+   You must check the box next to ``Install these packages to meet dependencies (RECOMMENDED)``
+   for PDAL to work.
+
+   .. image:: ./images/osgeo4w-dep-selection.png
+
+7. You will probably get at least one screen asking you to accept a license agreement.
+   You must check the box next to ``I agreed with the above license terms`` on each screen
+   for PDAL to work.
+
+   .. image:: ./images/osgeo4w-license-selection.png