updated essentials readme from last november

This commit is contained in:
Philip Sargent 2024-04-21 02:24:53 +01:00
parent 0c2b5e095f
commit eb1b67b47e

View File

@ -1,21 +1,27 @@
The folders for each year are for general gpx files from recorded tracks, The folders for each year are for general gpx files from recorded tracks,
which will be included as surface legs in '1623-and-1626-no-schoenberg-hs.svx'. which will be included as surface legs in all.svx.
gpx_publish is for creating exportable files to personal gps devices or smart phones. gpx_publish is for creating exportable files to personal
gps devices or smart phones.
The master copy of this file is kept at :loser:/gpx/README For instructions for the previous version of this, which used
gpx2survex.exe compiled from ocaml source and libraries, see
README_ocaml.txt
From 13 Nov 2023, create essentials.gpx like this.
To add a new GPS tracklog or waypoint file: To add a new GPS tracklog or waypoint file:
0. Read the Handbook on this http://expo.survex.com/handbook/essentials.html 0. Read the Handbook on this http://expo.survex.com/handbook/essentials.html
on how to download essentials.gpx which may be more up to date than this README
1. Download the .gpx file(s) from your GPS. (On modern Garmin GPSes this is done 1. Download the .gpx file(s) from your GPS. (On modern Garmin GPSes this is done
by connecting the GPS using a USB cable and then copying the relevant files by connecting the GPS using a USB cable and then copying the relevant files
from the "GPX" directory inside the "Garmin" directory on the USB disk.) from the "GPX" directory inside the "Garmin" directory on the USB disk.)
2. Create a new directory for the year if required (following the "2018" 2. Create a new directory for the year if required (following the "2018"
example) in the "gpx" subdirectory of the dataset. Put the .gpx file(s) in the example) in the "gpx" subdirectory of the dataset (loser repo).
year directory. They need to be renamed so as to follow our naming convention Put the .gpx file(s) in the year directory.
They need to be renamed so as to follow our naming convention
(see the "2018" directory). No formal distinction needs to be made between (see the "2018" directory). No formal distinction needs to be made between
files containing tracklogs and files containing waypoints (or a mix of the files containing tracklogs and files containing waypoints (or a mix of the
two). two).
@ -23,14 +29,14 @@ two).
3. Update (or create if currently absent) the additional_info.svx file in 3. Update (or create if currently absent) the additional_info.svx file in
the year directory following the 2018 example. This is the place to rename the year directory following the 2018 example. This is the place to rename
stations to follow normal conventions and to mark waypoints as entrances, stations to follow normal conventions and to mark waypoints as entrances,
etc. The file must be present even if empty. etc. The file does not need to be present.
4. Open a terminal in this directory and run the make_svx.sh script. This 4. Open a terminal in this directory loser/ and run
requires the gpx2survex program (https://github.com/mshinwell/gps2survex; the make_svx.sh script like this: bash gpx/make_svx.sh
installation instructions to follow).
5. Run "cavern 1623-and-1626-no-schoenberg-hs.svx" at the toplevel then 5. Run "cavern all.svx" in loser/gpx/ then "aven all.3d". Check that the
"aven 1623-and-1626-no-schoenberg-hs.3d". Check that the
tracks appear as expected when fixed points / surface surveys are enabled. tracks appear as expected when fixed points / surface surveys are enabled.
6. Commit everything to hg and push. 6. Commit everything to git and push.
7. run gpx/make_essentials.sh