Provides better documentation in dockerfile including full examples, fixes #1

This commit is contained in:
Scott Almes
2017-08-17 10:33:57 -04:00
parent c0bf22658e
commit 1a62c1a437

View File

@@ -15,8 +15,8 @@ RUN apt update && apt upgrade -y && apt install -y --fix-missing --no-install-re
RUN git clone https://github.com/pubgeo/pubgeo
WORKDIR /build/
# Make a directory to work out of, and change to it
WORKDIR /build
RUN cmake ../pubgeo && make -j 10
# cleanup
@@ -28,5 +28,14 @@ RUN apt purge -y \
cmake \
git
CMD echo "Please run a valid executable:" && \
echo "docker run -v <path to 3D data> shr3d <3D file> DH=2 DZ=1 AGL=2 AREA=50" && \
echo "docker run -v <path to point cloud> align3d <reference point cloud> <target pc> gsd=1.0 maxt=10.0"
echo "docker run -v <path to 3D data>:<mount point (mp)> jhuapl/pubgeo ./shr3d <mount point>/<3D file> DH=2 DZ=1 AGL=2 AREA=50" && \
echo "docker run -v <path to point clouds (pc)>:<mount point (mp)> jhuapl/pubgeo ./align3d <mp>/<reference pc> <mp>/<target pc> gsd=1.0 maxt=10.0"
# Examples
# docker run -v /home/ubuntu/pointclouds:pc jhuapl/pubgeo ./shr3d /pc/shr3dMe.las DH=2 DZ=1 AGL=2 AREA=50
# docker run -v /home/ubuntu/pointclouds:pc jhuapl/pubgeo ./align3d /pc/reference.las pc/alignMe.las gsd=1.0 maxt=10.0
# Reminders:
# -t makes output go to terminal instantly (instead of bulk dump at end)
# Data coming out will be in <path to 3D data> or <path to point cloud>
# --rm will auto delete the container when complete (no need to take up disk space)
# The files will be owned by root when they come out (known Docker behaviour)