Skip to content

Commit ecc87e4

Browse files
Merge pull request #219 from smathermather/faq_add
consolidate faq and resources
2 parents 93e421c + 4ebc0da commit ecc87e4

File tree

3 files changed

+38
-47
lines changed

3 files changed

+38
-47
lines changed

source/faq.rst

Lines changed: 38 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,41 @@
1-
##########################
1+
###################################################
2+
Frequently Asked Questions and Additional Resources
3+
###################################################
4+
5+
**************************
26
Frequently Asked Questions
3-
##########################
7+
**************************
48

5-
***************
69
Data Processing
7-
***************
10+
---------------
811

9-
Can I process two or more orthophoto GeoTIFFs to stitch them together?
10-
----------------------------------------------------------------------
12+
**Can I process two or more orthophoto GeoTIFFs to stitch them together?**
1113

1214
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 <http://hugin.sourceforge.net/>`_ to do that.
1315

14-
The software is not using all of my CPU cores / memory / GPU all of the times. Is it normal?
15-
--------------------------------------------------------------------------------------------
16+
**The software is not using all of my CPU cores / memory / GPU all of the times. Is it normal?**
1617

1718
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.
1819

19-
If I use the native version of the software, how can I allocate more resources for processing?
20-
----------------------------------------------------------------------------------------------
20+
**If I use the native version of the software, how can I allocate more resources for processing?**
2121

2222
No need; the native (non-docker) version of the software already uses all available resources.
2323

24-
*********
2524
Licensing
26-
*********
25+
---------
2726

28-
I want to build a commercial application that includes ODM. Do I need a commercial license?
29-
-------------------------------------------------------------------------------------------
27+
**I want to build a commercial application that includes ODM. Do I need a commercial license?**
3028

3129
ODM is free and open source software, released under the `AGPLv3 <https://github.com/OpenDroneMap/ODM/blob/master/LICENSE>`_. 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.
3230

33-
Are there other licensing options aside from the AGPLv3?
34-
--------------------------------------------------------
31+
**Are there other licensing options aside from the AGPLv3?**
3532

3633
Nope, sorry!
3734

38-
*************
3935
Memory issues
40-
*************
36+
-------------
4137

42-
Your computer is running out of memory, what can you do?
43-
--------------------------------------------------------
38+
**Your computer is running out of memory, what can you do?**
4439

4540
1. First you can buy more RAM, this is the ultimate and final solution.
4641
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?
5550
5651
- 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.
5752

53+
*********************
54+
Additional References
55+
*********************
56+
57+
For Users
58+
---------
59+
60+
The following resources are a good place to start:
61+
62+
* `README page for ODM <https://github.com/OpenDroneMap/OpenDroneMap>`_
63+
* `README page for WebODM <https://github.com/OpenDroneMap/WebODM>`_
64+
* `README page for NodeODM <https://github.com/OpenDroneMap/node-OpenDroneMap>`_
65+
* `Ground Control Points Format Specification <https://github.com/mapillary/OpenSfM/blob/master/doc/source/gcp.rst>`_
66+
* `OpenDroneMap: The Missing Guide <https://odmbook.com/>`_
67+
68+
For Developers
69+
--------------
70+
71+
In addition to user resources, we recommend to also read the following:
5872

73+
* WebODM documentation: https://docs.webodm.org
74+
* NodeODM API specification: https://github.com/OpenDroneMap/NodeODM/blob/master/docs/index.adoc
75+
* Overview of the ODM pipeline: http://community.opendronemap.org/t/where-can-i-find-background-information-on-the-concepts-of-odm/665/2
76+
* We keep a `section in our forum dedicated to research papers <http://community.opendronemap.org/c/ideas-proposals/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.
5977

6078
`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/faq.rst>`_!

source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ The documentation is available in several languages. Some translations are incom
5555
map-accuracy
5656
masks
5757
large
58-
resources
5958
flying
6059
multispectral
6160
requesting-features

source/resources.rst

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)