Skip to content

Commit ce62fba

Browse files
committed
[stn] added docs
1 parent ddd02c7 commit ce62fba

File tree

5 files changed

+52
-0
lines changed

5 files changed

+52
-0
lines changed

docs/commands/station/calc.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Calculation
2+
===========
3+
4+
Resection calculation is commonly used when setting up an instrument on an
5+
unkown point. Alternatively resection can be used in monitoring setups as well,
6+
to handle the possible movement of the instrument between measurement cycles,
7+
and to verify the integrity of the control points. The resection
8+
calculation will always have excess measurements, which means it can be
9+
adjusted with least squares, that provides standard deviations. If the
10+
deviations of the resection suddenly increase in one of the cycles, it likely
11+
indicates, that one of the control points moved.
12+
13+
The resection is done in two steps, separate horizontal and vertical
14+
calculations.
15+
16+
Usage
17+
-----
18+
19+
.. click:: instrumentman.station:cli_calc
20+
:prog: iman calc station

docs/commands/station/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:icon: material/map-marker-outline
2+
3+
Station
4+
=======
5+
6+
Managing the instrument station setup is an important part of measurements.
7+
The stationing commands can be used to manage various aspects of a setup.
8+
9+
.. toctree::
10+
:maxdepth: 1
11+
12+
calc
13+
upload

docs/commands/station/upload.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Uploading
2+
=========
3+
4+
If a station setup was calculated separately (not using the on-board software),
5+
it has to be uploaded to the instrument. This command allows to set the station
6+
coordinates, instrument height and orientation.
7+
8+
.. note::
9+
10+
The station name cannot be set. It will remain the last point name set with
11+
the on-board software.
12+
13+
Usage
14+
-----
15+
16+
.. click:: instrumentman.station:cli_upload
17+
:prog: iman upload station

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ Content
4646
commands/data/index
4747
commands/jobs/index
4848
commands/settings/index
49+
commands/station/index
4950

5051
Indices
5152

docs/latexindex.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ Applications
3131
commands/data/index
3232
commands/jobs/index
3333
commands/settings/index
34+
commands/station/index

0 commit comments

Comments
 (0)