// Subsurface 4.2 User Manual
// ==========================
// :author: Manual authors: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg,
// Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem
// Ferguson, Salvador Cuñat
// :revnumber: 4.2
// :revdate: July 2014
:icons:
:toc:
:toc-placement: manual
:numbered:
// :website: http://subsurface.hohndel.org
image::images/Subsurface4Banner.png["Banner",align="center"]
[big]USER MANUAL
Manual authors: Willem Ferguson, Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Salvador Cuñat
[blue]Version 4.2, August 2014
Welcome as a user of Subsurface, an advanced dive logging program with extensive infrastructure to describe, organise, interpret and print scuba and free dives. Subsurface offers many advantages over other similar software solutions:
Subsurface binaries are available for Windows PCs (Win XP or later), Intel based Macs (OS/X) and many Linux distributions. Subsurface can be built for many more hardware platforms and software environments where Qt and libdivecomputer are available.
The scope of this document is the use of the Subsurface program. To install the software, consult the Downloads page on the http://subsurface.hohndel.org/[Subsurface web site]. Please discuss issues with this program by sending an email to mailto:subsurface@hohndel.org[our mailing list] and report bugs at http://trac.hohndel.org[our bugtracker]. For instructions on how to build the software and (if needed) its dependencies please consult the INSTALL file included with the source code.
Audience: Recreational Scuba Divers, Free Divers, Tec Divers, Professional Divers
toc::[]
[[S_UserSurvey]]
In order to develop Subsurface in a way that serves its users in the best possible way, it is important to have some user information. Upon launching Subsurface after using this software for a week or so, a one-box user survey pops up. It is entirely optional and the user controls what, if any, data are sent to the Subsurface development team. Any data that the user chooses to send is extremely useful, and will only be used to steer future development and to customise the software to fit the needs of the Subsurface users. If one completes the survey, or clicks the option not to be asked again, that should be the last communication of this nature one receives. However, if one's diving and/or subsurface habits change and one wishes to provide another survey, this can be done by launching Subsurface with the --survey option on the command line.
[[S_StartUsing]]
Start Using the Program
The Subsurface window is usually divided into four panels with a Main Menu (File Import Log View Filter Help) at the top of the window (for Windows and Linux) or the top of the screen (for Mac and Ubuntu Unity). The four panels are:
The dividers between panels can be dragged in order to change the size of any of the panels. Subsurface remembers the position of the dividers, so the next time Subsurface starts it uses the positions of the dividers from when the program was last used.
If a dive is selected in the Dive List, the dive location, detailed information
and profile of
the selected dive are shown in the respective panels. On the other hand, if
one highlights more than one dive the last highlighted dive is the selected
dive, but summary data of all highlighted dives are shown in the Stats tab
of the Dive Info panel (maximum, minimum and average depths, durations, water
temperatures and SAC; total time and number of dives selected).
[[S_ViewPanels]]
image::images/main_window.jpg["The Main Window",align="center"]
The user can determine which of the four panels are displayed by selecting the View option on the main menu. This feature gives the user several choices of display:
All: show all four of the panels as in the screenshot above.
Divelist: Show only the Dive List.
Profile: Show only the Dive Profile of the selected dive.
Info: Show only the Dive Notes about the last selected dive and statistics for all highlighted dives.
Globe: Show only the world map, centred on the last selected dive.
Like many other functions that can be accessed via the Main Menu, these options can be triggered using keyboard shortcuts. The shortcuts for a particular system are shown with an underline in the main menu entries. Since different Operating Systems and the user chosen language may cause Subsurface to use different shortcut keys they are not listed here in the user manual.
When the program is started for the first time, it shows no information at all. This is because the program doesn't have any dive information available. In the following sections, the procedures to create a new logbook will be described.
[[S_NewLogbook]]
Creating a new logbook
[[S_GetInformation]]
== How to store dive information in the user's logbook
There are several ways in which dive information can be added to a logbook:
[[S_EnterData]]
=== Entering dive information by hand
This is usually the approach for dives without a dive computer. The basic record
of information within Subsurface is a dive. The most important information
in a simple dive logbook usually includes dive type, date, time, duration,
depth, the names of your dive buddy and of the dive master or dive guide, and
some remarks about the dive. Subsurface can store much more information
than this for each dive. In order to add a dive to a dive log, select Log
-> Add Dive from the Main Menu. The program then shows three panels to enter
information for a dive: two tabs in the Dive Info panel (Dive Notes and
Equipment), as well as the Dive Profile panel that displays a graphical profile
of each dive. These panels are respectively marked [red]A, [red]B and
[red]C
in the figure below. Each of these tabs will now be explained for data entry.
image::images/AddDive1.jpg["FIGURE: Add dive",align="center"]
When one edits a field in Dive notes or Equipment panels, Subsurface enters Editing Mode, indicated by the message in the blue box at the top of the Dive Notes panel. This message is displayed in all the panels under Dive notes and Equipment when in Editing Mode.
////
Not displaying the edit bar as the Save and Cancel buttons are on reverse order when comparing to
the full screenshot.
image::images/BlueEditBar.jpg["Blue edit bar",align="center"] ////
==== Dive Notes
This panel contains the date, time and place information for a particular dive, environmental conditions, co-divers and buddies, as well as some descriptive information. If one clicks on the Dive Notes tab, the following fields are visible:
image::images/AddDive2.jpg["FIGURE: The Dive Notes tab",align="center"]
The Time field reflects the date and the time of the dive. By clicking the date, a calendar is displayed from which one can choose the correct date. Press ESC to escape from the calendar. The time values (hour and minutes) can also be edited directly by clicking on each of them in the text box and by overtyping the information displayed. The default date is the present date and the default time is an hour in advance of the present time.
Air and water temperatures: the air and water temperatures during the dive can be typed directly on the fields to the right of the Start time. Temperature units are not needed, as they will be automatically supplied by Subsurface. Only the numerical value must be typed by the user (the units selected in the 'Preferences' will determine whether metric or imperial units are used).
Location: Here the name of the dive site can be entered, e.g. "Tihany, Lake
Balaton,
Hungary". Auto completion of location names will make this easier if one
frequently dives at the same sites.
Coordinates: The geographic coordinates of the dive site should be entered here. These can come from three sources:
ISO 6709 Annex D format e.g. 30°13'28.9"N 30°49'1.5"E
Degrees and decimal minutes, e.g. N30° 13.49760' , E30° 49.30788'
Degrees minutes seconds, e.g. N30° 13' 29.8" , E30° 49' 1.5"
Decimal degrees, e.g. 30.22496 , 30.821798
Southern hemisphere latitudes are given with a S, e.g. S30°, or with a negative value, e.g. -30.22496. Similarly western longitudes are given with a W, e.g. W07°, or with a negative value, e.g. -7.34323.
Please note that GPS coordinates of a dive site are linked to the Location name - so adding coordinates to dives that do not have a location description will cause unexpected behaviour (Subsurface will think that all of these dives have the same location and try to keep their GPS coordinates the same).
Divemaster: The name of the dive master or dive guide for this dive can be
entered here.
Again, this field offers auto completion based on the list of dive masters in
the current logbook.
Buddy: In this field one can enter the name(s) of the buddy / buddies (separated by commas) who accompanied the user on the dive. Auto completion is offered based on the list of buddies in the current logbook.
Suit: The type of diving suit used for the dive can be entered here. As with the other items, auto completion of the suit description is available. Some dry-suit users may choose to use this field to record what combination of suit and thermal protection undersuit was used.
Rating: One can provide a subjective overall rating of the dive on a 5-point scale by clicking the appropriate star on the rating scale.
Visibility: Similarly, one can provide a rating of visibility during the
dive on a
5-point scale by clicking the appropriate star.
Tags: Tags that describe the type of dive performed may be entered here (separated by commas). Examples of common tags are boat, drift, training, cave etc. Subsurface has many built-in tags. Auto completion is once again offered. For instance, if +cav+ was typed, then the tags cave and cavern are shown for the user to choose from.
Notes: Any additional information can be typed here.
The Save and Cancel buttons are used to save all the information for tabs in the info panel and in the dive profile panel, so there's no need to use them until ALL other information has been added. Here is an example of a completed Dive Notes panel:
image::images/CompletedDiveInfo.jpg["FIGURE: A completed Dive Notes tab",align="center"]
==== Equipment
The Equipment tab allows the user to enter information about the type of
cylinder and gas used, as well as the weights used for a dive. This is a highly interactive part of
Subsurface and the information on
cylinders and gases (entered here) affects the behaviour of the dive profile
(top right-hand panel).
[[S_CylinderData]]
Cylinders: The cylinder information is entered through a dialogue that looks
like this:
image::images/Gas_dialogue1.jpg["FIGURE:Initial cylinder dialogue",align="center"]
The + button at the top right allows the user to add more cylinders for this
dive.
The dark dustbin icon on the left allows one to delete information for a
particular cylinder. Note that it is not possible to delete a cylinder if it is used during the
dive. One cylinder is implicitly used in the dive, even without a gas change event. Thus the first
cylinder cannot be deleted until another cylinder is created.
Start by selecting a cylinder type on the left-hand side of the table. To select a cylinder, click in the Type box. This brings up a button that can be used to display a dropdown list of cylinders:
image::images/Gas_dialogue2.jpg["FIGURE:The cylinder drop-down list button",align="center"]
The drop-down list can be used to select the cylinder type used for the dive or the user may start typing in the box which shows the available options for the entered characters. The Size of the cylinder as well as its working pressure (WorkPress) will automatically be shown in the dialogue. If a cylinder is not shown in the dropdown list, type the name and description of that cylinder into the Type field.
Next, indicate the starting pressure and the ending pressure of
the
gas used during the dive. The unit of pressure (metric/imperial) corresponds
to the setting in the Preferences.
Finally, type in the gas mixture used in the O2% field. If air
was used, a value of 21% can be entered on this field, or it might be
left blank. If nitrox or trimix were used, their percentages of oxygen and/or
helium must be specified.
Any inappropriate fields should be left empty. After typing the information for
the cylinder, press ENTER on the keyboard or click
outside the cell that contains the cursor. Information for any additional
cylinders can be added by using the + button at the top right hand. Following
is an example of a complete description for a
dive made using two cylinders (air and EAN50):
image::images/CylinderDataEntry3.jpg["FIGURE: a completed cylinder dive information table",align="center"]
Weights: Information about the weight system used during a dive can be entered using a dialogue very similar to that for the cylinder information. If the user clicks the + button on the top right of the weights dialogue, the table looks like this:
image::images/WeightsDataEntry1.jpg["FIGURE: The Weights dialogue",align="center"]
If one then clicks on the Type field, a drop-down list becomes accessible through a down-arrow:
image::images/WeightsDataEntry2.jpg["FIGURE: Weights type drop-down list button",align="center"]
The drop-down list can then be used to select the type of weight system or the user may start
typing in the box which shows the available options for the entered characters. In
the Weight
field, the weight used during the dive must be typed. After typing the
information
for the weight system the user must either press ENTER on the keyboard or
click outside the
cell that contains the cursor. It is possible to enter
information for more than one weight system by adding an additional system using
the + button on the top right hand. Weight systems can be deleted using the
dustbin icon on the left hand. Here is an example of information for a dive
with two types of weights: integrated and a weight belt:
image::images/WeightsDataEntry3.jpg["FIGURE: A completed weights information table",align="center"]
There's NO need to click the Save button before the dive profile has been completed.
[[S_CreateProfile]]
==== Creating a Dive Profile
The Dive Profile (a graphical representation of the depth of the dive as a function of time) is indicated in the panel on the top right hand of the Subsurface window. When a dive is manually added to a logbook, Subsurface presents a default dive profile that needs to be modified to best represent the dive being described:
image::images/DiveProfile1.jpg["FIGURE: Initial dive profile",align="center"]
Modifying the dive profile: When the cursor is moved around the dive profile,
its position is indicated by two coloured lines (red and green) as shown below.
The depth and time
that the cursor represents are indicated at the top of the black information box
(@ and D). The units (metric/imperial) on the axes are determined by the
Preference settings. The dive profile itself comprises several
line segments demarcated by waypoints (white dots on the profile, as shown
above). The default dive depth is 15 m.
If the dive depth was 20 m then the user needs to drag the appropriate waypoints
downwards to represent 20 m. To add a waypoint, double-click on
any line segment. To move an additional waypoint, drag it.
To remove this waypoint, right-click on it and choose "Remove this point" from the
context menu. The user needs to drag the waypoints to represent an
accurate
time duration for the dive. Below is a dive profile that represents a dive
to 20 m for 30 min, followed by a 5 minute safety stop at 5 m.
image::images/DiveProfile2.jpg["FIGURE: Edited dive profile",align="center"]
Specifying the gas composition: The gas composition used is clearly indicated
along the line segments of the dive profile. This defaults to the first gas
mixture specified in the Equipment tab, which was air in the case of the
profile illustrated above. The gas mixtures of segments of the dive profile can
be edited. This is done by right-clicking on the particular
waypoint and selecting the appropriate gas from the context menu. Changing
the gas for a waypoint affects the gas shown in the segment to the left of
that
waypoint. Note that only the gases defined in the Equipment tab appear in the
context menu.
image::images/DiveProfile3.jpg["FIGURE: Gas composition context menu",align="center"]
Below is the profile of a dive to 20 m for 30 min and with a switch from air to EAN50 at the end of the duration at 20m. In this case the first cylinder in the Equipment tab contained air and the second cylinder contained EAN50.
image::images/DiveProfile4.jpg["FIGURE: Completed dive profile",align="center"]
==== Saving the hand-entered dive information
The information entered in the Dive Notes tab, the Equipment tab as well as
the Dive Profile can now be saved in the user's logbook by using the two
buttons
on the top right hand of the Dive Notes tab. If the Save button is clicked,
the dive data
are saved in the current logbook. If the Cancel button is clicked, the newly
entered
dive data are discarded. When exiting Subsurface, the user will be prompted
once more to save the logbook with the new dive(s).
[[S_ImportDiveComputer]]
=== Importing new dive information from a Dive Computer
==== Connecting and importing data from a dive computer.
The use of dive computers allows the collection of a large amount of
information about
each dive, e.g. a detailed record of depth, duration, rates of ascent/descent
and of gas partial pressures. Subsurface can capture this information and
present it as part of the dive information, using dive
information from a wide range of dive computers. The latest list of supported
dive computers can be found at:
link:http://subsurface.hohndel.org/documentation/supported-dive-computers/[
Supported dive computers].
[icon="images/icons/warning2.png"]
[WARNING]
Several dive computers consume more power when they are in their
PC-Communication mode. **This could drain the dive computer's battery**. We
therefore
recommend that the user checks if the dive computer is charged when
connected to the USB port of a PC. For example, several Suunto and Mares dive
computers do not recharge through the USB connection. Users should refer to
the dive computer's manual
if they are unsure whether the dive computer recharges its batteries
while connected to the USB port.
To import dive information from a dive computer to a computer with
Subsurface,
it is necessary that the two pieces of equipment communicate with one another.
This
involves setting up the communications port (or mount point) of the computer
with Subsurface that communicates with the dive computer. In order to set up
this communication, one needs to find the appropriate information to
instruct
Subsurface where and how to import the dive information.
xref:appendixaoperatingsystem_specific_information_for_importing_dive_information_fromadive_computer[Appendix A]
provides the technical information to help the user achieving this for different
operating
systems and
xref:appendixbdivecomputer_specific_information_for_importing_dive_information[Appendix B]
has dive computer specific information.
After this, the dive computer can be hooked up to the user's PC, which can be achieved by following these steps:
or Bluetooth connection set up as described later in this manual)
(Users should refer to the manual of their specific dive computer)
image::images/ImportFromDC1.jpg["FIGURE: Download dialogue 1",align="center"]
Dive computers tend to keep a certain number of dives in their memory, even though these dives have already been imported to Subsurface. For that reason Subsurface only imports dives that have not been uploaded before. This makes the download process faster on most dive computers and also saves battery power of the dive computer (at least for those not charging while connected via USB). If, for some reason, the user wishes to import ALL dives from the dive computer, even though some may already be in the logbook, then check the check box labelled Force download of all dives.
If the Subsurface computer does not recognise the USB adaptor by showing an appropriate device name next to the Mount Point, then there is a possibility that the cable or USB adaptor is faulty. A faulty cable is the most common cause of communication failure between dive computer and Subsurface computer. It is also possible that the Subsurface computer cannot interpret the data. Perform a download for diagnostic purposes with the following two check boxes checked in the download dialogue discussed above:
Save libdivecomputer logfile
Save libdivecomputer dumpfile
Important: These check boxes are only used when problems are encountered during the download process: under normal circumstances they should not be checked. When checking these boxes, the user is prompted to select a folder to save the information to. The default folder is the one in which the Subsurface dive log is kept.
Important: After downloading with the above checkboxes
checked, no dives are added to the
Dive List but two files are created in the folder selected above:
subsurface.log
subsurface.bin
These files should be send to the Subsurface mail list:
_subsurface@hohndel.org_ with a
request for the files to be analysed. Provide the dive computer
make and model
as well as contextual information about the dives recorded on the dive computer.
[[S_DeviceNames]]
==== Changing the name of a dive computer
It may be necessary to distinguish between different dive computers used to upload dive logs to Subsurface. For instance if one's partner's dive computer is the same make and model as one's own and dive logs are uploaded from both dive computers to the same Subsurface computer, then one would perhaps like to call one dc "Alice's Suunto D4" and the other one "Bob's Suunto D4". Alternatively, perhaps a technical diver dives with two or more dive computers of the same model, the logs of both (or all) being uploaded. In this case it might be prudent to call one of them "Suunto D4 (1)" and another one "Suunto D4 (2)". This is easily done in Subsurface. On the Main Menu, select Log -> Edit device names. A dialog opens, indicating the current Model, ID and Nickname of the dive computers used for upload. Edit the Nickname field for the appropriate dive computer. After saving the Nickname, the dive logs show the nickname for that particular device instead of the model name, allowing easy identification of devices.
[[S_EditDiveInfo]]
==== Updating the dive information imported from the dive computer.
The information from the dive computer is not complete and more
details must be added in order to have a fuller record of the dives. To
do this,
the Dive Notes and the Equipment tabs on the top left hand of the
Subsurface window should be used.
==== Dive Notes
The date and time of the dive, gas mixture and (often) water temperature is shown as obtained from the dive computer, but the user needs to add some additional information by hand in order to have a more complete dive record. If the contents of this tab is changed or edited in any way, the message in a blue box at the top of the panel indicates that the dive is being edited. If one clicks on the Dive Notes tab, the following fields are visible:
image::images/AddDive3.jpg["FIGURE: The Dive Notes tab",align="center"]
The Time field reflects the date and time of the dive. By clicking the date, a calendar is displayed from which one can choose the correct date. Press ESC to close the calendar. The time values (hour and minutes) can also be edited directly by clicking on each of them in the text box and by overtyping the information displayed.
Air/water temperatures: Air and water temperatures during the dive are shown
in these fields to the right of the Start time. Many dive computers supply water
temperature information and this field may therefore not require further
editing. If air temperature is not provided by the dive computer, the first temperature reading
might be used for the air temperature. Generally this is close enough to the real air temperature as
the change in the temperature sensor reading is quite slow to follow the changes in the environment.
If editing is required, only a value is required, the units of temperature will be
automatically supplied by
Subsurface (according to the Preferences, metric or imperial units will
be used).
Location: In this field one should type in text that describes the site
where the dive was performed, e.g. "Tihany, Lake Balaton, Hungary".
Auto completion of location names will
make this easier if one frequently dives at the same sites.
Coordinates: The geographic coordinates of the dive site should be entered here. These can come from three sources:
ISO 6709 Annex D format e.g. 30°13'28.9"N 30°49'1.5"E
Degrees and decimal minutes, e.g. N30° 13.49760' , E30° 49.30788'
Degrees minutes seconds, e.g. N30° 13' 29.8" , E30° 49' 1.5"
Decimal degrees, e.g. 30.22496 , 30.821798
Southern hemisphere latitudes are given with a S, e.g. S30°, or with a negative value, e.g. -30.22496. Similarly, western longitudes are given with a W, e.g. W07°, or with a negative value, e.g. -7.34323.
Please note that GPS coordinates of a dive site are linked to the Location name - so adding coordinates to dives that do not have a location description will cause unexpected behaviour (Subsurface will think that all of these dives have the same location and try to keep their GPS coordinates the same).
Divemaster: The name of the dive master or dive guide for this dive should be
entered in this field
which offers auto completion based on the list of dive masters in
the current logbook.
Buddy: In this field, one enters the name(s) of the buddy / buddies (separated with commas) who accompanied him/her on the dive. Auto completion based on the list of buddies in the current logbook is offered.
Suit: Here the type of diving suit used for the dive can be entered. Auto completion of the suit description is available. Some dry-suit users may choose to use this field to record what combination of suit and thermal protection undersuit was used.
Rating: One can provide a subjective overall rating of the dive on a 5-point scale by clicking the appropriate star on the rating scale.
Visibility: Similarly, one can provide a rating of visibility during the
dive on a
5-point scale by clicking the appropriate star.
Tags: Tags that describe the type of dive performed can be entered
here (separated by commas). Examples of common tags are boat, drift, training,
cave, etc.
Subsurface has many built-in tags. If the user starts typing a tag, the
program
will list the tags that correspond to the typing. For instance, if the user
typed
+cav+, then the tags cave and cavern are shown for the user to choose from.
Notes: Any additional information for the dive can be entered here.
The Save and Cancel buttons are used to save all the information for tabs in the info panel and in the dive profile panel, so there's no need to use them until ALL other information has been added. Here is an example of a completed Dive Notes panel:
image::images/CompletedDiveInfo.jpg["FIGURE: A completed Dive Notes tab",align="center"]
==== Equipment
The Equipment tab allows one to enter information about the type of cylinder and gas used as well as the weights used for the dive. The message in a blue box at the top of the panel:
image::images/BlueEditBar.jpg["FIGURE: Blue edit bar",align="center"]
indicates that the dive is being edited. This is a highly interactive part of
Subsurface and the information on
cylinders and gases (entered here) determines the behaviour of the dive profile
(top right-hand panel).
Cylinders: The cylinder information is entered through a dialogue that looks like this:
image::images/DC_gas_dialogue1.jpg["FIGURE: Initial cylinder dialogue",align="center"]
In most cases Subsurface obtains the gas used from the dive computer and automatically inserts the gas composition(% oxygen) in the table. The + button at the top right allows the user to add more cylinders for this dive. The dark dustbin icon on the left allows the deletion of information for a cylinder. Note that it is not possible to delete a cylinder if it is used during the dive. A cylinder might be implicitly used in the dive, even without a gas change event.
The user should start by selecting a cylinder type on the left-hand side of the table. To select a cylinder, the cylinder type box should be clicked. This brings up a list button that can be used to display a dropdown list of cylinders:
image::images/DC_gas_dialogue2.jpg["FIGURE: The cylinder drop-down list button",align="center"]
The drop-down list can then be used to select the cylinder type that was used for this dive or the user may start typing in the box which shows the available options for the entered characters. The Size of the cylinder as well as its working pressure (WorkPress) will automatically be shown in the dialogue.
Next one must indicate the starting pressure and the ending pressure of the specified gas during the dive. The unit of pressure (metric/imperial) corresponds to the settings chosen in the Preferences.
Finally, provide the gas mixture used. If air was used, the
value of 21% can be entered or this field can be left blank. If nitrox or
trimix were used, their percentages of oxygen and/or helium should be entered.
Any inappropriate fields should be left empty. After typing the
information for the cylinder,
either press ENTER on the keyboard or click outside the cell
that contains
the cursor. Information for any additional cylinders can be added by using the +
button at the top right hand. Following is an example of a complete description
for a dive using two cylinders (air and EAN50):
image::images/CylinderDataEntry3.jpg["FIGURE: a completed cylinder dive information table",align="center"]
Weights: Information about the weight system used can be entered
using a dialogue very similar to that of the cylinder information. If one
clicks
the + button on the top right of the weights dialogue, the table looks like
this:
image::images/WeightsDataEntry1.jpg["FIGURE:The Weights dialogue",align="center"]
By clicking on the Type field, a drop-down list becomes accessible through a down-arrow:
image::images/WeightsDataEntry2.jpg["FIGURE:Weights type drop-down list button",align="center"]
The drop-down list can then be used to select the type of weight system
used during the dive or the user may start typing in the box
which shows the available options for the entered characters.
In the Weight
field, type in the amount of weight used during the dive. After
specifying the weight
system, the user can either press ENTER on the keyboard or click outside the
cell with the cursor.
It is possible to enter information for more than one weight system by adding
an additional system
using the + button on the top right hand. Weight systems can be deleted using
the dustbin icon on the left hand. Here is an example of information for a dive
with two types of weights: integrated as well as a weight belt:
image::images/WeightsDataEntry3.jpg["FIGURE: A completed weights information table",align="center"]
==== Adding Bookmarks to a dive
Many divers wish to annotate their dives with text that indicate particular events during the dive, e.g. "Saw dolphins", or "Released surface bouy". This is easily done:
image::images/Bookmarks.jpg["FIGURE: Bookmark dialog",align="center"]
==== Saving the updated dive information
The information entered in the Dive Notes tab and the Equipment tab can be
saved by
using the
two buttons on the top right hand of the Dive Notes tab. If the Save button
is clicked,
the dive data are saved. If the Cancel button is clicked, then the newly
entered dive data are
deleted, although the dive profile obtained from the dive computer will be
retained. When the user exits Subsurface there is a final prompt to confirm
that the new data should be saved.
=== Importing dive information from other digital data sources or other data formats
[[S_ImportingAlienDiveLogs]]
If a user has been diving for some time, it is possible that several dives were
logged using other dive log software. This information does not need retyping
because these dive logs can probably be
imported into Subsurface. Subsurface will import dive logs from a range of
other
dive log software. While some software is supported natively, for others the
user has to
export the logbook(s) to an intermediate format so that they can then be imported
by Subsurface.
Currently, Subsurface supports importing CSV log files from several sources.
APD LogViewer, XP5, Sensus and Seabear files are
preconfigured, but because the import is flexible, users can configure their own
imports.
Manually kept log files (e.g. in spreadsheet) can also be imported by
configuring the CSV import.
Subsurface can also import UDDF and UDCF files used by some divelog
software and some dive computers, like the Heinrichs & Weikamp DR5. Finally,
for some divelog software like Mares Dive Organiser it is currently suggested to
import the logbooks first into a webservice like divelogs.de and then import
them from there with
Subsurface, as divelogs.de supports a few additional logbook formats that
Subsurface currently cannot parse.
If the format of other software is supported natively on Subsurface, it should be sufficient to select
either Import->Import log files or File->Open log file. Subsurface supports the data formats
of many dive computers, including Suunto and Shearwater. When importing dives, Subsurface
tries to detect multiple records for
the same dive and merges the information as best as it can. If
there are no time zone issues (or other reasons that would cause the
beginning time of the dives to be significantly different) Subsurface
will not create duplicate entries.
==== Using the universal import dialogue [[Unified_import]]
Importing dives from other software is performed through a universal interface that is activated by selecting Import from the Main Menu, then clicking on Import Log Files. This brings up the dialogue A below.
image::images/Import1.jpg["FIGURE: Import dialogue: step 1",align="center"]
Towards the bottom right is a dropdown selector with a default label of Dive Log Files which gives access to the different types of direct imports available, as in dialogue B, above. Currently these are:
Selecting the appropriate file in the file list of the dialogue opens the imported dive log in the Subsurface Dive List. Some other formats, not accessible through the Import dialogue are also supported, as explained below.
==== Importing from Mares Dive Organiser V2.1
Since Mares utilise proprietary Windows software not compatible with
multi-platform applications, these dive logs cannot be
directly imported into
Subsurface. Mares dive logs need to be imported using a three-step process,
using www.divelogs.de as a mechanism to extract the dive log information.
[[S_ImportingDivelogsDe]]
==== Importing dives from divelogs.de
The import of dive information from divelogs.de is simple, using a single
dialogue box. The Import->Import form Divelogs.de option should be selected
from the Main Menu. This
brings up a dialogue box (see figure on left [A] below). Enter a
user-ID and password for divelogs.de into the appropriate fields and then
select
the Download button. Download from divelogs.de starts immediately,
displaying a progress bar in the dialogue box. At the end of the download, the
success status is indicated (see figure on the right [B], below). The
Apply button should then be selected, after which the imported dives appear in the
Subsurface Dive List panel.
image::images/Divelogs1.jpg["FIGURE:Download from Divelogs.de",align="center"]
[[S_ImportingCSV]]
==== Importing dives in CSV format
Sometimes dive computers export dive information as files with
comma-separated values (.CSV). For example, the APD Inspiration and Evolution
closed circuit rebreather (CCR) systems export dive information in a CSV
formatted file that normally contains information for a single dive only. These
files can easily be imported into Subsurface.
CSV files are normally organised into
a single line that provides the headers of the data columns, followed by the
data, one record per line. CSV files can be opened with a normal text editor.
Following is a highly simplified and shortened example of a CSV file from an
APD rebreather:
Dive Time (s) Depth (m) pOâ - Setpoint (Bar) pOâ - C1 Cell 1 (Bar) Ambient temp. (Celsius)
0 0.0 0.70 0.81 13.1
0 1.2 0.70 0.71 13.1
0 0.0 0.70 0.71 13.1
0 1.2 0.70 0.71 13.2
0 1.2 0.70 0.71 13.1
10 1.6 0.70 0.72 12.7
20 1.6 0.70 0.71 12.6
30 1.7 0.70 0.71 12.6
40 1.8 0.70 0.68 12.5
50 1.6 0.70 0.68 12.5
60 2.4 0.70 0.69 12.5
70 3.5 0.70 0.69 12.4
80 4.2 0.70 0.72 12.5
90 4.0 0.70 0.71 12.4
Note that each title may comprise more than one word; for instance 'Dive Time (s)' in the above data example. Before being able to import the data to Subsurface one first needs to know:
Time: column 1
Depth: column 2
Temperature: column 5
pOâ: column 4
Armed with this information, importing the data into Subsurface is
straightforward. Select
Import->Import Log Files from the main menu. In the resulting file
selection menu, select CSV files, after which a common configuration dialog
appears for all the
files with a CSV extension:
image::images/Import_CSV1.jpg["FIGURE: CSV download dialogue",align="center"]
There are pre-configured definitions for some dive computers, e.g. the APD
rebreathers. If the user's dive computer is on this list, it should be selected
using the dropdown
box labeled Pre-configured imports. Select the button at the bottom right
to indicate whether the dive data are in metric of imperial units.
Finally OK should be clicked and
the dive will be imported and listed in the Dive List tab of Subsurface.
If the dive computer is not on the pre-configured list, the user must
select the Field
Separator (TAB or comma) for the particular CSV file, using the appropriate
dropdown list. and indicate which columns in the CSV file
contain which data
variables. For each data column used for import, the user must check the
appropriate check box
and indicate in which column these data are found. For instance, the image above
corresponds to the dialogue that would apply to the CSV data set described above
the image. After completing the column specification, select the OK button
and the dive will be imported and listed in the Dive List tab of Subsurface.
[[S_ImportingManualCSV]]
==== Importing dives from manually kept CSV file
If one keeps dive logs in a spreadsheet, there is an option to import those dives as well. Spreadsheet data, exported as a CSV file, can be imported to Subsurface. When importing manually kept log files, the information needed is quite different as we are importing only metadata, not profile samples.
Similarly to importing dives in CSV format (see above), one needs to
know the internal format
of the CSV data to import.
Importing manually kept CSV log files is quite straight forward, but there might be many fields and counting the field numbers is error prone. Therefore validation of the data to be imported is critical.
To import the dives, select Import->Import Log Files from the menu bar. If the CSV option in the dropdown list is selected and the file list includes file names ending with .CSV, one can select the Manual dives tab that will bring up the following configuration dialog:
image::images/Import_CSV2.jpg["FIGURE: Download dialog for Manual CSV logs",align="center"]
The input fields can be configured as appropriate, and when everything is done the OK button should be selected to perform the import. New dives should appear in the Dive List area of Subsurface.
[[S_Companion]]
=== Importing GPS coordinates with the Subsurface Companion App for mobile phones
Using the Subsurface Companion App on an Android device with a GPS, the coordinates
for the diving
location can be automatically passed to the Subsurface
dive log. The Companion App stores the dive locations on
a dedicated Internet-based file server. Subsurface, in turn, can collect
the localities from the file server.
To do this:
==== Create a Companion App account
==== Using the Subsurface companion app on a smartphone
On first use the app has three options:
[icon="images/icons/important.png"]
[IMPORTANT]
In the Subsurface main program, the DIVERID should also be entered on the
Default Preferences
panel, obtained by selecting File->Preferences->Defaults from the main menu
in Subsurface itself.
This facilitates synchronisation between Subsurface and the Companion App.
===== Creating new dive locations
Now one is ready to get a dive position and
send it to the server. The Android
display will look like the left hand image (A) below, but without any dives.
Touch the "+" icon on the top right to add a new dive site, a menu will be showed with 3 options:
image::images/Companion_5.jpg["FIGURE: Companion App, add location using map",align="center"]
===== Dive lists of dive locations
The main screen shows a list of dive locations, each with a name, date and time (see A below). Some locations may have an arrow-up icon over the selection box to the left indicating that they require upload to the server. One can select individual dive locations from the list. A selected location has a check mark in the selection box on the left. Group operations (such as Delete or Send) are performed on several locations that are selected.
Dive locations in this list can be viewed in two ways: a list of locations or a
map indicating the dive locations. The display mode (List or Map) is changed by
selecting Dives at the top left of the screen (see A below) and then selecting
the display mode. The display mode can be changed either from the list
of locations or from the map (see B below). If one selects a location (on the list
or on the map), an editing
panel opens (see C below) where the dive description or other details may be changed.
image::images/Companion_4.jpg["FIGURE: Companion App, add location using map",align="center"]
When one clicks on a dive (not selecting the check box), the name given to it, date/time and GPS coordinates will be shown, with two options at the top of the screen:
After editing and saving a dive location (see C above), one needs to upload it to the web service, as explained below.
===== Uploading dive locations
There are several ways to send locations to the server.
The easiest is by simply
selecting the locations (See A below) and then touching the right arrow at the
top right of the screen.
[icon="images/icons/important.png"]
[IMPORTANT]
Users must be careful, as the trash icon on the right means exactly what it should;
it deletes the selected dive location(s).
image::images/Companion_1.jpg["FIGURE: Screen shots (A-B) of companion app",align="center"]
After a dive trip using the Companion App, all dive locations are ready to be downloaded to a Subsurface dive log (see below).
===== Settings on the Companion app
Selecting the Settings menu option results in the right hand image above (B).
===== Server and account
===== Synchronisation
===== Background service
Instead of entering a unique dive location, users can leave the service running
in the background of their Android device, allowing the continuous collection of GPS locations.
The settings below define the behaviour of the service:
[icon="images/icons/info.jpg"]
[TIP]
How does the background service work? Assuming the user sets 5 minutes and 50
meters in the settings above, the app will start by recording a location at the current
location, followed by another one at every 5 minutes or every time one moves 50m
from previous location.
If subsequent locations are within a radius of 50 meters from the previous one,
a new location is not saved. If the user is not moving, only one location is saved,
but if the user is moving, a trace of the route is obtained by saving a
location every 50 meters.
===== Other
===== Search
Search the saved dive locations by name or by date and time.
===== Start service
Initiates the background service following the previously defined settings.
===== Disconnect
This is a badly named option that disconnects the app from the server by
resetting the user ID in the app, showing the first screen where an account
can be created, retrieve the ID for an existing account or use the users own
ID. The disconnect option
is useful if a user's Android device was used to download the dive locations
of another registered diver.
===== Send all locations
This option sends all locations stored in the Android device to the server.
==== Downloading dive locations to the Subsurface divelog
Download dive(s) from a dive computer or enter them manually into Subsurface before obtaining the GPS coordinates from the server. The download dialog can be reached via Ctrl+G or from the Subsurface Main Menu Import -> Import GPS data from Subsurface Service, resulting in the image on the left (A), below. On first use the DIVERID text box is blank. Provide a DIVERID, then select the Download button to initiate the download process, after which the screen on the right (B) below appears:
image::images/DownloadGPS.jpg["FIGURE: Downloading Companion app GPS data",align="center"]
Note that the Apply button is now active. By clicking on it, users can update the locations of the newly entered or uploaded dives in Subsurface which applies the coordinates and names entered on the app for all the new dives that match the date-times of the uploaded GPS localities. If one has entered the name of the dive location in Subsurface before downloading the GPS coordinates, this name will take precedence over downloaded one.
Since Subsurface matches GPS locations from the Android device and dive information from the dive computer based on date-time data, automatic assignment of GPS data to dives is dependent on agreement of the date-time information between these two devices. Although Subsurface has a wide range tolerance, it may be unable to identify the appropriate dive if there is a large difference between the time in the dive computer and that of the Android device, resulting in no updates.
Similar date-times may not always be possible and there may be many reasons for this (e.g. time zones), or Subsurface may be unable to decide which is the correct position for a dive (e.g. on repetitive dives while running background service there may be several locations that would be included in the time range that fit not only the first dive, but one or more subsequent dives as well). A workaround for this situation to manually edit the date-time of a dive in the Subsurface Dive List before downloading the GPS data and then to change the date-time back again after downloading GPS data.
[icon="images/icons/info.jpg"]
[NOTE]
[[S_LoadImage]]
=== Adding photographs to dives
Many (if not most) divers take a camera with them and take photographs during a dive. One would like to associate each photograph with a specific dive. Subsurface allows one to load photos into a dive. Photos are superimposed on the dive profile, from where they can be viewed.
==== Loading photos and getting synchronisation between dive computer and camera
Left-lick on a dive or on a group of dives on the dive list. Then right-click on this dive or group of dives and choose the option Load Images:
image::images/LoadImage1.jpg["FIGURE: Load images option",align="center"]
The system file browser appears. Select the folder and photographs that need to be loaded into Subsurface and click the Open button.
image::images/LoadImage2.jpg["FIGURE: Load images option",align="center"]
This brings one to the time synchronisation dialog, shown below. The
critical problem is that the time
synchronisation is not perfect between the dive computer used during a dive,
and the camera used during that same dive. These two devices
often differ by several minutes. If Subsurface can achieve synchronisation,
then the exact times of photographs can be used to position photographs on
the dive profile.
Subsurface achieves this synchronisation in two ways:
image::images/LoadImage3b.jpg["FIGURE: Synchronisation dialog",align="center"]
If the timestamp of a photograph is long before or after the dive, it is not placed on the dive profile. If the timestamp of the photo is within 30 minutes of the dive, it is shown.
==== Viewing the photos
In order to view the photos added to a dive, activate the show-photos button in the tool bar to the left of the dive profile:
image::images/icons/ShowPhotos.png["FIGURE:Show photos toolbar button",align="left"]
After the images have been loaded, they appear in two places:
image::images/LoadImage4.jpg["FIGURE: Photos on dive profile",align="center"]
If one hovers with the mouse over any of the photo icons, then a thumbnail photo is shown of the appropriate photo. See the image below:
image::images/LoadImage5.jpg["FIGURE:Thumbnail photo on dive profile",align="center"]
Clicking on the thumbnail brings up a full size photo overlaid on the Subsurface window. This allows good viewing of the photographs that have been added (see the image below). Note that the thumbnail has a small dustbin icon in the bottom right hand corner (see image above). If one selects the dustbin, the image is removed from the dive. Therefore some care is required when clicking on a thumbnail. Images can also be deleted using the Photos tab (see text below).
image::images/LoadImage6.jpg["FIGURE: Full-screen photo on dive profile",align="center"]
==== The Photos tab
Photographs associated with a dive are shown as thumbnails in the Photos tab of the Dive Notes panel. Photos taken in rapid succession during a dive (therefore sometimes with large overlap on the dive profile) can easily be accessed in the Photos tab. This tab serves as a tool for individually accessing the photos of a dive, while the stubs on the dive profile give an indication of when during a dive a photo was taken. By single-clicking on a thumbnail in the Photos panel, a photo is selected. By double-clicking a thumbnail, the full-sized image is shown, overlaying the Subsurface window. A photo can be deleted from the Photos panel by selecting it (single-click) and then by pressing the Del key on the keyboard. This removes the photo both from the Photos tab as well as the dive profile.
==== Photos on an external hard disk
Most underwater photographers store their photos on an external drive. If such a drive can be mapped (almost always the case) the photos can be directly accessed by Subsurface. This facilitates the interaction between Subsurface and an external repository of photos. When associating a dive profile with photos from an external drive, the normal procedure of selection and synchronisation (see text above) is used. However, after the external drive has been disconnected, Subsurface cannot access these photos any more. If the display of photos is activated (using the toolbox to the left of the Dive Profile), the program only shows a small white dot where each photo should be on the dive profile. In addition the Photos tab only shows the file names of the photos. This is normal behaviour. If, later, the external drive with the photos is connected again, the photos can be seen in the normal way.
== Obtaining more information about dives entered into the logbook
=== The Dive Info tab (for individual dives)
The Dive Info tab gives some summary information about a particular dive that has been selected in the Dive List. Useful information here includes the surface interval before the dive, the maximum and mean depths of the dive, the gas volume consumed, the surface air consumption (SAC) and the number of oxygen toxicity units (OTU) incurred.
[icon="images/icons/info.jpg"]
[NOTE]
Gas consumption and SAC calculations:
Subsurface calculates SAC and Gas consumption taking in account gas
incompressibility, particularly at tank pressures above 200 bar, making them more accurate.
Users should refer to xref:SAC_CALCULATION[Appendix D] for more information.
=== The Stats tab (for groups of dives)
The Stats tab gives summary statistics for more than one dive, assuming that
more than one dive has been selected in the Dive List using the standard
Ctrl-click or Shift-click of the mouse. If only one
dive has been selected, figures pertaining to only that dive are given. This tab
shows the number of dives selected, the total amount of dive time in these
dives,
as well as the minimum, maximum and mean for the dive duration,
water temperature and surface air consumption (SAC). It also shows the depth of the
shallowest and deepest dives of those selected.
[[S_DiveProfile]]
=== The Dive Profile
image::images/Profile2.jpg["Typical dive profile",align="center"]
Of all the panels in Subsurface, the Dive Profile contains the most detailed
information about each dive. The Dive Profile has a button bar on the left hand side
that allows control over several display options. The functions of these
buttons are described below. The main item in the Dive
Profile is the graph of
dive depth as a function of time. In addition to the obvious information of
the depth it also shows the ascent and descent rates compared to the recommended
speed of going up or down in the water column. This information is given using
different colours:
|====================
|Colour|Descent speed (m/min)|Ascent speed (m/min)
|Red|> 30|> 18
|Orange|18 - 30|9 - 18
|Yellow|9 - 18|4 - 9
|Light green|1.5 - 9|1.5 - 4
|Dark green|< 1.5|< 1.5
|=====================
The profile also includes depth readings for the peaks and troughs in the graph. Thus, users should see the depth of the deepest point and other peaks. Mean depth is marked with a horizontal red line.
[icon="images/icons/scale.jpg"]
[NOTE]
In some cases the dive profile does not fill the whole area of the Dive Profile
panel. Clicking the Scale button in the toolbar on the left of the dive profile
frequently increases the size of the dive profile to fill the area of the panel efficiently.
Water temperature is displayed with its own blue line with temperature values placed adjacent to significant changes.
The dive profile can include graphs of the partial pressures of O2, N2, and He during the dive (see figure above) as well as a calculated and dive computer reported deco ceilings (only visible for deep, long, or repetitive dives). Partial pressures of oxygen are indicated in green, those of nitrogen in black, and those of helium in dark red. These partial pressure graphs are shown below the profile data.
[icon="images/icons/O2.jpg"]
[NOTE]
Clicking this button allows display of the partial pressure of oxygen during the
dive. This is depicted below the dive depth and water temperature graphs.
[icon="images/icons/N2.jpg"]
[NOTE]
Clicking this button allows display of the partial pressure of nitrogen during the dive.
[icon="images/icons/He.jpg"]
[NOTE]
Clicking this button allows display of the partial pressure of helium during the dive.
This is only of importance to divers using Trimix, Helitrox or similar breathing gasses.
The air consumption graph displays the tank pressure and its change during the
dive. The air consumption takes depth into account so that even when manually
entering the start and end pressures the graph is not a straight line.
Similarly to the depth graph the slope of the tank pressure gives the user information
about the
momentary SAC rate (Surface Air Consumption) when using an air integrated dive computer.
Here the colour
coding is not relative to some absolute values but relative to the average
normalised air consumption during the dive. So areas that are red or orange
indicate
times of increased normalized air consumption while dark green reflects times
when the diver was using less gas than average.
[icon="images/icons/Heartbutton.png"]
[NOTE]
Clicking on the heart rate button will allow the display of heart rate information
during the dive if the dive computer was attached to a heart rate sensor.
It is possible to zoom into the profile graph. This is done either by using
the scroll wheel / scroll gesture of your mouse or trackpad. By default
Subsurface always shows a profile area large enough for at least 30 minutes
and 30m
(100ft) â this way short or shallow dives are intuitively recognizable;
something
that free divers clearly wonâTMt care about.
image::images/MeasuringBar.png["FIGURE: Measuring Bar",align="center"]
[icon="images/icons/ruler.jpg"]
[NOTE]
Measurements of depth or time differences can be achieved by using the
ruler button on the left of the dive profile panel.
The measurement is done by dragging the red dots to the two points
on the dive profile that the user wishes to measure. Information is then given
in the horizontal white area underneath the
two red dots.
[icon="images/icons/ShowPhotos.png"]
[NOTE]
Photographs that have been added to a dive can be shown on the profile
by selecting
the Show-photo button. The position of a photo on the profile
indicates the exact time when this photo was taken. If this button is not active,
the photos are hidden.
The profile can also include the dive computer reported ceiling (more
precisely, the deepest deco stop that the dive computer calculated for each
particular moment in time) as a red overlay on the dive profile. Ascent ceilings
arise when a direct ascent to the surface increases
the risk of a diver suffering from decompression sickness (DCS) and it is necessary
to either ascend
slower or to perform decompression stop(s) before ascending to the surface. Not
all dive computers record this information and make it available for download;
for example all of the Suunto dive computers fail to make this very useful data
available to divelog software. Subsurface also calculates ceilings independently,
shown as a green overlay on the dive profile.
Because of the differences in algorithms used
and amount of data available (and other factors taken into consideration at the time
of the calculation) it is unlikely that ceilings from dive computers and from Subsurface
are the same, even if the same algorithm and gradient factors (see below) are used.
It is also quite common that Subsurface calculates a ceiling for
non-decompression dives when the dive computer stayed in non-deco mode during
the whole dive (represented by the [green]dark green section in the profile
at the beginning of this section). This is caused by the fact that
SubsurfaceâTMs
calculations describe the deco obligation at each moment during a dive,
while dive computers usually take the upcoming ascent into account. During the
ascent some excess nitrogen (and possibly helium) are already breathed off so
even
though the diver technically encountered a ceiling at depth, the dive still does
not require an explicit deco stop. This feature allows dive computers to offer
longer non-stop bottom times.
[icon="images/icons/cceiling.jpg"]
[NOTE]
If the dive computer itself calculates a ceiling and makes it available to
Subsurface during upload of dives, this can be
shown as a red area by checking Dive computer reported ceiling button on the Profile Panel.
[icon="images/icons/ceiling1.jpg"]
[NOTE]
If the Calculated ceiling button on the Profile Panel is clicked, then a ceiling,
calculated by Subsurface, is shown in green if it exists for
a particular dive (A in figure below). This setting can be modified in two ways:
[icon="images/icons/ceiling2.jpg"]
[NOTE]
If, in addition, the show all tissues button on the Profile Panel is clicked, the ceiling is shown for the tissue
compartments following the Bühlmann model (B in figure below).
[icon="images/icons/ceiling3.jpg"]
[NOTE]
If, in addition, the 3m increments button on the Profile Panel is clicked, then the ceiling is indicated in 3 m increments
(C in figure below).
image::images/Ceilings2.jpg["Figure: Ceiling with 3m resolution",align="center"]
Gradient Factor settings strongly affect the calculated ceilings and their depths. For more information about Gradient factors, see the section on xref:S_GradientFactors[Gradient Factor Preference settings]. The currently used gradient factors (e.g. GF 35/75) are shown above the depth profile if the appropriate toolbar buttons are activated. N.B.: The indicated gradient factors are NOT the gradient factors in use by the dive computer, but those used by Subsurface to calculate deco obligations during the dive. For more information external to this manual see:
** http://www.tek-dive.com/portal/upload/M-Values.pdf[Understanding M-values by Erik Baker, Immersed Vol. 3, No. 3.]
** link:http://www.rebreatherworld.com/general-and-new-to-rebreather-articles/5037-gradient-factors-for-dummies.html[Gradient factors for dummies, by Kevin Watts]
=== The Dive Profile context menu
The context menu for the Dive Profile is accessed by right-clicking while the mouse cursor is over the Dive Profile panel. The menu allows the creation of Bookmarks or Gas Change Event markers other than the ones that might have been imported from a Dive Computer. Markers are placed against the depth profile line and with the time of the event set by where the mouse cursor was when the right mouse button was initially clicked to bring up the menu. Gas Change events open a further selection of which gas is being switched to, the list based on the available gases defined in the Equipment Tab. By right-clicking while over an existing marker, the menu extends adding options to allow deletion of the marker or to allow all markers of that type to be hidden. Hidden events can be restored to view by selecting Unhide all events from the context menu.
=== The Information Box
The Information box displays a large range of information pertaining to the dive profile. Normally the Information Box is located to the top left of the Dive Profile panel. If the mouse points outside of the Dive Profile panel, then only the top line of the Information Box is visible (see left-hand part of figure (A) below). The Information Box can be moved around in the Dive Profile panel by click-dragging it with the mouse so that it is not obstructing important detail. The position of the Information Box is saved and used again during subsequent dive analyses.
image::images/InfoBox2.jpg["Figure: Information Box",align="center"]
The moment the mouse points inside the Dive Profile panel, the information box expands and
shows many data items. In this situation, the data reflect the time point along
the dive profile indicated by the mouse cursor (see right-hand part of figure (B) above
where the Information Box reflects the situation at the position of the cursor
[arrow] in that image). Therefore, moving the cursor in the horizontal
direction allows the Information Box to show information for any point along the
dive profile.
In this mode, the Information Box gives extensive statistics about depth, gas
and ceiling characteristics of the particular dive. These include: Time period
into the dive (indicated by a @), depth, cylinder pressure (P), temperature,
ascent/descent rate, surface air consumption (SAC), oxygen partial pressure,
maximum operating depth, equivalent air depth (EAD), equivalent narcotic depth
(END), equivalent air density depth (EADD), decompression requirements at that
instant in time (Deco), time to surface (TTS), the calculated ceiling, as well
as the calculated ceiling for several Bühlmann tissue compartments.
The user has control over the display of several statistics, represented as four buttons on the left of the profile panel. These are:
[icon="images/icons/MOD.jpg"]
[NOTE]
Clicking this button causes the Information Box to display the Maximum Operating Depth
(MOD) of the dive, given the
gas mixture used. MOD is dependent on the oxygen concentration in the breathing gas.
For air (21% oxygen) it is around 57 m. Below the MOD there is a markedly increased
risk of exposure to the dangers associated with oxygen toxicity.
[icon="images/icons/NDL.jpg"]
[NOTE]
Clicking this button causes the Information Box to display the No-deco Limit (NDL) or the
Total Time to Surface (TTS). NDL is the time duration that a diver can continue with a
dive, given the present depth, that does not require decompression (that is, before an
ascent ceiling appears). Once one has exceeded the NDL and decompression is required (that
is, there is an ascent ceiling above the diver, then TTS gives the number of minutes
required before the diver can surface. TTS includes ascent time as well as decompression
time.
[icon="images/icons/SAC.jpg"]
[NOTE]
Clicking this button causes the Information Box to display the Surface Air Consumption (SAC).
SAC is an indication of the surface-normalised respiration rate of a diver. The value of SAC
is less than the real
respiration rate because a diver at 10m uses breathing gas at a rate roughly double that of
the equivalent rate at the surface. SAC gives an indication of breathing gas consumption rate
independent of the depth of the dive so that the respiratory rates of different dives
can be compared. The units for SAC is litres/min or cub ft/min.
[icon="images/icons/EAD.jpg"]
[NOTE]
Clicking this button displays the Equivalent Air Depth (EAD) for
nitrox dives as well as the Equivalent
Narcotic Depth (END) for trimix dives. These are numbers of
importance to divers who use breathing gases other than air. Their
values are dependent on the composition of the breathing gas. The EAD
is the depth of a hypothetical air dive that has the same partial
pressure of nitrogen as the current depth of the nitrox dive at
hand. A nitrox dive leads to the same decompression obligation as an
air dive to the depth equalling the EAD. The END is the depth of a
hypothetical air dive that has the same sum of partial pressures of
the narcotic gases nitrogen and oxygen as the current trimix dive. A
trimix diver can expect the same narcotic effect as a diver breathing
air diving at a depth equalling the END.
Figure (B) above shows an information box with a nearly complete set of data.
== Organising the logbook (Manipulating groups of dives)
=== The Dive List context menu
Many actions within Subsurface are dependent on a context menu used mostly to manipulate groups of dives. The context menu is found by selecting a dive or a group of dives and then right-clicking.
image::images/ContextMenu.jpg["Figure: Context Menu",align="center"]
The context menu is used in many manipulations described below.
==== Customising the information showed in the Dive List panel
image::images/DiveListOptions.jpg["Example: Dive list info options",align="left"]
The default information in the Dive List includes, for each dive, Dive_number, Date, Rating, Dive_depth, Dive_duration and Dive_location. This information can be contolled and changed by right-clicking on the header bar of the Dive List. For instance, a right-click on the 'Date' header brings up a list of items that can be shown in the dive list (see above). Select an item to be shown in the Dive List or to be deleted from the dive list, and the list is immediately updated accordingly. Preferences for information shown in the Dive List is saved and used when Subsurface is re-opened.
==== Selecting dives from a particular dive site
Many divers have long dive lists and it may be difficult to locate all the dives at a particular site. By pressing Ctl-F on the keyboard, a text box is opened at the top left hand of the Dive List. Type the name of a dive site in this text box and the Dive List is immediately filtered to show only the dives for that site.
[[S_Renumber]]
=== Renumbering the dives
Dives are normally numbered incrementally from non-recent dives (low sequence numbers) to recent dives (having the highest sequence numbers). The numbering of the dives is not always consistent. For instance, when non-recent dives are added to the dive list the numbering does not automatically follow on because of the dives that are more recent in date/time than the newly-added dive with an older date/time. Therefore, one may sometimes need to renumber the dives. This is performed by selecting (from the Main Menu) Log -> Renumber. Users are given a choice with respect to the lowest sequence number to be used. Completing this operation results in new sequence numbers (based on date/time) for the dives in the Dive List panel.
[[S_Group]]
=== Grouping dives into trips and manipulating trips
For regular divers, the dive list can rapidly become very long. Subsurface can group dives into trips. It performs this by grouping dives that have date/times that are not separated in time by more than two days, thus creating a single heading for each diving trip represented in the dive log. Below is an ungrouped dive list (A, on the left) as well as the corresponding grouped dive list comprising five dive trips (B, on the right):
image::images/Group2.jpg["Figure: Grouping dives",align="center"]
Grouping into trips allows a rapid way of accessing individual dives without having to scan a long lists of dives. In order to group the dives in a dive list, (from the Main Menu) users must select Log -> Autogroup. The Dive List panel now shows only the titles for the trips.
==== Editing the title and associated information for a particular trip
Normally, in the dive list, minimal information is included in the trip title.
More information about a trip can be added by selecting its trip title from
the Dive List. This shows a Trip Notes tab in the Dive Notes panel. Here
users can add or edit information about the date/time, the trip location and any
other general comments about the trip as a whole (e.g. the dive company that was
dived with, the general weather and surface conditions during the trip, etc.).
After entering this
information, users should select Save from the buttons at the top right
of the Trip Notes
tab. The trip title in the Dive List panel should now reflect some of the
edited information.
==== Viewing the dives during a particular trip
Once the dives have been grouped into trips, users can expand one or more trips by clicking the arrow-head on the left of each trip title. This expands the selected trip, revealing the individual dives performed during the trip.
==== Collapsing or expanding dive information for different trips
If a user right-clicks after selecting a particular trip in the dive list, the resulting context menu allows several possibilities to expand or collapse dives within trips. This includes expanding all trips, collapsing all trips and collapsing all trips except the selected one.
==== Merging dives from more than one trip into a single trip
By right-clicking on a selected trip title in the Dive List panel, a context menu shows up that allows the merging of trips by either merging of the selected trip with the trip below or with the trip above.
==== Splitting a single trip into more than one trip
If a trip includes five dives, the user can split this trip into two trips (trip 1:
top 3 dives; trip 2: bottom 2 dives) by selecting and right-clicking the top
three dives. The resulting context menu allows the user to create a new trip by
choosing the option Create new trip above. The top three dives are then
grouped
into a separate trip. The figures below shows the selection and context menu
on the left (A) and
the completed action on the right (B):
image::images/SplitDive3a.jpg["FIGURE: Split a trip into 2 trips",align="center"]
=== Manipulating single dives
==== Delete a dive from the dive log
Dives can be permanently deleted from the dive log by selecting and
right-clicking them to bring up the context menu, and then selecting Delete
dive(s). Typically this would apply to a case where a user wishes to delete
workshop
calibration dives of the dive computer or dives of extremely short duration.
==== Unlink a dive from a trip
Users can unlink dives from the trip to which they belong. In order to do this,
select and right-click
the relevant dives to bring up the context menu. Then select the option Remove dive(s)
from trip. The dive(s) now appear immediately above the trip to
which they belonged.
==== Add a dive to the trip immediately above
Selected dives can be moved from the trip to which they belong and placed within
the trip immediately above the currently active trip. To do this, select
and right-click
the dive(s) to bring up the context menu, and then select Add dive(s) to trip
immediately above.
==== Shift the start time of dive(s)
Sometimes it is necessary to adjust the start time of a dive. This may apply to
situations where dives are performed in different time zones or when the dive
computer has an erroneous time. In order to do this, user must select and right-click
the dive(s) to be
adjusted. This action brings up the context menu on which the Shift times
option should be selected. User must then specify the
time
(in hours and minutes) by which the dives should be adjusted and click on the
option indicating whether the time adjustment should be forwards or backwards.
==== Merge dives into a single dive
Sometimes a dive is briefly interrupted, e.g. if a diver returns to the surface for a few minutes, resulting in two or more dives being recorded by the dive computer and appearing as different dives in the Dive List panel. Users can merge these dives onto a single dive by selecting the appropriate dives, right-clicking them to bring up the context menu and then selecting Merge selected dives. It may be necessary to edit the dive information in the Dive Notes panel to reflect events or conditions that apply to the merged dive. The figure below shows the depth profile of two such dives that were merged:
image::images/MergedDive.png["Example: Merged dive",align="center"]
[[S_ExportLog]]
== Exporting the dive log or parts of the dive log
The export function can be reached by selecting File -> Export, which brings up the Export dialog. This dialog always gives two options: save ALL dives, or save only the dives selected in Dive List panel of Subsurface. Click the appropriate radio button (see images below).
image::images/Export.jpg["Figure: Export dialog",align="center"]
A dive log or part of it can be saved in three formats:
** Subsurface Numbers: if this option is checked, the dive(s) are exported with the
numbers associated with them in Subsurface, Otherwise the dive(s) will be numbered
starting from 1.
** Minimum Javascript: This will minimize the Javascript produced with the file,
some functionality will be lost.
** Export List only: a list of dives will only be exported and the detailed dive
information will not be available.
Export to other formats can be achieved through third party facilities, for instance www.divelogs.de.
[[S_Cloud_access]]
== Keeping a Subsurface dive log in the Cloud
For each diver, dive log information is highly important. Not only is it a record of diving activities for one's own pleasure, but it is important information required for admission to further training courses or (sometimes) even diving sites. The security of the dive log is therefore critical. In order to have a dive log that is resistant to failure of a home computer hard drive, loss or theft of equipment, the Cloud is an obvious solution. This also has the added benefit that one can access one's dive log from anywhere in the world without having to carry it with oneself. For this reason, facilities such as divelogs.de and Diving Log offer facilities to store dive log information on the Internet. Although Subsurface does not offer integrated Cloud storage of dive logs, it is simple to achieve this using several of the existing facilities on the Internet.
For instance
http://www.dropbox.com/[Dropbox]
offers a free application that allows
files on the Dropbox servers to be seen as a local folder on one's desktop computer.
image::images/Cloud.jpg["FIGURE: Dropbox folder",align="center"]
The Dropbox program creates a copy of the Dropbox Internet Cloud content on one's desktop computer. When the computer is connected to the Internet, the Internet content is automatically updated. Therefore both the Open and Save of dive logs are done using the local copy of the dive log in the local Dropbox folder, so there's no need for a direct internet connection. If the local copy is modified, e.g. by adding a dive, the remote copy in the Dropbox server in the Cloud will be automatically updated whenever Internet access is available.
In this way a dive log in
one's Dropbox folder can be accessed seamlessly from the Internet and can
be accessed from any place with Internet access. Currently there are no costs
involved for this service. Dropbox (Windows, Mac
and Linux) can be installed by accessing the
http://www.dropbox.com/install[Install Page on the Dropbox website]
. Alternatively one can use Dropbox as a mechanism to backup one's dive log. To
Store a dive log in the Cloud, select File->Save as from the Subsurface main menu,
navigate to the Dropbox folder and select the Save button. To access the dive log
in the Cloud, select File->Open Logbook from the Subsurface
main menu and navigate to the dive log file in the Dropbox folder and select the
Open button.
Several paid services exist on the Internet (e.g. Google, Amazon) where the same process could be used for the Cloud-based storage of dive logs.
[[S_PrintDivelog]]
== Printing a dive log
Subsurface provides a simple interface to print a whole dive log or only a few selected dives, including dive profiles and other contextual information.
Before printing, two decisions are required:
Now the print options should be selected to match the user's needs. To do this, user should select File->Print from the Main menu. The following dialogue appears (see the image on the left [A], below).
image::images/PrintDiveLog.jpg["FIGURE: Print dialogue",align="center"]
Under Print type users need to select one of three options:
Under Print options users need to select:
The Ordering affects the layout of the page (or part of it) for each dive. The dive profile could be printed at the top of each dive, with the textual information underneath, or it could be printed with the textual information at the top with the dive profile underneath. Users should select the appropriate option in the print dialogue. See the image below which has a layout with text below the dive profile.
Users can Preview the printed page by selecting the Preview button on the dialogue. After preview, changes to the options in the print dialogue can be made, resulting in a layout that fits personal taste.
Next, select the Print button in the dialogue. This activates the regular print
dialogue used by the user operating system (image [B] in the middle, above),
allowing them to choose a printer and to set its properties (image [C] on the right,
above).
It is important to set the print resolution of the printer to an appropriate value by
changing
the printer properties. Finally, one can print the dives. Below is a (rather small)
example of
the output for one particular page.
image::images/Printpreview.jpg["FIGURE: Print preview page",align="center"]
[[S_Preferences]]
== Setting user Preferences for Subsurface
There are several settings within Subsurface that the user can specify. These are found when selecting File->Preferences. The settings are performed in five groups: Defaults, Units, Graph, Language and Network. All five sections operate on the same principles: the user must specify the settings that are to be changed, then these changes are saved using the Apply button. After applying all the new settings users can then leave the settings panel by selecting OK.
=== Defaults
There are several settings in the Defaults panel:
image::images/Pref1.jpg["FIGURE: Preferences defaults page",align="center"]
** Lists and tables: Here one can specify the font type and font size of the Dive Table panel. By decreasing the font size of the Dive Table, users can see more dives on a screen.
** Dives: For the Default Dive File one need to specify the directory and
file name of one's
electronic dive log book. This is a file with filename extension .xml. When
launched, Subsurface will automatically load the specified dive log book.
** Display invalid: Dives can be marked as invalid (when a user wishes to hide dives that he/she don't consider valid dives, e.g. pool dives, but still want to keep them in the dive log). This controls whether those dives are displayed in the dive list.
** Default cylinder: Here users can specify the default cylinder listed in the Equipment tab of the Dive Notes panel.
** Animations: Some actions in showing the dive profile are performed using
animations. For instance, the axis values for depth and time change from dive to
dive. When viewing a different dive, these changes in axis characteristics do not
happen instantaneously, but are animated. The Speed of animations can be controlled
by setting this slider
with faster animation speed to the left, with a 0 value representing no animation
at all.
** Subsurface web service: When one subscribes to the <<S_Companion,Subsurface web service>>, a very long and hard-to-remember userID is issued. This is the place to save that userID. By checking the option Save User ID locally?, one ensures that a local copy of that userID is saved.
** Clear all settings: As indicated in the button below this heading, all settings are cleared and set to default values.
=== Units
image::images/Pref2.jpg["FIGURE: Preferences Units page",align="center"]
Here user can choose between metric and imperial units of depth, pressure, volume, temperature and mass. By selecting the Metric or Imperial radio button at the top, users can specify that all units are in the chosen measurement system. Alternatively, if one selects the Personalise radio button, units can be selected independently, with some units in the metric system and others in imperial.
=== Graph
image::images/Pref3.jpg["FIGURE: Preferences Graph page",align="center"]
[[S_GradientFactors]]
This panel allows two type of selections:
** Draw dive computer reported ceiling red: This checkbox allows exactly what it says. Not all dive computers report ceiling values. If the dive computer does report it, it may differ from the ceilings calculated by Subsurface. This is because of the different algorithms and gradient factors available for calculating ceilings, as well as the dynamic way that a dive computer can calculate ceilings during a dive.
** Show unused cylinders in Equipment Tab: This checkbox allows display of information about unused cylinders when viewing the Equipment Tab. Conversely, if this box is not checked, and any cylinders entered using the Equipment Tab are not used (e.g. there was no gas switch to such a cylinder), then these cylinders are omitted from that list.
** Show average depth: Activating this checkbox causes Subsurface to draw a red line across the dive profile, indicating the mean depth of the dive.
** Gradient Factors:* Here users can set the gradient factors used while diving. GF_Low is the gradient factor at depth and GF_High is used just below the surface. At intermediate depths gradient factors between GF_Low and GF_High are used. Gradient factors add conservatism to the nitrogen exposure during a dive, in a similar way that many dive computers have a conservatism setting. The lower the value of a gradient factor, the more conservative the calculations are with respect to nitrogen loading and the deeper the ascent ceilings are. Gradient factors of 20/60 are considered conservative and values of 60/90 are considered harsh. Checking GFLow at max depth box causes GF_Low to be used at the deepest depth of a dive. If this box is not checked, GF_Low is applied at all depths deeper than the first deco stop. For more information see:
** http://www.tek-dive.com/portal/upload/M-Values.pdf[Understanding M-values by Erik Baker, Immersed Vol. 3, No. 3.]
** link:http://www.rebreatherworld.com/general-and-new-to-rebreather-articles/5037-gradient-factors-for-dummies.html[Gradient factors for dummies, by Kevin Watts]
=== Language
Choose a language that Subsurface will use.
image::images/Pref4.jpg["FIGURE: Preferences Language page",align="center"]
A checkbox allows one to use the System Default language which in most cases will be the correct setting; with this Subsurface simply runs in the same language / country settings as the underlying OS. If this is for some reason undesirable users can uncheck this checkbox and pick a language / country combination from the list of included localizations. The Filter text box allows one to list similar languages. For instance there are several system variants of English or French. This particular preference requires a restart of Subsurface to take effect.
=== Network
This panel facilitates communication between Subsurface and data sources on the Internet.
image::images/Pref5.jpg["FIGURE: Preferences Network page",align="center"]
This is important, for instance, when Subsurface needs to communicate with Internet services such as the <<S_Companion,Subsurface Companion app>> or data export/import from Divelogs.de. These Internet requirements are determined by one's type of connection to the Internet and by the Internet Service Provider (ISP) used. One's ISP should provide the appropriate information. If a proxy server is used for Internet access, the appropriate information needs to be provided here. The type of proxy needs to be selected from the dropdown list. after which the IP address of the host and the appropriate port number should be provided. If the proxy server uses authentication, the appropriate userID and password also needs to be provided so that Subsurface can automatically pass through the proxy server to access the Internet.
[[S_DivePlanner]]
== The Subsurface dive planner
Dive planning is an advanced feature of Subsurface, accessible by selecting Log -> Plan Dive from the main menu. It allows calculation of
nitrogen load during a dive by using the Bühlmann ZH-L16 algorithm with the addition of gradient factors as
implemented by Erik Baker.
The Subsurface dive planner IS CURRENTLY EXPERIMENTAL and assumes the user is already familiar with the Subsurface user interface. It is explicitly used under the following conditions:
=== The Subsurface dive planner screen
Like the Subsurface dive log, the planner screen is divided into several sections (see image below). The setup parameters for a dive are entered into the several sections on the left hand side of the screen. The setup is divided into several sections: Available Gases, Rates, Planning, Gas Options and Dive Notes.
At the top right hand is a green design panel upon which the profile of the dive can be manipulated directly by dragging and clicking as explained below. This feature makes the Subsurface dive planner unique in ease of use.
At the bottom right is a text panel with a heading of Dive Plan Details. This is where the details of the dive plan are provided in a way that can easily be copied to other software. This is also where any warning messages about the dive plan are printed.
image::images/PlannerWindow1.jpg["FIGURE: Dive planner startup window",align="center"]
=== Initiating dive planning
The dive planner comprises two parts: constructing a dive plan and evaluating that dive plan. To perform dive planning, perform these steps:
=== Managing nitrogen, oxygen and gas consumption
The planning is performed in three stages:
*** link:http://www.tek-dive.com/portal/upload/M-Values.pdf[Understanding M-values by Erik Baker, Immersed Vol. 3, No. 3.] *** link:http://www.rebreatherworld.com/general-and-new-to-rebreather-articles/5037-gradient-factors-for-dummies.html[Gradient factors for dummies, by Kevin Watts] *** link:http://www.amazon.com/Deco-Divers-Decompression-Theory-Physiology/dp/1905492073/ref=sr_1_1?s=books&ie=UTF8&qid=1403932320&sr=1-1&keywords=deco+for+divers[Deco for Divers, by Mark Powell (2008). Aquapress] Southend-on-Sea, UK. ISBN 10: 1-905492-07-3. An excellent non-technical review.
** The ascent rate is critical for nitrogen off-gassing at the end of the dive and is specified for several depth ranges, utilising the average (or mean) depth as a yardstick. The mean depth of the dive plan is indicated on the dive profile in the green panel of the dive planner. Ascent rates at deeper levels are often in the range of 8-12 m/min, while ascent rates near the surface are often in the range of 4-9 m/min. The descent rate is also specified. If the option Drop to first depth is activated, then the descent phase of the planned dive will be at the maximal descent rate specified in the Rates section of the dive setup.
Below is an example of a dive plan to 45m using EAN26, followed by an ascent using EAN50 and using the settings as described above.
image::images/DivePlanner2.jpg["FIGURE: Planning a dive: setup",align="center"]
Once the above has been completed, one can save it by clicking the Save button towards the bottom left of the green design panel. The saved dive plan will appear in the Dive List panel of Subsurface.
=== The dive plan details
On the bottom right of the dive planner, under Dive Plan Details, the exact details of the dive plan are provided. These details may be modified by checking any of the options under the Dive Notes section of the dive planner, immediately to the left of the Dive Plan Details. If a Verbatim diveplan is requested, a detailed sentence-level explanation of the dive plan is given. If any of the management specifications have been exceeded during the planning, a warning message is printed underneath the dive plan information.
If the option Display segment duration is checked, then the duration of each depth level is indicated in the Dive Plan Details. This duration INCLUDES the transition time to get to that level. However, if the Display transition in deco option is checked, the transitions are shown separately from the segment durations at a particular level.
=== Printing the dive plan
Selecting the Print button in the planner allows printing of the Dive Plan Details for wet notes. Alternatively one can cut and paste the Dive Plan Details for inclusion in a text file or word processing document.
Dive plans have many characteristics in common with dive logs (dive profile, dive notes, etc). After a dive plan has been saved, the dive details and gas calculations are saved in the Dive Notes tab. While a dive plan is being designed, it can be printed using the Print button in the dive planner. This prints the dive details and gas calculations in the Dive Plan Details panel of the dive planner. However, after the plan has been saved, it is represented in a way very similar to a dive log and the gas calculations cannot be accessed in the same way as during the planning process. The only way to print the dive plan is to use the File->Print facility on the main menu in the same way as for dive logs.
=== Planning for repetitive dives
Repetitive dives can easily be planned if the dates and start times of the
repetitive dive set
is specified appropriately in the top left-hand Start Time field. Subsurface
calculates the gas loading figures correctly and the effect of the first dive is
evaluated on later dives.
If one has just completed a long/deep dive and is planning another dive, then highlight, in the Dive List, the dive that has just been completed and then activate the planner. Depending on the start time of the planned dive, the planner takes into account the gas loading incurred during the completed dive and allows planning within these limitations.
If only a few standard configurations are used (e.g. in GUE), then a template dive can be created conforming to one of the configurations. If one now wishes to plan a dive using this configuration, just highlight the template dive in the Dive List and activate the planner: the planner takes into account the configuration in the highlighted dive.
== Description of the Subsurface Main Menu items
This section describes the functions and operation of the items in the Main Menu of Subsurface. Several of the items below are links to sections of this manual dealing with the appropriate operations.
=== File
- <<S_NewLogbook,New Logbook>> - Close the currently open dive logbook and
clear all dive information.
- Open logbook - This opens the file manager in order to select a dive
logbook to open.
- Save - Save the dive logbook that is currently open.
- Save as - Save the current logbook under a different file name.
- Close - Close the dive logbook that is currently open.
- <<S_ExportLog,Export>> - Export the currently open dive logbook (or
the selected dives in the logbook) to one of several formats.
- <<S_PrintDivelog,Print>> - Print the currently open logbook.
- <<S_Preferences,Preferences>> - Set the Subsurface preferences.
- Quit - Quit Subsurface.
=== Import
- <<S_ImportDiveComputer,Import from dive computer>> - Import dive information
from a dive computer.
- <<Unified_import,Import Log Files>> - Import dive information from a file in
in a Subsurface-compatible format.
- <<S_Companion,Import GPS data from Subsurface Service>> - Load GPS
coordinates from the Subsurface mobile phone app.
- <<S_ImportingDivelogsDe,Import from Divelogs.de>> - Import dive information
from www.Divelogs.de.
=== Log
- <<S_EnterData,Add Dive>> - Manually add a new dive to the Dive List panel.
- <<S_DivePlanner,Plan Dive>> - This feature allows the planning of dives.
- <<S_Renumber,Renumber>> - Renumber the dives listed in the Dive List
panel.
- <<S_Group,Auto Group>> - Group the dives in the Dive List panel into dive
trips.
- <<S_DeviceNames,Edit Device Names>> - Edit the names of dive computers to facilitate your logs.
=== View
- <<S_ViewPanels,All>> - View the four main Subsurface panels
simmultaneously.
- <<S_ViewPanels,Dive List>> - View only the Dive List panel.
- <<S_ViewPanels,Profile>> - View only the Dive Profile panel.
- <<S_ViewPanels,Info>> - View only the Dive Notes panel.
- <<S_ViewPanels,Globe>> - View only the World Map panel.
- Yearly Statistics - Display summary statistics about dives during this and past
years.
- Prev DC - Switch to next dive computer.
- Next DC - Switch to previous dive computer.
- Full Screen - Toggles Full Screen mode.
=== Filter
- Select Events - This option is not implemented yet.
=== Help
- About Subsurface - Show a panel with the version number of Subsurface as
well as licensing information.
- Check for updates - Find out whether a newer version of Subsurface is available
on the http://subsurface.hohndel.org/[Subsurface web site].
- User Manual - Open a window showing this user manual.
== APPENDIX A: Operating system specific information for importing dive information from a dive computer.
=== Make sure that the OS has the required drivers installed
[icon="images/icons/drivers.jpg"]
[NOTE]
The operating system of the desktop computer needs the appropriate drivers in
order to communicate with the dive computer in whichever way the dive
computer prefers (e.g. bluetooth, USB, infra-red).
[[S_HowFindDeviceName]]
=== How to Find the Device Name for USB devices and set its write permission
[icon="images/icons/usb.jpg"]
[NOTE]
When a user connects the dive computer by using a USB connector, usually
Subsurface will either propose a drop down list that contains the
correct device name (or mount point for the Uemis Zurich), or it will
disable the device select drop down if no device name is needed at
all. In the rare cases where this doesn't work, here are some
suggestions of ways to find out what the device name is:
.On Windows:
Simply try COM1, COM2, etc. The drop down list should contain all connected COM devices.
.On MacOS:
The drop down box should find all connected dive computers.
.On Linux:
There is a definitive way to find the port:
A message similar to this one should appear:
usb 2-1.1: new full speed USB device number 14 using ehci_hcd
usbcore: registered new interface driver usbserial
USB Serial support registered for generic
usbcore: registered new interface driver usbserial_generic
usbserial: USB Serial Driver core
USB Serial support registered for FTDI USB Serial Device
ftdi_sio 2-1.1:1.0: FTDI USB Serial Device converter detected
usb 2-1.1: Detected FT232BM
usb 2-1.1: Number of endpoints 2
usb 2-1.1: Endpoint 1 MaxPacketSize 64
usb 2-1.1: Endpoint 2 MaxPacketSize 64
usb 2-1.1: Setting MaxPacketSize 64
usb 2-1.1: FTDI USB Serial Device converter now attached to ttyUSB3
usbcore: registered new interface driver ftdi_sio
ftdi_sio: v1.6.0:USB FTDI Serial Converters Driver
The third line from the bottom shows that the FTDI USB adapter is detected and connected to +ttyUSB3+. This information can now be used in the import settings as +/dev/ttyUSB3+ which directs Subsurface to the correct USB port.
Ensuring that the user has write permission to the USB serial port:
On Unix-like operating systems the USB ports can only be accessed by users who
are members
of the +dialout+ group. If one is not root, one may not be a member of
that group and
will not be able to use the USB port. Let us assume one's username is 'johnB'.
With the appropriate device name (e.g. +dev/ttyUSB3+) and with write permission
to the USB
port, the dive computer interface can connect and one should be able to import
dives.
[[S_HowFindBluetoothDeviceName]]
=== Setting up bluetooth enabled devices
[icon="images/icons/bluetooth.jpg"]
[NOTE]
For dive computers communicating through bluetooth like the Heinrichs
Weikamp Frog or the Shearwater Predator and Petrel there is a
different procedure to get the devices name to communicate with
Subsurface. Follow these steps:
For Bluetooth pairing of the dive computer, refer to the manufacturer's user guide. When using a Shearwater Predator/Petrel, select Dive Log -> Upload Log and wait for the Wait PC message.
.On Windows:
Bluetooth is most likely already enabled. For pairing with the dive computer choose Control Panel->Bluetooth Devices->Add Wireless Device. This should bring up a dialog showing your dive computer (in Bluetooth mode) and allowing pairing. Right click on it and choose Properties->COM Ports to identify the port used for your dive computer. If there are several ports listed, use the one saying "Outgoing" instead of "Incoming".
For downloading to Subsurface, the Subsurface drop-down list should contain this COM port already. If not, enter it manually.
Note: If there are issues afterwards when downloading from the dive computer using other software, remove the existing pairing with the dive computer.
.On MacOS:
Click on the Bluetooth symbol in the menu bar and select Set up Bluetooth Device.... The dive computer should then show up in the list of devices. Select it and go through the pairing process. This step should only be needed once for initial setup.
Once the pairing is completed the correct device is shown in the 'Device or Mount Point' drop-down in the Subsurface Import dialog.
.On Linux
Ensure Bluetooth is enabled on the Subsurface computer.
On most common distributions this should be true out of the box and
pairing should be straight forward. For instance, Gnome3 shows a
Bluetooth icon in the upper right corner of the desktop where one selects 'Set
up New Device'. This should show a dialog where one can select the
dive computer (which already should be in Bluetooth mode) and pair it.
If a PIN is required, try manually setting '0000'.
In the rare cases where the above is not true, then depending on your system, try +initd+ or +systemd+. This might be different and also involve loading modules specific to your hardware. In case your system is running +systemd+, manually run +systemctl start bluetooth.service+ to enable it, in case of +initd+, run something like +rc.config start bluetoothd+ or +/etc/init.d/bluetooth start+.
One may also use a manual approach by using such commands:
Unfortunately on Linux binding to a communication device has to be done manually by running:
For downloading dives in Subsurface specify the device name connected to the MAC address in the last step above, e.g. /dev/rfcomm0.
== APPENDIX B: Dive Computer specific information for importing dive information.
[[S_ImportUemis]]
=== Import from a Uemis Zurich
[icon="images/icons/iumis.jpg"]
[NOTE]
Subsurface downloads the information
stored on the SDA (the built-in file system of the Uemis) including
information about dive spots and
equipment. Buddy information is not yet downloadable.
Things are very similar to a normal USB-connected dive computer
(the Uemis is one of those that recharge when connected to the USB port).
The main difference is that one does not enter a
device name, but instead the location where the UEMISSDA file system is
mounted once connected to the dive computer. On Windows this is a drive letter (
often 'E:' or 'F:'), on a Mac this is
'/Volumes/UEMISSDA' and on Linux systems this differs depending on the
distribution. On Fedora it usually is
'/var/run/media/<your_username>/UEMISSDA'. In all cases Subsurface
should suggest the correct location in the drop down list.
After selecting the above device name, download the dives from the Uemis Zurich. One technical issue with the Uemis Zurich download implementation (this is a Uemis firmware limitation, not a Subsurface issue) is that one cannot download more than about 40-50 dives without running out of memory on the SDA. This will usually only happen the very first time one downloads dives from the Uemis Zurich. Normally when downloading at the end of a day or even after a dive trip, the capacity is sufficient. If Subsurface displays an error that the dive computer ran out of space the solution is straight forward. Disconnect the SDA, turn it off and on again, and reconnect it. You can now retry (or start a new download session) and the download will continue where it stopped previously. One may have to do this more than once, depending on how many dives are stored on the dive computer.
[[S_ImportingGalileo]]
=== Importing dives from the Uwatec Galileo
[icon="images/icons/Galileo.jpg"]
[NOTE]
The Uwatec Galileo dive computers use infra red (IrDA) communication
between the dive computer and Subsurface. The Uwatec hardware uses
a USB dongle based on the serial infra-red (SIR) protocol and the
MSC7780 IrDA controller manufactured by MosChip
and marketed by Scubapro and some electronics companies.
Under Linux, the kernel
already provides for communication using the IrDA protocol. However,
the user additionally needs to load a driver for the IrDA interface
with the dive computer. The easiest way is to load the irda-tools
package from the http://irda.sourceforge.net/docs/startirda.html[Linux IrDA Project].
After the installation of the irda-tools, the root user can specify a device name
from the console as follows:
+irattach irda0+
After executing this command, Subsurface will recognise the Galileo dive computer and download dive information.
Under Windows, a similar situation exists. Drivers for the MCS7780 are available from some Internet web sites e.g. http://www.drivers-download.com/Drv/MosChip/MCS7780/[www.drivers-download.com].
For the Apple Mac, IrDA communication via the MCS7780 link is not available for OSX 10.6 or higher.
[[S_ImportingDR5]]
=== Importing dives from Heinrichs Weikamp DR5
[icon="images/icons/HW_DR5.jpg"]
[NOTE]
When mounted as a USB drive the Heinrichs Weikamp DR5 saves a single UDDF file
for every dive.
Mark all the dives you'd like to import or open.
Note: The DR5 does not seem to store gradient factors nor deco information, so
for Subsurface it is not possible to display them. Adjust the gradient
factors in the Graph Settings in Subsurface to generate a deco overlay in the
Subsurface Dive Profile panel but please note that the deco calculated by
Subsurface will most likely differ from the one displayed on the DR5.
=== Import from Shearwater Predator using Bluetooth
[icon="images/icons/predator.jpg"]
[NOTE]
Using a Shearwater Predator one may be able to pair Bluetooth but then encounter
issues when downloading, showing errors like Slip RX: unexp. SLIP END on the
Predator.
This might also arise when using other dive log software and operating
systems other than Linux. We have no detailed idea about the source and how to fix
this, but it is reported to be solved sometimes by one of these steps:
== APPENDIX C: Exporting Dive log information from external dive log software.
The import of dive log data from external dive log software is mostly performed
using
the dialogue found by selecting Import from the Main Menu, then clicking on
Import Log Files. This is a single-step process, more information about which
can be found
xref:Unified_import[here.]
However, in some cases, a two-step process may be required:
This appendix provides some information about approaches to export dive log
data from foreign
dive log software. The procedures below mostly apply to Linux and/or Windows.
[[S_ImportingDivesSuunto]]
=== Exporting dives from Suunto Divemanager (DM3 and DM4)
[icon="images/icons/suuntologo.jpg"]
[NOTE]
Divemanager 3 (DM3) is an older version of the Suunto software. More recent
Suunto dive computers use Divemanager 4 (DM4). The
two versions of Divemanager use different methods and different file naming
conventions to export dive log data.
Divemanager 3 (DM3):
** A file-manager like window pops up ** Navigate to the directory for storing the Divelog.SDE file
** Optionally change the name of the file for saving ** Click 'Save'
Divemanager 4 (DM4):
To export divelog from 'Suunto DM4', one needs to locate the DM4 database where the dives are stored. the user can either look for the original database or make a backup of the dives. Both methods are described here.
Locating the Suunto DM4 database:
Backing up Suunto DM4:
=== Exporting from Mares Dive Organiser V2.1 [[Mares_Export]]
[icon="images/icons/mareslogo.jpg"]
[NOTE]
Mares Dive Organiser is a Windows application. The dive log is kept as a
Microsoft SQL Compact Edition database with a '.sdf' filename extension. The
database includes all Dive Organiser-registered divers on the particular
computer and all Mares dive computers used. The safest way to obtain a copy
of the dive database is to export the information to another compatible format
which can be imported into Subsurface.
[[S_ImportingDivinglog]]
=== Exporting dives from DivingLog 5.0
[icon="images/icons/divingloglogo.jpg"]
[NOTE]
Unfortunately DivingLog XML files give us no
indication on the preferences set on one's system. So in order for
Subsurface to be able to successfully import XML files from DivingLog
one first needs to ensure that DivingLog is configured
to use the Metric system (one can easily change this within Diving Log by
selecting 'File -> Preferences -> Units and Language' by clicking the 'Metric'
button). Then do the following:
== APPENDIX D: FAQs.
=== Subsurface appears to miscalculate gas consumption and SAC
[[SAC_CALCULATION]]
'Question': I dived with a 12.2 l tank, starting with 220 bar and ending with 100 bar, and I calculate a different SAC compared what Subsurface calculates. Is Subsurface
miscalculating?
'Answer': Not really. What happens is that Subsurface actually calculates gas consumption differently - and better - than you expect. In particular, it takes the incompressibility of the gas into account. Traditionally, Gas consumption and SAC should be: +consumption = tank size x (start pressure - end pressure)+
and that's true for an ideal gas, and it's what you get taught in dive theory.
But an "ideal gas" doesn't actually exist, and real gases actually don't compress
linearly with pressure. Also, you are missing the fact that one atmosphere of
pressure isn't actually one bar.
So the real calculation is:
+consumption = (amount_of_air_at_beginning - amount_of_air_at_end)+
where the amount of air is not just "tank size times pressure in bar". It's a combination of: "take compressibility into account" (which is a fairly small issue under 220 bar - you'll see more differences when you do high-pressure tanks with 300bar) and "convert bar to atm" (which is the majority of your discrepancy). Remember: one ATM is ~1.013 bar, so without the compressibility, your gas use is:
+12.2*((220-100)/1.013)+
which is about 1445, not 1464. So there was 19 l too much in your simple calculation that ignored the difference between 1 bar and one ATM. The compressibility does show up above 200 bar, and takes that 1445 down about eight litres more, so you really did use only about 1437 l of air at surface pressure.
So be happy: your SAC really is better than your calculations indicated. Or be sad: your cylinder contains less air than you thought it did. And as mentioned, the "contains less air than you thought it did" really starts becoming much more noticeable at high pressure. A 400 bar really does not contain twice as much air as a 200 bar one. At lower pressures, air acts pretty much like an ideal gas.
=== Some dive profiles have time discrepancies with the recorded samples from my dive computer...
Subsurface ends up ignoring surface time for many things (average depth, divetime, SAC, etc). 'Question': Why do dive durations in my dive computer differ from that given by Subsurface?
'Answer': For example, if you end up doing a weight check (deep enough to trigger the "dive started") but then come back up and wait five minutes for your buddies, your dive computer may say that your dive is 50 minutes long - because you have fifty minutes worth of samples - but subsurface will say it's 45 minutes - because you were actually diving for 45 minutes. It's even more noticeable if you do things like divemastering the initial OW dives, when you may stay in the water for a long time, but spend most of it at the surface. And then you don't want that to count as some kind of long diveâ.