comparison Readme.rst @ 10:1944acce0e6f

Add --output= option.
author David Barts <n5jrn@me.com>
date Thu, 26 Aug 2021 08:37:46 -0700
parents c20b5314774f
children
comparison
equal deleted inserted replaced
9:a56d3d3b5efd 10:1944acce0e6f
36 enough. 36 enough.
37 2. I am not yet certain if there is really a need to. A lot of that depends 37 2. I am not yet certain if there is really a need to. A lot of that depends
38 on the need for TopoTiler in the first place. If this program proves useful 38 on the need for TopoTiler in the first place. If this program proves useful
39 to a lot of people, and the consensus among its user base is that a GUI 39 to a lot of people, and the consensus among its user base is that a GUI
40 would be beneficial, I will probably add one. 40 would be beneficial, I will probably add one.
41 41
42 Prerequisites 42 Prerequisites
43 ------------- 43 -------------
44 44
45 This program requires `python3 <https://python.org/>`_ (specifically, Python 3.9 or better), the 45 This program requires `python3 <https://python.org/>`_ (specifically, Python 3.9 or better), the
46 `Pillow Python library <https://python-pillow.org/>`_, and 46 `Pillow Python library <https://python-pillow.org/>`_, and
63 Arguments 63 Arguments
64 ^^^^^^^^^ 64 ^^^^^^^^^
65 65
66 -l/--layers 66 -l/--layers
67 Comma-separated list of layers to include. See below for default. 67 Comma-separated list of layers to include. See below for default.
68 -o/--output
69 Specify output file. Defaults to input file with extention changed
70 to .tiff.
68 -r/--resolution 71 -r/--resolution
69 Output resolution in DPI. Default is 300. 72 Output resolution in DPI. Default is 300.
70 73
71 Environment 74 Environment
72 ^^^^^^^^^^^ 75 ^^^^^^^^^^^
73 76
74 ``GDALBIN`` may be set to the directory containing the GDAL executables. If 77 ``GDALBIN`` may be set to the directory containing the GDAL executables. If
75 so, they will only be looked for there. Else the standard execution path 78 so, they will only be looked for there. Else the standard execution path
83 ^^^^^^ 86 ^^^^^^
84 87
85 By default, all ``Map_Frame`` layers, except for 88 By default, all ``Map_Frame`` layers, except for
86 ``Map_Frame.Projection_and_Grids`` and 89 ``Map_Frame.Projection_and_Grids`` and
87 ``Map_Frame.Terrain.Shaded_Relief``, will be included. This behavior can be 90 ``Map_Frame.Terrain.Shaded_Relief``, will be included. This behavior can be
88 changed with the ``--layers`` option. 91 changed with the ``--layers`` option.
89 92
93 MakeWaypoints
94 -------------
95
96 Synopsis
97 ^^^^^^^^
98
99 ``kotlin MakeWaypointsKt`` [``-latfirst``] *file*
100
101 Prompt for long, lat (or, with ``-latfirst``, lat, long) pairs and names and
102 create a file containing the specified waypoints. Coordinates are expected to
103 be two comma-separated floating-point numbers, with negative values indicating
104 locations in the southern or western hemispheres (i.e. the standard way of
105 representing coordinates in computer storage).
106
107 Basic sanity checks are performed on the coordinates entered.
108
109 Notes
110 ^^^^^
111
112 This program is in Kotlin, despite my starting this project in Python, because
113 the JVM has a much more concise and simple way (i.e. ``XMLStreamWriter``) for
114 producing XML output.
115
116 Longitude, not latitude, is first by default because that is the way QGIS
117 exports coordinates.