/usr/share/doc/pdal/html/quickstart.html is in pdal-doc 1.6.0-1build2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Quickstart — pdal.io</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/breathe.css" type="text/css" />
<link rel="author" title="About these documents"
href="about.html"/>
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="pdal.io" href="index.html"/>
<link rel="next" title="Applications" href="apps/index.html"/>
<link rel="prev" title="Download" href="download.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> PDAL
</a>
<div class="version">
1.6.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="download.html">Download</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="#install-docker">Install Docker</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#enable-docker-access-to-your-machine">Enable Docker access to your machine</a></li>
<li class="toctree-l3"><a class="reference internal" href="#run-docker-quickstart-terminal">Run Docker Quickstart Terminal</a></li>
<li class="toctree-l3"><a class="reference internal" href="#obtain-pdal-image">Obtain PDAL Image</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#fetch-sample-data">Fetch Sample Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="#print-the-first-point">Print the first point</a></li>
<li class="toctree-l2"><a class="reference internal" href="#what-s-next">What’s next?</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apps/index.html">Applications</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="community.html">Community</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="pipeline.html">Pipeline</a></li>
<li class="toctree-l1"><a class="reference internal" href="stages/readers.html">Readers</a></li>
<li class="toctree-l1"><a class="reference internal" href="stages/writers.html">Writers</a></li>
<li class="toctree-l1"><a class="reference internal" href="stages/filters.html">Filters</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="dimensions.html">Dimensions</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="python.html">Python</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">Tutorials</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="workshop/index.html">Workshop</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="development/index.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="copyright.html">License</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PDAL</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Home</a> »</li>
<li>Quickstart</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="quickstart">
<span id="id1"></span><h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<span id="index-0"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>It’s a giant pain to build everything yourself. The quickest way to start using
PDAL is to leverage builds that were constructed by the PDAL development team
using <a class="reference internal" href="#docker">Docker</a>. Docker is a containerization technology that allows you to
run pre-built software in a way that is isolated from your system. Think of
it like a binary that doesn’t depend on your operating system’s configuration
to be able to run.</p>
<p>This exercise will print the first point of an <a class="reference internal" href="stages/readers.las.html#readers-las"><span class="std std-ref">ASPRS LAS</span></a> file.
It will utilize the PDAL <a class="reference internal" href="apps/index.html#apps"><span class="std std-ref">command line application</span></a> to inspect the
file.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>While Docker is convenient, it is not for everyone. You can also obtain the
software by installing a Linux package from <a class="reference internal" href="download.html#download"><span class="std std-ref">Download</span></a> or compiling it
yourself from <a class="reference internal" href="development/compilation/index.html#building"><span class="std std-ref">Compilation</span></a>.</p>
<p>Docker is not required to use PDAL, and there are packages available on
Linux (Debian, RPM) and OSX (<a class="reference external" href="http://brew.sh">Homebrew</a>). See <a class="reference internal" href="download.html#download"><span class="std std-ref">Download</span></a> to obtain
them. If you are a developer looking to leverage PDAL, you will need access
to the library in your environment, but this quick start document is for
those looking to quickly interact with data using PDAL’s <a class="reference internal" href="apps/index.html#apps"><span class="std std-ref">command line
applications</span></a> and <a class="reference internal" href="pipeline.html#pipeline"><span class="std std-ref">Pipeline</span></a>.</p>
<p class="last">If you need to compile your own copy of PDAL, see <a class="reference internal" href="development/compilation/index.html#building"><span class="std std-ref">Compilation</span></a> for
more details.</p>
</div>
</div>
<div class="section" id="install-docker">
<span id="docker"></span><h2>Install Docker<a class="headerlink" href="#install-docker" title="Permalink to this headline">¶</a></h2>
<p>Docker starting documentation can be found at the following links. Read through
them a bit for your platform so you have an idea what to expect.</p>
<ul class="simple">
<li><a class="reference external" href="https://docs.docker.com/docker-for-windows/">Windows</a></li>
<li><a class="reference external" href="https://docs.docker.com/docker-for-mac/">OSX</a></li>
<li><a class="reference external" href="https://docs.docker.com/engine/installation/linux/">Linux</a></li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">We will assume you are running on Windows, but the same commands should
work in OSX or Linux too – though definition of file paths might provide
a significant difference.</p>
</div>
<div class="section" id="enable-docker-access-to-your-machine">
<h3>Enable Docker access to your machine<a class="headerlink" href="#enable-docker-access-to-your-machine" title="Permalink to this headline">¶</a></h3>
<p>In order for Docker to be able to interact with data on your machine, you must
make sure to tell it to be able to read your drive(s). Right-click on the
little Docker whale icon in you System Tray, choose Settings, and click
the Shared box by your C drive:</p>
<img alt="_images/docker-quickstart-share.png" src="_images/docker-quickstart-share.png" />
</div>
<div class="section" id="run-docker-quickstart-terminal">
<h3>Run Docker Quickstart Terminal<a class="headerlink" href="#run-docker-quickstart-terminal" title="Permalink to this headline">¶</a></h3>
<p><a class="reference internal" href="#docker">Docker</a> is most easily accessed using a terminal window that it configures
with environment variables and such. Run PowerShell or <cite>cmd.exe</cite> and issue
a simple <cite>info</cite> command to verify that things are operating correctly:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">info</span>
</pre></div>
</div>
<img alt="_images/docker-quickstart-env.png" src="_images/docker-quickstart-env.png" />
</div>
<div class="section" id="obtain-pdal-image">
<h3>Obtain PDAL Image<a class="headerlink" href="#obtain-pdal-image" title="Permalink to this headline">¶</a></h3>
<p>A PDAL image based on the latest release, including all recent patches, is
pushed to <a class="reference external" href="http://hub.docker.com">Docker Hub</a> with every code change on the PDAL maintenance branch (find
out more about that at <a class="reference internal" href="development/docker.html#development-docker"><span class="std std-ref">here</span></a>).
We need to pull it locally so we can use it to run PDAL commands. Once it is
pulled, we don’t have to pull it again unless we want to refresh it for
whatever reason.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">pull</span> <span class="n">pdal</span><span class="o">/</span><span class="n">pdal</span><span class="p">:</span><span class="mf">1.6</span>
</pre></div>
</div>
<img alt="_images/docker-quickstart-pull.png" src="_images/docker-quickstart-pull.png" />
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Other PDAL versions are provided at the same <a class="reference external" href="http://hub.docker.com">Docker Hub</a> location,
with an expected tag name (ie <code class="docutils literal"><span class="pre">pdal/pdal:1.6</span></code>, or <code class="docutils literal"><span class="pre">pdal/pdal:1.x</span></code>) for
major PDAL versions. The PDAL Docker hub location at
<a class="reference external" href="https://hub.docker.com/u/pdal/">https://hub.docker.com/u/pdal/</a> has images and more information
on this topic.</p>
</div>
</div>
</div>
<div class="section" id="fetch-sample-data">
<h2>Fetch Sample Data<a class="headerlink" href="#fetch-sample-data" title="Permalink to this headline">¶</a></h2>
<p>We need some sample data to play with, so we’re going to download
the <code class="docutils literal"><span class="pre">autzen.laz</span></code> file to your <code class="docutils literal"><span class="pre">C:/Users/hobu/Downloads</span></code> fold.
Inside your terminal, issue the following command:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">explorer</span><span class="o">.</span><span class="n">exe</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">liblas</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">samples</span><span class="o">/</span><span class="n">autzen</span><span class="o">/</span><span class="n">autzen</span><span class="o">.</span><span class="n">laz</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">C</span><span class="p">:</span><span class="o">/</span><span class="n">Users</span><span class="o">/</span><span class="n">hobu</span><span class="o">/</span><span class="n">Downloads</span>
<span class="n">copy</span> <span class="n">autzen</span><span class="o">.</span><span class="n">laz</span> <span class="o">..</span>
</pre></div>
</div>
</div>
<div class="section" id="print-the-first-point">
<h2>Print the first point<a class="headerlink" href="#print-the-first-point" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">docker</span> <span class="n">run</span> <span class="o">-</span><span class="n">v</span> <span class="o">/</span><span class="n">c</span><span class="o">/</span><span class="n">Users</span><span class="o">/</span><span class="n">hobu</span><span class="p">:</span><span class="o">/</span><span class="n">data</span> <span class="n">pdal</span><span class="o">/</span><span class="n">pdal</span><span class="p">:</span><span class="mf">1.6</span> <span class="n">pdal</span> <span class="n">info</span> <span class="o">/</span><span class="n">data</span><span class="o">/</span><span class="n">autzen</span><span class="o">.</span><span class="n">laz</span> <span class="o">-</span><span class="n">p</span> <span class="mi">0</span>
</pre></div>
</div>
<p>Here’s a summary of what’s going on with that command invocation</p>
<ol class="arabic">
<li><p class="first"><code class="docutils literal"><span class="pre">docker</span></code>: We are running PDAL within the context of docker, so all of our
commands will start with the <code class="docutils literal"><span class="pre">docker</span></code> command.</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">run</span></code>: Tells docker we’re going to run an image</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">-v</span> <span class="pre">/c/Users/hobu:/data</span></code>: Maps our home directory to a directory called
<code class="docutils literal"><span class="pre">/data</span></code> inside the container.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">The <a class="reference external" href="https://docs.docker.com/engine/userguide/dockervolumes/">Docker Volume</a>
document describes mounting volumes in more detail.</p>
</div>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">pdal/pdal:1.6</span></code>: This is the Docker image we are going to run. We fetched it
with the command above. If it were not already fetched, Docker would attempt
to fetch it when we run this command.</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">pdal</span></code>: We’re finally going to run the <code class="docutils literal"><span class="pre">pdal</span></code> command :)</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">info</span></code>: We want to run <a class="reference internal" href="apps/info.html#info-command"><span class="std std-ref">info</span></a> on the data</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">/data/autzen.laz</span></code>: The <code class="docutils literal"><span class="pre">pdal</span></code> command is now running in the context of
our container, which we mounted a <code class="docutils literal"><span class="pre">/data</span></code> directory in with the volume
mount operation in Step #3. Our <code class="docutils literal"><span class="pre">autzen.laz</span></code> file resides there.</p>
</li>
</ol>
<img alt="_images/docker-print-one.png" src="_images/docker-print-one.png" />
</div>
<div class="section" id="what-s-next">
<h2>What’s next?<a class="headerlink" href="#what-s-next" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Visit <a class="reference internal" href="apps/index.html#apps"><span class="std std-ref">Applications</span></a> to find out how to utilize PDAL applications to process
data on the command line yourself.</li>
<li>Visit <a class="reference internal" href="development/index.html#development-index"><span class="std std-ref">Development</span></a> to learn how to embed and use PDAL in your own
applications.</li>
<li><a class="reference internal" href="stages/readers.html#readers"><span class="std std-ref">Readers</span></a> lists the formats that PDAL can read, <a class="reference internal" href="stages/filters.html#filters"><span class="std std-ref">Filters</span></a> lists the
kinds of operations you can do with PDAL, and <a class="reference internal" href="stages/writers.html#writers"><span class="std std-ref">Writers</span></a> lists the
formats PDAL can write.</li>
<li><a class="reference internal" href="tutorial/index.html#tutorial"><span class="std std-ref">Tutorials</span></a> contains a number of walk-through tutorials for achieving
many tasks with PDAL.</li>
<li><a class="reference internal" href="workshop/index.html#workshop"><span class="std std-ref">The PDAL workshop</span></a> contains numerous hands-on examples with screenshots and
example data of how to use PDAL <a class="reference internal" href="apps/index.html#apps"><span class="std std-ref">Applications</span></a> to tackle point cloud data
processing tasks.</li>
<li><a class="reference internal" href="python.html#python"><span class="std std-ref">Python</span></a> describes how PDAL embeds and extends Python and
how you can leverage these capabilities in your own programs.</li>
</ul>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="community.html#community"><span class="std std-ref">Community</span></a> is a good source to reach out to when you’re stuck.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apps/index.html" class="btn btn-neutral float-right" title="Applications" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="download.html" class="btn btn-neutral" title="Download" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© 2017
<a href="http://github.com/hobu">Howard Butler</a>,
<a href="http://github.com/mpgerlek">Michael Gerlek</a>,
and
<a href="https://github.com/PDAL/PDAL/graphs/contributors">others</a>.
Last updated on Dec 17, 2017.
</p>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.6.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/mathjax/MathJax.js?config=tex-ams-mml_htmlormml"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
<div class="footer">
<div class="container">
© 2017
<a href="http://github.com/hobu">Howard Butler</a>,
<a href="http://github.com/mpgerlek">Michael Gerlek</a>,
and
<a href="https://github.com/PDAL/PDAL/graphs/contributors">others</a>,
Last updated
on Dec 17, 2017.
</div>
</div>
</body>
</html>
|