mirror of
https://expo.survex.com/repositories/expoweb/.git/
synced 2024-11-29 13:21:58 +00:00
97 lines
5.7 KiB
HTML
97 lines
5.7 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<title>CUCC Expedition Handbook: Programmers manual</title>
|
|
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
|
|
</head>
|
|
<body>
|
|
<h2 id="tophead">CUCC Expedition Handbook - Minimal laptop</h2>
|
|
|
|
<h1>Setting up a minimal Expo laptop</h1>
|
|
|
|
<h2>What you can do from any laptop</h2>
|
|
<p>There is a lot you can do without installing any software on your own machine. Using a browser, you can logon to the Expo online system ("the website", also known as "troggle") as user 'expo' at <a href="/accounts/login/">the Troggle User Login page</a>. (Ask another expoer for the 'cavey:beery' password.) You can:
|
|
<ul>
|
|
<li>Edit any HTML page in the online handbook: correct errors, update phone numbers
|
|
<li>Edit existing Survex files in our complete Loser cave data repository
|
|
<li>Create new Survex files - a template is provided - for new cave passages
|
|
<li>Edit the cave description and entrance description text for existing caves
|
|
<li>Create entirely new caves in the system by filling out online forms
|
|
</ul>
|
|
<p>And using email to send the results to an expo nerd, you can:
|
|
<ul>
|
|
<li>Type up your logbook entry for any trip you do (surface or underground), but please use <a href="../logbooks.html">our standard format</a>
|
|
<li>Upload GPS tracks from your phone
|
|
<li>Send photos of cave entrances and cavers doing mad things
|
|
<li>Sketch rigging plans on paper, photograph them, and email them
|
|
<li>Regularly take photos of pages of '<a href="../bierbook.html">the bier book</a>' and 'the sesh book' and email them, to protect against accidental 'Gössering'
|
|
<li>Regularly take photos of pages of '<a href="../logbooks.html">the handwritten expo logbook</a>', also to protect against accidental 'Gössering' but also against permanent loss. We are missing several vital logbooks from past expos through carelessness.
|
|
</ul>
|
|
<p>and of course using your phone or laptop you can update entries on expo antics on public forums such as ukcaving.
|
|
|
|
<p>We are actively working on increasing the number of expo activities that can be done with just a browser and no installed software.
|
|
|
|
<h2>Your own laptop</h2>
|
|
<p>If you are new to expo please use the <em>expo laptop</em> first. You don't <em>need</em> to use your own laptop - which takes most of a day to setup completely.
|
|
<p>To set up your own laptop you need to do this:</p>
|
|
<ol>
|
|
<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="../computing/repos.html">expo repositories</a> <var>loser, drawings</var> and <var>expoweb</var> so you have the files on your machine. (Use the <a href="qstart-git.html">git reminder</a> for how to do this, e.g. <em>git clone ssh://expo@expo.survex.com:/home/expo/expoweb</em></li>
|
|
<li>Install survex, and therion or tunnel for editing cave data.
|
|
</ol>
|
|
|
|
<p>Once you have got this working, and if it doesn't do what you want or you don't understand how to use it,
|
|
look at the <a href="yourlaptop.html">full laptop configuration</a> for everything else.
|
|
And please <b>write some documentation for the next person</b> in your situation.
|
|
|
|
<h3>Cheat lists and quick reminders</h3>
|
|
<ul>
|
|
<li>Quick <a href="qstart-git.html">reminders for using git</a> at the command line.
|
|
<li>Quick <a href="qstart-rsync.html">reminders for using rsync</a> at the command line.
|
|
</ul>
|
|
|
|
<h2 id="software">Software</h2>
|
|
<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="getsurvex.html">Installing surveying software</a> - survex, tunnel, therion - specifically for expo use
|
|
<li><a href="https://survex.com/download.html">Survex</a>, including the Aven visualisation tool.
|
|
<li><a href="https://github.com/CaveSurveying/tunnelx">Tunnel</a>: 2.5D cave drawing program based on Survex-compatible data which can also read PocketTopo files. (Generally called 'tunnel' even though the project and executable is actually 'tunnelx'.)
|
|
<li><a href="https://therion.speleo.sk/">Therion</a> - Therion processes survey data and generates maps or 3D models of caves.
|
|
</ul>
|
|
|
|
<h2 id="configuration">Configuration</h2>
|
|
|
|
<p>Follow this link to <a href="keyexchange.html">register a key with the expo server</a> to get upload (i.e. read/write) access.
|
|
Do this first, Without it none of git, scp, ftp or rsync will work.
|
|
|
|
<p>On a Windows machine you will need to configure pageant (the putty authentication agent)
|
|
to <a href="https://blog.shvetsov.com/2010/03/making-pageant-automatically-load-keys.html">run at startup to load your key</a>.
|
|
Note that you are loading your <em>private</em> key, the .ppk file, into pageant and that this key never leaves your laptop.</p>
|
|
|
|
<ul>
|
|
|
|
<li><a href="../putty/putty.html">Installing PuTTy</a>.</li>
|
|
<li><a href="winlaptop.html#hard">A Windows laptop for expo</a> - PuTTy and WSL here.</li>
|
|
</ul>
|
|
<p>When using Windows please, please be <a href="http://expo.survex.com/handbook/survey/getin.htm#filenames">excessively
|
|
careful when naming files and survex names</a> and be <a href="manual.html#quickstart">exceptionally careful when using rsync</a>.
|
|
|
|
<h3>Learning how to use this software</h3>
|
|
|
|
<ul>
|
|
<li>Using Survex, Tunnel and Therion, see the <a href="http://expo.survex.com/handbook/survey/">Expo Handbook - Surveying section</a>.
|
|
<li>For more detailed configuration, explanations and help see the <a href="yourlaptop.html#configuration">full laptop</a> instructions
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
</body>
|
|
</html>
|