Merge pull request #19 from smathermather/publish

reorganize installation and getting started and add edit links
pull/20/head
Stephen Mather 2019-09-14 14:44:31 -04:00 zatwierdzone przez GitHub
commit a035fbbb3e
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
8 zmienionych plików z 32 dodań i 13 usunięć

Wyświetl plik

@ -2,3 +2,7 @@ Code Reference
==============
Coming soon!
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/api.rst>`_

Wyświetl plik

@ -78,3 +78,4 @@ Pull Requests
* Using a plain return when returning explicitly at the end of a function.
* Not return null, return undefined, null, or undefined
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/contributing.rst>`_

Wyświetl plik

@ -14,3 +14,5 @@ The guidelines are intended for drone mapping projects on islands, but have gene
See also DroneDeploy's guide on `Making Successful Maps <https://support.dronedeploy.com/docs/making-successful-maps>`_, which provides great tips on mission planning.
Finally, lens distortion is a challenge in projects requiring accurate 3D data. See our section in these docs on `Camera Calibration <using.html#calibrating-the-camera>`_.
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/flying.rst>`_

Wyświetl plik

@ -9,7 +9,7 @@ Welcome to OpenDroneMap's documentation!
:maxdepth: 3
:caption: Contents:
ODMinstallation
installation
using
outputs
large
@ -17,3 +17,5 @@ Welcome to OpenDroneMap's documentation!
flying
contributing
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/index.rst>`_

Wyświetl plik

@ -76,8 +76,8 @@ Installation
We recommend people use `docker <https://www.docker.com>`_ for running ODM, whether you are on Windows, macOS or Linux.
Install on Windows
``````````````````
Windows
```````
To run OpenDroneMap you need at least Windows 7. Previous
versions of Windows are not supported.
@ -227,8 +227,8 @@ You should get a result like the following:
Then connect to http://192.168.1.100:8000 (replacing the IP address with the proper one).
Installing on macOS
```````````````````
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).
@ -322,8 +322,8 @@ From a **Terminal** type:
Then open a web browser to http://localhost:8000.
Installing on Linux
```````````````````
Linux
`````
OpenDroneMap can run on any Linux distribution that supports docker. According to `dockers documentation website <https://docs.docker.com/install/>`_ 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.
@ -424,7 +424,7 @@ From a terminal type:
Then open a web browser to http://localhost:8000.
Basic Commands and Troubleshooting
``````````````````````````````````
----------------------------------
The cool thing about using docker is that 99% of the tasks youll ever need to perform while using WebODM can be done via the ./webodm.sh script. You have already encountered one of them:
@ -466,7 +466,7 @@ Other useful commands are listed below:
`The community forum <https://community.opendronemap.org>`_ 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 running ./webodm.sh start and opening WebODM in the browser, you will be greeted with a welcome message and will be asked to create the first user. Take some time to familiarize yourself with the web interface and explore its various menus.
@ -498,3 +498,5 @@ The above command asks docker to launch a new container using the opendronemap/n
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.
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/installation.rst>`_

Wyświetl plik

@ -171,3 +171,5 @@ GCPs are fully supported, however, there needs to be at least 3 GCP points on ea
Aknowledgments
--------------
Huge props to Pau and the folks at Mapillary for their amazing contributions to OpenDroneMap through their OpenSfM code, which is a key component of the split-merge pipeline. We look forward to further pushing the limits of OpenDroneMap and seeing how big a dataset we can process.
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/large.rst>`_

Wyświetl plik

@ -94,3 +94,6 @@ List of all outputs
└── odm_dem/
├── dsm.tif # Digital Surface Model Geotiff - the tops of everything
└── dtm.tif # Digital Terrain Model Geotoff - the ground.
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/outputs.rst>`_

Wyświetl plik

@ -393,3 +393,6 @@ Arguments::
--merge <string> Choose what to merge in the merge step in a split
dataset. By default all available outputs are merged.
Default: all
`Help edit these docs! <https://github.com/OpenDroneMap/docs/blob/publish/source/using.rst>`_