expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2024-11-25 08:41:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

New troggle development laptop config page

Browse Source
This commit is contained in:
Philip Sargent 2021-10-22 16:18:09 +03:00
parent db0e1e634f
commit 7a614ccec8
9 changed files with 81 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
handbook/computing/basiclaptop.html
View File

@ -6,11 +6,11 @@
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body>
<h2 id="tophead">CUCC Expedition Handbook - Minimal laptop</h2>
<h2 id="tophead">CUCC Expedition Handbook - Basic laptop</h2>
<h1>Setting up a minimal Expo laptop</h1>
<h1>Setting up a basic Expo laptop</h1>
<h2>What you can do from any laptop</h2>
<h2 id="any">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
@ -33,18 +33,35 @@
<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>
<h3>Which laptop do you need?</h3>
<ul>
<li><a href="#any">Any laptop</a> with a broswer and email
<li>An <a href="#basic">expo basic laptop</a>
<li>A <a href="winlaptop.html">Windows expo basic laptop</a>
<li>A full <a href="yourlaptop.html">expo data maintenance computer</a> and Android phone config
<li>An <a href="../troggle/troglaptop.html">expo software development computer</a> for troggle programming
</ul>
<h2 id="basic">Your own basic 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 can take several hours to configure completely.
<p>To set up your own basic laptop for all cave data maintenance 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>Clone two <a href="../computing/repos.html">expo repositories</a> <var>loser</var> and <var>drawings</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> [actually <var>los</var> is still (Oct.2021) using mercurial not git.</li>
<li>Install survex, and therion or tunnel for editing cave data.
<li>Install image editing software such as Irfanview or gimp.
<li>If you are also planning on extensive work rewriting parts of the handbook, then you will also need the <a href="../computing/repos.html">expo repository</a> <var>expoweb</var>.
</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.
<p>The <em>expo laptop</em> is a basic laptop configuration. It has everything for editing and testing survey files (survex, aven, cavern), drawings (tunnel, therion), scanned images of sketches and centre-lines, and photographs. The <em>expo laptop</em> in the potato hut is also physically connected to a flatbed scanner but you can use your phone camera instead and email the images to yourself on your laptop.
<p>The <em>expo laptop</em> may also have some software for managing vector images (such as rigging guides), <a href="https://paperless.bheeb.ch/">PocketTopo</a> files, <a href="https://en.wikipedia.org/wiki/Geographic_information_system">GIS digital maps</a> and <a href="https://activityworkshop.net/software/gpsprune/development.html">GPS tracks</a>. See the <a href="yourlaptop.html">full data maintenance laptop configuration</a> for details.
<p>Managing large sets of photographs and scanned images, and managing several folders of these on your laptop and on <var>expofiles</var> on the server is finicky and time-consuming. Many programmers use rsync to help them with this, but if you have never used rsync, now is <em>not</em> the time to learn. Use filezilla and FTP. It is at this point that if you are using a Windows machine, you <em>really</em> need to <a href="winlaptop.html#problems">read about how expo uses hard and soft links and filenames on Windows</a>. If things get screwed up badly, it will need someone on a Linux machine to sort it out.
<p>Once you have got all 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 data maintenance 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>
@ -56,6 +73,7 @@ And please <b>write some documentation for the next person</b> in your situation
<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="fzconfig.html">Filezilla</a> - ftp GUI software with a configuration file to get to the expo server</li>
<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.

10
handbook/computing/contribute.html
View File

@ -139,11 +139,11 @@ a page or two on what you think would be a good idea (using the handbook editing
add a new design document).
<p>
Before you do anything substantial you will probably need to
<a href="basiclaptop.html">set up a minimal expo machine</a> and
then <a href="yourlaptop.html">set up a full configuration</a>. This
can take nearly a full day even if you are moderately competent at
configuring a Linux machine, but you don't need to install everything before
you can contribute to fixing things in the <a href="todo.html">Expo <em>Systems</em> To-Do List</a>.
<a href="basiclaptop.html">set up a basic expo machine</a> and
then <a href="yourlaptop.html">a data management configuration</a>. This
can take several hours, but you don't need to install everything before
you can contribute to fixing things in the <a href="todo.html">Expo <em>Systems</em> To-Do List</a>.
If you really want to get stuck into the code you will need a <a href="../troggle/troglaptop.html">troggle software development configuration</a>.
<p>Finally, if that all sounds like too much hassle for you, were are in desparate need
of a lot more very simple <a href="../troggle/unittests.html">unit tests for troggle</a>.

2
handbook/computing/onlinesystems.html
View File

@ -48,7 +48,7 @@ This page is the overview. The online systems manuals are split into these secti
<li><a href="gpxupload.html">Uploading GPS tracks</a></li>
<li><a href="../survey/newcave.html">Recording a new cave discovery</a></li>
<li><a href="manual.html">Data maintenance</a> - finding and updating cave survey data using online tools
<li><a href="yourlaptop.html">Configuring your own laptop</a> - for fixing /expofiles/ files with rsync and software work</li>
<li><a href="basiclaptop.html">Configuring your own laptop</a> - for managing drawings and survey files, photogrpahs and scanned images</li>
</ul>
<p><strong>Surveying and recording survey data is the reason all this exists.</strong> The "survey handbook" part of this handbook gives instructions to beginners for how to record discoveries and surveys. <p><a href="../survey/why.htm"><img class="onleft" src="go-caving-th.jpg"></a>The "data maintenance" manual is where to look for help when things go wrong: the data has been entered incorrectly, or software has crashed due to corrupt input data.
<p>The "system maintenance" manual may of interest to a caver who wonders how it is all put together but should not be needed by most people.

2
handbook/computing/repos.html
View File

@ -43,7 +43,7 @@ expo.survex.com:
<p>NOTE: when using git to path to a repository, always use user <var>'expo'</var> as the login user (<var>ssh://expo@...</var>) even though within git you will be identified by your own ssh key name. This is because file permissions on the server require this.
<p>So cavers wanting to upload their cave survey data have to use a machine on which they key is already set up. The <i>expo laptop</i> lives in the potato hut during expo and it is sometimes joined by the laptop '<i>aziraphale</i>'. These are both loaned machines running Linux. If you want to use your own laptop then
see the <a href="basiclaptop.html">minimal laptop setup</a>.
see the <a href="basiclaptop.html">basic laptop setup</a>.
<h3 id="git">Version control system</a></h3>

8
handbook/computing/winlaptop.html
View File

@ -12,9 +12,9 @@
<p>First read the generic instructions for all the software installations you will need:
<br>
<a href="yourlaptop.html">Setting up a machine for Expo</a>
<a href="basiclaptop.html">Setting up a basic Expo laptop</a>
<br>
<a href="basiclaptop.html">Setting up a minimal Expo laptop</a>
<a href="yourlaptop.html">Setting up a machine for Expo data maintenance</a>
</p>
<p>It used to be quite simple: software equivalents existed for Windows for everything we needed. Since Spring 2018, we unfortunately have to use ssh keys. This has simply added an extra step for most things, but has made one thing (rsync) really quite hard to get working.
@ -31,7 +31,7 @@
- large-scale updating of several folders at once on expofiles without overwriting other people's work (which means using rsync)<br />
- well not "hard" exactly, but complicated with lot of steps that are easy to get wrong and with poor feedback as to whether you have done each step correctly.
<li><a href="#bold">Things for the bold</a><br />
- using WSL2, Linux virtual machines and Docker containers
- using WSL2, Linux virtual machines and Docker containers.
</ul>
<h3 id="well">Things that already work well</h3>
@ -180,7 +180,7 @@ Now finally you can use all the usual command line tools at yor wsl command line
<tt><a href="https://man.openbsd.org/ssh">ssh command line</a></tt>
<h3>Installing and Configuring the rest of the software you need on Windows</h3>
<p>Now return to <a href="yourlaptop.html">the Your Laptop</a> page to configure all the rest of the software you need.
<p>Now return to <a href="yourlaptop.html">the data maintenance laptop</a> page to configure all the rest of the software you need.
<hr />

2
handbook/troggle/trogdjangup.html
View File

@ -70,7 +70,7 @@
<p>[ However django-extensions looks like it could be useful explicitly to help us through the upgrade process:
<a href="https://pypi.org/project/django-extensions/">pypi.org/project/django-extensions/</a> (only available for django 2.2 and later). ]
<h3>Important Tricks</h3>
<h3 id="djangotricks">Important Tricks</h3>
<p>There are six critical tricks that make everything much, much easier:
<ol>
<li>Use <a href="https://docs.python.org/3/library/venv.html">pip venv</a> or virtualenv to set up a virtual python environment within which you can easily and quickly change the specific releases of python, django, django's dependencies and django plugins.

3
handbook/troggle/trogindex.html
View File

@ -25,7 +25,8 @@
<li><a href="trogspeculate.html">Troggle Architecture Speculations</a> - as in April 2020<br>
<li><a href="trog2030.html">Troggle in 2025-2030</a> - architectural evolution proposal<br>
</ul>
<a href="serverconfig.html">Troggle server configuration</a> - how to get troggle running on a new machine (incoimplete!)<br>
<a href="troglaptop.html">Troggle laptop configuration</a> - how to gset up a software development machine<br>
<a href="serverconfig.html">Troggle server configuration</a> - how to get troggle running on a new machine (incomplete!)<br>
<a href="trogimport.html">Troggle - Data Import</a> - reset and import data<br>
<ul>
<li><a href="exportjson.html">Troggle - JSON export</a> - export data as JSON<br>

39
handbook/troggle/troglaptop.html Normal file
View File

@ -0,0 +1,39 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Handbook Troggle Laptop</title>
<link rel="stylesheet" type="text/css" href="../../css/main2.css" />
</head>
<body><style>body { background: #fff url(/images/style/bg-system.png) repeat-x 0 0 }</style>
<h2 id="tophead">CUCC Expedition Handbook</h2>
<h1>Troggle - software development laptop</h1>
<img src="https://www.python.org/favicon.ico" width=64 hspace="20" align="right" alt='python logo'>
<h2>Software development machine</h2>
<p>For troggle itself, you need a linux machine. We all use Debian or Debian-derived machines (Debian itself, Ubuntu, Xubuntu etc.) but other forms of linux may work. Running Debian or Ubuntu under WSL on Windows 10 works fine.
<p>This page is a work in progess. Text will be moved here from
<img border="1" class="onright" width="150px" src='tricky-troggle.jpg' alt='troggle logo'/></a>
<pre>
http://expo.survex.com/repositories/troggle/.git/tree/README.txt
handbook/troggle/serverconfig.html
handbook/computing/yourlaptop.html
handbook/computing/basiclaptop.html
handbook/computing/manual.html
handbook/troggle/trogdjangup.html
handbook/computing/qstart-git.html
</pre>
<hr />
Go on to: <a href="trogarch.html">Troggle architecture</a><br />
Return to: <a href="trognotes.html">Troggle programmers' guide</a><br />
Troggle index:
<a href="trogindex.html">Index of all troggle documents</a><br />
<hr />
</body>
</html>

2
handbook/troggle/trognotes.html
View File

@ -66,7 +66,7 @@ to <a href="../computing/contribute.html#programming">get involved in the progra
<li>Configure <a href="../computing/keyexchange.html">an ssh key</a> and <a href="../computing/fzconfig.html">Filezilla</a> or scp/sFTP.
<li>Configure a <a href="../computing/basiclaptop.html">minimal expo laptop</a>
<li>Configure a <a href="../computing/yourlaptop.html">basic expo laptop</a>
<li>Configure a <a href="../survey/nerd.html">troggle development machine</a> - a laptop where you have cloned the repos and installed django. Installing is the same as updating Django. See <a href="trogdjangup.html">Troggle: updating Django</a>.
<li>Configure a <a href="troglaptop.html">troggle development machine</a> - a laptop where you have cloned the repos and installed django. Installing is the same as updating Django. See <a href="trogdjangup.html">Troggle: updating Django</a>.
</ol>
<h3>Fixing broken URL dispatch</h3>