expo/expoweb
1
0
Fork 0
mirror of https://expo.survex.com/repositories/expoweb/.git/ synced 2025-01-18 00:42:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update yourlaptop page. Some extra software, an overview and a bit less didactic.

Browse Source
This commit is contained in:
Wookey 2020-01-06 23:56:10 +00:00
parent 298778bedd
commit e2fed7f2ab
1 changed files with 53 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
handbook/computing/yourlaptop.html
View File

@ -8,27 +8,36 @@
<body>
<h2 id="tophead">CUCC Expedition Handbook - Your laptop</h2>
<h1>Setting up an Expo laptop</h1>
<h1>Setting up a machine to access Expo data</h1>
<h2>Overview</h2>
<p>The main things you need to do to get set up are:</p>
<ul>
<li>Install software to access version control and edit/view caving data</li>
<li>Register an SSH key with the expo server (i.e 'get a login')</li>
<li>Download the expo repositories so you have the files on your machine</li>
</ul>
<h3>Operating Systems</h3>
<ul>
<li>The quickest way to get a complete setup is to use a <b>Debian Linux laptop</b>.
<br>
The <i>expo laptop</i> uses <a href="https://www.debian.org/intro/about">Debian</a> with the <a href="https://computingforgeeks.com/how-to-install-cinnamon-desktop-environment-on-debian/">Cinnamon</a> interface, but pretty much any Linux system works fine. This handbook does assume that you are using apt - the Debian package manager - which is good for all Debian-derived Linuxes such as <a href="https://ubuntu.com/">Ubuntu</a>. Old, slow machines without much memory can be very effective with <a href="https://xubuntu.org/">Xubuntu/xfce</a>.
<li>You should be able to use any OS to interact with expo, but it's a bit simpler to get set up using Linux or MacOS, rather than Windows, just because the core stuff will already be installed.</li>
<li>Windows machines can do almost everything needed (rsync is a problem), but some useful software has no Windows version and you will need to find your own equivalents. There are also dangerous 'gotchas' to look out for because the file-naming system is different. Do use Linux if you can.
The <i>expo laptop</i> uses <a href="https://www.debian.org/intro/about">Debian</a> with the <a href="https://computingforgeeks.com/how-to-install-cinnamon-desktop-environment-on-debian/">Cinnamon</a> interface, but pretty much any Linux system works fine. This handbook does assume that you are using apt - the Debian package manager - which is good for all Debian-derived Linuxes such as <a href="https://ubuntu.com/">Ubuntu</a>. Old, slow machines without much memory can be very effective with <a href="https://xubuntu.org/">Xubuntu/xfce</a>. If using a Red-Hat-based linux you'll need to work out the equivalent rpm/yum commands.</li>
<li><a href="winlaptop.html">A Windows laptop for expo</a> - a page of more detailed instructions for those who are definitely going to be using a Windows PC or laptop.
<li>Windows machines can do almost everything needed (rsync is a problem), but some useful software has no Windows version and you will need to find your own equivalents. There are also some 'gotchas' to look out for due to filesystem differences (e.g letter case). If you have the choice, use Linux.</li>
<li><a href="winlaptop.html">A Windows laptop for expo</a> - a page of more detailed instructions for those who are definitely going to be using a Windows PC or laptop.</li>
<li>Mac users will need to use the Linux documentation as a guide and work it all out for themselves.
<li>Mac users will need to use the Linux documentation as a guide and work it all out for themselves (and then hopefully update this handbook).</li>
<li>Android phone apps can be invaluable too.
<li>Android phone apps can be invaluable too.</li>
</ul>
<h3>Software</h3><a href="https://survex.com/screenshots.html"><img src="https://survex.com/img/aven-1.2.37-by-date.png" hspace="20" align="right" width="300"></a>
<p></a>Long-standing Expo policy is to retain absolute control of all software and all data.
<p></a>Long-standing Expo policy is to use open tools and protocols so we can retain control of our own data over the long term. And not to require expo-goers to sign up to external services or spend money on software.
So we use <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FOSS software</a>.
You can use other software on your own machine if it is format-compatible and exports data in the formats we want,
but all the recommended software here is open source (and please don't install proprietary software on the '<em>expo laptop</em>').</p>
@ -37,29 +46,33 @@ but all the recommended software here is open source (and please don't install p
<p>The list of software:
<ul>
<li><a href="https://git-scm.com/">git</a> - distributed version control system - already installed on Linux probably
<li><a href="https://tortoisehg.bitbucket.io/"> TortoiseHg</a> - GUI to mercurial (to be deprecated during 2020)
<li><a href="https://www.mercurial-scm.org/">mercurial</a> - distributed version control system (to be deprecated during 2020)
<li><a href="../fzconfig.html">Filezilla</a> - ftp GUI software with a configuration file to get to the expo server
<li><a href="https://git-scm.com/">git</a> - distributed version control system - already installed on Linux probably</li>
<li><a href="https://tortoisehg.bitbucket.io/"> TortoiseHg</a> - GUI to mercurial (to be deprecated during 2020)</li>
<li><a href="https://www.mercurial-scm.org/">mercurial</a> - distributed version control system (to be deprecated during 2020)</li>
<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://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.
<li><a href="https://bitbucket.org/AndrewA/topparser/src/default/">TopParser</a> - to convert PocketTopo .top files from a DistoX into Therion.
<li><a href="http://wscc.darkgem.com/caveconverter/">Footleg Cave Converter</a> - to convert PocketTopo .top files from a DistoX into survex (Java)
<li><a href="https://www.qgis.org/en/site/">QGIS</a> - A Free and Open Source Geographic Information System
<li><a href="https://www.qgis.org/en/site/">QGIS</a> - A Geographic Information System
<li><a href="https://activityworkshop.net/software/gpsprune/development.html">GPSprune</a> - to edit GPS tracks in GPX files (Java).
<li><a href="https://sourceforge.net/projects/viking/">Viking</a> - an alternative to GPSprune. The <a href="https://github.com/viking-gps/viking">code</a> is on github.
<li>python, if you are extending troggle or the scripts in expoweb/noinfo/ - already installed on Linux <img src="https://www.python.org/favicon.ico" width=64 hspace="20" align="right">
<li>python packages you will want to install: [<em>not yet documented</em>]
<li><a href="https://github.com/patrickbwarren/qgis3-survex-import">qgis3-survex-import</a> - plugin to import/export survex .3d files</li>
<li><a href="http://www.thomas-holder.de/projects/inkscape-speleo/extensions/">inkscape-speleo</a> - plugin to import/export survex, therion and pockettopo files to the drawing package inkscape.
</ul>
<p>Nearly all our Austrian surveys have beeen produced using Tunnel but we are moving to Therion for new caves because Therion does elevations properly and Tunnel never will.</p>
<p>Nearly all our Austrian surveys have beeen produced using Tunnel (or were hand-drawn) but many smaller caves and some areas of SMKsystem are done with Therion because Therion does elevations and Tunnel doesn't.</p>
<a href="https://therion.speleo.sk/2D.php"><img src="https://therion.speleo.sk/img/head.jpg" hspace="20"></a>
<p>Note that on a Debian/Ubuntu machine you should normally install the versions that come with the distro, not be getting things fromthe above sites</p>
<p>For Linux users only:
<ul>
<li><a href="https://git-scm.com/download/gui/linux">GUI for git</a> - There is a choice on Linux but many people just use the command line.
<li>Your favourite syntax-highlighting code editor. gedit is installed on the <em>expo laptop</em> has syntax highlighting for .svx files too. This works with <a href="https://survex.com/changes.html">all GtkSourceView-based editors</a> (thanks to Phil Withnall).
<li>Your favourite text editor. gedit is installed on the <em>expo laptop</em> and has syntax highlighting for .svx files too. This works with <a href="https://survex.com/changes.html">all GtkSourceView-based editors</a> (thanks to Phil Withnall).
</ul>
<p>For Windows users only:
@ -90,10 +103,9 @@ but all the recommended software here is open source (and please don't install p
<h3>Logins to external systems</h3>
<ul>
<li><a href="https://github.com/join">Github</a> - create your own github account if you don't have one already.
<li><a href="https://github.com/join">Github</a> - You'll need an account if you want to use this.
<li><a href="https://bitbucket.org/product/">Bitbucket</a> - create an account to help develop tunnel. <img src="https://tortoisehg.bitbucket.io/img/bitbucket-icon.png" width=64 hspace="20" align="right">
<li><a href="https://trac.survex.com/wiki">Trac issue tracker and wiki</a> for developing survex
<li><a href="https://launchpad.net/">Launchpad</a> - create an account to help develop survex.
<li><a href="https://trac.survex.com/wiki">Trac issue tracker and wiki</a> for developing survex. You'll need a login to file bugs there.
</ul>
<p>You should also have a look at, and keep up to date with:
@ -109,22 +121,21 @@ a wiki on github discussing workflows to generate centerlines, GEOTIFF and QGIS
<h3>Configuration</h3>
You need to do the
<a href="keyexchange.html">key exchange</a> procedure - which you can only do entirely on your own if
you have access to the <i>expo laptop</i> to upload and install the public key generated by your laptop. Do this first, Without it none of git, mercurial, scp, ftp or rsync will work.
<p>You need 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, mercurial, scp, ftp or rsync will work.
You can do this entirely on your own if you have access to the <i>expo laptop</i> to upload and install the public key generated by your laptop.</p>
<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.
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>
<p>The above gets TortoiseHg and the command-line PuTTY tools (ssd, sftp, pscp) running, but doesn't get Cygwin rsync working. You might like to try <a href="https://stackoverflow.com/questions/23517023/rsync-from-windows-to-linux-using-puttys-pagent-authentication">this</a> (untested).
<p>The above gets TortoiseHg and the command-line PuTTY tools (ssd, sftp, pscp) running, but doesn't get Cygwin rsync working. You might like to try <a href="https://stackoverflow.com/questions/23517023/rsync-from-windows-to-linux-using-puttys-pagent-authentication">this</a> (untested).</p>
<p>Full illustrated instructions:<img src="https://wiki.filezilla-project.org/favicon.ico" width=64 hspace="20" align="right">
<p>Full illustrated instructions:<img src="https://wiki.filezilla-project.org/favicon.ico" width=64 hspace="20" align="right"></p>
<ul>
<li><a href="../tortoise/tortoise-win.htm">Installing TortoiseHg and PuTTy on Windows</a>.
<li><a href="../tortoise/tortoise-win.htm">Installing TortoiseHg and PuTTy on Windows</a>.</li>
<li><a href="../fzconfig.html">Installing Filezilla</a>.
<li><a href="../fzconfig.html">Installing Filezilla</a>.</li>
<li><a href="https://tortoisehg.readthedocs.io/en/latest/quick.html">Quick Start guide o TortoiseHg</a>.
</ul>