diff --git a/README.md b/README.md index d03212d2..7f1dbff7 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ So far, it does Point Clouds, Digital Surface Models, Textured Digital Surface M ## QUICKSTART -Requires Ubuntu 14.04 or later, see https://github.com/OpenDroneMap/odm_vagrant for running on Windows in a VM +OpenDroneMap can run natively on Ubuntu 14.04 or later, see [Build and Run Using Docker](#build-and-run-using-docker) for running on Windows / MacOS. A Vagrant VM is also available: https://github.com/OpenDroneMap/odm_vagrant. *Support for Ubuntu 12.04 is currently BROKEN with the addition of OpenSfM and Ceres-Solver. It is likely to remain broken unless a champion is found to fix it.* @@ -133,16 +133,15 @@ has equivalent procedures for Mac OS X and Windows. See [docs.docker.com](docs.d OpenDroneMap is Dockerized, meaning you can use containerization to build and run it without tampering with the configuration of libraries and packages already installed on your machine. Docker software is free to install and use in this context. If you don't have it installed, see the [Docker Ubuntu installation tutorial](https://docs.docker.com/engine/installation/linux/ubuntulinux/) and follow the -instructions through "Create a Docker group". Once Docker is installed, an OpenDroneMap Docker image can be created -like so: +instructions through "Create a Docker group". Once Docker is installed, the fastest way to use OpenDroneMap is to run a pre-built image by typing: + + docker run -it --rm -v $(pwd)/images:/code/images v $(pwd)/odm_orthophoto:/code/odm_orthophoto -v $(pwd)/odm_texturing:/code/odm_texturing opendronemap/opendronemap + +If you want to build your own Docker image from sources, type: docker build -t packages -f packages.Dockerfile . - docker build -t odm_image . - docker run -it --user root\ - -v $(pwd)/images:/code/images\ - -v $(pwd)/odm_orthophoto:/code/odm_orthophoto\ - -v $(pwd)/odm_texturing:/code/odm_texturing\ - --rm odm_image + docker build -t my_odm_image . + docker run -it --rm -v $(pwd)/images:/code/images v $(pwd)/odm_orthophoto:/code/odm_orthophoto -v $(pwd)/odm_texturing:/code/odm_texturing my_odm_image Using this method, the containerized ODM will process the images in the OpenDroneMap/images directory and output results to the OpenDroneMap/odm_orthophoto and OpenDroneMap/odm_texturing directories as described in the **Viewing Results** section. @@ -150,13 +149,11 @@ If you want to view other results outside the Docker image simply add which dire established above. For example, if you're interested in the dense cloud results generated by PMVS and in the orthophoto, simply use the following `docker run` command after building the image: - docker run -it \ - -v $(pwd)/images:/code/images\ - -v $(pwd)/pmvs:/code/pmvs\ - -v $(pwd)/odm_orthophoto:/code/odm_orthophoto\ - --rm odm_image + docker run -it --rm -v $(pwd)/images:/code/images -v $(pwd)/pmvs:/code/pmvs -v $(pwd)/odm_orthophoto:/code/odm_orthophoto my_odm_image -To pass in custom parameters to the run.py script, simply pass it as arguments to the `docker run` command. +To pass in custom parameters to the run.py script, simply pass it as arguments to the `docker run` command. For example: + + docker run -it --rm -v $(pwd)/images:/code/images v $(pwd)/odm_orthophoto:/code/odm_orthophoto -v $(pwd)/odm_texturing:/code/odm_texturing opendronemap/opendronemap --resize-to 1800 --force-ccd 6.16 ## User Interface