From 0155496f97938f6db9c3417ffc35b567920f0e4a Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Sat, 14 Sep 2019 13:45:17 -0400 Subject: [PATCH] remove install instructions from Usage --- source/using.rst | 45 --------------------------------------------- 1 file changed, 45 deletions(-) diff --git a/source/using.rst b/source/using.rst index 896feecd9..5105777f9 100644 --- a/source/using.rst +++ b/source/using.rst @@ -3,51 +3,6 @@ Usage ===== -.. _docker-usage: - -Docker ------- - -There are two methods for running with docker. One pulls a pre-built image from the docker hub. This is the most reliable. You can also :ref:`build your own image `. In either case, the run command is the same, what you will change is the name of the image. For the docker hub image, use ``opendronemap/odm``. For an image you built yourself, use that image name (in our case, ``my_odm_image``).:: - - docker run -ti --rm -v /my/project:/datasets/code --project-path /datasets - -Where /my/project is the path to your project containing an ``images`` folder (/my/project/images). ``-v`` is used to connect folders in the docker container to local folders. See :doc:`outputs` for reference on the project layout. - -To pass in custom parameters to the run.py script, simply pass it as arguments to the docker run command. For example:: - - docker run -ti --rm -v /my/project:/datasets/code --project-path /datasets --resize-to 1800 --dsm - -If you want to pass in custom parameters using the settings.yaml file, you can pass it as a -v volume binding:: - - docker run -ti --rm -v $(pwd)/settings.yaml:/code/settings.yaml -v /my/project:/datasets/code --project-path /datasets --resize-to 1800 --dsm - -For more information about Docker, check out their `docs `_. - -.. _native-usage: - -Native ------- - - -First thing you need to do is set the project path. Edit the ``settings.yaml`` file to add your projects folder:: - - # This line is really important to set up properly - project_path: '' # Example: '/home/user/ODMProjects' - - # The rest of the settings will default to the values set unless you uncomment and change them - #resize_to: 2400 - -You must change ``project_path: ''`` to add an absolute path to somewhere on your machine. Whenever you run a new project, it will be saved here. - -To use OpenDroneMap run the following command:: - - python run.py --images [arguments] - -Then sit back, grab a coffee and wait. You only have to specify ``--images `` on the first run. - -.. _Tutorials: - Tutorials ---------