From 31e60d4c3fdda64b49607c2e0136b430e46a34d5 Mon Sep 17 00:00:00 2001 From: Dakota Benjamin Date: Wed, 30 Nov 2016 14:59:44 -0500 Subject: [PATCH] Simplify QUICKSTART instructions and updates --- README.md | 52 +++++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 0b9a052c..166ac81e 100644 --- a/README.md +++ b/README.md @@ -29,17 +29,22 @@ Requires Ubuntu 14.04 or later, see https://github.com/OpenDroneMap/odm_vagrant **[Download the latest release here](https://github.com/OpenDroneMap/OpenDroneMap/releases)** -Current version: 0.2 (beta) +Current version: 0.2-RC1 (beta) + +1. Extract and enter the OpenDroneMap directory +2. Run `bash configure.sh` +3. Download and extract a sample dataset [here](https://github.com/OpenDroneMap/odm_data_aukerman/archive/master.zip) +4. Run `./run.sh --project-path `, replacing `` with the dataset path. +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 + +See below for more detailed installation instructions. ### Installation - -Before installing you need to set your environment variables. Open the ~/.bashrc file on your machine and add the following 3 lines at the end. The file can be opened with ```gedit ~/.bashrc``` if you are using an Ubuntu desktop environment. Be sure to replace the "/your/path/" with the correct path to the location where you extracted OpenDroneMap: - export PYTHONPATH=$PYTHONPATH:/your/path/OpenDroneMap/SuperBuild/install/lib/python2.7/dist-packages - export PYTHONPATH=$PYTHONPATH:/your/path/OpenDroneMap/SuperBuild/src/opensfm - export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your/path/OpenDroneMap/SuperBuild/install/lib - -Now, enter the OpenDroneMap directory and compile all of the code by executing a single configuration script: +Extract and enter the downloaded OpenDroneMap directory and compile all of the code by executing a single configuration script: bash configure.sh @@ -48,6 +53,16 @@ For Ubuntu 15.10 users, this will help you get running: sudo apt-get install python-xmltodict sudo ln -s /usr/lib/x86_64-linux-gnu/libproj.so.9 /usr/lib/libproj.so +### Environment Variables + +There are some environmental variables that need to be set. Open the ~/.bashrc file on your machine and add the following 3 lines at the end. The file can be opened with ```gedit ~/.bashrc``` if you are using an Ubuntu desktop environment. Be sure to replace the "/your/path/" with the correct path to the location where you extracted OpenDroneMap: + + export PYTHONPATH=$PYTHONPATH:/your/path/OpenDroneMap/SuperBuild/install/lib/python2.7/dist-packages + export PYTHONPATH=$PYTHONPATH:/your/path/OpenDroneMap/SuperBuild/src/opensfm + export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/your/path/OpenDroneMap/SuperBuild/install/lib + +Note that using `run.sh` sets these temporarily in the shell. + ### Run OpenDroneMap First you need a set of images, taken from a drone or otherwise. @@ -118,11 +133,9 @@ 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 up until "Create a Docker group" inclusive. Once Docker is installed, an OpenDroneMap Docker image can be created +instructions through "Create a Docker group". Once Docker is installed, an OpenDroneMap Docker image can be created like so: - git clone https://github.com/OpenDroneMap/OpenDroneMap.git - cd OpenDroneMap docker build -t packages -f packages.Dockerfile . docker build -t odm_image . docker run -it --user root\ @@ -137,7 +150,7 @@ 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 --user root\ + docker run -it \ -v $(pwd)/images:/code/images\ -v $(pwd)/pmvs:/code/pmvs\ -v $(pwd)/odm_orthophoto:/code/odm_orthophoto\ @@ -151,22 +164,11 @@ A web interface and API to OpenDroneMap is currently under active development in ## Examples -Here are some other videos, which may be outdated: - -- https://www.youtube.com/watch?v=7ZTufQkODLs (2015-01-30) -- https://www.youtube.com/watch?v=m0i4GQdfl8A (2015-03-15) - -Now that texturing is in the code base, you can access the full textured meshes using MeshLab. -Open MeshLab, choose `File:Import Mesh` and choose your textured mesh from a location similar to the following: -`reconstruction-with-image-size-1200-results\odm_texturing\odm_textured_model.obj`. Long term, the aim is for -the toolchain to also be able to optionally push to a variety of online data repositories, pushing hi-resolution -aerials to [OpenAerialMap](https://openaerialmap.org/), point clouds to [OpenTopography](http://opentopography.org/), -and pushing digital elevation models to an emerging global repository (yet to be named...). That leaves only -digital surface model meshes and UV textured meshes with no global repository home. +Coming soon... ## Documentation: -For documentation, please take a look at our [wiki](https://github.com/OpenDroneMap/OpenDroneMap/wiki).Check here first if you are heaving problems. If you still need help, look through the issue queue or create one. There's also a general help chat [here](https://gitter.im/OpenDroneMap/generalhelp). +For documentation, please take a look at our [wiki](https://github.com/OpenDroneMap/OpenDroneMap/wiki).Check here first if you are having problems. If you still need help, look through the issue queue or create one. There's also a general help chat [here](https://gitter.im/OpenDroneMap/generalhelp). ## Developers