Skip to content

Commit 1ecb8de

Browse files
committed
Update project references
1 parent b231a11 commit 1ecb8de

12 files changed

Lines changed: 56 additions & 56 deletions

scripts/options-flags.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Options & Flags
33
template: doc
44
---
55

6-
This is the complete list of options available in [ODM](https://github.com/WebODM/ODM).
6+
This is the complete list of options available in [ODX](https://github.com/WebODM/ODX).
77

88

99
:::note

scripts/update_options_flags.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
from string import Template
55

66
SCRIPT_DIR = os.path.dirname(__file__)
7-
DEFAULT_URL = "https://raw.githubusercontent.com/WebODM/ODM/master/opendm/config.py"
7+
DEFAULT_URL = "https://raw.githubusercontent.com/WebODM/ODX/master/opendm/config.py"
88

9-
parser = argparse.ArgumentParser(description='Extract ODM arguments and generate a Markdown reference page.')
9+
parser = argparse.ArgumentParser(description='Extract ODX arguments and generate a Markdown reference page.')
1010
parser.add_argument('input', type=str, nargs='?',
1111
default=DEFAULT_URL,
12-
help='URL to ODM\'s config.py')
12+
help='URL to ODX\'s config.py')
1313
args = parser.parse_args()
1414

1515
url = args.input
@@ -116,7 +116,7 @@ def get_opt_choices(opt):
116116

117117
# --- build markdown ---
118118

119-
print("Found %s ODM options" % len(options))
119+
print("Found %s ODX options" % len(options))
120120

121121
if len(options) == 0:
122122
print("No options found")

src/content/docs/architecture.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ template: doc
55

66
[WebODM](https://github.com/WebODM/WebODM) is composed of several components.
77

8-
- [ODM](https://github.com/WebODM/ODM) is a command line toolkit that processes aerial images. Users comfortable with the command line are probably OK using this component alone.
9-
- [NodeODM](https://github.com/WebODM/NodeODM) is a lightweight interface and API (Application Program Interface) built directly on top of [ODM](https://github.com/WebODM/ODM). Users not comfortable with the command line can use this interface to process aerial images and developers can use the API to build applications. Features such as user authentication, map displays, etc. are not provided.
10-
- [WebODM](https://github.com/WebODM/WebODM) adds more features such as user authentication, map displays, 3D displays, a higher level API and the ability to orchestrate multiple processing nodes (run jobs in parallel). Processing nodes are simply servers running [NodeODM](https://github.com/WebODM/NodeODM).
8+
- [ODX](https://github.com/WebODM/ODX) is a command line toolkit that processes aerial images. Users comfortable with the command line are probably OK using this component alone.
9+
- [NodeODX](https://github.com/WebODM/NodeODX) is a lightweight interface and API (Application Program Interface) built directly on top of [ODX](https://github.com/WebODM/ODX). Users not comfortable with the command line can use this interface to process aerial images and developers can use the API to build applications. Features such as user authentication, map displays, etc. are not provided.
10+
- [WebODM](https://github.com/WebODM/WebODM) adds more features such as user authentication, map displays, 3D displays, a higher level API and the ability to orchestrate multiple processing nodes (run jobs in parallel). Processing nodes are simply servers running [NodeODX](https://github.com/WebODM/NodeODX).
1111

1212
![webodm](https://cloud.githubusercontent.com/assets/1951843/25567386/5aeec7aa-2dba-11e7-9169-aca97b70db79.png)
1313

@@ -16,5 +16,5 @@ WebODM is built with scalability and performance in mind. While the default setu
1616
![Architecture](https://user-images.githubusercontent.com/1951843/36916884-3a269a7a-1e23-11e8-997a-a57cd6ca7950.png)
1717

1818
A few things to note:
19-
* We use Celery workers to do background tasks such as resizing images and processing task results, but we use an ad-hoc scheduling mechanism to communicate with NodeODM (which processes the orthophotos, 3D models, etc.). The choice to use two separate systems for task scheduling is due to the flexibility that an ad-hoc mechanism gives us for certain operations (capture task output, persistent data and ability to restart tasks mid-way, communication via REST calls, etc.).
19+
* We use Celery workers to do background tasks such as resizing images and processing task results, but we use an ad-hoc scheduling mechanism to communicate with NodeODX (which processes the orthophotos, 3D models, etc.). The choice to use two separate systems for task scheduling is due to the flexibility that an ad-hoc mechanism gives us for certain operations (capture task output, persistent data and ability to restart tasks mid-way, communication via REST calls, etc.).
2020
* If loaded on multiple machines, Celery workers should all share their `app/media` directory with the Django application (via network shares). You can manage workers via `./worker.sh`

src/content/docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Directories of interest are listed as follow:
5252
Directory | Description
5353
--------- | -----------
5454
`/app` | Main application, includes the UI components, API, tests and backend logic.
55-
`/nodeodm`| Application that bridges the communication between WebODM and [NodeODM](https://github.com/WebODM/NodeODM). Includes its own unit tests and models.
55+
`/nodeodx`| Application that bridges the communication between WebODM and [NodeODX](https://github.com/WebODM/NodeODX). Includes its own unit tests and models.
5656
`/webodm` | Django's main project directory. Setting files are here.
5757

5858
### Frontend

src/content/docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ WebODM has officially decoupled from OpenDroneMap! [Read the announcement](https
1212

1313
:::
1414

15-
[WebODM](https://github.com/WebODM/WebODM) is a user-friendly, commercial grade software for drone image processing. Generate georeferenced maps, point clouds, elevation models and textured 3D models from aerial images. It supports multiple engines for processing, currently [ODM](https://github.com/WebODM/ODM), [MicMac](https://github.com/OpenDroneMap/NodeMICMAC/) and [LGT](https://webodm.net/lgt).
15+
[WebODM](https://github.com/WebODM/WebODM) is a user-friendly, commercial grade software for drone image processing. Generate georeferenced maps, point clouds, elevation models and textured 3D models from aerial images. It supports multiple engines for processing, currently [ODX](https://github.com/WebODM/ODX), [MicMac](https://github.com/OpenDroneMap/NodeMICMAC/) and [LGT](https://webodm.net/lgt).
1616

1717
![image](https://user-images.githubusercontent.com/1951843/174504773-f8d8febb-7a45-4d9c-89b6-7d2404c5b8fd.png)
1818

src/content/docs/installation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -100,17 +100,17 @@ To install WebODM on a Qnap NAS:
100100

101101
### Manage Processing Nodes
102102

103-
WebODM can be linked to one or more processing nodes that speak the [NodeODM API](https://github.com/WebODM/NodeODM/blob/master/docs/index.adoc), such as [NodeODM](https://github.com/WebODM/NodeODM), [NodeMICMAC](https://github.com/OpenDroneMap/NodeMICMAC/), [ClusterODM](https://github.com/WebODM/ClusterODM) and [Lightning](https://webodm.net). The default configuration includes a "node-odm-1" processing node which runs on the same machine as WebODM, just to help you get started. As you become more familiar with WebODM, you might want to install processing nodes on separate machines.
103+
WebODM can be linked to one or more processing nodes that speak the [NodeODX API](https://github.com/WebODM/NodeODX/blob/master/docs/index.adoc), such as [NodeODX](https://github.com/WebODM/NodeODX), [NodeMICMAC](https://github.com/OpenDroneMap/NodeMICMAC/), [ClusterODM](https://github.com/WebODM/ClusterODM) and [Lightning](https://webodm.net). The default configuration includes a "node-odx-1" processing node which runs on the same machine as WebODM, just to help you get started. As you become more familiar with WebODM, you might want to install processing nodes on separate machines.
104104

105105
Adding more processing nodes will allow you to run multiple jobs in parallel.
106106

107107
You can also setup a [ClusterODM](https://github.com/WebODM/ClusterODM) node to run a single task across multiple machines with [distributed split-merge](https://docs.opendronemap.org/large/?highlight=distributed#getting-started-with-distributed-split-merge) and process dozen of thousands of images more quickly, with less memory.
108108

109-
If you don't need the default "node-odm-1" node, simply pass `--default-nodes 0` flag when starting WebODM:
109+
If you don't need the default "node-odx-1" node, simply pass `--default-nodes 0` flag when starting WebODM:
110110

111111
`./webodm.sh restart --default-nodes 0`.
112112

113-
Then from the web interface simply manually remove the "node-odm-1" node.
113+
Then from the web interface simply manually remove the "node-odx-1" node.
114114

115115

116116

@@ -159,7 +159,7 @@ To add IPv6, simply run:
159159
`./webodm.sh restart --ipv6`
160160

161161
Note: When using `--ssl` mode, you cannot pass an IP address to the hostname parameter; you must set up a DNS AAAA record. Without `--ssl` mode enabled, access the site at (e.g., http://[2001:0db8:3c4d:0015::1]:8000). The brackets around the IPv6 address are essential!
162-
You can add a new NodeODM node in WebODM by specifying an IPv6 address. Don't forget to include brackets around the address! e.g., [2001:0db8:fd8a:ae80::1]
162+
You can add a new NodeODX node in WebODM by specifying an IPv6 address. Don't forget to include brackets around the address! e.g., [2001:0db8:fd8a:ae80::1]
163163

164164
## Common Troubleshooting
165165

@@ -230,7 +230,7 @@ If a particular hook / signal for your plugin does not yet exist, [request it](h
230230

231231
## Hardware Requirements
232232

233-
To run a standalone installation of WebODM (the user interface), including the processing component ([NodeODM](https://github.com/WebODM/NodeODM)), we recommend at a minimum:
233+
To run a standalone installation of WebODM (the user interface), including the processing component ([NodeODX](https://github.com/WebODM/NodeODX)), we recommend at a minimum:
234234

235235
* 100 GB free disk space
236236
* 16 GB RAM
@@ -257,4 +257,4 @@ A CPU with more cores will speed up processing, but can increase memory usage. G
257257

258258
WebODM runs best on Linux, but works well on Windows and Mac too.
259259

260-
WebODM by itself is just a user interface and does not require many resources. WebODM can be loaded on a machine with just 1 or 2 GB of RAM and work fine without [NodeODM](https://github.com/WebODM/NodeODM). You can use a processing service such as [webodm.net](https://webodm.net) or run NodeODM on a separate, more powerful machine.
260+
WebODM by itself is just a user interface and does not require many resources. WebODM can be loaded on a machine with just 1 or 2 GB of RAM and work fine without [NodeODX](https://github.com/WebODM/NodeODX). You can use a processing service such as [webodm.net](https://webodm.net) or run NodeODX on a separate, more powerful machine.

src/content/docs/options-flags.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Options & Flags
33
template: doc
44
---
55

6-
This is the complete list of options available in [ODM](https://github.com/WebODM/ODM).
6+
This is the complete list of options available in [ODX](https://github.com/WebODM/ODX).
77

88

99
:::note
@@ -484,7 +484,7 @@ Skip generation of a full 3D model. This can save time if you only need 2D resul
484484

485485
## skip-band-alignment
486486

487-
When processing multispectral datasets, ODM will automatically align the images for each band. If the images have been postprocessed and are already aligned, use this option.
487+
When processing multispectral datasets, automatically align the images for each band. If the images have been postprocessed and are already aligned, use this option.
488488

489489
**Default:** `False`
490490

src/content/docs/reference/processingnode.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ template: doc
1313
"port": 80,
1414
"api_version": "1.0.1",
1515
"engine_version": "0.6.0",
16-
"engine": "odm",
16+
"engine": "odx",
1717
"last_refreshed": "2017-03-01T21:14:49.918276Z",
1818
"queue_count": 0,
1919
"max_images": null,
@@ -30,15 +30,15 @@ template: doc
3030
```
3131

3232
Processing nodes are associated with zero or more tasks and
33-
take care of processing input images. Processing nodes are computers or virtual machines running [NodeODM](https://github.com/WebODM/NodeODM) or any other API compatible with it.
33+
take care of processing input images. Processing nodes are computers or virtual machines running [NodeODX](https://github.com/WebODM/NodeODX) or any other API compatible with it.
3434

3535
Field | Type | Description
3636
----- | ---- | -----------
3737
id | int | Unique Identifier
3838
online | bool | Whether the processing node could be reached in the last 5 minutes
3939
hostname | string | Hostname/IP address
4040
port | int | Port
41-
api_version | string | Version of NodeODM currently running
41+
api_version | string | Version of NodeODX currently running
4242
engine_version | string | Version of processing engine currently being used
4343
engine | string | Lowercase identifier of processing engine
4444
last_refreshed | string | Date and time this node was last seen online. This value is typically refreshed every 15-30 seconds and is used to decide whether a node is offline or not
@@ -56,7 +56,7 @@ help | Description of the option
5656
name | Name that identifies the option. This is the value you pass in the `name` key/value pair when creating a set of options for a new [Task](/reference/task/)
5757
type | Possible values are `int`, `float`, `string`, `bool`
5858
value | Default value if the option is not specified
59-
domain | Restriction of the range of values that this option allows. Examples are `float`, `negative integer`, `percent`, `float: 0 <= x <= 10`, etc. for all possible values, check [NodeODM's odmOptions.js code](https://github.com/WebODM/NodeODM/blob/master/libs/odmOptions.js#L135)
59+
domain | Restriction of the range of values that this option allows. Examples are `float`, `negative integer`, `percent`, `float: 0 <= x <= 10`, etc. for all possible values, check [NodeODX's odxOptions.js code](https://github.com/WebODM/NodeODX/blob/master/libs/odxOptions.js#L135)
6060

6161

6262
### Add a processing node
@@ -142,5 +142,5 @@ Display the common options available among all online processing nodes. This is
142142

143143
Use this list of options to check whether a particular option is supported by all online processing nodes. If you use the automatic processing node assignment feature for processing tasks, this is the list you want to display to the user for choosing the options to use during processing.
144144

145-
<aside class="notice">While WebODM is capable of handling processing nodes running different versions of NodeODM, we don't recommend doing so. When all processing nodes use the same NodeODM version, the output of this API call will be identical to the <b>available_options</b> field of any node.</aside>
145+
<aside class="notice">While WebODM is capable of handling processing nodes running different versions of NodeODX, we don't recommend doing so. When all processing nodes use the same NodeODX version, the output of this API call will be identical to the <b>available_options</b> field of any node.</aside>
146146

src/content/docs/reference/task.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Parameters are the same as above.
9494

9595
`POST /api/projects/{project_id}/tasks/import`
9696

97-
Import task that have been processed by another WebODM instance (or via [webodm.net](https://webodm.net) or NodeODM)
97+
Import task that have been processed by another WebODM instance (or via [webodm.net](https://webodm.net) or NodeODX)
9898

9999
Parameter | Required | Default | Description
100100
--------- | -------- | ------- | ----------

src/content/docs/tutorials/large-datasets.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Split-merge works in WebODM out of the box as long as the processing nodes suppo
1414
Splitting a dataset into more manageable submodels and sequentially processing all submodels on the same machine is easy! Just use `--split` and `--split-overlap` to decide the average number of images per submodel and the overlap (in meters) between submodels respectively:
1515

1616
```bash
17-
docker run -ti --rm -v /my/project:/datasets/code webodm/odm --project-path /datasets --split 400 --split-overlap 100
17+
docker run -ti --rm -v /my/project:/datasets/code webodm/odx --project-path /datasets --split 400 --split-overlap 100
1818
```
1919

2020
If you already know how you want to split the dataset, you can provide that information and it will be used instead of the clustering algorithm.
@@ -33,7 +33,7 @@ will create 3 submodels. Make sure to pass `--split-overlap 0` if you manually p
3333

3434
## Distributed Split-Merge
3535

36-
WebODM can also automatically distribute the processing of each submodel to multiple machines via [NodeODM](https://github.com/WebODM/NodeODM) nodes, orchestrated via [ClusterODM](https://github.com/WebODM/ClusterODM).
36+
WebODM can also automatically distribute the processing of each submodel to multiple machines via [NodeODX](https://github.com/WebODM/NodeODX) nodes, orchestrated via [ClusterODM](https://github.com/WebODM/ClusterODM).
3737

3838
![ClusterODM](/images/clusterodm.webp)
3939

@@ -45,25 +45,25 @@ The first step is start ClusterODM:
4545
docker run -ti -p 3001:3000 -p 8080:8080 webodm/clusterodm
4646
```
4747

48-
Then on each machine you want to use for processing, launch a NodeODM instance via:
48+
Then on each machine you want to use for processing, launch a NodeODX instance via:
4949

5050
```bash
51-
docker run -ti -p 3000:3000 webodm/nodeodm
51+
docker run -ti -p 3000:3000 webodm/nodeodx
5252
```
5353

54-
Connect via telnet to ClusterODM and add the IP addresses/port of the machines running NodeODM:
54+
Connect via telnet to ClusterODM and add the IP addresses/port of the machines running NodeODX:
5555

5656
```bash
5757
$ telnet <cluster-odm-ip> 8080
5858
Connected to <cluster-odm-ip>.
5959
Escape character is '^]'.
6060
[...]
61-
# node add <node-odm-ip-1> 3000
62-
# node add <node-odm-ip-2> 3000
61+
# node add <node-odx-ip-1> 3000
62+
# node add <node-odx-ip-2> 3000
6363
[...]
6464
# node list
65-
1) <node-odm-ip-1>:3000 [online] [0/2] <version 1.5.1>
66-
2) <node-odm-ip-2>:3000 [online] [0/2] <version 1.5.1>
65+
1) <node-odx-ip-1>:3000 [online] [0/2] <version 1.5.1>
66+
2) <node-odx-ip-2>:3000 [online] [0/2] <version 1.5.1>
6767
```
6868

6969
At this point, simply use the `--sm-cluster` option to enable distributed split-merge.
@@ -93,7 +93,7 @@ ASR VIEWCMD <number of images> - View command used to create a machine
9393
!! - Repeat last command
9494
```
9595

96-
If the NodeODM instance wasn't active when ClusterODM started, you can perform a `NODE UPDATE`:
96+
If the NodeODX instance wasn't active when ClusterODM started, you can perform a `NODE UPDATE`:
9797

9898
```
9999
# NODE UPDATE
@@ -143,7 +143,7 @@ info: Can write to S3
143143
info: Found docker-machine executable
144144
```
145145

146-
You should always have at least one static NodeODM node attached to ClusterODM, even if you plan to use the autoscaler for all processing. If you setup auto scaling, you can't have zero nodes and rely 100% on the autoscaler. You need to attach a NodeODM node to act as the "reference node" otherwise ClusterODM will not know how to handle certain requests. For this purpose, you should add a "dummy" NodeODM node and lock it:
146+
You should always have at least one static NodeODX node attached to ClusterODM, even if you plan to use the autoscaler for all processing. If you setup auto scaling, you can't have zero nodes and rely 100% on the autoscaler. You need to attach a NodeODX node to act as the "reference node" otherwise ClusterODM will not know how to handle certain requests. For this purpose, you should add a "dummy" NodeODX node and lock it:
147147

148148
```bash
149149
telnet localhost 8080

0 commit comments

Comments
 (0)