New Cave data entry process: logbook entry, wallets, survex files,

This commit is contained in:
Philip Sargent 2020-02-28 16:18:54 +00:00
parent 6d2b915617
commit 2282b06dc4
9 changed files with 410 additions and 315 deletions

View File

@ -8,13 +8,13 @@
<body>
<h2 id="tophead">CUCC Expedition Handbook - Minimal laptop</h2>
<h1>Setting up a minimal machine to work with Expo data</h1>
<h1>Setting up a minimal Expo laptop</h1>
<h2>Overview</h2>
<p>You need to do this:</p>
<p>To set up your own laptop you need to do this:</p>
<ol>
<li><a href="#configuration">Register an SSH key</a> with an expo nerd (i.e 'get a login').</li>
<li>Register an SSH key</a> with an expo nerd i.e 'get a login'. (see "Key Configuration" below)</li>
<li>Install <a href="#software">git version control software</a> to download ("clone"), view and edit caving data.</li>
<li>Clone three <a href="../manual.html#repositories">expo repositories</a> so you have the files on your machine.</li>
<li>Install survex, and therion or tunnel for editing cave data.
@ -31,7 +31,7 @@ And please <b>write some documentation for the next person</b> in your situation
</ul>
<h2 id="software">Software</h2>
<p>Download this software (short list):
<p>If you are just typing up logbook entries then you don't need any other software. If you are working with survey data download this software (short list):
<ul>
<li><a href="https://git-scm.com/">git</a> - version control system</li>
<li><a href="https://survex.com/download.html">Survex</a>, including the Aven visualisation tool.

View File

@ -0,0 +1,89 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>CUCC Expedition Handbook: Logbook import</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Logbooks Import</h1>
<h3 id="import">Importing the logbook into troggle</a></h3>
<p>This is usually done after expo but it is in excellent idea to have a nerd do this a couple of times during expo to discover problems while the people are still around to ask.
<p>The nerd needs to login to the expo server using <em>their own userid</em>, not the 'expo' userid. The nerd also needs to be in the group that is allowed to do 'sudo'.
<p>The nerd needs to do this:
<ol>
<li>Look at the list of pre-existing old import errors at </br> <a href="http://expo.survex.com/admin/core/dataissue/">http://expo.survex.com/admin/core/dataissue/</a> </br>
The nerd will have to login to the troggle management console to do this, not just the usual troggle login.
<li>You need to get the list of people on expo sorted out first. </br>
This is documented in the <a href="folkupdate.html">Folk Update</a> process.
<li>Log in to the expo server and run the update script (see below for details)
<li>Watch the error messages scroll by, they are more detailed than the messages archived in the old import errors list
<li>Edit the logbook.html file to fix the errors. These are usually typos, non-unique tripdate ids or unrecognised people. Some unrecognised people will mean that you have to fix them using the <a href="folkupdate.html">Folk Update</a> process first.
<li>Re-run the import script until you have got rid of all the import errors.
<li>Pat self on back. Future data managers and people trying to find missing surveys will worship you.
</ol>
<p>The procedure is like this. It will be familiar to you because
you will have already done most of this for the <a href="folkupdate.html">Folk Update</a> process.
<pre><code>ssh {youruserid}@expo.survex.com
cd ~expo
cd troggle
sudo python databaseReset.py logbooks
</code></pre>
<p>It will produce a list of errors like these below, starting with the most recent logbook which will be the one for the expo you are working on.
You can abort the script (Ctrl-C) when you have got the errors for the current expo that you are going to fix
<pre><code>Loading Logbook for: 2017
- Parsing logbook: 2017/logbook.html
- Using parser: Parseloghtmltxt
Calculating GetPersonExpeditionNameLookup for 2017
- No name match for: 'Phil'
- No name match for: 'everyone'
- No name match for: 'et al.'
("can't parse: ", u'\n\n&lt;img src="logbkimg5.jpg" alt="New Topo" /&gt;\n\n')
- No name match for: 'Goulash Regurgitation'
- Skipping logentry: Via Ferata: Intersport - Klettersteig - no author for entry
- No name match for: 'mike'
- No name match for: 'Mike'</code></pre>
<p>Errors are usually misplaced or duplicated &lt;hr /&gt; tags, names which are not specific enough to be recognised by the parser (though it tries hard) such as "everyone" or "et al." or are simply missing, or a bit of description which has been put into the names section such as "Goulash Regurgitation".
<h3 id="history">The logbooks format</h3>
<p>This is documented on the <a href="..logbooks.html#format">logbook user-documentation page</a> as even expoers who can do nothing else technical can at least write up their logbook entries.
<p>[ Yes this format needs to be re-done using a proper structure:<br>
<code><pre>
&lt;div class="logentry"&gt;<br>
<span style="text-decoration: line-through wavy red;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
&lt;/div"&gt;</pre></code>
it's on the to-do list...]
<h3 id="history">Historical logbooks format</h3>
<p>Older logbooks (prior to 2007) were stored as logbook.txt with just a bit of consistent markup to allow troggle parsing.</p>
<p>The formatting was largely freeform, with a bit of markup ('===' around header, bars separating date, <place> - <description>, and who) which allows the troggle import script to read it correctly. The underlines show who wrote the entry. There is also a format for time-underground info so it can be automagically tabulated.</p>
<p>So the format should be:</p>
<code>
===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson ===
</br>
&#123;Text of logbook entry&#125;
</br>
T/U: Jess 1 hr, Emma 0.5 hr
</code>
<p>
<a href="../logbooks.html">Back to Logbooks for Cavers</a> documentation.
<hr />
</body>
</html>

BIN
handbook/i/logbookpage.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

View File

@ -12,13 +12,12 @@
the base camp logbook or the top camp logbook.
<ul>
<li><a href="#why">Why</a> the logbook is so important
<li>Why the logbook is so important
<li><a href="#type">Typing on the <em>Expo Laptop</em></a>
<li><a href="#another">Typing on another laptop</a>
<li><a href="#format">Formatting</a> a typed logbook entry
</br></br>
<li><a href="#import">Importing</a> the logbook into troggle (nerds only) - error checking
<li><a href="#history">Historical</a> logbookformat (nerds only)
<li><a href="computing/logbooks-parsing.html">Importing</a> the logbook into troggle (nerds only) - and error checking
</ul>
<h3 id="why">Why the logbook is important</h3>
@ -31,10 +30,29 @@ do lots of sketches in the logbook.
If you mention a cave location, please also write down the cave name somewhere. In 10 years no-one will know
where "Lemon Snout" is.
<p>If this is all new to you, please now read <a href="datamgt.html">Cave data management</a>,
and <a href="survey/why.htm">why we make surveys</a> and then the
<p>
<a href="/years/2018/logbook.html#t2018-08-03w"><img src="i/logbookpage.jpg" class="onright"></a>
If this is all new to you, please now read
<a href="survey/why.htm"><strong>Why we make surveys</strong></a>
and
<a href="datamgt.html">Cave data management</a>,
and then the
<a href="survey/index.htm">Survey Handbook</a>
<h3>Interim rigging guide</h3>
<p>The logbook is the place where we record the rigging of caves as we discover them.
<p>When a cave is derigged,
a good way of getting the rope lengths for your rigging guide is to
leave the knots in ropes removed so they can
be <b>measured</b>, but these days our caves are a bit deep
and complicated for this to be feasible.
Although a good survey and details of the belays
can be used to estimate the length of rope needed, this is no substitute for
measuring how much rope it actually took to rig.</p>
<h3>The online logbook file</h3>
<p>If you are at basecamp, then it is an excellent idea to
<b>type the text of your logbook trip report</b> instead of writing it by hand - see <a href="#type">below</a>. But still do lots of drawings in the paper logbook.
@ -52,14 +70,13 @@ correlated with survey data done on the same day or by the same people.
<li><a href="../years/2018/logbook.html">2018</a>
<li><a href="../years/2017/logbook.html">2017</a>
</ul>
<p>All these logbook entries are then typed into a laptop (often the expo laptop)
<p>All these scanned handwritten logbook entries are typed into a laptop (often the expo laptop)
which is then synchronised the version control system.
<p>The result is a webpage reporting who did what and what was done by whom on expo,
e.g. see <a href="http://expo.survex.com/expedition/2018">the 2018 expo report</a>.
<h3 =id="type">Typing just your trip report (at the <i>Expo Laptop</i>)</h3>
<p>If you are at basecamp, then it is an excellent idea to type up your logbook trip report.
You can then print this and stick it in the logbook, adding any sketches by hand.
<p>As handwriting can be very bad, please try to type the text, print it and stick it in the logbook, adding any sketches by hand.
This will save someone (probably you) deciphering your handwriting and typing it up later.
<p>These instructions assume that (a) you are sitting at the <em>expo laptop</em> and that someone who knows
@ -101,8 +118,8 @@ copy it by email or USB stick to another laptop, edit it there and then copy it
<p>If you are using your own laptop then you will need to either:
<ul>
<li>Just type up your trip as a separate file e.g. "logbook-mynewtrip.txt", or just write it in an email, and send it to someone nerdish, or
<li><a href="onlinesystems.html#manual">install and learn how to use</a> the version control software.
<li>Just type up your trip as a separate file with a useful filename e.g. "logbook-myname-2018-08-03.txt", or just write it in an email, and send it to someone nerdish, or
<li><a href="computing/basiclaptop.html">install and learn how to use</a> the version control software.
And you will need to synchronise regularly (every day) to
ensure that the updates from all the people entering trip data are OK and don't get overwritten by ignorant use of this software.
</ul>
@ -130,70 +147,9 @@ when there is more than one trip on a day.</p>
<p>Note: T/U stands for "Time Underground" in hours (6 minutes would be "0.1 hours").
<p>Note: the &lt;hr /&gt; is significant and used in parsing, it is not just prettiness.
<p>[ Yes this format needs to be re-done using a proper structure:<br>
<code><pre>
&lt;div class="logentry"&gt;<br>
<span style="text-decoration: line-through wavy red;">&nbsp;&nbsp;&nbsp;&nbsp;</span>
&lt;/div"&gt;</pre></code>
it's on the to-do list...]
<hr />
<h3 id="history">Historical logbooks</h3>
<p>Older logbooks (prior to 2007) were stored as logbook.txt with just a bit of consistent markup to allow troggle parsing.</p>
<p>The formatting was largely freeform, with a bit of markup ('===' around header, bars separating date, <place> - <description>, and who) which allows the troggle import script to read it correctly. The underlines show who wrote the entry. There is also a format for time-underground info so it can be automagically tabulated.</p>
<p>So the format should be:</p>
<code>
===2009-07-21|204 - Rigging entrance series| Becka Lawson, Emma Wilson ===
</br>
&#123;Text of logbook entry&#125;
</br>
T/U: Jess 1 hr, Emma 0.5 hr
</code>
<h3 id="import">Importing the logbook into troggle</a></h3>
<p>This is usually done after expo but it is in excellent idea to have a nerd do this a couple of times during expo to discover problems while the people are still around to ask.
<p>The nerd needs to login to the expo server using <em>their own userid</em>, not the 'expo' userid. The nerd also needs to be in the group that is allowed to do 'sudo'.
<p>The nerd needs to do this:
<ol>
<li>Look at the list of pre-existing old import errors at </br> <a href="http://expo.survex.com/admin/core/dataissue/">http://expo.survex.com/admin/core/dataissue/</a> </br>
The nerd will have to login to the troggle management console to do this, not just the usual troggle login.
<li>You need to get the list of people on expo sorted out first. </br>
This is documented in the <a href="computing/folkupdate.html">Folk Update</a> process.
<li>Log in to the expo server and run the update script (see below for details)
<li>Watch the error messages scroll by, they are more detailed than the messages archived in the old import errors list
<li>Edit the logbook.html file to fix the errors. These are usually typos, non-unique tripdate ids or unrecognised people. Some unrecognised people will mean that you have to fix them using the <a href="computing/folkupdate.html">Folk Update</a> process first.
<li>Re-run the import script until you have got rid of all the import errors.
<li>Pat self on back. Future data managers and people trying to find missing surveys will worship you.
</ol>
<p>The procedure is like this. It will be familiar to you because
you will have already done most of this for the <a href="computing/folkupdate.html">Folk Update</a> process.
<pre><code>ssh {youruserid}@expo.survex.com
cd ~expo
cd troggle
sudo python databaseReset.py logbooks
</code></pre>
<p>It will produce a list of errors like this, starting with the most recent logbook which will be the one for the expo you are working on.
You can abort the script (Ctrl-C) when you have got the errors for the current expo that you are going to fix
<pre><code>Loading Logbook for: 2017
- Parsing logbook: 2017/logbook.html
- Using parser: Parseloghtmltxt
Calculating GetPersonExpeditionNameLookup for 2017
- No name match for: 'Phil'
- No name match for: 'everyone'
- No name match for: 'et al.'
("can't parse: ", u'\n\n&lt;img src="logbkimg5.jpg" alt="New Topo" /&gt;\n\n')
- No name match for: 'Goulash Regurgitation'
- Skipping logentry: Via Ferata: Intersport - Klettersteig - no author for entry
- No name match for: 'mike'
- No name match for: 'Mike'</code></pre>
<hr />
</body>
</html>

View File

@ -15,11 +15,14 @@
and you want to let the world know of your massive discovery.
<ul>
<li>If you have not yet learned how to record your prospecting and survey
your leads, read the <a href="../look4.htm">prospecting introduction</a> and
<a href="../survey/index.htm">survey handbook</a> which tells you how to record
your leads, read the
<ul>
<li><a href="../look4.htm">prospecting introduction</a> and
<li><a href="../survey/index.htm">survey handbook</a> which tells you how to record
survey information in your waterproof notebook. But first you should read the
<a href="/expofiles/presentations/cave_surveying_20130626.pdf">
<li><a href="/expofiles/presentations/cave_surveying_20130626.pdf">
Cave Surveying training course slidepack</a>.
</ul>
<li>This page outlines the rest of the process. Each part of it is documented separately.
</ul>
@ -30,9 +33,9 @@ the instructions section by section which tell you how to
actually do these things.
<ul>
<li>Write up your trip in the <a href="../logbooks.html">logbook</a><br><br>
<li>Write up your trip in the <a href="../logbooks.html">logbook</a> including rigging sketches<br><br>
<li>Put notes in a new wallet
<li>Scan the notes (see <a href="#onlinew">below</a> for the filenames to use and <a href="#scan">how to use the scanner</a>)
<li>Scan the notes (see <a href="newwallet.html#onlinew">"new wallet"</a> for the filenames to use and <a href="newwallet.html#scan">how to use the scanner</a>)
<li>Type in survey data (in the right place in the file system) in <a href="#survexformat">survex format</a>.<br>
(This includes passage descriptions and open leads known as QMs: Question Marks).
<li>Run survex to create a centre-line printout
@ -49,235 +52,17 @@ actually do these things.
(This will mean copying the passage descriptions from the survex files.)
<li>Update the index tick boxes on paper: as your wallet progresses through this process
<li>Update the online record of those tick boxes
<li>Regenerate the <a href="http://expo.survex.com/expofiles/surveyscans/2018/">list of outstanding survey tasks</a> for everyone
<li>Regenerate the <a href="/expofiles/surveyscans/2018/">list of outstanding survey tasks</a> for everyone for the current year
</ul>
<p>This documentation assumes that you have recorded your survey data in
a waterproof paper notebook. If instead you are using a PDA to record the survey readings
digitally for your first cave, don't. Use the paper process first, then when you are familiar
the overall process, look at the <a href="pdanotes.html">PDA additional notes</a>.
<h3 id="newwallet">Starting a new wallet</h3>
<ol>
<li>Put all your written notes into the next empty "wallet":
(a transparent folder/envelope) in this year's lever-arch file labelled
e.g. "Expo Survey 2018" in the potato hut*.
<li>The wallet has a paper sticky label on it with the wallet-identifier,
e.g. <b>2018#22</b>, already printed on the label.
<li>Write the date and the names of the people on the trip on the label.
<li>Tick whether your trip was a surface or a cave trip.
<li>Write the name of the cave (with number if you know it), e.g. "264 Balkon"
<li>Write the area in the cave you did your surveying, e.g. "mongol rally"<br>
<li>Now turn to the index sheets at the front of the folder,
and fill in the line (e.g. 2018#22) for your wallet
<ul>
<li>"264 mongol rally"
<li>date of trip
<li>people who were on it
<li>then there are a lot of tick boxes. The explanations for these will come later.
</ul>
<p align=center>
<a href="2017-wallet-coverlist.jpg" border=1><img src="2017-wallet-coverlist.jpg" width=50%></a>
<br>
<em>Image of wallet index sheet - click for larger image</em>
</p>
<li>Now, if you have not done it immediately after you left the cave,
photograph all the pages of survey notes with your phone.
Get one or more of the people also on the trip to do this too.
</ol>
<p>* As people spend longer and longer at top camp, we may establish
a wallet file at top camp
too, with pre-allocated numbers.
<p>The original notes and sketches should be filed in the clearly marked
wallet. Rip them out of the notebook, don't take them caving again and <em>don't leave them lying around to
be "G&ouml;ssered"!</em></p>
<p>The notes (all of them, including dates, personnel, calibration, LRUD,
station details, etc.) should be filed away in the wallet in the current year's
surveys file. You should include a transcription on a sheet of paper if they are illegible
(to other people; if you can't read them yourself, go back and do the survey
again!). Even if you do this, never throw away the original notes.</p>
<!-- Original text: ...copied onto a fresh page of the Survey Book
while everyone's memory is still fresh (this helps if something is only
marginally legible). This should be proof checked by someone else. Current
survey books are divided into "Kaninchenh&ouml;hle" (usually referred to as
"KH Survey book") and "surface stuff and other caves" (usually referred to as
"notKH survey book"). There should be an index page at the front, which you
should also fill in so that people can find your survey again.</p>-->
<h3 id="onlinew">Scan the notes into the online wallet</h3>
<p>Each wallet has a corresponding folder in the online system where a record is kept
of what information is in the wallet and where the corresponding survey data is filed:
<pre>
/expofiles/surveyscans/2018/2018#22/
</pre>
<p>This is where the scanned (or photographed) copies of the survey notes are kept.
<p id="scan">To use the scanner attached to the <em>expo laptop</em>, select the "Simple Scan"
icon from the vertical menu of icons which you get by clicking on
"Activities" in the top lefthand corner of the screen.
<p style="margin-left:20px">[ Normal people should skip this, <br>&nbsp;
but nerds need to look here
for the <a href="onlinewallet.html">online wallet maintenance process</a> ].
<p>If your initial backup photos of your notes were poor quality, use the
scanner in the potato hut to make better copies. Scan to JPEG format as .jpg files.
<p>Name the scanned pages "<em>notes-1.jpg</em>, or perferably <em>notes-cavepassagename.jpg</em>" etc. This is important as a script detects whether these files exist
(with names beginning "notes.." and "elev..") and if you name them something else it will hassle you unnecessarily.
<p>[ Note to maintainers: do not rename these files even if they have been created with the wrong names.
They are permanently referred to by the tunnel/therion/troggle system !]
<p>Scanned survey notes are voluminous and so are not kept in the version control system. Instead it is all kept
in the file bucket "expofiles" on the expo server in Cambridge.
<p>You will be using the expo laptop to do the scanning
and you will put all the scan files in the folder for your wallet, e.g. for 2018#19 it is:
<pre>
/home/expo/expofiles/surveyscans/2018/2018#19/
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is copied to the expo server.
[ If you want to do this yourself, or are using your own laptop, then learn how to use Filezilla
- as <a href="../uploading.html">documented for uploading your expo photographs</a>. The correct folder
on the expo server is the same as that on the expo laptop- because we set up the expo laptop to be like that.
But <em>only copy files to the server that you created yourself and which live in your own wallet folder</em> ]
<h3 id="runsurvex">Storing your electronic survey files</h3>
<p>If you used a PDA instead of making notes on paper, you need to store your .topo files in the right place.
<p>If you using the expo laptop you can put the .topo files in a special "X" folder for your virtual
wallet, as there is no physical wallet,
e.g. for 2018#X16 it would be:
<pre>
/home/expo/expofiles/surveyscans/2018/2018#X16/
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is copied from the <em>expo laptop</em> to the expo server.
<p>[ If all else fails, use the "Upload your photos" documented process and store
the .topo files where you would have stored your .jpg photo files. Otherwise you can email all the .topo files
to a friendly nerd who will put them in the right place. ]
<p><em>to be further documented - probably in a separate page</em>
<h3 id="survexformat">Typing in the survey data in survex format</h3>
<p>[This has been described in several places and we are in the process of consolidating
the documentation and getting rid of out of date notes.]
<p>The survey data typed up must include all the notes, including station details and passage
names. Make a backup copy to another machine or USB stick as soon as you have typed it in.
New users will be using the expo laptop to create the .svx file and
you will put it in the folder
<pre>
/home/expo/loser/caves-1623/264/mongolrally.svx
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is <em>saved, committed, </em>and<em> pushed</em> appropriately.
<p>If you have several parts of the cave surveyed on one trip, create several distinct .svx files.
<ul>
<li><a href="how_to_make_a_survex_file.pdf">How to make a survex file</a> - PDF
<li><a href="getin.htm">From muddy book to survex plot</a> - the survex file format (to be revised)
<li><a href="qmentry.html">How to add QM data and cave descriptions</a> - and why this is vital
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/svxhowto.htm">Contents of .svx files</a> - How do I?
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/genhowto.htm">How do I Create a new survey</a> - example with several surveys joined
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/datafile.htm">Survex data files</a> - all the sections and keywords explained
</ul>
<p>Once you have created the .svx file you will run survex to generate a centre line, transcribe your sketches onto that paper, scan it again and then digitise into tunnel or therion.
<ul>
<li><a href="drawup.htm">Drawing up your survey</a> - incomplete and a bit out of date
<li><a href="athome.htm">Back in the UK</a> - not really part of the process
<li><a href="/expofiles/presentations/cave_surveying_20130626.pdf">Cave Surveying - training course slidepack</a>
</ul>
<p>[Nerds: survex cave data belongs in the repository "loser", e.g.
loser "caves-1623/264/mongolrally.svx". We are assuming that normal users have never
worked with an distributed version control system at this point which is why we are only
telling them to use the <em>expo laptop</em>.]
<h3><a id="tickingoff">Ticking off QMs</a></h3>
<p>To be written.</p>
<h3 id="runsurvex">Running survex to create a centre-line</h3>
<p><em>to be documented</em>
<h3 id="rescan">Transcribing and re-scanning your sketches</h3>
<p><em>to be documented</em> See <a href="drawup.htm">drawing up the sketches</a>.
<p>The files of your scanned and re-scanned sketches should be stored in the same folder
as the scanned notes, i.e. (for wallet #19) you would put them in:
<tt>
/home/expo/expofiles/surveyscans/2018/2018#19/
</tt>
<h3 id="therion">Using tunnel or therion for final survey production</h3>
<p><em>to be documented</em>
<ul>
<li><a href="/expofiles/tunnelwiki/wiki/pages/Tunnel.html">Tunnel tutorial</a> - a wiki of examples and tutorials
</ul>
<p>Tunnel only produces plan surveys, but they are very pretty.
<p>The tunnel (or therion) files should NOT stored in the same folder as the scanned notes. They should
be uploaded to the version control repository <span style="font-family:monospace; size=x-small; background-color: lightgray"><a href="http://expo.survex.com/cgit/drawings/.git/log">drawings</a></span>,
<h3>Interim rigging guide</h3>
<p>The logbook is the place where we record the rigging of caves as we discover them.
<p>When a cave is derigged,
a good way of getting the rope lengths for your rigging guide is to
leave the knots in ropes removed so they can
be <b>measured</b>, but these days our caves are a bit deep
and complicated for this to be feasible.
Although a good survey and details of the belays
can be used to estimate the length of rope needed, this is no substitute for
measuring how much rope it actually took to rig.</p>
<h3>Guidebook description and final rigging guide</h3>
<p>This is the last thing to do - typically after all exploration has been finished for the summer.
The rigging guide sections will have been written into the logbook, and the passage descriptions will
have been written into the survex files, with more lyrical descriptions written into the logbook for each trip.
<p><em>to be documented</em>
<p>Write a <b>passage descriptions</b> by copying and extending the descriptions
given in all the component .svx files.
<p>This should be detailed enough to be
followed by someone in the cave who hasn't been there before, and should
include all passage names, lengths of pitches and climbs, compass directions
when this makes left/right/ahead clearer. If your passage is a connection
it is worth while writing descriptions from both directions.
<p>In
written descriptions, underline passage names the first time they are
mentioned, or when they are "defined".</p>
<p>
You will type this description, and pass it on to someone more nerdy who
will file it in the right place. This will involve "creating a new cave" using the <a href="../computing/troggle-ish.html">troggle</a> system.
<p><em>to be documented</em>
<p>Complementing the passage description in vertical bits is a <b>Rigging
Guide</b>. This is usually easiest to do as a sketch, but include notes to
ensure that all bolts can be found again and any deviations and natural belays recognised.
<p><em>to be completed</em>
<p>Now go the the next page in this sequence <a href="newwallet.html">Starting a new wallet"</a>.
<hr />
<ul id="links">
<li><a href="../index.htm">Expedition Handbook</a>
<li><a href="index.htm">Survey Handbook</a>
</ul>
</body>
</html>

View File

@ -0,0 +1,125 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Handbook - Starting a new Survex file</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook - New Survex file</h2>
<h1>Creating a new survex file</h1>
<h2>Great, I have discovered a new cave...</h2>
<p>If you have not come to this page from the sequence starting at <a href="newcave.html">Starting a New Cave"</a> then go and read that first.
<li>This page outlines the next step of the process. Each part of it is documented separately.
</ul>
<h2>Process</h2>
<p>
<h3 id="survexformat">Typing in the survey data in survex format</h3>
<p>[This has been described in several places and we are in the process of consolidating
the documentation and getting rid of out of date notes.]
<p>The survey data typed up must include all the notes, including station details and passage
names. Make a backup copy to another machine or USB stick as soon as you have typed it in.
New users will be using the expo laptop to create the .svx file and
you will put it in the folder
<pre>
/home/expo/loser/caves-1623/264/mongolrally.svx
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is <em>saved, committed, </em>and<em> pushed</em> appropriately.
<p>If you have several parts of the cave surveyed on one trip, create several distinct .svx files.
<ul>
<li><a href="how_to_make_a_survex_file.pdf">How to make a survex file</a> - PDF
<li><a href="getin.htm">From muddy book to survex plot</a> - the survex file format (to be revised)
<li><a href="qmentry.html">How to add QM data and cave descriptions</a> - and why this is vital
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/svxhowto.htm">Contents of .svx files</a> - How do I?
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/genhowto.htm">How do I Create a new survey</a> - example with several surveys joined
<li><font color=red>[survex software docm.]</font> <a href="https://survex.com/docs/manual/datafile.htm">Survex data files</a> - all the sections and keywords explained
</ul>
<p>Once you have created the .svx file you will run survex to generate a centre line, transcribe your sketches onto that paper, scan it again and then digitise into tunnel or therion.
<ul>
<li><a href="drawup.htm">Drawing up your survey</a> - incomplete and a bit out of date
<li><a href="athome.htm">Back in the UK</a> - not really part of the process
<li><a href="/expofiles/presentations/cave_surveying_20130626.pdf">Cave Surveying - training course slidepack</a>
</ul>
<p>[Nerds: survex cave data belongs in the repository "loser", e.g.
loser "caves-1623/264/mongolrally.svx". We are assuming that normal users have never
worked with an distributed version control system at this point which is why we are only
telling them to use the <em>expo laptop</em>.]
<h3><a id="tickingoff">Ticking off QMs</a></h3>
<p>To be written.</p>
<h3 id="runsurvex">Running survex to create a centre-line</h3>
<p><em>to be documented</em>
<h3 id="rescan">Transcribing and re-scanning your sketches</h3>
<p><em>to be documented</em> See <a href="drawup.htm">drawing up the sketches</a>.
<p>The files of your scanned and re-scanned sketches should be stored in the same folder
as the scanned notes, i.e. (for wallet #19) you would put them in:
<tt>
/home/expo/expofiles/surveyscans/2018/2018#19/
</tt>
<h3 id="therion">Using tunnel or therion for final survey production</h3>
<p><em>to be documented</em>
<ul>
<li><a href="/expofiles/tunnelwiki/wiki/pages/Tunnel.html">Tunnel tutorial</a> - a wiki of examples and tutorials
</ul>
<p>Tunnel only produces plan surveys, but they are very pretty.
<p>The tunnel (or therion) files should NOT stored in the same folder as the scanned notes. They should
be uploaded to the version control repository <span style="font-family:monospace; size=x-small; background-color: lightgray"><a href="http://expo.survex.com/cgit/drawings/.git/log">drawings</a></span>,
<h3>Guidebook description and final rigging guide</h3>
<p>This is the last thing to do - typically after all exploration has been finished for the summer.
The rigging guide sections will have been written into the logbook, and the passage descriptions will
have been written into the survex files, with more lyrical descriptions written into the logbook for each trip.
<p><em>to be documented</em>
<p>Write a <b>passage descriptions</b> by copying and extending the descriptions
given in all the component .svx files.
<p>This should be detailed enough to be
followed by someone in the cave who hasn't been there before, and should
include all passage names, lengths of pitches and climbs, compass directions
when this makes left/right/ahead clearer. If your passage is a connection
it is worth while writing descriptions from both directions.
<p>In
written descriptions, underline passage names the first time they are
mentioned, or when they are "defined".</p>
<p>
You will type this description, and pass it on to someone more nerdy who
will file it in the right place. This will involve "creating a new cave" using the <a href="../computing/troggle-ish.html">troggle</a> system.
<p><em>to be documented</em>
<p>Complementing the passage description in vertical bits is a <b>Rigging
Guide</b>. This is usually easiest to do as a sketch, but include notes to
ensure that all bolts can be found again and any deviations and natural belays recognised.
<p><em>to be completed</em>
<hr />
</body>
</html>

View File

@ -0,0 +1,138 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Handbook - Starting a new survey wallet</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook - New survey wallet</h2>
<h1>Creating a new survey wallet</h1>
<h2>Great, I have discovered a new cave...</h2>
<p>If you have not come to this page from <a href="newcave.html">Starting a New Cave"</a> then go and read that first.
<li>This page outlines the next step of the process. Each part of it is documented separately.
</ul>
<h2>Process</h2>
<p>
<h3 id="newwallet">Starting a new wallet</h3>
<ol>
<li>Put all your written notes into the next empty "wallet":
(a transparent folder/envelope) in this year's lever-arch file labelled
e.g. "Expo Survey 2018" in the potato hut*.
<li>The wallet has a paper sticky label on it with the wallet-identifier,
e.g. <b>2018#22</b>, already printed on the label.
<li>Write the date and the names of the people on the trip on the label.
<li>Tick whether your trip was a surface or a cave trip.
<li>Write the name of the cave (with number if you know it), e.g. "264 Balkon"
<li>Write the area in the cave you did your surveying, e.g. "mongol rally"<br>
<li>Now turn to the index sheets at the front of the folder,
and fill in the line (e.g. 2018#22) for your wallet
<ul>
<li>"264 mongol rally"
<li>date of trip
<li>people who were on it
<li>then there are a lot of tick boxes. The explanations for these will come later.
</ul>
<p align=center>
<a href="2017-wallet-coverlist.jpg" border=1><img src="2017-wallet-coverlist.jpg" width=50%></a>
<br>
<em>Image of wallet index sheet - click for larger image</em>
</p>
<li>Now, if you have not done it immediately after you left the cave,
photograph all the pages of survey notes with your phone.
Get one or more of the people also on the trip to do this too.
</ol>
<p>* As people spend longer and longer at top camp, we may establish
a wallet file at top camp
too, with pre-allocated numbers.
<p>The original notes and sketches should be filed in the clearly marked
wallet. Rip them out of the notebook, don't take them caving again and <em>don't leave them lying around to
be "G&ouml;ssered"!</em></p>
<p>The notes (all of them, including dates, personnel, calibration, LRUD,
station details, etc.) should be filed away in the wallet in the current year's
surveys file. You should include a transcription on a sheet of paper if they are illegible
(to other people; if you can't read them yourself, go back and do the survey
again!). Even if you do this, never throw away the original notes.</p>
<!-- Original text: ...copied onto a fresh page of the Survey Book
while everyone's memory is still fresh (this helps if something is only
marginally legible). This should be proof checked by someone else. Current
survey books are divided into "Kaninchenh&ouml;hle" (usually referred to as
"KH Survey book") and "surface stuff and other caves" (usually referred to as
"notKH survey book"). There should be an index page at the front, which you
should also fill in so that people can find your survey again.</p>-->
<h3 id="onlinew">Scan the notes into the online wallet</h3>
<p>Each wallet has a corresponding folder in the online system where a record is kept
of what information is in the wallet and where the corresponding survey data is filed:
<pre>
/expofiles/surveyscans/2018/2018#22/
</pre>
<p>This is where the scanned (or photographed) copies of the survey notes are kept.
<p id="scan">To use the scanner attached to the <em>expo laptop</em>, select the "Simple Scan"
icon from the vertical menu of icons which you get by clicking on
"Activities" in the top lefthand corner of the screen.
<p style="margin-left:20px">[ Normal people should skip this, <br>&nbsp;
but nerds need to look here
for the <a href="onlinewallet.html">online wallet maintenance process</a> ].
<p>If your initial backup photos of your notes were poor quality, use the
scanner in the potato hut to make better copies. Scan to JPEG format as .jpg files.
<p>Name the scanned pages "<em>notes-1.jpg</em>, or <em>notes-cavepassagename.jpg</em>" etc. This is important as a script detects whether these files exist
(with names beginning "notes..", "plan.." and "elev..") and if you name them something else it will hassle you unnecessarily.
<p>[ Note to maintainers: do not rename these files even if they have been created with the wrong names.
They are permanently referred to by the tunnel/therion/troggle system !]
<p>Scanned survey notes are voluminous and so are not kept in the version control system. Instead it is all kept
in the file bucket "expofiles" on the expo server in Cambridge.
<p>You will be using the expo laptop to do the scanning
and you will put all the scan files in the folder for your wallet, e.g. for 2018#19 it is:
<pre>
/home/expo/expofiles/surveyscans/2018/2018#19/
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is copied to the expo server.
<code>
If you want to do this yourself on your own laptop then be aware that
since 2018 this is all more involved because of the enforced security on our new server. First you need a <a href="../computing/basiclaptop.html">minimal laptop setup</a> and then you will need to
learn how to use Filezilla
- as <a href="../uploading.html">documented for uploading your expo photographs</a>. The correct folder
on the expo server is the same as that on the expo laptop- because we set up the expo laptop to be like that.
But <em>only copy files to the server that you created yourself and which live in your own wallet folder</em>
</code>
<h3 id="runsurvex">Storing your electronic survey .topo files</h3>
<p>If you used a PDA instead of making notes on paper, you need to store your .topo files in the right place.
<p>If you using the expo laptop you can put the .topo files in a special "X" folder for your virtual
wallet, as there is no physical wallet,
e.g. for 2018#X16 it would be:
<pre>
/home/expo/expofiles/surveyscans/2018/2018#X16/
</pre>
and tell someone nerdy when you have finished and they will
ensure that it is copied from the <em>expo laptop</em> to the expo server.
<p>If you are not in the potato hut then email all the .topo files
to a friendly nerd (not necessarily on expo) who will upload them in the right place.
<p>Now go the the next page in this sequence <a href="newsurvex.html">Starting a new survex file"</a>.
<hr />
</body>
</html>

View File

@ -29,7 +29,7 @@ the survey data.
<h3>The other files and online index <span style="font-family:monospace; size=x-small; background-color: lightgray">contents.json</span></h3>
<p>All the other files are part of the multi-step process of producing the cave survey - see <a href="newcave.html">
Creating a new cave...</a> for the full list of steps.
Creating a new cave...</a> for the full list of steps. The <em><span style="font-family:monospace">notesXXX.jpg</span></em> files need to be at moderately high resolution but the plan and elevation files are usually fine at 200 dpi. So if the caver has scanned these at high resolution you can reduce the size of these files without damange.
<p>We keep an index of how many of those steps have been completed in two places:
<ul>
@ -180,15 +180,16 @@ regularly, after every batch of survey data is entered or scanned.
<p>This will always overwrite all the <span style="font-family:monospace">index.html</span> files but it will never touch
the <span style="font-family:monospace; size=x-small; background-color: lightgray">contents.json</span> files.
<p>You will also regularly synchronise your laptop
and the expo laptop with <span style="font-family:monospace">expo.survex.com/expofiles/surveyscan/2018/</span>
and this is where it gets tricky.
and the expo laptop with <br />
<span style="font-family:monospace">expo.survex.com/expofiles/surveyscan/2018/</span>
<br />and this is where it gets tricky.
<p><span style="font-family:monospace">expo.survex.com/expofiles/</span> is <font color=red><b>not under version control</b></font>,
so the most recent person
to upload the contents of <span style="font-family:monospace">/2018/</span> <font color=red><b>will overwrite everyone else's work</b></font>.
This does not matter for the autogenerated files, but it is vital that it does not overwrite all the painfully manually edited
<span style="font-family:monospace; size=x-small; background-color: lightgray">contents.json</span> files. Which is very easy to do.
This does mean that this is one of the cases where
it is better to use <span style="font-family:monospace; size=x-small; background-color: lightgray">rsync</span> rather than an FTP client such as Filezilla.
it may be better to use <span style="font-family:monospace; size=x-small; background-color: lightgray">rsync</span> rather than an FTP client such as Filezilla.
<h4>Naming the included files</h4>
<p>The script detects if there are notesX.jpg planX.jpg and elevX.jpgfiles present, and
@ -196,7 +197,7 @@ produces a reminder/warning if they are not,even if these have all been scanned
and given different names.
<p>
The job of the checker (perhaps on a second pass) if to rename files so that these
warnings disappear.
warnings disappear. But if tunnel or therion files have already been produce don't rename anything.
<h4>Not under version control</h4>

View File

@ -9,20 +9,21 @@
<h1>Why am I doing this?</h1>
<p>Once upon a time, none of the caves were explored. Anything you found was
guaranteed virgin. Now, many of the obvious caves have been looked at. Some
went, some didn't. The fact that <strong>you can come to Austria and be pretty sure
of finding new passage to explore is all down to the folk who came before you
recording what they looked at</strong>, both the stuff that went, and the stuff that
didn't. Without detailed recording and surveying of the caves, it would
rapidly become more difficult to find new passage, or to be sure that round
the next corner wouldn't be a load of previous explorers' footprints.</p>
<p>The main aim of the expedition is to explore new passages - to boldly
explore what noone has seen before. Indeed, in many cases, what noone even
suspected was there. This is the fun and excitement of expo, so why spoil it
all by doing tedious activities like surveying?</p>
<p>Once upon a time, none of the caves were explored. Anything you found was
guaranteed virgin. Now, many of the obvious caves have been looked at. Some
went, some didn't. The fact that you can come to Austria and be pretty sure
of finding new passage to explore is all down to the folk who came before you
recording what they looked at, both the stuff that went, and the stuff that
didn't. Without detailed recording and surveying of the caves, it would
rapidly become more difficult to find new passage, or to be sure that round
the next corner wouldn't be a load of previous explorers' footprints.</p>
<p>A lot of work is involved in maintaining the lists of caves that didn't
go, the lists of going leads, the cave surveys, the route descriptions and
other documentation. In the very earliest years, this work was not regarded