From 44a9001797cd78e1afdbc4189978bcc5c34d3eec Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Wed, 20 May 2026 11:30:43 -0400 Subject: [PATCH 1/6] remove refs --- source/arguments/auto-boundary.rst | 5 +- source/arguments/boundary.rst | 24 +- source/arguments/build-overviews.rst | 2 +- source/arguments/cog.rst | 2 +- source/arguments_edit/auto-boundary.rst | 5 +- source/arguments_edit/boundary.rst | 24 +- source/arguments_edit/build-overviews.rst | 2 +- source/arguments_edit/cog.rst | 2 +- source/installation.rst | 562 +--------------------- 9 files changed, 32 insertions(+), 596 deletions(-) diff --git a/source/arguments/auto-boundary.rst b/source/arguments/auto-boundary.rst index dd40c9516..5b47e1ac1 100644 --- a/source/arguments/auto-boundary.rst +++ b/source/arguments/auto-boundary.rst @@ -58,16 +58,13 @@ Example Images True: ``--auto-boundary`` ^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140864618-2a0c95f2-669e-45dc-b5c5-df82a555e4e5.webp - :alt: WebODM displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. + :alt: displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. - The WebODM 3D View shows the full extent of the reconstruction, bounded by the ``--auto-boundary`` option. False: ``null`` ^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140864753-db3695c5-3ba2-48fb-a644-3e591913de72.webp - :alt: WebODM displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. - The WebODM 3D View shows the full extent of the recosntruction. Compared to the ``--auto-boundary`` reconstruction above, one can see that the full reconstruction area is much larger (and therefore more visually sparse). `Learn to edit `_ and help improve `this page `_! diff --git a/source/arguments/boundary.rst b/source/arguments/boundary.rst index 9b6fa6b2b..5b55123ad 100644 --- a/source/arguments/boundary.rst +++ b/source/arguments/boundary.rst @@ -141,7 +141,7 @@ Downloading A Polygon .. figure:: https://user-images.githubusercontent.com/19295950/145103954-17ba7c31-fda6-4883-b7a6-3f0bacc266dd.webp :alt: Browser Download/Save file prompt for the generated GeoJSON file. - Once the GeoJSON file has been chosen for saving, the browser will prompt you to save it to disk. Choose an appropriate location where you can access it at a later time to load into WebODM. + Once the GeoJSON file has been chosen for saving, the browser will prompt you to save it to disk. Choose an appropriate location where you can access it at a later time to load into OpenDroneMap Desktop. Setting Boundary [GeoJSON] In Task Options """"""""""""""""""""""""""""""""""""""""""" @@ -186,7 +186,7 @@ New Temporary Scratch Layer Settings Adding an Orthophoto Background """""""""""""""""""""""""""""""" .. figure:: https://user-images.githubusercontent.com/19295950/145109918-df591ce8-3df4-485d-a775-81813b7e61ef.webp - :alt: Browsing to a generated Orthophoto from WebODM that covers the Area Of Interest (AOI). + :alt: Browsing to a generated Orthophoto from OpenDroneMap Desktop that covers the Area Of Interest (AOI). If you have run the task already without a Boundary [GeoJSON], you can load the generated Orthophoto from OpenDroneMap into QGIS to use as your basemap for creating your Boundary [GeoJSON]. This should ensure that your boundary polygon exactly matches the data in your Task, as different basemaps can have errors of 1-10m or more. If have not generated an Orthophoto for your Area Of Interest (AOI), you can use one of the various methods within QGIS to add a basemap. Just be mindful of possible differences in location, angle, skew, scale, and other registration changes that can occur between your data and a basemap provider's data. @@ -232,37 +232,37 @@ Example Images True: ``--boundary [GeoJSON]`` - Point Cloud ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140858936-10fda65f-c278-46ae-95bd-7af8f8369554.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Point Cloud. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Point Cloud. - The WebODM 3D View shows the modified extent of the reconstruction Point Cloud, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Point Cloud, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - Orthophoto ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859033-c6cab4f0-74b3-4266-b5ec-4a90da931340.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Orthophoto. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Orthophoto. - The WebODM 3D View shows the modified extent of the reconstruction Orthophoto, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Orthophoto, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - Digital Elevation Model ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859073-28db5174-9a40-42d8-86d6-f345d9dad5a8.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Digital Elevation Model. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Digital Elevation Model. - The WebODM 3D View shows the modified extent of the reconstruction Digital Elevation Model, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Digital Elevation Model, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - 3D Model/Textured Mesh ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859125-4854e651-9eff-430d-956c-16f4d9a52dfd.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset 3D Model/Textured Mesh. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset 3D Model/Textured Mesh. - The WebODM 3D View shows the modified extent of the reconstruction 3D Model/Textured Mesh, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction 3D Model/Textured Mesh, bounded by the GeoJSON proivded to the ``--boundary`` option. False: ``null`` ^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140858712-9bfd8c56-a52a-480e-b68d-d5a97bc516fd.webp - :alt: WebODM displaying the full reconstruction of the Brighton Beach dataset Point Cloud. + :alt: OpenDroneMap Desktop displaying the full reconstruction of the Brighton Beach dataset Point Cloud. - The WebODM 3D View shows the full extent of the recosntruction. Compared to the ``--boundary`` reconstruction above, one can see that the full reconstruction area is much larger and includes many features outside of the Area Of Interest used to generate the GeoJSON. + The OpenDroneMap Desktop 3D View shows the full extent of the recosntruction. Compared to the ``--boundary`` reconstruction above, one can see that the full reconstruction area is much larger and includes many features outside of the Area Of Interest used to generate the GeoJSON. diff --git a/source/arguments/build-overviews.rst b/source/arguments/build-overviews.rst index 1ec80e65f..1535ab075 100644 --- a/source/arguments/build-overviews.rst +++ b/source/arguments/build-overviews.rst @@ -53,7 +53,7 @@ Why would one use Overviews? ---------------------------- Overviews speed preview of the raster data by allowing the program rendering the raster to choose the closest size pyramid to match the resolution of the display extent that it is being rendered into, potentially saving a significant amount of time retrieving the full-size raster, buffering it, and then downscaling it for display. -In the case of WebODM, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map. +In the case of OpenDroneMap Desktop, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map. Example Images -------------- diff --git a/source/arguments/cog.rst b/source/arguments/cog.rst index 3f4f1467e..8a5749ab9 100644 --- a/source/arguments/cog.rst +++ b/source/arguments/cog.rst @@ -38,7 +38,7 @@ What Are Cloud Optimized GeoTIFFs (COGs)? ------------------------------------------ Cloud Optimized GeoTIFFs (COGs hereafter) are a special formulation of GeoTIFF files that take advantage of internal overivews as well as tiling (and various forms of compression). -In the case of WebODM, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by WebODM. +In the case of OpenDroneMap Desktop, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by OpenDroneMap Desktop. When are COGs appropriate? --------------------------- diff --git a/source/arguments_edit/auto-boundary.rst b/source/arguments_edit/auto-boundary.rst index f993fb807..4ff77170d 100644 --- a/source/arguments_edit/auto-boundary.rst +++ b/source/arguments_edit/auto-boundary.rst @@ -44,13 +44,10 @@ Example Images True: ``--auto-boundary`` ^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140864618-2a0c95f2-669e-45dc-b5c5-df82a555e4e5.webp - :alt: WebODM displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. + :alt: displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. - The WebODM 3D View shows the full extent of the reconstruction, bounded by the ``--auto-boundary`` option. False: ``null`` ^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140864753-db3695c5-3ba2-48fb-a644-3e591913de72.webp - :alt: WebODM displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. - The WebODM 3D View shows the full extent of the recosntruction. Compared to the ``--auto-boundary`` reconstruction above, one can see that the full reconstruction area is much larger (and therefore more visually sparse). diff --git a/source/arguments_edit/boundary.rst b/source/arguments_edit/boundary.rst index 83de1f955..74ac0e235 100644 --- a/source/arguments_edit/boundary.rst +++ b/source/arguments_edit/boundary.rst @@ -127,7 +127,7 @@ Downloading A Polygon .. figure:: https://user-images.githubusercontent.com/19295950/145103954-17ba7c31-fda6-4883-b7a6-3f0bacc266dd.webp :alt: Browser Download/Save file prompt for the generated GeoJSON file. - Once the GeoJSON file has been chosen for saving, the browser will prompt you to save it to disk. Choose an appropriate location where you can access it at a later time to load into WebODM. + Once the GeoJSON file has been chosen for saving, the browser will prompt you to save it to disk. Choose an appropriate location where you can access it at a later time to load into OpenDroneMap Desktop. Setting Boundary [GeoJSON] In Task Options """"""""""""""""""""""""""""""""""""""""""" @@ -172,7 +172,7 @@ New Temporary Scratch Layer Settings Adding an Orthophoto Background """""""""""""""""""""""""""""""" .. figure:: https://user-images.githubusercontent.com/19295950/145109918-df591ce8-3df4-485d-a775-81813b7e61ef.webp - :alt: Browsing to a generated Orthophoto from WebODM that covers the Area Of Interest (AOI). + :alt: Browsing to a generated Orthophoto from OpenDroneMap Desktop that covers the Area Of Interest (AOI). If you have run the task already without a Boundary [GeoJSON], you can load the generated Orthophoto from OpenDroneMap into QGIS to use as your basemap for creating your Boundary [GeoJSON]. This should ensure that your boundary polygon exactly matches the data in your Task, as different basemaps can have errors of 1-10m or more. If have not generated an Orthophoto for your Area Of Interest (AOI), you can use one of the various methods within QGIS to add a basemap. Just be mindful of possible differences in location, angle, skew, scale, and other registration changes that can occur between your data and a basemap provider's data. @@ -218,35 +218,35 @@ Example Images True: ``--boundary [GeoJSON]`` - Point Cloud ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140858936-10fda65f-c278-46ae-95bd-7af8f8369554.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Point Cloud. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Point Cloud. - The WebODM 3D View shows the modified extent of the reconstruction Point Cloud, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Point Cloud, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - Orthophoto ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859033-c6cab4f0-74b3-4266-b5ec-4a90da931340.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Orthophoto. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Orthophoto. - The WebODM 3D View shows the modified extent of the reconstruction Orthophoto, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Orthophoto, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - Digital Elevation Model ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859073-28db5174-9a40-42d8-86d6-f345d9dad5a8.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Digital Elevation Model. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Digital Elevation Model. - The WebODM 3D View shows the modified extent of the reconstruction Digital Elevation Model, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Digital Elevation Model, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - 3D Model/Textured Mesh ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859125-4854e651-9eff-430d-956c-16f4d9a52dfd.webp - :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset 3D Model/Textured Mesh. + :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset 3D Model/Textured Mesh. - The WebODM 3D View shows the modified extent of the reconstruction 3D Model/Textured Mesh, bounded by the GeoJSON proivded to the ``--boundary`` option. + The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction 3D Model/Textured Mesh, bounded by the GeoJSON proivded to the ``--boundary`` option. False: ``null`` ^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140858712-9bfd8c56-a52a-480e-b68d-d5a97bc516fd.webp - :alt: WebODM displaying the full reconstruction of the Brighton Beach dataset Point Cloud. + :alt: OpenDroneMap Desktop displaying the full reconstruction of the Brighton Beach dataset Point Cloud. - The WebODM 3D View shows the full extent of the recosntruction. Compared to the ``--boundary`` reconstruction above, one can see that the full reconstruction area is much larger and includes many features outside of the Area Of Interest used to generate the GeoJSON. + The OpenDroneMap Desktop 3D View shows the full extent of the recosntruction. Compared to the ``--boundary`` reconstruction above, one can see that the full reconstruction area is much larger and includes many features outside of the Area Of Interest used to generate the GeoJSON. diff --git a/source/arguments_edit/build-overviews.rst b/source/arguments_edit/build-overviews.rst index b03689018..c08655f50 100644 --- a/source/arguments_edit/build-overviews.rst +++ b/source/arguments_edit/build-overviews.rst @@ -39,7 +39,7 @@ Why would one use Overviews? ---------------------------- Overviews speed preview of the raster data by allowing the program rendering the raster to choose the closest size pyramid to match the resolution of the display extent that it is being rendered into, potentially saving a significant amount of time retrieving the full-size raster, buffering it, and then downscaling it for display. -In the case of WebODM, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map. +In the case of OpenDroneMap Desktop, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map. Example Images -------------- diff --git a/source/arguments_edit/cog.rst b/source/arguments_edit/cog.rst index 1648442b0..59bbbc80f 100644 --- a/source/arguments_edit/cog.rst +++ b/source/arguments_edit/cog.rst @@ -24,7 +24,7 @@ What Are Cloud Optimized GeoTIFFs (COGs)? ------------------------------------------ Cloud Optimized GeoTIFFs (COGs hereafter) are a special formulation of GeoTIFF files that take advantage of internal overivews as well as tiling (and various forms of compression). -In the case of WebODM, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by WebODM. +In the case of OpenDroneMap Desktop, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by OpenDroneMap Desktop. When are COGs appropriate? --------------------------- diff --git a/source/installation.rst b/source/installation.rst index e77328654..24904db27 100644 --- a/source/installation.rst +++ b/source/installation.rst @@ -3,7 +3,7 @@ Installation and Getting Started ================================ -This section is excerpted and modified with permission from `OpenDroneMap: The Missing Guide `_, by Piero Toffanin. +.. This section is excerpted and modified with permission from `OpenDroneMap: The Missing Guide `_, by Piero Toffanin. Quickstart ---------- @@ -12,7 +12,7 @@ Installers for OpenDroneMap are available for purchase, and are the easiest way https://opendronemap.org/download/ -That said, OpenDroneMap is a free and open source ecoystem. Community support is available for those looking to install themselves and directions follow: +That said, OpenDroneMap is a free and open source ecoystem. Community support is available for those looking to install themselves and directions follow can be found here: `ODM Repo `_ Hardware Recommendations ------------------------ @@ -43,561 +43,3 @@ The above will allow the processing of a few hundred images with minimal issues. "3500","192" "5000","256" - -.. _docker-installation: - -Installation ------------- - -We recommend people use `docker `_ for running ODM, whether you are on Windows, macOS or Linux. - -Windows -``````` - -To run OpenDroneMap you need at least Windows 7. Previous -versions of Windows are not supported. - -Step 1. Check Virtualization Support -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Docker requires a feature from your CPU called virtualization, which allows it to run virtual machines (VMs). Make sure you have it enabled! Sometimes this is disabled. To check, on Windows 8 or higher you can open the **Task Manager** (press CTRL+SHIFT+ESC) and switch to the **Performance** tab. - -.. figure:: images/virtualizationcheck.webp - :alt: Image of checking virtualization in Windows 8 or higher - :align: center - -*Virtualization should be enabled* - -On Windows 7 to see if you have virtualization enabled you can use the `Microsoft® Hardware-Assisted Virtualization Detection Tool `_ instead. - -If virtualization is disabled, you’ll need to enable it. The procedure unfortunately is a bit different for each computer model, so the best way to do this is to look up on a search engine “how to enable vtx for ”. Often times it’s a matter of restarting the computer, immediately pressing F2 or F12 during startup, navigating the boot menu and changing the settings to enable virtualization (often called “VT-X”). - -.. figure:: images/bioskeys.webp - :alt: Table of different bios keys - :align: center - -*Common keys to press at computer startup to access the boot menu for various PC vendors* - -Step 2. Install Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -First, you’ll need to install: - -* Git: https://git-scm.com/downloads -* Python (latest version 3): https://www.python.org/downloads/windows/ - -For Python 3, make sure you check **Add Python 3.x to PATH** during the installation. - -.. figure:: images/installpython3.webp - :alt: Screenshot of Python3 installation process - :align: center - -*Don’t forget to add the Python executable to your PATH (so that you can run commands with it)* - -Then, only if you are on Windows 10 Home, Windows 8 (any version) or Windows 7 (any version), install: - -* Docker Toolbox: https://github.com/docker/toolbox/releases/download/v18.09.3/DockerToolbox-18.09.3.exe - -If you are on Windows 10 Professional or a newer version, you should install instead: - -* Docker for Windows:https://docs.docker.com/desktop/install/windows-install/ - -Please do **NOT** install both docker programs. They are different and will create a mess if they are both installed. - -After installing docker, launch it from the Desktop icon that is created from the installation (**Docker Quickstart** in the case of Docker Toolbox, **Docker for Windows** for Docker for Windows). This is important, do not skip this step. If there are errors, follow the prompts on screen to fix them. - -Step 3. Check Memory and CPU Allocation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Docker on Windows works by running a VM in the background (think of a VM as a “computer emulator”). This VM has a certain amount of memory allocated and WebODM can only use as much memory as it’s allocated. - -If you installed Docker Toolbox (see below if you installed Docker for Windows instead): - -1. Open the **VirtualBox Manager** application -2. Right click the **default** VM and press **Close (ACPI Shutdown)** to stop the machine -3. Right click the **default** VM and press **Settings...** -4. Move the **Base Memory** slider from the **System** panel and allocate 60-70% of all available memory, optionally adding 50% of the available processors from the **Processor** tab also - -.. figure:: images/virtualboxsettings.webp - :alt: Screenshot of VirtualBox Settings - :align: center - -*VirtualBox default VM settings* - -Then press **OK**, right click the **default** VM and press **Start**. - -If you installed Docker for Windows instead: - -1. Look in the system tray and right click the “white whale” icon. -2. From the menu, press **Settings...** -3. From the panel, click **Advanced** and use the sliders to allocate 60-70% of available memory and use half of all available CPUs. -4. Press **Apply**. - -.. figure:: images/dockericon.webp - :alt: Screenshot of Docker Icon - :align: center - -*Step 1 Docker icon* - -.. figure:: images/dockersettings.webp - :alt: Screenshot of Docker Settings - :align: center - -*Step 3 & 4 Docker settings* - -Step 4. Download WebODM -^^^^^^^^^^^^^^^^^^^^^^^ - -Open the **Git Gui** program that comes installed with Git. From there: - -* When Git Gui opens, click 'Clone Existing Repository' option -* In **Source Location** type: https://github.com/OpenDroneMap/WebODM -* In **Target Directory** click browse and navigate to a folder of your choosing (create one if necessary) -* Press **Clone** - -.. figure:: images/gitgui.webp - :alt: Screenshot of Git Gui - :align: center - -*Git Gui* - -If the download succeeded, you should now see this window: - -.. figure:: images/gitguisuccess.webp - :alt: Screenshot of Git Gui after successful download - :align: center - -*Git Gui after successful download (clone)* - -Go to the **Repository** menu, then click **Create Desktop Icon**. This will allow you to come back to this application easily in the future. - -Step 4. Launch WebODM -^^^^^^^^^^^^^^^^^^^^^ - -From Git Gui, go to the **Repository** menu, then click **Git Bash**. From the command line terminal type: - -.. code:: bash - - $ ./webodm.sh start & - -Several components will download to your machine at this point, including WebODM, NodeODM and ODM. After the download you should be greeted by the following screen: - -.. figure:: images/webodmsuccess.webp - :alt: Screenshot of after successfully downloading WebODM - :align: center - -*Console output after starting WebODM for the first time* - -* If you are using Docker for Windows, open a web browser to http://localhost:8000 -* If you are using Docker Toolbox, find the IP address to connect to by typing: - -.. code:: bash - - $ docker-machine ip - -You should get a result like the following: - -.. code:: bash - - 192.168.1.100 - -Then connect to http://192.168.1.100:8000 (replacing the IP address with the proper one). - -macOS -````` - -Most modern (post 2010) Mac computers running macOS Sierra 10.12 or higher can run OpenDroneMap using docker, as long as hardware virtualization is supported (see below). - -Step 1. Check Virtualization Support -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Open a Terminal window and type: - -.. code:: bash - - $ sysctl kern.hv_support - -You will get a response similar to the following: - -.. code:: bash - - kern.hv_support: 1 - -If the result is *kern.hv_support: 1*, then your Mac is supported! Continue with Step 2. - -If the result is *kern.hv_support: 0*, unfortunately it means your Mac is too old to run OpenDroneMap. :( - -Step 2. Install Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -There are only two programs to install: - -1. Docker: https://download.docker.com/mac/stable/Docker.dmg -2. Git: https://sourceforge.net/projects/git-osx-installer/files/ - -After installing docker you should find an icon that looks like a whale in the task bar. - -.. figure:: images/macwhale.webp - :alt: Screenshot of Docker whale - :align: center - -*Docker app running* - -You can verify that docker is running properly by opening the **Terminal** app and typing: - -.. code:: bash - - $ docker run hello-world - -Which should return - -.. code:: bash - - Hello from Docker! - -To verify that git is installed, simply type: - -.. code:: bash - - $ git --version - -Which should return something similar to the following: - -.. code:: bash - - git version 2.20.1 (Apple Git-117) - -If you get a “bash: git: command not found”, try to restart your **Terminal** app and double-check for any errors during the install process. - -Step 3. Check Memory and CPU Allocation -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Docker on macOS works by running a VM in the background (think of it as a “computer emulator”). This VM has a certain amount of memory allocated and WebODM can only use as much memory as it’s allocated. - -1. Right click the whale icon from the task bar and click **Preferences**... -2. Select the **Advanced** tab -3. Adjust the CPUs slider to use half of all available CPUs and the memory to use 60-70% of all available memory -4. Press **Apply & Restart** - -.. figure:: images/dockeradvanced.webp - :alt: Screenshot of Docker advanced settings - :align: center - -*Docker advanced settings* - -Step 4. Download and Launch WebODM -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -From a **Terminal** type: - -.. code:: bash - - $ git clone https://github.com/OpenDroneMap/WebODM - $ cd WebODM - $ ./webodm.sh start - -Then open a web browser to http://localhost:8000. - -Linux -````` - -OpenDroneMap can run on any Linux distribution that supports docker. According to `docker’s documentation website `_ the officially supported distributions are CentOS, Debian, Ubuntu and Fedora, with static binaries available for others. If you have to pick a distribution solely for running OpenDroneMap, Ubuntu is the recommended way to go. - -Step 1. Install Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -There are four programs that need to be installed: - -1. Docker -2. Git -3. Python (2 or 3) -4. Pip - -We cannot possibly cover the installation process for every Linux distribution out there, so we’ll limit the instructions to those that are distributions officially supported by docker. In all cases it’s just a matter of opening a terminal prompt and typing a few commands. - -Install on Ubuntu / Debian -__________________________ - -Commands to type: - -.. code:: bash - - $ sudo apt update - $ curl -fsSL https://get.docker.com -o get-docker.sh - $ sh get-docker.sh - $ sudo apt install -y git python python-pip - -Install on CentOS / RHEL -________________________ - -Commands to type: - -.. code:: bash - - $ curl -fsSL https://get.docker.com -o get-docker.sh - $ sh get-docker.sh - $ sudo yum -y install git python python-pip - -Install on Fedora -_________________ - -Commands to type: - -.. code:: bash - - $ curl -fsSL https://get.docker.com -o get-docker.sh - $ sh get-docker.sh - $ sudo dnf install git python python-pip - -Install on Arch -_______________ - -Commands to type: - -.. code:: bash - - $ sudo pacman -Sy docker git python python-pip - -Step 2. Check Additional Requirements -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -In addition to the three programs above, the docker compose script is also needed. Sometimes it’s already installed with docker, but sometimes it isn’t. To verify if it’s installed try to type: - -.. code:: bash - - $ docker compose --version - -You should see somethings similar to the following: - -.. code:: bash - - docker compose version 24.0.5, build ced0996600 - - -Step 3a. Download and Launch WebODM with webodm.sh call of docker compose -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -From a terminal type: - -.. code:: bash - - $ git clone https://github.com/OpenDroneMap/WebODM - $ cd WebODM - $ ./webodm.sh start - -Then open a web browser to http://localhost:8000. - -Step 3b. Alternatively, start via docker compose without webodm.sh -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -copy the following 3 files into a newly created folder: - -The ``config-default.json``: - -.. code:: json - - { - "instance": "node-OpenDroneMap", - "odm_path": "/code", - - "logger": { - "level": "info", - "maxFileSize": 104857600, - "maxFiles": 10, - "logDirectory": "" - }, - - "port": "auto", - "deamon": false, - "parallelQueueProcessing": 8, - "cleanupTasksAfter": 2880, - "test": false, - "testSkipOrthophotos": false, - "testSkipDems": false, - "token": "", - "authorizedIps": [], - "maxImages": "" - } - -The ``init.sql``: - -.. code:: sql - - CREATE EXTENSION postgis_raster; - SET postgis.gdal_enabled_drivers = 'ENABLE_ALL'; - -And finally the ``compose.yml``: - -.. code:: yml - - services: - webodm-node-odm-1: - image: opendronemap/nodeodm:gpu - container_name: webodm-node-odm-1 - ports: - - "3000:3000" - volumes: - - ./config-default.json:/var/www/config-default.json - privileged: true - restart: unless-stopped - deploy: - resources: - reservations: - devices: - - driver: nvidia - capabilities: [gpu] - - webapp-odm: - image: opendronemap/webodm_webapp - container_name: webapp - entrypoint: /bin/bash -c "service cron start && chmod +x /webodm/*.sh && /bin/bash -c \"/webodm/wait-for-it.sh -t 0 redis-odm:6379 -- /webodm/start.sh\" && python manage.py migrate" - restart: always - volumes: - - ./data/webodm:/webodm/app/media:z - ports: - - "8000:8000" - depends_on: - - db-odm - - redis-odm - - webodm-node-odm-1 - environment: - - WO_BROKER=redis://redis-odm - - WO_DEFAULT_NODES=1 - - WO_HOST=localhost - - WO_PORT=8000 - - WO_MEDIA_DIR=appmedia - - WO_DB_DIR=dbdata - - WO_SSL=NO - - WO_SSL_INSECURE_PORT_REDIRECT=80 - - WO_DATABASE_HOST=db-odm - - WO_DATABASE_NAME=webodm_dev - - WO_DATABASE_USER=postgres - - WO_DATABASE_PASSWORD=postgres - - redis-odm: - image: redis:alpine - container_name: redis-odm - restart: always - - db-odm: - image: postgis/postgis:17-3.5-alpine - container_name: db-odm - restart: always - volumes: - - ./data/odm-db:/var/lib/postgresql/data - - ./init.sql:/docker-entrypoint-initdb.d/init.sql - environment: - - POSTGRES_USER=postgres - - POSTGRES_PASSWORD=postgres - - POSTGRES_DB=webodm_dev - healthcheck: - test: [ "CMD", "pg_isready", "-q", "-d", "webodm_dev", "-U", "postgres"] - timeout: 45s - interval: 20s - retries: 5 - - worker: - image: opendronemap/webodm_webapp - container_name: worker - entrypoint: /bin/bash -c "/webodm/wait-for-it.sh -t 0 redis-odm:6379 -- /webodm/wait-for-it.sh -t 0 webapp-odm:8000 -- /webodm/worker.sh start" - restart: always - volumes: - - ./data/webodm:/webodm/app/media:z - depends_on: - - redis-odm - - db-odm - environment: - - WO_BROKER=redis://redis-odm - - WO_DATABASE_HOST=db-odm - - WO_DATABASE_NAME=webodm_dev - - WO_DATABASE_USER=postgres - - WO_DATABASE_PASSWORD=postgres - -Finally, start the stack using ``docker compose up -d``. -You can now access WebODM at http://localhost:8000 and the nodeODM at http://localhost:3000. - -To view logs of the services use ``docker compose logs`` - -To shut down the services run ``docker compose down``. - - -Basic Commands and Troubleshooting ----------------------------------- - -The cool thing about using docker is that 99% of the tasks you’ll ever need to perform while using WebODM can be done via the ./webodm.sh script. You have already encountered one of them: - -.. code:: bash - - $ ./webodm.sh start - -which takes care of starting WebODM and setting up a default processing node (node-odm-1). If you want to stop WebODM, you can already guess what the command is: - -.. code:: bash - - $ ./webodm.sh stop - -There are several other commands you can use, along with different flags. Flags are parameters passed to the ./webodm.sh command and are typically prefixed with “–”. The **port** flag for example instructs WebODM to use a different network port: - -.. code:: bash - - $ ./webodm.sh start --port 80 - -Other useful commands are listed below: - -.. code:: bash - - # Restart WebODM (useful if things get stuck) - $ ./webodm.sh restart - - # Reset the admin user's password if you forget it - $ ./webodm.sh resetadminpassword newpass - - # Update everything to the latest version - $ ./webodm.sh update - - # Store processing results in the specified folder instead of the default location (inside docker) - $ ./webodm.sh restart --media-dir /path/to/webodm_results - - # See all options - $ ./webodm.sh --help - -`The community forum `_ is a great place to ask for help if you get stuck during any of the installation steps and for general questions on using the ./webodm.sh script. - -Hello, WebODM! --------------- - -After starting the containers using 3a. or 3b. you can open WebODM in the browser. -This will greet you with a welcome message and will ask to create the first user. Take some time to familiarize yourself with the web interface and explore its various menus. - -.. figure:: images/webodmdashboard.webp - :alt: Screenshot of WebODM Dashboard - :align: center - -*WebODM Dashboard* - -Notice that under the **Processing Nodes** menu there’s a "node-odm-1" node already configured for you to use. This is a NodeODM node and has been created automatically by WebODM. This node is running on the same machine as WebODM. - -If you’ve made it this far, congratulations! Now it’s time to start processing some data. - -.. figure:: images/congratulations.webp - :alt: Image of celebratory dance - :align: center - -Running on more than one machine -```````````````````````````````` - -**Optionally:** If you have another computer, you can repeat the installation process (install docker, git, python, etc.) and launch a new NodeODM node by typing from a Terminal/Git Bash window: - -.. code:: bash - - docker run --rm -it -p 3000:3000 opendronemap/nodeodm -q 1 --token secret - -The above command asks docker to launch a new container using the opendronemap/nodeodm image from Docker Hub (the latest version of NodeODM), using port 3000, setting a maximum number of concurrent tasks to 1 and to protect the node from unauthorized access using the password "secret". - -From WebODM you can then press the **Add New** button under **Processing Nodes**. For the **hostname/IP** field type the IP of the second computer. For the **port** field type “3000”. For the **token** field type “secret”. You can also add an optional **label** for your node, such as “second computer”. Then press **Save**. - -If everything went well, you should now have two processing nodes! You will be able to process multiple tasks in parallel using two different machines. - - -`Learn to edit `_ and help improve `this page `_! From ac9912ecc7ac0eab3dee9443f72704af1f6806f2 Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Wed, 20 May 2026 14:16:48 -0400 Subject: [PATCH 2/6] fix underline length --- source/large.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/large.rst b/source/large.rst index 9e946058a..2484fb02e 100644 --- a/source/large.rst +++ b/source/large.rst @@ -40,7 +40,7 @@ ODM can also automatically distribute the processing of each submodel to multipl :align: center Getting Started with Distributed Split-Merge -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The first step is start ClusterODM From 59ebb41f75d8949195c55e188264189ea2723978 Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Wed, 20 May 2026 14:17:37 -0400 Subject: [PATCH 3/6] fix underline length --- source/map-accuracy.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/map-accuracy.rst b/source/map-accuracy.rst index ca1efb597..e7246bf01 100644 --- a/source/map-accuracy.rst +++ b/source/map-accuracy.rst @@ -358,9 +358,9 @@ At the end of the script you obtain a directory by epoch (at the same level as t .. |image1| image:: https://forge.inrae.fr/Denis.Feurer/timesift-odm-data-example/-/raw/main/Example.webp?ref_type=heads ------------------------ +------------------------ Aligning Large Datasets ------------------------ +------------------------ When attempting to process very large datasets it may very well be the case that one needs to devide a large set of images into smaller more manageable chunks for ease of processing.This process however, may introduce some uncertainty with respect to the alignment of all the processed outputs.To make sure that all point clouds and terrain/suface models are seamlessly alighn in preparation for merging we follow the simple techniques outlined below. From a4c606f32cde9f2c24603bd0f86ca38ebaa74475 Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Wed, 20 May 2026 14:26:09 -0400 Subject: [PATCH 4/6] remove remaining references --- source/multispectral.rst | 2 +- source/tutorials.rst | 94 ++++++++++++++++++++-------------------- 2 files changed, 48 insertions(+), 48 deletions(-) diff --git a/source/multispectral.rst b/source/multispectral.rst index ccddcff93..68c94a769 100644 --- a/source/multispectral.rst +++ b/source/multispectral.rst @@ -21,7 +21,7 @@ While we aim to support as many cameras as possible, multispectral support has b Other cameras might also work. You can help us expand this list by `sharing datasets `_ captured with other cameras. Creating Orthophotos from Multispectral Data -------------------------------------------- +-------------------------------------------- For supported sensors listed above (and likley other sensors), users can process multipsectral data in the same manner as visible light images. Images from all sensor bands should be processed at once (do not separate the bands into multiple folders). Users have the option to pass the ``--radiometric-calibration`` parameter with options ``camera`` or ``camera+sun`` to enable radiometric normalization. If the images are part of a multi-camera setup, the resulting orthophoto will have N bands, one for each camera (+ alpha). diff --git a/source/tutorials.rst b/source/tutorials.rst index c21b58410..b7bdc91b9 100644 --- a/source/tutorials.rst +++ b/source/tutorials.rst @@ -55,9 +55,9 @@ Example of how to generate a DTM:: docker run -ti --rm -v /my/project:/datasets/code --project-path /datasets --dtm --dem-resolution 2 --smrf-threshold 0.4 --smrf-window 24 -*************************************** +***************************************************** Using Potree 3D viewer module on OpenDroneMap Desktop -*************************************** +***************************************************** Cameras ======= @@ -519,73 +519,73 @@ Cleaning up after Docker Docker has a lamentable use of space and by default does not clean up excess data and machines when processes are complete. This can be advantageous if we need to access a process that has since terminated, but carries the burden of using increasing amounts of storage over time. Maciej Łebkowski has an `excellent overview of how to manage excess disk usage in docker `_. -************ -Using Podman -************ -As an alternative to Docker, one may choose to run WebODM using `Podman `. To do so, simply install your distribution's podman package as well as its compatibility layer for docker. For example, on Alpine Linux: -:: +.. ************ + Using Podman + ************ + As an alternative to Docker, one may choose to run WebODM using `Podman `. To do so, simply install your distribution's podman package as well as its compatibility layer for docker. For example, on Alpine Linux: + :: - apk add podman podman-docker + apk add podman podman-docker -The Podman command line bears strong resemblance to the Docker one, so referring to the past section and replacing every ``docker`` command invocation with ``podman`` is likely sufficient to teach its basic use. + The Podman command line bears strong resemblance to the Docker one, so referring to the past section and replacing every ``docker`` command invocation with ``podman`` is likely sufficient to teach its basic use. -Migrating from Docker to Podman -=============================== -Unfortunately, given the number of options ``webodm.sh`` provides for deployment, migrating between the two may require some manual work before switching platforms. If WebODM's information was stored in directories using the ``--media-dir`` and ``--db-dir`` flags, then the data within those needs to be owned by the user running the Podman containers. If running rootlessly, be sure to set this to your current user. You should be safe to recursively chown the whole git repository as such if your ``media-dir`` and ``db-dir`` lives within it: -:: + Migrating from Docker to Podman + =============================== + Unfortunately, given the number of options ``webodm.sh`` provides for deployment, migrating between the two may require some manual work before switching platforms. If WebODM's information was stored in directories using the ``--media-dir`` and ``--db-dir`` flags, then the data within those needs to be owned by the user running the Podman containers. If running rootlessly, be sure to set this to your current user. You should be safe to recursively chown the whole git repository as such if your ``media-dir`` and ``db-dir`` lives within it: + :: - sudo chown -R $(whoami) WebODM + sudo chown -R $(whoami) WebODM -If ``webodm.sh`` was used without flags, then a different intervention is necessary to migrate their data. -:: + If ``webodm.sh`` was used without flags, then a different intervention is necessary to migrate their data. + :: - docker volume export webodm-dbdata > webodm-dbdata.tar - docker volume export webodm-appmedia > webodm-appmedia.tar + docker volume export webodm-dbdata > webodm-dbdata.tar + docker volume export webodm-appmedia > webodm-appmedia.tar -Regardless of data location, you'll now need to uninstall Docker completely from your system according to your operating system's documentation. Note that, by default, the ``webodm.sh`` script may have taken the liberty of installing docker-compose for you. To clean that up, run the following: -:: + Regardless of data location, you'll now need to uninstall Docker completely from your system according to your operating system's documentation. Note that, by default, the ``webodm.sh`` script may have taken the liberty of installing docker-compose for you. To clean that up, run the following: + :: - rm ~/.docker/cni-plugins-docker-compose + rm ~/.docker/cni-plugins-docker-compose -Now, install Podman according to your operating system's documentation. If you needed to export the media and db dirs from Docker before, you may now use it to import the volumes. -:: + Now, install Podman according to your operating system's documentation. If you needed to export the media and db dirs from Docker before, you may now use it to import the volumes. + :: - podman volume import webodm-dbdata webodm-dbdata.tar - podman volume import webodm-appmedia webodm-appmedia.tar + podman volume import webodm-dbdata webodm-dbdata.tar + podman volume import webodm-appmedia webodm-appmedia.tar -It is recommended that you log out and log back in to your system at this point to ensure all environment variables are properly sourced. + It is recommended that you log out and log back in to your system at this point to ensure all environment variables are properly sourced. -Running ``webodm.sh`` now should result in user data persisting between the switch. + Running ``webodm.sh`` now should result in user data persisting between the switch. -For versions of podman-compose < 1.5.0 -====================================== + For versions of podman-compose < 1.5.0 + ====================================== -podman-compose versions lower than 1.5.0 lack support for environment variables in docker-compose files. If your distribution does not provide an up to date version in its repositories, you can choose to either provide your own up-to-date binary or use the `Docker Compose `_ with podman itself. In either case, you'll need to update the compose_providers line of the ``/etc/containers/containers.conf`` file. + podman-compose versions lower than 1.5.0 lack support for environment variables in docker-compose files. If your distribution does not provide an up to date version in its repositories, you can choose to either provide your own up-to-date binary or use the `Docker Compose `_ with podman itself. In either case, you'll need to update the compose_providers line of the ``/etc/containers/containers.conf`` file. -If you choose to use Docker Compose instead of podman-compose, you might need to configure a few extra environment variables to tell WebODM where to send its Docker API requests to. The following environment configuration resulted in WebODM successfully spawning in Alpine Linux 3.22, though it should be fairly agnostic across distros. -:: + If you choose to use Docker Compose instead of podman-compose, you might need to configure a few extra environment variables to tell WebODM where to send its Docker API requests to. The following environment configuration resulted in WebODM successfully spawning in Alpine Linux 3.22, though it should be fairly agnostic across distros. + :: - export WEBODM_PODMAN_SOCKET=$(podman info --format '{{.Host.RemoteSocket.Path}}') - mkdir -p $(dirname WEBODM_PODMAN_SOCKET) - export DOCKER_HOST=unix://$WEBODM_PODMAN_SOCKET + export WEBODM_PODMAN_SOCKET=$(podman info --format '{{.Host.RemoteSocket.Path}}') + mkdir -p $(dirname WEBODM_PODMAN_SOCKET) + export DOCKER_HOST=unix://$WEBODM_PODMAN_SOCKET -Finally, start WebODM as such: -:: + Finally, start WebODM as such: + :: - podman system service --time=0 unix://$WEBODM_PODMAN_SOCKET & ./webodm.sh start + podman system service --time=0 unix://$WEBODM_PODMAN_SOCKET & ./webodm.sh start -Configuring Podman to run Rootlessly -==================================== -A major benefit of using Podman instead of Docker is due to its ability to run rootlessly. Your specific operating system may or may not configure this for you manually, but generic instructions on doing so can be found `in Podman's official documentation `_. To surmise, executing the following commands is likely what you'll need to do: -:: + Configuring Podman to run Rootlessly + ==================================== + A major benefit of using Podman instead of Docker is due to its ability to run rootlessly. Your specific operating system may or may not configure this for you manually, but generic instructions on doing so can be found `in Podman's official documentation `_. To surmise, executing the following commands is likely what you'll need to do: + :: - sudo usermod --add-subuids 10000-75535 $(whoami) - sudo usermod --add-subgids 10000-75535 $(whoami) + sudo usermod --add-subuids 10000-75535 $(whoami) + sudo usermod --add-subgids 10000-75535 $(whoami) -MacOS -===== -In theory, `installing `_ and running Podman Desktop from the official website should be all you need to use the ``webodm.sh`` script. Install and configure it for both `Docker compatibility `_ and `Compose functionality `_. + MacOS + ===== + In theory, `installing `_ and running Podman Desktop from the official website should be all you need to use the ``webodm.sh`` script. Install and configure it for both `Docker compatibility `_ and `Compose functionality `_. ************************************* Using ODM from low-bandwidth location From 0ac4d323458af3ffb669eb7f030e0fcc84fba449 Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Wed, 20 May 2026 15:37:02 -0400 Subject: [PATCH 5/6] remove direct edits --- source/arguments/auto-boundary.rst | 5 ++++- source/arguments/boundary.rst | 24 ++++++++++++------------ source/arguments/build-overviews.rst | 2 +- source/arguments/cog.rst | 2 +- 4 files changed, 18 insertions(+), 15 deletions(-) diff --git a/source/arguments/auto-boundary.rst b/source/arguments/auto-boundary.rst index 5b47e1ac1..dd40c9516 100644 --- a/source/arguments/auto-boundary.rst +++ b/source/arguments/auto-boundary.rst @@ -58,13 +58,16 @@ Example Images True: ``--auto-boundary`` ^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140864618-2a0c95f2-669e-45dc-b5c5-df82a555e4e5.webp - :alt: displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. + :alt: WebODM displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. + The WebODM 3D View shows the full extent of the reconstruction, bounded by the ``--auto-boundary`` option. False: ``null`` ^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140864753-db3695c5-3ba2-48fb-a644-3e591913de72.webp + :alt: WebODM displaying the reconstruction extent of a terrestrial orbit survey of a Northern Catalpa tree. + The WebODM 3D View shows the full extent of the recosntruction. Compared to the ``--auto-boundary`` reconstruction above, one can see that the full reconstruction area is much larger (and therefore more visually sparse). `Learn to edit `_ and help improve `this page `_! diff --git a/source/arguments/boundary.rst b/source/arguments/boundary.rst index 5b55123ad..9b6fa6b2b 100644 --- a/source/arguments/boundary.rst +++ b/source/arguments/boundary.rst @@ -141,7 +141,7 @@ Downloading A Polygon .. figure:: https://user-images.githubusercontent.com/19295950/145103954-17ba7c31-fda6-4883-b7a6-3f0bacc266dd.webp :alt: Browser Download/Save file prompt for the generated GeoJSON file. - Once the GeoJSON file has been chosen for saving, the browser will prompt you to save it to disk. Choose an appropriate location where you can access it at a later time to load into OpenDroneMap Desktop. + Once the GeoJSON file has been chosen for saving, the browser will prompt you to save it to disk. Choose an appropriate location where you can access it at a later time to load into WebODM. Setting Boundary [GeoJSON] In Task Options """"""""""""""""""""""""""""""""""""""""""" @@ -186,7 +186,7 @@ New Temporary Scratch Layer Settings Adding an Orthophoto Background """""""""""""""""""""""""""""""" .. figure:: https://user-images.githubusercontent.com/19295950/145109918-df591ce8-3df4-485d-a775-81813b7e61ef.webp - :alt: Browsing to a generated Orthophoto from OpenDroneMap Desktop that covers the Area Of Interest (AOI). + :alt: Browsing to a generated Orthophoto from WebODM that covers the Area Of Interest (AOI). If you have run the task already without a Boundary [GeoJSON], you can load the generated Orthophoto from OpenDroneMap into QGIS to use as your basemap for creating your Boundary [GeoJSON]. This should ensure that your boundary polygon exactly matches the data in your Task, as different basemaps can have errors of 1-10m or more. If have not generated an Orthophoto for your Area Of Interest (AOI), you can use one of the various methods within QGIS to add a basemap. Just be mindful of possible differences in location, angle, skew, scale, and other registration changes that can occur between your data and a basemap provider's data. @@ -232,37 +232,37 @@ Example Images True: ``--boundary [GeoJSON]`` - Point Cloud ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140858936-10fda65f-c278-46ae-95bd-7af8f8369554.webp - :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Point Cloud. + :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Point Cloud. - The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Point Cloud, bounded by the GeoJSON proivded to the ``--boundary`` option. + The WebODM 3D View shows the modified extent of the reconstruction Point Cloud, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - Orthophoto ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859033-c6cab4f0-74b3-4266-b5ec-4a90da931340.webp - :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Orthophoto. + :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Orthophoto. - The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Orthophoto, bounded by the GeoJSON proivded to the ``--boundary`` option. + The WebODM 3D View shows the modified extent of the reconstruction Orthophoto, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - Digital Elevation Model ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859073-28db5174-9a40-42d8-86d6-f345d9dad5a8.webp - :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset Digital Elevation Model. + :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset Digital Elevation Model. - The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction Digital Elevation Model, bounded by the GeoJSON proivded to the ``--boundary`` option. + The WebODM 3D View shows the modified extent of the reconstruction Digital Elevation Model, bounded by the GeoJSON proivded to the ``--boundary`` option. True: ``--boundary [GeoJSON]`` - 3D Model/Textured Mesh ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140859125-4854e651-9eff-430d-956c-16f4d9a52dfd.webp - :alt: OpenDroneMap Desktop displaying the "clipped" reconstruction of the Brighton Beach dataset 3D Model/Textured Mesh. + :alt: WebODM displaying the "clipped" reconstruction of the Brighton Beach dataset 3D Model/Textured Mesh. - The OpenDroneMap Desktop 3D View shows the modified extent of the reconstruction 3D Model/Textured Mesh, bounded by the GeoJSON proivded to the ``--boundary`` option. + The WebODM 3D View shows the modified extent of the reconstruction 3D Model/Textured Mesh, bounded by the GeoJSON proivded to the ``--boundary`` option. False: ``null`` ^^^^^^^^^^^^^^^^ .. figure:: https://user-images.githubusercontent.com/19295950/140858712-9bfd8c56-a52a-480e-b68d-d5a97bc516fd.webp - :alt: OpenDroneMap Desktop displaying the full reconstruction of the Brighton Beach dataset Point Cloud. + :alt: WebODM displaying the full reconstruction of the Brighton Beach dataset Point Cloud. - The OpenDroneMap Desktop 3D View shows the full extent of the recosntruction. Compared to the ``--boundary`` reconstruction above, one can see that the full reconstruction area is much larger and includes many features outside of the Area Of Interest used to generate the GeoJSON. + The WebODM 3D View shows the full extent of the recosntruction. Compared to the ``--boundary`` reconstruction above, one can see that the full reconstruction area is much larger and includes many features outside of the Area Of Interest used to generate the GeoJSON. diff --git a/source/arguments/build-overviews.rst b/source/arguments/build-overviews.rst index 1535ab075..1ec80e65f 100644 --- a/source/arguments/build-overviews.rst +++ b/source/arguments/build-overviews.rst @@ -53,7 +53,7 @@ Why would one use Overviews? ---------------------------- Overviews speed preview of the raster data by allowing the program rendering the raster to choose the closest size pyramid to match the resolution of the display extent that it is being rendered into, potentially saving a significant amount of time retrieving the full-size raster, buffering it, and then downscaling it for display. -In the case of OpenDroneMap Desktop, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map. +In the case of WebODM, Overviews are used to create dynamic tiles for rapid display and navigation of the 2D web map. Example Images -------------- diff --git a/source/arguments/cog.rst b/source/arguments/cog.rst index 8a5749ab9..3f4f1467e 100644 --- a/source/arguments/cog.rst +++ b/source/arguments/cog.rst @@ -38,7 +38,7 @@ What Are Cloud Optimized GeoTIFFs (COGs)? ------------------------------------------ Cloud Optimized GeoTIFFs (COGs hereafter) are a special formulation of GeoTIFF files that take advantage of internal overivews as well as tiling (and various forms of compression). -In the case of OpenDroneMap Desktop, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by OpenDroneMap Desktop. +In the case of WebODM, all GeoTIFFs will be generated as COGs because the 2D Map View uses the special attributes of COGs to enable rapid display and preview of the data generated by WebODM. When are COGs appropriate? --------------------------- From d78914a2b192e483fa962bbdd60d96b9571f07de Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Wed, 20 May 2026 15:38:58 -0400 Subject: [PATCH 6/6] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 220bd4548..b596056cb 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,7 @@ Then if there are no errors, run: make livehtml ``` -Note that if WebODM is running you should temporarily stop it while you edit the documentation. +Note that if OpenDroneMap Desktop or another application is running on port 8000 you should temporarily stop it while you edit the documentation. ## Step 5. Start Editing