Installing and Running

From Fs_wiki

Jump to: navigation, search

Contents

Getting Java SE Development Kit / JDK 6

You must have a Java Runtime Environment (JRE) installed on your computer in order to run Tunnel. Versions for most operating systems are available at the link above. You are advised, however, to install the much larger Java Development Kit (JDK), which contains the JRE as well as a compiler. This will make it easier to get bugfixes and feature improvements because you will have access to the sourcecode itself.

Download and install JDK 6 for free from [1]. This contains the compiler as well as a runtime environment.

Easy Tunnel Install for Windows Users

Your options include the very latest version in the form of a JAR file

tunnel2009-09-26.jar

into a directory of your choice (eg inside one called "caving"). This is a single file and you can simply run it by double-clicking on it or run it from the command line (see below, Runnng Tunnel section).

For Windows users, there is an installer package from User:Footleg. The zip file contains instructions in a readme file. You will still need to download and install the Java Runtime Environment as explained above. This version was built from the source code on Oct. 1st, 2009 and has been tested for stability using some large system surveys from Matienzo.

Download Tunnel_Install.zip (uploaded 2009-12-02 after testing code compiled on 2009-10-01)

Unzip this to your C:\ drive to create the folder C:\Tunnel rather than under Program Files, as Windows blocks Tunnel from writing temporary data files under Program Files and therefore the Survex integration will not work! Alternatively unzipping it somewhere under your My Documents or the Shared Documents folders should work OK.

Note: These require version 6 of the Java Runtime.
Directly from the Mercurial repository on Source Forge

This is preferable if you want the most recent version, particularly one incorporating the most recent bugs and features. You will then need to compile Tunnel before you can run it).

Note: The latest code is no longer in CVS. It is using a Mercurial based source repository now. So the installer package above is a more recent version than you will get from CVS. (See instructions on the page Tunnel from CVS for the old CVS instructions if you really need them).
An online applet version

Not actually a download, but your browser is up to the job, this should give you a taste of the user interface without having the hassle of installing Java properly. Does not have the capability to save your work.

An example cave drawn by Neil Pacey using Tunnel is available from Media+Inlet7sketches.zip, but for the complete picture you will also need to download his original pencil drawings from Inlet7rawscans.zip (3.3Mbs).

Running Tunnel

If you have downloaded the Tunnel.jar file (see above section) it can be run by simply double-clicking on this file.

However, it is better to run Tunnel from a command line opened from in the directory that the Tunnel.jar file is in because then you can see error messages in the command window if there is a problem (like Tunnel crashes). To run Tunnel from a command line type:

> java -jar Tunnel.jar

If you are in Windows and don't know what a command line is, you open one using the Command Prompt item under Accessories on your start menu. On some computers you might find in Windows Explorer that you can single click on the directory that contains the Tunnel.jar file then right click and select Command Prompt Here. This makes the command line, a black window with a cursor. Then you can type the command above. If you open the command prompt from the start menu then you will need to navigate to the folder containing the jar file using the command 'cd <path>' where <path> is the folder you want to navigate to (e.g. cd c:\Tunnel ).

Much easier if you are not familiar with command prompts is to download the zip file installer and then simply double-click on the run, or run.bat file in Windows Explorer in the folder where you unpacked the zip file.

If you have installed Tunnel from the source code repository, you can also start Tunnel by double-clicking on the file called "r.bat" in the directory containing the Tunnel.jar file and it should start up. "r.bat" is a batch file or shell script called to save some typing:

> java -Xmx200M -cp . Tunnel.MainBox inlet7

The "-Xmx200M" is to give Java lots of memory to work with if it needs it (200Mb, or thereabouts). The final word, "inlet7" makes it autoload the example to save going through the file-dialog thing every time.

If none of the above works, contact julian@goatchurch.org.uk for further ideas.

If Tunnel does start up, the following "Sketch List" window should appear on the screen:

Navigation

-->
Navigation
Toolbox