Merge branch 'OpenDroneMap:publish' into publish

smathermather · web-flow · commit f18927cf64bf · 2026-05-12T13:34:00.000-04:00
diff --git a/.tx/config b/.tx/config
@@ -1,5 +1,5 @@
 [main]
-host = https://www.transifex.com
+host = https://app.transifex.com
 
 [o:americanredcross:p:opendronemap_docs:r:arguments]
 file_filter            = source/locale/<lang>/LC_MESSAGES/arguments.po
diff --git a/Makefile b/Makefile
@@ -31,15 +31,15 @@ updatepot:
 
 # update the po files for each target language from the EN pot files
 updatelangpo:
-	sphinx-intl update --pot-dir "source/locale/pot" --language cs,es,fil,fr,id,sw,te
+	sphinx-intl update --pot-dir "source/locale/pot" --language cs,es,fil,fr,id,sw,te,zh
 
 # push new and changed strings to Transifex
 pushlang:
 	tx push --source
 
 # push translated strings from Transifex
 pulllang:
-	tx pull --language "cs,es,fil,fr,id,sw,te"
+	tx pull --language "cs,es,fil,fr,id,sw,te,zh"
 
 build:
 	@$(SPHINXBUILD) -b dirhtml "$(SOURCEDIR)" "$(BUILDDIR)/html" -nW
@@ -50,6 +50,7 @@ build:
 	@$(SPHINXBUILD) -b dirhtml -D language='id' "$(SOURCEDIR)" "$(BUILDDIR)/html/id"  -nW
 	@$(SPHINXBUILD) -b dirhtml -D language='sw' "$(SOURCEDIR)" "$(BUILDDIR)/html/sw" -nW
 	@$(SPHINXBUILD) -b dirhtml -D language='te' "$(SOURCEDIR)" "$(BUILDDIR)/html/te" -nW
+	@$(SPHINXBUILD) -b dirhtml -D language='zh' "$(SOURCEDIR)" "$(BUILDDIR)/html/zh" -nW
 	#  -n   Run in nit-picky mode. Currently, this generates warnings for all missing references.
 	#  -W   Turn warnings into errors that stop the build.
 	# for more details about the options see https://www.sphinx-doc.org/en/1.8/man/sphinx-build.html#options
@@ -65,6 +66,7 @@ allerr:
 	@$(SPHINXBUILD) -v -b dirhtml -D language='id' "$(SOURCEDIR)" "$(BUILDDIR)/html/id"
 	@$(SPHINXBUILD) -v -b dirhtml -D language='sw' "$(SOURCEDIR)" "$(BUILDDIR)/html/sw"
 	@$(SPHINXBUILD) -v -b dirhtml -D language='te' "$(SOURCEDIR)" "$(BUILDDIR)/html/te"
+	@$(SPHINXBUILD) -v -b dirhtml -D language='zh' "$(SOURCEDIR)" "$(BUILDDIR)/html/zh"
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
diff --git a/README.md b/README.md
@@ -152,7 +152,7 @@ The script creates a blank `*.rst` file for each argument in `/source/arguments_
 
 Transifex has a getting [started guide for translators](https://docs.transifex.com/getting-started-1/translators) that will walk you through the steps to setup an account.
 
-The ODM documentation Transifex project can be found at: https://www.transifex.com/americanredcross/opendronemap_docs/
+The ODM documentation Transifex project can be found at: https://app.transifex.com/americanredcross/opendronemap_docs/
 
 The documentation uses a formatting known as [reStructuredTest (reST)](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) to add links, formatting, and other styling. reST uses plain text to annotate the documentation and identify to the system how to process the different page items. Unfortunately, the translation management process doesn't hide the reST markup. It is important that you keep the reST markup when translating.
 
diff --git a/scripts/extract_odm_strings.py b/scripts/extract_odm_strings.py
@@ -117,7 +117,7 @@ def get_opt_choices(opt):
                 f.write("\n")
             print("Wrote %s" % include_file)
 
-        argument_edit = Path(include_file).read_text()
+        argument_edit = Path(include_file).read_text(encoding='utf-8')
 
         kwargs = {
             'opt': opt_name,
diff --git a/source/arguments.rst b/source/arguments.rst
@@ -113,6 +113,9 @@ Options and Flags
 :ref:`merge<merge>` all |  pointcloud |  orthophoto |  dem
   Choose what to merge in the merge step in a split dataset. By default all available outputs are merged. Options: ['all', 'pointcloud', 'orthophoto', 'dem']. Default: ``all``
 
+:ref:`merge-skip-blending<merge-skip-blending>` 
+  During the orthophoto merging, skip expensive blending operation: ``False``
+
 :ref:`mesh-octree-depth<mesh-octree-depth>` <integer: 1 <= x <= 14>
   Octree depth used in the mesh reconstruction, increase to get more vertices, recommended values are 8-12. Default: ``11``
 
diff --git a/source/arguments/merge-skip-blending.rst b/source/arguments/merge-skip-blending.rst
@@ -0,0 +1,18 @@
+..
+  AUTO-GENERATED by extract_odm_strings.py! DO NOT EDIT!
+  If you want to add more details to a command, edit a
+  .rst file in arguments_edit/<argument>.rst
+
+.. _merge-skip-blending:
+
+merge-skip-blending
+```````````````````
+
+
+
+During the orthophoto merging, skip expensive blending operation: ``False``
+
+
+
+
+`Learn to edit <https://github.com/opendronemap/docs#how-to-make-your-first-contribution>`_ and help improve `this page <https://github.com/OpenDroneMap/docs/blob/publish/source/arguments_edit/merge-skip-blending.rst>`_!
diff --git a/source/arguments_edit/merge-skip-blending.rst b/source/arguments_edit/merge-skip-blending.rst
@@ -0,0 +1 @@
+
diff --git a/source/flying.rst b/source/flying.rst
@@ -9,7 +9,7 @@ For best in class results with full 3D reconstruction, we recommend the followin
 * 60% overlap nadir flight
 * 70-80% overlap 45-degree gimbal angle cross-grid
 
-The 45-degree cross-grid flight provides the basis for a fully tied together model, while the nadir flights provide the necessary texture for orthophoto texturing. The lower overlap  meets the minimum requirement for orthophoto products as facilitated by by feature matching from the much higher overlap cross-grid.
+The 45-degree cross-grid flight provides the basis for a fully tied together model, while the nadir flights provide the necessary texture for orthophoto texturing. The lower overlap  meets the minimum requirement for orthophoto products as facilitated by feature matching from the much higher overlap cross-grid.
 
 Data collection effort, 2D and 2.5D products
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/source/images/3D_result.webp b/source/images/3D_result.webp
diff --git a/source/images/target_image.webp b/source/images/target_image.webp
diff --git a/source/images/target_image_mask.webp b/source/images/target_image_mask.webp
diff --git a/source/index.rst b/source/index.rst
@@ -18,14 +18,15 @@ There is a `guide <https://github.com/opendronemap/docs#how-to-make-your-first-c
 
 The documentation is available in several languages. Some translations are incomplete and will still display in English. The below languages are at least 20 percent translated. You can help us translate those languages (and other languages!) via Transifex. There is a `getting started guide on GitHub <https://github.com/opendronemap/docs#translations>`_.
 
-- `English <https://docs.opendronemap.org/>`_
-- `Czech <https://docs.opendronemap.org/cs>`_
-- `Filipino <https://docs.opendronemap.org/fil>`_
-- `French <https://docs.opendronemap.org/fr>`_
-- `Spanish <https://docs.opendronemap.org/es>`_
-- `Indonesian <https://docs.opendronemap.org/id>`_
-- `Swahili <https://docs.opendronemap.org/sw>`_
-- `Telugu <https://docs.opendronemap.org/te>`_
+- `English </>`_
+- `Czech </cs>`_
+- `Filipino </fil>`_
+- `French </fr>`_
+- `Spanish </es>`_
+- `Indonesian </id>`_
+- `Swahili </sw>`_
+- `Telugu </te>`_
+- `Chinese </zh>`_
 
 |
 |
diff --git a/source/installation.rst b/source/installation.rst
@@ -10,7 +10,7 @@ Quickstart
 
 Installers for OpenDroneMap are available for purchase, and are the easiest way to get started and come with support.
 
-https://opendronemap.org/webodm/download/#installer
+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:
 
@@ -362,7 +362,7 @@ Commands to type:
 Step 2. Check Additional Requirements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-In addition to the three programs above, the dockercompose 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:
+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
 
@@ -375,8 +375,8 @@ You should see somethings similar to the following:
 	docker compose version 24.0.5, build ced0996600
 	
 
-Step 3a. Download and Launch WebODM
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Step 3a. Download and Launch WebODM with webodm.sh call of docker compose
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 From a terminal type:
 
@@ -388,8 +388,8 @@ From a terminal type:
 	
 Then open a web browser to http://localhost:8000.
 
-Step 3b. Start Docker Compose stack
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Step 3b. Alternatively, start via docker compose without webodm.sh
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 copy the following 3 files into a newly created folder:
 
diff --git a/source/map-accuracy.rst b/source/map-accuracy.rst
@@ -366,11 +366,11 @@ When attempting to process very large datasets it may very well be the case that
 
 **Workflow for aligning large  datasets:**
 
-#.Split the full compliment of images into manageable chunks. E.g. If you have flown and collected a total of  1000 images but you know your processor cannot handle all these images at once, you may want to devide these images into four sets of submodels with 250 images each.
-#.Process the first dataset with theDigital Surface Model (DSM) option enabled.
-#.Download the DSM from first dataseta in its raw-tiff format and rename it to 'align.tif'
-#.Load the second dataset together with the align.tif
-#.Process the second dataset (including the align.tif file)
-#.Repeat until all submodels have been processed.    
+#. Split the full compliment of images into manageable chunks. E.g. If you have flown and collected a total of  1000 images but you know your processor cannot handle all these images at once, you may want to devide these images into four sets of submodels with 250 images each.
+#. Process the first dataset with theDigital Surface Model (DSM) option enabled.
+#. Download the DSM from first dataseta in its raw-tiff format and rename it to 'align.tif'
+#. Load the second dataset together with the align.tif
+#. Process the second dataset (including the align.tif file)
+#. Repeat until all submodels have been processed.    
 
 `Learn to edit <https://github.com/opendronemap/docs#how-to-make-your-first-contribution>`_ and help improve `this page <https://github.com/OpenDroneMap/docs/blob/publish/source/map-accuracy.rst>`_!
diff --git a/source/tutorials.rst b/source/tutorials.rst
@@ -520,6 +520,65 @@ 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 <https://lebkowski.name/docker-volumes/>`_.
 
+************
+Using Podman
+************
+As an alternative to Docker, one may choose to run WebODM using `Podman <https://podman.io>`. 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
+
+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:
+::
+   sudo chown -R $(whoami) WebODM
+
+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
+
+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
+
+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
+
+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.
+
+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 <https://docs.docker.com/compose/install/linux/#install-the-plugin-manually>`_ 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.
+::
+   $ 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:
+::
+   $ 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 <https://docs.podman.io/en/latest/markdown/podman.1.html#rootless-mode>`_. 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)
+
+
+MacOS
+=====
+In theory, `installing <https://podman-desktop.io/docs/installation/macos-install>`_ 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 <https://podman-desktop.io/docs/migrating-from-docker/customizing-docker-compatibility#enable-docker-compatibility>`_ and `Compose functionality <https://podman-desktop.io/docs/compose/setting-up-compose>`_. 
+
 *************************************
 Using ODM from low-bandwidth location
 *************************************
@@ -831,16 +890,16 @@ Starting from ODM ``2.0`` people can supply image masks to inform the software t
 
 To add a mask, simply create a new black and white image of the same dimension as the target image you want to mask (you can use a program such as GIMP to do this). Color in black the areas to exclude from the reconstruction. 
 
-.. figure:: https://user-images.githubusercontent.com/1951843/93247037-ade87a00-f75b-11ea-8b42-25bc1d89279d.webp
+.. figure:: images/target_image.webp
    :alt: Target image
    :align: center
 
-.. figure:: https://user-images.githubusercontent.com/1951843/93247007-a2954e80-f75b-11ea-87b3-4f04bd1737b9.webp
+.. figure:: images/target_image_mask.webp
    :alt: Image mask
    :align: center
 
 
-.. figure:: https://user-images.githubusercontent.com/1951843/93246970-8f827e80-f75b-11ea-8179-5a8fdd9f5193.webp
+.. figure:: images/3D_result.webp
    :alt: 3D result (building is masked)
    :align: center
 
