From 4ebc0da3ff4323a8fa03f51e056110bb17c10cd6 Mon Sep 17 00:00:00 2001 From: Stephen Mather Date: Sat, 19 Oct 2024 21:06:46 -0400 Subject: [PATCH] consolidate faq and resources --- source/faq.rst | 58 +++++++++++++++++++++++++++++--------------- source/index.rst | 1 - source/resources.rst | 26 -------------------- 3 files changed, 38 insertions(+), 47 deletions(-) delete mode 100644 source/resources.rst diff --git a/source/faq.rst b/source/faq.rst index d48693eb27..c420d8c69c 100644 --- a/source/faq.rst +++ b/source/faq.rst @@ -1,46 +1,41 @@ -########################## +################################################### +Frequently Asked Questions and Additional Resources +################################################### + +************************** Frequently Asked Questions -########################## +************************** -*************** Data Processing -*************** +--------------- -Can I process two or more orthophoto GeoTIFFs to stitch them together? ----------------------------------------------------------------------- +**Can I process two or more orthophoto GeoTIFFs to stitch them together?** No. ODM is a photogrammetric pipeline and orthophotos do not have the necessary camera information since the images have already been orthorectified. You can use another program such as `Hugin `_ to do that. -The software is not using all of my CPU cores / memory / GPU all of the times. Is it normal? --------------------------------------------------------------------------------------------- +**The software is not using all of my CPU cores / memory / GPU all of the times. Is it normal?** Yes. The software tries to use all available resources, when possible, but not always. It's normal to see 10-15% CPU utilization at several moments during processing and 0% GPU utilization for lots of times. -If I use the native version of the software, how can I allocate more resources for processing? ----------------------------------------------------------------------------------------------- +**If I use the native version of the software, how can I allocate more resources for processing?** No need; the native (non-docker) version of the software already uses all available resources. -********* Licensing -********* +--------- -I want to build a commercial application that includes ODM. Do I need a commercial license? -------------------------------------------------------------------------------------------- +**I want to build a commercial application that includes ODM. Do I need a commercial license?** ODM is free and open source software, released under the `AGPLv3 `_. You are free to build and sell applications with it, just make sure to comply with the requirements of the license, in particular the disclose source requirement. -Are there other licensing options aside from the AGPLv3? --------------------------------------------------------- +**Are there other licensing options aside from the AGPLv3?** Nope, sorry! -************* Memory issues -************* +------------- -Your computer is running out of memory, what can you do? --------------------------------------------------------- +**Your computer is running out of memory, what can you do?** 1. First you can buy more RAM, this is the ultimate and final solution. 2. Alternatively you can resize the images when uploading and/or tweak your quality settings. @@ -55,6 +50,29 @@ Your computer is running out of memory, what can you do? - In Linux you can add a swap file or a partition dedicated to swap. For more information, please consult your search engine of choice as there are a lot of different distributions and methods to add swap. +********************* +Additional References +********************* + +For Users +--------- + +The following resources are a good place to start: + +* `README page for ODM `_ +* `README page for WebODM `_ +* `README page for NodeODM `_ +* `Ground Control Points Format Specification `_ +* `OpenDroneMap: The Missing Guide `_ + +For Developers +-------------- + +In addition to user resources, we recommend to also read the following: +* WebODM documentation: https://docs.webodm.org +* NodeODM API specification: https://github.com/OpenDroneMap/NodeODM/blob/master/docs/index.adoc +* Overview of the ODM pipeline: http://community.opendronemap.org/t/where-can-i-find-background-information-on-the-concepts-of-odm/665/2 +* We keep a `section in our forum dedicated to research papers `_. This is a valuable place where to read more about state of the art research related to structure from motion, multi-view stereo, meshing, texturing, etc. which can be used to improve the software. `Learn to edit `_ and help improve `this page `_! diff --git a/source/index.rst b/source/index.rst index d6844c3d3a..23bba5de86 100644 --- a/source/index.rst +++ b/source/index.rst @@ -55,7 +55,6 @@ The documentation is available in several languages. Some translations are incom map-accuracy masks large - resources flying multispectral requesting-features diff --git a/source/resources.rst b/source/resources.rst deleted file mode 100644 index 9fcb910ee0..0000000000 --- a/source/resources.rst +++ /dev/null @@ -1,26 +0,0 @@ -Additional References -===================== - -For Users --------------- - -The following resources are a good place to start: - -* `README page for ODM `_ -* `README page for WebODM `_ -* `README page for NodeODM `_ -* `Ground Control Points Format Specification `_ -* `OpenDroneMap: The Missing Guide `_ - -For Developers --------------- - -In addition to user resources, we recommend to also read the following: - -* WebODM documentation: https://docs.webodm.org -* NodeODM API specification: https://github.com/OpenDroneMap/NodeODM/blob/master/docs/index.adoc -* Overview of the ODM pipeline: http://community.opendronemap.org/t/where-can-i-find-background-information-on-the-concepts-of-odm/665/2 -* We keep a `section in our forum dedicated to research papers `_. This is a valuable place where to read more about state of the art research related to structure from motion, multi-view stereo, meshing, texturing, etc. which can be used to improve the software. - - -`Learn to edit `_ and help improve `this page `_! \ No newline at end of file