CUCC Expedition Handbook

Current scripts

Current scripts

See index to the full list of these scripts at Other Scripts. This page only documents a sub-set which is not more fully documented elsewhere.

[This page should be split so that the obsolete stuff is recorded but doesn't get in the way.]

Javascript

See the Expo server page for what javascript packages are used by some troggle pages (CaveView, jquery etc.).

Makefiles

In :expoweb:/noinfo/

This may be obsolete. It used to coordinate running essential updates but also definitely includes redundant stuff. It needs some serious attention.

It coordinates producing the 3d surveys used in the cave description pages, updates the area pages, runs the folk script, runs the QM list generation within each of the cave pages that needs it, runs svxtrace, and reports on everything using "bigbro" which we don't have any other reference to.

Today, troggle generates the .3d and .pos files, parses and loads the QM list and parses the include tree of the survex files.

Folk

Folk update process produces a webpage listing all expo participants and it also runs some validation checks on the input file /folk/folk.csv . Troggle also directly imports folk.csv so that it knows who everyone is, but errors during the importing are not as easy to see as validation errors printed when running the make-folklist.py script.

Photos

updatephotos (in the :loser: repo) uses the BINS package to generate photo albums. BINS uses the EXIF data (date, location if available) in the uploaded image files to produce a page showing the information available about the picture. All image meta-data are stored in XML files.

BINS is no longer maintained by its author so expo has taken on the responsibility for keeping it running. (Wookey is in the process of packaging it as a proper debian package).

Geolocated Photos

In Autumn 2023 we searched all the EXIF data on all our hoto archive looking for geo-located photos. This found a few entrances which had been lost.

The script is /troggle/photomap/pmap.py which currently generates a single file photos_jpg.gpx which can be imported into mapping software (such as GPSprune), but does not yet hot-link to the cave description pages or the photos themselves.

Each line of the gpx file is of this form: <wpt lat="47.616123" lon="13.812214">
<name>[img_20170801_143731431]</name>
<type>photo</type>
<desc>/2017/PhilipSargent/img_20170801_143731431.jpg</desc>
</wpt>

We would want to add <ele> for elevation and we could use GPX extensions to insert the URL info we need to make this clickable and more useful, e.g. see What is a GPX file and GPX extensions.

seshbook, bierbook & protractors

How these are used once produced is documented in the the handbook

These are LaTeX files and the instructions for how to process them are in each .tex file. The protractors do not change but the others need a configuration file for all the cavers expected to attend expo.

The .tex files are in :expoweb:/documents/. There is a style file also there bierbook-style.sty which is used by both the bierbook and seshbook. Read the readme.txt file which explains which LaTeX packages you need. Build like this:

pdflatex.exe -synctex=1 -interaction=nonstopmode -shell-escape bierbook.tex
pdflatex.exe -synctex=1 -interaction=nonstopmode -shell-escape seshbook.tex

Due to the way LaTeX works out table column witdths, these commands may need to be run several times until a stable output is produced.

The design of these files is intended to confine all changes year to year to the names.txt and dates.txt files, thanks to LaTeX's capability to read an external file and iterate through line by line performing the same action for each name.

Packages needed (LaTeX) are:

geometry
fancyhdr
tikz
booktabs
tongtable
multirow
tocloft
yfonts
anyfontsize
ifthen

sudo apt texlive-latex-extra

make

Links to:

• Makefile
• bierbook.tex
• seshbook.tex
• bierbook-style.sty
• dates.txt
• names.txt
• readme.txt

make_essentials.sh

In :loser:/gpx/

Makes essentials.gpx - see GPS on expo. This used to require the gpx2survex program (written in OCAML) but now doesn't (since 2023). Get the OCAML file from GitHub https://github.com/mshinwell/gps2survex;

Read the README file in :loser:/gpx/y.

Someone needs to document this and and make_svx.sh properly.

gpx2survex and make_svx.sh

In :loser:/gpx/

Regenerates the surface tracks as survex files from GPS .gpx files. Also requires the gpx2survex program.

We used to use the OCAML program gpx2survex but we now also have a python equivalent gpx2survex.py which is used by make_svx2.sh This is part of the make_essentials generation process.

gpx2survex simplifies a track so that it is less voluminous.

For the reverse process we don't need a script. For svx-to-gps we can use survexport: Olly says [2022]: "you shouldn't need to mess around with undocumented scripts - since 2018, you can just do: survexport --entrances all.3d essentials.gpx"

But that does rather rely on all.3d being properly generated, which troggle does not currently do reliably and automatically.

Documented, by man survexport, survexport --help, and in the Survex manual on survexport.

convert_shx.ml

Not quite obsolete, but nearly.

svx2qm.py, tablize-qms.pl, find-dead-qms.py,qmreader.pl

create_dplong_table.py, cavestats and smklengths

"cavestats" is compiled by noinfo/cavestats.build source code and is used by "create_dplong_table.py".

smklengths

:loser:/docs/smklengths is a brief bash script that runs cavern on all the top-level cave svx files and extracts the total lengths:

cave length depth
32:  1973m   161m
40:  7154m   262m
41:  9925m   387m
78:  7847m   328m
87:   520m   289m
88:  1849m   201m
115:  6407m   741m
142:   645m    53m
143:  3382m   309m
144:  3263m   366m
158:  3061m   345m
216:   105m    27m
83:   493m    62m
107:  3788m   254m
136:  3461m   438m
161: 26284m   526m
204: 18593m   622m
258: 20736m   912m
264: 18265m   591m
290:  5968m   456m
291:   868m   137m
359:  3442m   376m
Sat Dec 2 21:00:40 GMT 2023

#!/bin/sh 

echo "cave length depth"
for cave in 32 40 41 78 87 88 115 142 143 144 158 216 83 107 136 161 204 258 264 290 
do 
  echo -n "$cave:"
  cavern -o /tmp ../caves-1623/${cave}/${cave}.svx | grep -o "(.*m adjusted)\|Vertical range = [.[:digit:]]*m " | grep -o [.[:digit:]]*m | gawk '{ gsub(/m/,""); printf "%6.0fm", $1 }'
  echo
done
for cave in  359
do 
  echo -n "$cave:"
  cavern -o /tmp ../caves-1626/${cave}/${cave}.svx | grep -o "(.*m adjusted)\|Vertical range = [.[:digit:]]*m " | grep -o [.[:digit:]]*m | gawk '{ gsub(/m/,""); printf "%6.0fm", $1 }'
  echo
done
echo `date`

make-glossary.pl

In :expoweb:/1623/204/ and /1623/161/. It reads a cave-specific glossary.csv and produces the HTML files for caves 161 and 204:

• /1623/204/atoz.html
• /1623/161/a-z.htm

which are indexes to passage names and locations in the very extensive cave descriptions for Kaninchenhohle and Steinbruckenhohle. We may need this again for Tunnocks/Balkonhohle.

make-alljs.py

Writes out legs and entrances in json format. In :loser:/fixedpts/ (along with make-fb-map.plwhich does Austrian coordinate transformations). Also in the :loser:fixedpts/scripts/convert_shx/ folder is a 135-line short script convert_shx.ml written in OCaml which constructs input to the ogr2ogr GIS feature file format conversion utility.

The documented workflow today does not appear to need this, but that might be a documentation fault. It might do a key job. [to be investigated]

Old and possibly obsolete scripts

summarizecave.sh

This runs "cavern" (a commandline tool installed as part of survex) to produce a text (or HTML) report of the key statistics from the master svx file for a cave (the one that includes all the svx files for the individual passages). It is unclear who uses this or for what. It may be the script that generates the input data used by caves-tabular.html

caves-tabular.html

This webpage caves-tabular.html uses a page-specifc JavaScript file TableSort.js which allows the user to resort the table of all the cave data by any of the columns by clicking on it [by Radost]. The exact source of the data in the table is undocumented, but presumably from cavern .3d file export at an unknown date. This may be that generated by summarizecave.sh .

make-prospectingguide-new.py and prospecting_guide_short.py

In :expoweb:/noinfo/prospecting_guide_scripts/

These are now obsolete, replaced by the troggle code ( troggle/core/views/prospect.py) that generates prospecting_guide on the fly (taking a couple of minutes each time).
[Disabled.
Bad links, incompatible image package use and very, very out of date. ]