<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expo Surveying Handbook: Entering data</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expo Surveying Handbook</h2>
<h1>From muddy book to survex plot</h1>

<div class="onright">
<a href="../../piclinks/typing.htm"><img src="../../tinypix/typing.jpg"
width="176" height="115" alt="" /></a>
<p class="caption">Tony Rooke entering data (1991)</p></div>



<p>Survex has its own documentation for the format of the data, though the
template file and a look at someone else's data will quickly make this
fairly clear. 
<p>Survex has some very flexible data entry options, so there
are a few extra guidelines to try to get some consistency in the way
everyone uses it within this project.</p>

<p>Survex (including the graphical software 'aven') is already installed
on the expo laptop. These instructions assume that you are using the expo laptop.



<h3>Where to put your data</h3>
<p style="margin:4%">[These instructions pre-date the online form and describe typing using a text editor. Use the online form! But the content of the survex file is the same. This page will be edited to specifically describe using the form when time permits.]

<p>Where to put your data: <b>If in doubt, ask!</b>. These instructions assume 
that you are typing it in on the <em>expo laptop</em>. (You can do it fom your own
laptop if you have been initiated into the deep magic of the ":loser:" repository
of the distributed version control system - see the
<a href="../computing/repos.html">list of repositories</a>.

<ul><li>If it is a surface
survey, it goes in the :loser:/surface" directory; 
<li>if it is a file of fixed points
(like GPS fixes, or map coordinates), it goes in the ":loser:/fixedpts" directory; 
<li>if
it is a new cave on the near-plateau, put it in a new directory under ":loser:/caves-1623".
<li>Underground data for Steinbr&uuml;ckenh&ouml;hle goes in one of the
subdirectories under :loser:/caves-1623/204/; it may well be clear which one from what it
links to, but if not, ask.</p>
</li>
</ul>

<h3>Use a template</h3>


<p>The beginner should start from the existing template file :loser:/template/template.svx 
as this has lines to remind you to add various details - make sure you
don't leave any blanks! Copy <em>and rename this</em>  to where you want to put your data
<em>before</em> editing it. Too many people have overwritten the
template in the past, try not to do this yourself.
<p>Working by editing a .svx file from another bit of the same cave may seem like a short cut but whoever edited it may have deleted some of the helpful and useful hints that are in the template.svx file - so don't do this please, until you really know what you are doing.

<h3><a id="filenames">Filename and data-entry conventions in svx files</a></h3>

<ul>
<li>Use Unix line endings (i.e. \n not \r\n).

<li>Use UTF-8 character encoding.
<li>NO UMLAUTS. Use <em>&amp;uml;</em> for u-umlaut and <em>&amp;oml;</em> for o-umlaut in text. But don't use these
 in filenames.

<li>Cave numbers are written without any leading zeros at all (in filenames,
  survey names, or anything else!).

<li>Entrances have station names such as <b>p204b</b>.  In the event of the tag
  location being different from the entrance location, the tag point
  should be named with a "t" instead, e.g. <b>t204b</b>.

<li>No full stop (.) characters in station names.

<li>All filenames to be in lower case. Capital letters in filenames can still (in 2022)
cause hassle when moving between Linux and Windows. (This includes suffix letters for cave entrances: it is "87a" NOT "87A".)

<li>No filenames starting with "-" or "!".

<li>No colons in filenames.

<li>Caves with a provisional number consisting of a year and a serial number
  should be <em>hyphenated</em>, thus 2018-ad-01 not with underscore 2018<b>_</b>01 or any of the various other
  variants.
</ul>



<h3>The name of your survey</h3>
What to call your survey: all your data should be inside a begin/end pair
with a meaningful name. This need not be the same name as the file, but as a
general rule it should be so unless there is a really good reason not to.  On
the other hand, if you have made two or three trips to the same cave,
it can be a good idea to nest surveys in one file:
<pre><i>File 2050-01.svx</i>
*begin 2050-01
    *export pt1.1 pt2.5 [...]
    *begin pt1
        <i>[survey data from first trip]</i>
    *end pt1
    *begin pt2
        <i>[survey data from second trip]</i>
    *end pt2
*end 2050-01
</pre>
or you can create several .svx files. 
Creating several .svx files seems to be current practice as it 
simplifies the manual process of knitting several different people's trips together (though the online wallet system can only record one of these at the moment).

<p>There is no restriction on the length of these names, but as they can be
displayed in aven, tunnel and other such programs, it helps not to have
anything too elaborate. Older versions of survex required each prefix to be
unique in its first eight characters, and this is not a bad guideline to
follow.</p></li>

<h3 id="stationanmes">Station names</h3>

<p>Every station should have a number <em>within your survey</em> even if it
is an existing station to which you have connected. Any survey stations which
you think can reliably be found again should be listed at the start of your
survey file. This includes the name (within your survey) of any existing points
you linked into. I have used lines like <tt>;*export mysurvey.pt1.0 ; 2nd bolt at
head of new pitch</tt> &ndash; this may or may not catch on as a standard.</li>
</ul>

<p>At this stage, you have done enough to get a centre line for drawing up.
If you aren't completely confident about the structure of the Austria data, or
the survex syntax of <tt>*equate</tt> and <tt>*export</tt> which can be rather
cryptic for the uninitiated, it may be best not to try to link your survey to
everything else so skip the next bit and read on <a href="#concrete">from
here</a>.</p>

<h3 id="plumbing">Plumbing your survey into the rest of the cave</h3>

<p>However, if you need to see your survey in relation to the rest of the
dataset:</p>

<ul>

<li>Don't put any *equate directives to other surveys into your file (or any
survey legs which quote station names from other survey files).  Instead, go to
the file which *includes the other files in the same area.  <br /><br />
For example, if you
have created a file trivial.svx in the caves-1623/204/deepsouth directory, go to the
file deepsouth/deepsouth.svx, where you will find *include lines for each of
the files, together with the *equate lines to connect them together. Add an
include for your file, and *equate lines for each of your survey stations which
is the same as one in another survey. If your survey connects to points in
surveys in files in more than one directory then the *equates should go in the
/204/204.svx file, but at this stage it is probably worth enlisting the help of
someone who knows the structure of the data inside-out! <br /><br />
<li>You should now find that if you run survex on one of the master files
(
<a href="/survexfile/1623-and-1626-no-schoenberg-hs">1623-and-1626-no-schoenberg-hs.svx</a>, 
<a href="/survexfile/204">204.svx</a>, 
<a href="/survexfile/smk-system">smk-system.svx</a>
, etc.) which includes the area of
your new survey, it is linked in and will show up when you use the resultant
.3d file in aven. </li>
</ul>

<p>Now you have been typing this on the expo laptop, and before you let someone 
else use the laptop you need to find a nerd to do the deep magic to add your 
file to the version control <a href="../computing/repos.html">repository</a> "loser". Watching the nerd do this is 
usually your first initiation into learning how to do it yourself.


<h3 id="concrete">Example svx file</h3>

<p>To make that all a bit more concrete, here is a
fictitious example of a survey off Swings &amp; Roundabouts in 204. Let's say
that you went to explore a lead from the QM list numbered 2002-99, that the
nearest survey station was listed as 204.allswings.swings5.2 and you found it
successfully, and numbered it within your own survey as station 0. Then you
might create the following file: (note we don't use umlauts)</p>
<!-- Stolen, with apologies to Martin and Lucia, from
caves/204/swings/ermintrude.svx. --> 
<pre><code><i>File wibble.svx</i>
*begin wibble

; Locn:	Totes Gebirge, Austria - Loser/Augst-Eck Plateau (kataster group 1623)
; Cave:	Steinbruckenhohle
*title "Wibbled by Goesser"
*date 2004.08.32 ;date the survey was done
*team Insts John Doe
*team Notes Amalthea Jones
*team Tape Amalthea Jones
 
; ref.:	2004 #999 ; the #number is on the clear pocket containing the original notes.

; ====== stations refindable to link to other surveys: ======

*export 0 ; list all exported survey points.

*calibrate tape 0	; +ve if tape was too short, -ve if too long
;calibration data 148,+23,147,+23.5,148,+23,329,-23,328,-23.5,328.5,-23

;from	to	tape	compass	clino	; remarks
1	p5	5.48	181	-27
<i>[and the rest of your survey data]</i>
6	5	5.66	-	DOWN

;stn	L	R	U	D	Desc
;1	0.7	0.4	0.3	0.5	RP top of boulder
<i>[and the rest of the station details]</i>
*end wibble</code>
</pre>

<p>That lot would be typed by copying :loser:/template/template.svx to
:loser:/caves-1623/204/swings/wibble.svx and then filling in the blanks and adding your
data. If you are linking to the rest of the survey then in the file
:loser:/caves-1623/204/swings/allswings.svx add the lines:</p>

<pre><code>*include wibble
*equate wibble.0 swings5.2
</code></pre>

<h3 id="split">Split surface and underground files</h3>

<p>Remember not to put surface data and underground data in the same file,
even if they are part of one continuous survey. You need to create two
files, with a defined station for the entrance, and a suitable equate in
the file which includes both surface stuff and underground stuff.</p>
<!-- Did whoever surveyed bogenhoehle read this? -->

<h3 id="roles">*Team options</h3>
<p>We have used a varied and peculiar range of roles in our survex files over the years. e.g.
  <pre><code>*team nail_varnish_bitch Amalthea Jones
</code></pre>
<p>The list of approved roles (as of July 2023) is: <br>
  <code>bitch|bodger|bolt|bolter|bolting|book|clino|comp|
  compass|consultant|disto|distox|distox2|dog|
  dogsbody|drawing|drill|gps|helper|inst|instr|
  instrument|monkey|nagging|nail|nail_polish|
  nail_polish_bitch|nail_polish_monkey|nail_varnish|
  nail_varnish_bitch|note|paint|photo|pic|point|
  polish|powerdrill|rig|rigger|rigging|sketch|
  slacker|something|tape|topodroid|unknown|
    useless|varnish|waiting_patiently</code>


<h3 id="postprocess">Postprocessing and Update</h3>
<p>Once you have your data typed in and checked, it must be run through the
survey software (which on expo will be <a
href="http://www.survex.com/">survex</a>) and a centre line printed, both for
plan and for extended elevation. Measure the print out to check that it really
has printed at the scale you wanted (typically 1:500), as this has sometimes
caused problems in the past.</p>

<p>Return to  "<a href="newcave.html#survexformat">Survey handbook - survex format</a>".</p>

<hr /></body>
</html>