Skip to content

Commit

Permalink
remove OSGeo4W mentions from docs and workshop (#2419)
Browse files Browse the repository at this point in the history
  • Loading branch information
hobu authored and abellgithub committed Mar 21, 2019
1 parent be7c13c commit 3fefd14
Show file tree
Hide file tree
Showing 24 changed files with 77 additions and 169 deletions.
12 changes: 4 additions & 8 deletions doc/development/compilation/dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,10 @@ ability, you must have GDAL (and GeoTIFF_) linked in at compile time.

Obtain `GDAL`_ via whatever method is convenient. Linux platforms such as
`Debian`_ have `DebianGIS`_, Mac OS X has the `KyngChaos`_ software frameworks,
and Windows has the `OSGeo4W`_ platform.
and Windows has the `Conda Forge`_ platform.

* GDAL 1.9+ is required.
* GDAL 2.2+ is required.

.. warning::
If you are using `OSGeo4W`_ as your provider of GDAL, you must make sure
to use the GDAL 1.9 package.

GeoTIFF
..............................................................................
Expand All @@ -52,7 +49,7 @@ LAS driver. Obtain `GeoTIFF`_ from the same place you got `GDAL`_.
meaning that PDAL can't simply link against `GDAL`_. If you are
building both of these libraries yourself, make sure you build GDAL
using the "External libgeotiff" option, which will prevent the
insanity that can ensue on some platforms. `OSGeo4W`_ users, including
insanity that can ensue on some platforms. `Conda Forge`_ users, including
those using that platform to link and build PDAL themselves, do
not need to worry about this issue.

Expand Down Expand Up @@ -187,7 +184,7 @@ used by :ref:`writers.tiledb` and :ref:`readers.tiledb`.
.. _`DebianGIS`: http://wiki.debian.org/DebianGis
.. _`Debian`: http://www.debian.org
.. _`KyngChaos`: http://www.kyngchaos.com/software/unixport
.. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/
.. _`Conda Forge`: https://anaconda.org/conda-forge/pdal

.. _Boost: http://www.boost.org
.. _GDAL: http://www.gdal.org
Expand All @@ -197,6 +194,5 @@ used by :ref:`writers.tiledb` and :ref:`readers.tiledb`.
.. _CMake: http://www.cmake.org
.. _`libpq`: http://www.postgresql.org/docs/9.3/static/libpq.html

.. _`Points2Grid`: https://github.com/CRREL/points2grid
.. _`Point Cloud Library (PCL)`: http://pointclouds.org
.. _`TileDB`: https://www.tiledb.io
2 changes: 0 additions & 2 deletions doc/development/compilation/unix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ substituting accordingly, to values that match your system layout.
.. _`DebianGIS`: http://wiki.debian.org/DebianGis
.. _`Debian`: http://www.debian.org
.. _`KyngChaos`: http://www.kyngchaos.com/software/unixport
.. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/


CCMake and cmake-gui
Expand Down Expand Up @@ -309,5 +308,4 @@ configure your :ref:`dependencies`.
.. _`Curses`: http://en.wikipedia.org/wiki/Curses_%28programming_library%29
.. _`Autoconf`: http://www.gnu.org/software/autoconf/
.. _`LLVM`: http://llvm.org/
.. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/

61 changes: 21 additions & 40 deletions doc/development/compilation/windows.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,27 @@ Building Under Windows

:Author: Howard Butler
:Contact: howard at hobu.co
:Date: 11/02/2017
:Date: 03/20/2019

.. note::

`OSGeo4W`_ contains a pre-built up-to-date 64 bit Windows binary. It
:ref:`conda` contains a pre-built up-to-date 64 bit Windows binary. It
is fully-featured, and if you do not need anything custom, it is likely
the fastest way to get going.

.. _`OSGeo4W`: https://trac.osgeo.org/osgeo4w/

Introduction
------------------------------------------------------------------------------

Pre-built binary packages for Windows are available via `OSGeo4W`_ (64-bit version),
Pre-built binary packages for Windows are available via :ref:`conda` (64-bit version),
and all of the prerequisites required for compilation of a fully featured build
are also available via that packaging system. This document assumes you
will be using OSGeo4W as your base, and anything more advanced is beyond
will be using Conda Forge as your base, and anything more advanced is beyond
the scope of the document.

.. note::

The AppVeyor build system uses the PDAL project's configuration on the OSGeo4W
The AppVeyor build system uses the PDAL project's configuration on the Conda Forge
system. It contains a rich resource of known working examples. See
https://github.com/PDAL/PDAL/blob/master/appveyor.yml and
https://github.com/PDAL/PDAL/tree/master/scripts/appveyor for inspiration.
Expand All @@ -44,54 +43,37 @@ with good support for those features is required.

.. _CMake: http://www.cmake.org

Prerequiste Libraries
Prerequisite Libraries
------------------------------------------------------------------------------

PDAL uses the `AppVeyor`_ continuous integration platform for building and
testing itself on Windows. The configuration that PDAL uses is valuable
raw materials for configuring your own environment because the PDAL
team must keep it up to date with both the OSGeo4W environment and
team must keep it up to date with both the :ref:`conda` environment and
the Microsoft compiler situation.

You can see the current AppVeyor configuration at
https://github.com/PDAL/PDAL/blob/master/appveyor.yml The most interesting
bits are the ``install`` section, the ``config.cmd``, and the ``build.cmd``.
https://github.com/PDAL/PDAL/blob/master/appveyor.yml The most interesting bits
are the ``install`` section, the ``config.cmd``, and the ``build.cmd`` scripts.
The AppVeyor configuration already has Miniconda installed, and the
``config.cmd`` script installs all of PDAL's prerequisites via the command
line.

The AppVeyor configuration installs OSGeo4W and all of PDAL's prerequisites
via the command line.

After downloading the `OSGeo4W setup`_, you can invoke it via the command
line to install PDAL's prerequisite packages.

::

C:\temp\osgeo4w-setup.exe -q -k -r -A -s http://download.osgeo.org/osgeo4w/ -a x86_64 ^
-P eigen,gdal,iconv,laszip,libgeotiff,libpq,libtiff,^
libxml2,msys,nitro,laz-perf,proj,zlib,python3-core,python3-devel,^
python3-numpy,oci,oci-devel,laz-perf,jsoncpp -R c:/OSGeo4W64
conda install geotiff laszip nitro curl ^
gdal pcl cmake eigen ninja libgdal ^
zstd numpy xz libxml2 laz-perf qhull ^
sqlite hdf5 tiledb conda-build ninja -y

.. note::

The package list here might change over time. The canonnical location
to learn the OSGeo4W prerequisite list for PDAL is the ``appveyor.yml``
to learn the prerequisite list for PDAL is the ``scripts/appveyor/test/build.cmd``
file in PDAL's source tree.

.. seealso::

If you don't wish to run via the command line, you can choose the GUI
for installation. Visit :ref:`workshop-osgeo4w` for a description, and then
choose all of the listed support libraries (minus ``PDAL`` of course)
to schedule them for installation.

.. warning::

There are a number of package scripts that assume ``c:/OSGeo4W64`` as the
installation path, and it is likely that you will run into some
trouble attempting to install in other locations. It's possible it will
work with some elbow grease, but it might not work out of the box.

.. _`AppVeyor`: https://ci.appveyor.com/project/hobu/pdal/history
.. _`OSGeo4W setup`: http://download.osgeo.org/osgeo4w/osgeo4w-setup-x86_64.exe


Fetching the Source
Expand All @@ -111,7 +93,7 @@ Switch to the ``-maintenance`` branch.

::

c:\dev> git checkout 1.7-maintenance
c:\dev> git checkout 1.9-maintenance


.. note::
Expand All @@ -138,7 +120,7 @@ for inspiration on this topic.

1. The AppVeyor build configuration https://github.com/PDAL/PDAL/blob/master/scripts/appveyor/config.cmd#L26

2. Howard Butler's example build configuration https://github.com/PDAL/PDAL/blob/master/cmake/examples/hobu-windows.bat
2. Howard Butler's example build configuration https://github.com/PDAL/PDAL/blob/master/scripts/conda/wind64.bat


.. note::
Expand Down Expand Up @@ -170,6 +152,5 @@ After you've built the tree, you can run ``pdal.exe`` by issuing it

.. note::

You need to have your OSGeo4W shell active to enable access to
PDAL's dependencies. Issue ``c:\osgeo4w64\bin\o4w_env.bat`` in
your shell to activiate it.
You may need to have your Conda environment active to enable access to
PDAL's dependencies.
43 changes: 21 additions & 22 deletions doc/download.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,31 +64,29 @@ and RiVLib. To enable any of these plugins, the reader will need to install any
required dependencies and build PDAL from source.

.. csv-table:: PDAL Distribution Feature Comparison
:header: "", "Docker", "OSGeo4W", "RPMs", "Debian", "Alpine", "Conda"
:widths: 20, 20, 20, 20, 20, 20, 20

"Platform(s)", "linux", "win", "linux", "linux", "linux", "win, mac, linux"
"CPD", "X", "", "", "", "X", ""
"Greyhound", "X", "X", "", "X", "X", "X"
"Hexbin", "X", "X", "X", "", "X", "X"
"Icebridge", "X", "", "X", "X", "X", "X"
"laszip", "X", "X", "X", "", "X", "X"
"laz-perf", "X", "X", "", "", "X", "X"
"NITF", "X", "X", "", "", "X", "X"
"OCI", "", "X", "", "", "", ""
"PCL", "", "", "X", "", "", "X"
"pgpointcloud", "X", "X", "X", "X", "X", "X"
"Python", "X", "X", "", "X", "X", "X"
"SQLite", "X", "X", "", "X", "X", "X"
:header: "", "Docker", "RPMs", "Debian", "Alpine", ":ref:`Conda`"
:widths: 20, 20, 20, 20, 20, 20

"Platform(s)", "linux", "linux", "linux", "linux", "win64, mac, linux"
"CPD", "X", "", "", "X", ""
"Greyhound", "X", "", "X", "X", "X"
"Icebridge", "X", "X", "X", "X", "X"
"laszip", "X", "X", "", "X", "X"
"laz-perf", "X", "", "", "X", "X"
"NITF", "X", "", "", "X", "X"
"OCI", "", "", "", "", ""
"PCL", "", "X", "", "", "X"
"pgpointcloud", "X", "X", "X", "X", "X"
"Python", "X", "", "X", "X", "X"
"SQLite", "X", "", "X", "X", "X"


Windows
................................................................................

Windows builds are available via `OSGeo4W`_ (64-bit only). See the
:ref:`workshop-osgeo4w` page for more detailed information.
Windows builds are available via `Conda Forge`_ (64-bit only). See the
:ref:`conda` for more detailed information.

.. _`OSGeo4W`: http://trac.osgeo.org/osgeo4w/


RPMs
Expand Down Expand Up @@ -142,6 +140,9 @@ the Python extension.

.. _`Alpine Linux`: https://www.alpinelinux.org/

.. _`Conda Forge`: https://anaconda.org/conda-forge/pdal

.. _conda:

Conda
................................................................................
Expand All @@ -166,7 +167,7 @@ To install one or more Conda packages, use the following command.

conda install [-c channel] [package...]

Because the PDAL package (and it's dependencies) live in the `conda-forge`_
Because the PDAL package (and it's dependencies) live in the `Conda Forge`_
channel, the command to install both the PDAL application and the Python
extension is

Expand All @@ -178,5 +179,3 @@ It is strongly recommended that you make use of Conda's environment management
system and install PDAL in a separate environment (i.e., not the base
environment). Instructions can be found on the Conda website.

.. _`Conda`: https://conda.io/docs/
.. _`conda-forge`: https://conda-forge.org/
5 changes: 2 additions & 3 deletions doc/project/integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,8 @@ https://github.com/PDAL/PDAL/blob/master/appveyor.yml All administrators of the
GitHub `PDAL` group have rights to modify the AppVeyor configuration.

`Howard Butler`_ currently pays the bill to run in the AppVeyor upper
performance processing tier. The AppVeyor configuration depends on `OSGeo4W64`_
performance processing tier. The AppVeyor configuration depends on :ref:`conda`
for dependencies. If you want to add new test functionality based on a
dependency, you will need to update OSGeo4W64 with a new package to do so.
dependency, you will need to update :ref:`conda` with a new package to do so.

.. _`OSGeo4W64`: http://trac.osgeo.org/osgeo4w/
.. _`Howard Butler`: http://github.com/hobu
4 changes: 4 additions & 0 deletions doc/stages/readers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ like :ref:`readers.oci`, or a network service like :ref:`readers.greyhound`.
readers.slpk
readers.terrasolid
readers.text
readers.tiledb
readers.tindex

:ref:`readers.bpf`
Expand Down Expand Up @@ -146,6 +147,9 @@ like :ref:`readers.oci`, or a network service like :ref:`readers.greyhound`.
:ref:`readers.text`
Read point clouds from ASCII text files.

:ref:`readers.tiledb`
Read point cloud data from a TileDB instance.

:ref:`readers.tindex`
The tindex (tile index) reader allows you to automatically merge and query
data described in tile index files that have been generated using the PDAL
Expand Down
8 changes: 8 additions & 0 deletions doc/stages/writers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ dimension type, while others only understand fixed dimension names.
:hidden:

writers.bpf
writers.ept_addon
writers.gdal
writers.geowave
writers.greyhound
Expand All @@ -32,10 +33,14 @@ dimension type, while others only understand fixed dimension names.
writers.sbet
writers.sqlite
writers.text
writers.tiledb

:ref:`writers.bpf`
Write BPF version 3 files. BPF is an NGA specification for point cloud data.

:ref:`writers.ept_addon`
Append additional dimensions to Entwine resources.

:ref:`writers.gdal`
Create a raster from a point cloud using an interpolation algorithm.

Expand Down Expand Up @@ -86,3 +91,6 @@ dimension type, while others only understand fixed dimension names.

:ref:`writers.text`
Write points in a text file. GeoJSON and CSV formats are supported.

:ref:`writers.tiledb`
Write points into a TileDB database.
2 changes: 0 additions & 2 deletions doc/stages/writers.tiledb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,4 @@ stats
Dump query stats to stdout [Optional]


.. include:: writers_opts.rst

.. _TileDB: https://tiledb.io
2 changes: 1 addition & 1 deletion doc/workshop/exercises/analysis/clipping/clipping.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ We will write our content back out using a :ref:`writers.las`.
Execution
................................................................................

Invoke the following command, substituting accordingly, in your `OSGeo4W Shell`:
Invoke the following command, substituting accordingly, in your |Terminal|:


.. literalinclude:: ./clipping-run-command.txt
Expand Down
2 changes: 1 addition & 1 deletion doc/workshop/exercises/analysis/denoising/denoising.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ add a few options to have finer control over what is written. These include:
Execution
................................................................................

Invoke the following command, substituting accordingly, in your `OSGeo4W Shell`:
Invoke the following command, substituting accordingly, in your |Terminal|:

.. literalinclude:: ./denoising-run-command.txt

Expand Down
2 changes: 1 addition & 1 deletion doc/workshop/exercises/analysis/density/density.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ simple interpolation, which we will use for visualization in |QGIS|.
Command
................................................................................

Invoke the following command, substituting accordingly, in your `OSGeo4W Shell`:
Invoke the following command, substituting accordingly, in your |Terminal|:

.. literalinclude:: ./density-command.txt
:linenos:
Expand Down
2 changes: 1 addition & 1 deletion doc/workshop/exercises/analysis/dtm/dtm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Exercise
Command
................................................................................

Invoke the following command, substituting accordingly, in your `OSGeo4W Shell`:
Invoke the following command, substituting accordingly, in your |Terminal|:

PDAL capability to generate rasterized output is provided by the :ref:`writers.gdal`
stage. There is no :ref:`application <apps>` to drive this stage, and we
Expand Down
2 changes: 1 addition & 1 deletion doc/workshop/exercises/analysis/ground/ground.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ generate a ground surface.
Command
................................................................................

Invoke the following command, substituting accordingly, in your `OSGeo4W Shell`:
Invoke the following command, substituting accordingly, in your |Terminal|:

.. literalinclude:: ./ground-run-no-filter.txt
:linenos:
Expand Down
5 changes: 3 additions & 2 deletions doc/workshop/exercises/analysis/rasterize/classification.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"pipeline":[
{
"type":"readers.greyhound",
"url":"http://na.greyhound.io/resource/dk-z/read?depthBegin=1&depthEnd=29&bounds=[11045777.34375,-11852109.375,223441.40625,11055492.1875,-11842394.53125,233156.25]&compress=true&scale=0.01&offset=[1295630,7596240,-2280]"
"type":"readers.ept",
"url":"http://na-c.entwine.io/dk",
"bounds":"([11045777.34375,11055492.1875],[-11852109.375,-11842394.53125],[223441.40625,233156.25])"
},
{
"type":"writers.gdal",
Expand Down
4 changes: 1 addition & 3 deletions doc/workshop/exercises/analysis/rasterize/rasterize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,6 @@ Exercise
Command
................................................................................

Invoke the following command, substituting accordingly, in your `OSGeo4W Shell`:

PDAL capability to generate rasterized output is provided by the :ref:`writers.gdal` stage.
There is no :ref:`application <apps>` to drive this stage, and we must use a pipeline.

Expand Down Expand Up @@ -69,7 +67,7 @@ The :ref:`writers.gdal` writer that bins the point cloud data with classificatio
values.

.. literalinclude:: ./classification.json
:lines: 7-14
:lines: 8-15

Execution
................................................................................
Expand Down

0 comments on commit 3fefd14

Please sign in to comment.