From aed4cfc3478ebca3c45690c37a4bc1bd54ef8558 Mon Sep 17 00:00:00 2001 From: Dakota Benjamin Date: Tue, 18 Jul 2017 11:19:07 -0400 Subject: [PATCH 1/2] Make Docker more prominent for installation --- README.md | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f1f2786d..9f24ef76 100644 --- a/README.md +++ b/README.md @@ -31,17 +31,30 @@ OpenDroneMap can run natively on Ubuntu 14.04 or later, see [Build and Run Using Current version: 0.3.1 (this software is in beta) +### Docker +The easiest way to run ODM is through Docker. 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". The Docker image workflow +has equivalent procedures for Mac OS X and Windows found at [docs.docker.com](docs.docker.com). Then run the following command which will build a pre-built image and run on images found in `$(pwd)/images` (you can change this if you need to, see the [wiki](https://github.com/OpenDroneMap/OpenDroneMap/wiki/Docker) for more detailed instructions. +``` +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 +``` + +### Native Install + 1. Extract and enter the OpenDroneMap directory 2. Run `bash configure.sh install` 4. Edit the `settings.yaml` file in your favorite text editor. Set the `project-path` value to an empty directory (you will place sub-directories containing individual projects inside). You can add many options to this file, [see here](https://github.com/OpenDroneMap/OpenDroneMap/wiki/Run-Time-Parameters) 3. Download a sample dataset from [here](https://github.com/OpenDroneMap/odm_data_aukerman/archive/master.zip) (about 550MB) and extract it as a subdirectory in your project directory. 4. Run `./run.sh odm_data_aukerman` 5. Enter dataset directory to view results: - - orthophoto: odm_orthophoto/odm_orthophoto.tif - - textured mesh model: odm_texturing/odm_textured_model_geo.obj - - point cloud (georeferenced): odm_georeferencing/odm_georeferenced_model.ply + - orthophoto: odm_orthophoto/odm_orthophoto.tif + - textured mesh model: odm_texturing/odm_textured_model_geo.obj + - point cloud (georeferenced): odm_georeferencing/odm_georeferenced_model.ply -See [here](https://github.com/OpenDroneMap/OpenDroneMap/blob/3964f21377e27c261c305b30537f699853ac2004/README.md#installation) for more detailed installation instructions. +See below for more detailed installation instructions. + +## Diving Deeper ### Installation From e413b1fd7b3c5b06313e7075154216ab0441dcb0 Mon Sep 17 00:00:00 2001 From: Dakota Benjamin Date: Tue, 18 Jul 2017 11:36:52 -0400 Subject: [PATCH 2/2] Remove awkward wording and rearrange --- README.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9f24ef76..a3182d01 100644 --- a/README.md +++ b/README.md @@ -20,27 +20,23 @@ In a word, OpenDroneMap is a toolchain for processing raw civilian UAS imagery t Open Drone Map now includes state-of-the-art 3D reconstruction work by Michael Waechter, Nils Moehrle, and Michael Goesele. See their publication at http://www.gcc.tu-darmstadt.de/media/gcc/papers/Waechter-2014-LTB.pdf. - ## QUICKSTART -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](https://github.com/OpenDroneMap/odm_vagrant) is also available. +### Docker (All platforms) -*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.* - -**[Download the latest release here](https://github.com/OpenDroneMap/OpenDroneMap/releases)** - -Current version: 0.3.1 (this software is in beta) - -### Docker The easiest way to run ODM is through Docker. 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". The Docker image workflow has equivalent procedures for Mac OS X and Windows found at [docs.docker.com](docs.docker.com). Then run the following command which will build a pre-built image and run on images found in `$(pwd)/images` (you can change this if you need to, see the [wiki](https://github.com/OpenDroneMap/OpenDroneMap/wiki/Docker) for more detailed instructions. + ``` 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 ``` -### Native Install +### Native Install (Ubuntu 14.04 or later) + +**[Download the latest release here](https://github.com/OpenDroneMap/OpenDroneMap/releases)** +Current version: 0.3.1 (this software is in beta) 1. Extract and enter the OpenDroneMap directory 2. Run `bash configure.sh install`