Changeset 75e8b1e in subsurface


Ignore:
Timestamp:
Dec 6, 2013, 10:59:55 AM (4 years ago)
Author:
Dirk Hohndel <dirk@…>
Branches:
Mtest, android_test, dcDownload, foratdotde, gitMerge, gitdebug, gitpictures, ios, master, mergeKirigamiPort, pictimeshift, resolutionIndependence, spinner, testTomaz, testing, v4.0-branch, v4.0.3-branch, v4.2-branch, v4.4-branch, v4.5-branch
Children:
710fba9
Parents:
f20e07d
git-author:
Willem Ferguson <willemferguson@…> (12/06/13 10:09:55)
git-committer:
Dirk Hohndel <dirk@…> (12/06/13 10:59:55)
Message:

Usermanual update.

1) Several layout changes including banner.
2) Stylistic revision of part of textr.
3) Addition of text to dive computer upload section.

Signed-off-by: Willem Ferguson <willemferguson@…>
Signed-off-by: Dirk Hohndel <dirk@…>

File:
1 edited

Legend:

Unmodified
Added
Removed
  • Documentation/user-manual.txt

    rc7a4bb1 r75e8b1e  
    1 Subsurface 4.0 User Manual
    2 ==========================
    3 :author: Manual authors: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem Ferguson
    4 
    5 :revnumber: 4.0
    6 :revdate: December 2013
     1// Subsurface 4.0 User Manual
     2// ===========================
     3// :author: Manual authors: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem Ferguson
     4// :revnumber: 4.0
     5// :revdate: December 2013
     6:icons:
    77:toc:
    8 :icons:
     8:toc-placement: manual
    99:numbered:
    10 :website: http://subsurface.hohndel.org
    11 
    12 Welcome as a user of _subsurface_, an advanced dive logging programme with extensive infrastructure to describe, organise and interpret scuba and free dives. _subsurface_ runs on many hardware platforms and software environments. These include Linux (many distros), Mac (OS/X) and Windows (Win XP or later). 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 writing 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 README file included with the source code.
     10// :website: http://subsurface.hohndel.org
     11
     12image::images/SubsurfaceBanner.png["Banner",align="center"]
     13
     14[big]#USER MANUAL#
     15
     16*Manual authors*: Jacco van Koll, Dirk Hohndel, Reinout Hoornweg, Linus Torvalds, Miika Turkia, Amit Chaudhuri, Jan Schubert, Willem Ferguson
     17
     18[blue]#_Version 4.0,  December 2013_#
     19
     20
     21Welcome as a user of _subsurface_, an advanced dive logging programme with extensive infrastructure to describe, organise and interpret scuba and free dives. _subsurface_ runs on many hardware platforms and software environments. These include Linux (many distros), Mac (OS/X) and Windows (Win XP or later). 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 writing 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 README file included with the source code.
    1322
    1423*Audience*: Recreational Scuba Divers, Free Divers, Tec Divers, Professional Divers
     24
     25toc::[]
    1526
    1627[[S_StartUsing]]
     
    3849*All*: show all four of the above panels.
    3950
    40 *Divelist*: Show only the dive list. One can select and highlight a dive on the dive list by clicking on it.
    41 
    42 *Profile*: Show only the profile of the highlighted dive in the dive list.
    43 
    44 *Info*: Show only the textual information about the highlighted dive.
     51*Divelist*: Show only the Dive List. One can select and highlight a dive on the dive list by clicking on it.
     52
     53*Profile*: Show only the Dive Profile of the highlighted dive in the dive list.
     54
     55*Info*: Show only the Dive Notes about the highlighted dive.
    4556
    4657*Globe*: Show only the world map, centered on the highlighted dive.
     
    51621) Create a new logbook in which you can store dive data.
    5263
    53 2) Store dive information in the new logbook.
    54 
    55 3) Save the information in your logbook.
     642) Enter information in the new logbook.
     65
     663) Save your logbook.
    5667
    5768[[S_NewLogbook]]
     
    69802. Import dive information directly from a dive computer if it is supported by _subsurface_. The latest list of dive computers supported by _subsurface_ can be found at: link:http://subsurface.hohndel.org/documentation/supported-dive-computers/[Supported dive computers].
    7081
    71 3. Import dive information from another file format. This is discussed in more detail below.
     823. Import dive information from another data base or file format. This is discussed in more detail below.
    7283
    7384[[S_EnterData]]
    7485=== Entering dive information by hand
    7586
    76 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 written dive logbook includes dive type, date, time, duration of dive, depth of dive, name of buddy and of dive master and some remarks about the dive. _subsurface_ can store much more information than this for each dive. In order to add a dive to your dive log, click on _Log -> Add Dive_. The program then shows three panels to enter information for a dive: two tabs in the *Info* panel (*Dive Notes* and *Equipment*), as well as the *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. We will now consider each of the tabs used for data entry.
     87This 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 written dive logbook includes dive type, date, time, duration of dive, depth of dive, name of buddy and of dive master and some remarks about the dive. _subsurface_ can store much more information than this for each dive. In order to add a dive to your 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 *Info* panel (*Dive Notes* and *Equipment*), as well as the *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. We will now consider each of the tabs used for data entry.
    7788
    7889image::images/AddDive1.jpg["The most important parts of the _subsurface_ window for manual data entry",align="center"]
     
    8899*Air/water temperatures*: Type in the air and water temperatures during the dive into these fields to the right of the Starttime. You do not need to type in units of temperature: subsurface supplies these automatically, you only need type the number. (The units selected in the 'Preferences' [red]#[[URL link]]# will determine whether metric or imperial units are displayed)
    89100
    90 *Location*: Here type in text that describes the site where you did this dive, e.g. "Lake Balaton, Hungary".
     101*Location*: Here type in text that describes the site where you did this dive, e.g. "Tihany, Lake Balaton, Hungary".
    91102
    92103*Coordinates*: The geographic coordinates of the dive site should be entered here. These can come from three sources:
     
    113124*Notes*: Type any additional information here.
    114125
    115 The *Save* and *Cancel* buttons are used to save all the information for the dive after all the other information has been added. Here is an example of a completed Dive Notes panel:
     126The *Save* and *Cancel* buttons are used to save all the information for the whole dive after ALL the other information has been added. Do NOT use them before also completing the *Equipment* tab as well as the *Dive Profile*. Here is an example of a completed Dive Notes panel:
    116127
    117128image::images/CompletedDiveInfo.png["Example: A completed Dive Notes tab",align="center"]
     
    119130==== Equipment
    120131
    121 The Equipment tab allows the user to enter information about the type of cylinder and gas you used, as well as the weighting for that dive. The message in a blue box at the top of the panel:
     132The Equipment tab allows the user to enter information about the type of cylinder and gas used, as well as the weighting for a dive. The message in a blue box at the top of the panel:
    122133
    123134image::images/BlueEditBar.png["Blue edit bar",align="center"]
     
    129140image::images/CylinderDataEntry1.png["Initial cylinder dialogue",align="center"]
    130141
    131 The + icon at the top right allows one to add more cylinders for this dive. The dark dustbin icon on the left allows one to delete information for a cylinder.
     142The + button at the top right allows one to add more cylinders for this dive. The dark dustbin icon on the left allows one to delete information for a cylinder.
    132143
    133144Start by selecting a cylinder type. The AL80 cylinder is shown as the default cylinder type. If you wish to change this, click on the AL80. This will bring up a dropdown list, accessible through a down-arrow:
     
    137148Use the dropdown list to select the cylinder type you used for this dive. The *Size* of the cylinder as well as its working pressure (*WorkPress*) will automatically be shown in the dialogue.
    138149
    139 Now you need to indicate the starting pressure and the ending pressure of the specified gas during your dive. The unit of pressure (metric/imperial) corresponds to the setting you chose in the preferences [red]#[[LINK]]#.
    140 
    141 Finally you need to type in the gas mixture that you used. If you used air, you can enter 21% or leave the field blank. If you used nitrox or trimix, specify the percentage of oxygen and the percentage of helium. Leave any inappropriate fields empty. Add information for any additional cylinders by using the + icon at the top right hand. Here is an example of a complete description for a dive using two cylinders (air and EAN40):
     150Now you need to indicate the starting pressure and the ending pressure of the gas used during your dive. The unit of pressure (metric/imperial) corresponds to the setting you chose in the preferences [red]#[[LINK]]#.
     151
     152Finally you need to type in the gas mixture that you used. If you used air, you can enter 21% or leave the field blank. If you used nitrox or trimix, specify the percentage of oxygen and the percentage of helium. Leave any inappropriate fields empty. Add information for any additional cylinders by using the + button at the top right hand. Here is an example of a complete description for a dive using two cylinders (air and EAN40):
    142153
    143154image::images/CylinderDataEntry3.png["Example: a completed cylinder dive information table",align="center"]
    144155
    145 *Weights*: Information about the weighting system used during a dive can be entered using a dialogue very similar to that of the cylinder information. If you click the + icon on the top right of the weights dialogue, the table looks like this:
     156*Weights*: Information about the weighting system used during a dive can be entered using a dialogue very similar to that of the cylinder information. If you click the + button on the top right of the weights dialogue, the table looks like this:
    146157
    147158image::images/WeightsDataEntry1.png["The Weights dialogue",align="center"]
     
    151162image::images/WeightsDataEntry2.png["Weights type drop-down list button",align="center"]
    152163
    153 Use the dropdown list to select your type of weighting system. In the *Weight* field, type in the weight used during the dive. It is possible to enter information for more than one weighting system by adding an additional system using the + icon on the top right hand. Weighting 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:
     164Use the dropdown list to select your type of weighting system. In the *Weight* field, type in the weight used during the dive. It is possible to enter information for more than one weighting system by adding an additional system using the + button on the top right hand. Weighting 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:
    154165
    155166image::images/WeightsDataEntry3.png["Example: A completed weights information table",align="center"]
    156167
     168Do NOT select the _Save_ button before you have completed the dive profile.
    157169
    158170==== Creating a Dive Profile
     
    162174image::images/DiveProfile1.png["Initial dive profile",align="center"]
    163175
    164 _Configuring the dive profile_: When one moves the cursor around the dive profile, its position is indicated by two red lines as shown above. The depth and time that the cursor represents are indicated, respectively on the left hand and bottom axes. The units (metric/imperial) on the axes are determined by the *preference* settings [red]#[[LINK]]#. The dive profile itself comprises several line segments demarcated by waypoints (white dots on the profile, as shown above). The default dive depth is 15m. If your dive depth was 21m then you need to drag the appropriate waypoints downwards to represent 21m. To add a waypoint, double-clicking on any line segment. To remove a waypoint, right-click on it and choose "Remove this point" from the context menu. You will also need to drag the waypoints to represent an accurate time duration for your dive. Below is a dive profile that represents a dive to 21m for 31 min., followed by a 3 minute safety stop at 5m.
     176_Configuring the dive profile_: When one moves the cursor around the dive profile, its position is indicated by two red lines as shown above. The depth and time that the cursor represents are indicated, respectively on the left hand and bottom axes. The units (metric/imperial) on the axes are determined by the *preference* settings [red]#[[LINK]]#. The dive profile itself comprises several line segments demarcated by waypoints (white dots on the profile, as shown above). The default dive depth is 15m. If your dive depth was 21m then you need to drag the appropriate waypoints downwards to represent 21m. To add a waypoint, double-click on any line segment. To remove a waypoint, right-click on it and choose "Remove this point" from the context menu. You will also need to drag the waypoints to represent an accurate time duration for your dive. Below is a dive profile that represents a dive to 21m for 31 min., followed by a 3 minute safety stop at 5m.
    165177
    166178image::images/DiveProfile2.png["Edited dive profile",align="center"]
    167179
    168 _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 performed by clicking on the gas description for a particular segment and selecting the appropriate choice from the context menu. Note that only the gases defined in the *Equipment* tab appear in the context menu:
     180_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 performed by clicking on the gas description for a particular waypoint and selecting the appropriate choice 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:
    169181
    170182image::images/DiveProfile3.png["Gas composition context menu",align="center"]
    171183
    172 If one inadvertently clicks on the gas composition but one does not wish to change this, press the ESCAPE keyboard button. Below is the profile of a dive to 21m for 31 min. with a switch from air to EAN40 on the ascent. In this case the first cylinder in the *Equipment* tab contained air and the second cylinder contained EAN40.
     184Below is the profile of a dive to 21m for 31 min. with a switch from air to EAN40 on the ascent. In this case the first cylinder in the *Equipment* tab contained air and the second cylinder contained EAN40.
    173185
    174186image::images/DiveProfile4.png["Example: Completed dive profile",align="center"]
     
    176188==== Saving the hand-entered dive information
    177189
    178 The information entered in the *Dive Notes* tab, the *Equipment* tab as well as the dive profile can now be saved in your logbook by using the two buttons on the top right hand of the Dive Notes tab. If one clicks _Save_, the dive data are saved. If a logbook file hasn't been selected before, one can now select name and place to store the logbook otherwise it is saved in the already opened logbook. If one clicks _Cancel_, the newly entered dive data are deleted. When one exits _subsurface_ there is a final prompt to confirm that the new data should be saved.
     190The information entered in the *Dive Notes* tab, the *Equipment* tab as well as the *Dive Profile* can now be saved in your logbook by using the two buttons on the top right hand of the Dive Notes tab. If one clicks _Save_, the dive data are saved. If a logbook file hasn't been selected before, one can now select the file name and directory to store the logbook, otherwise it is saved in the already opened logbook. If one clicks _Cancel_, the newly entered dive data are deleted. When one exits _subsurface_ there is a final prompt to confirm that the new data should be saved.
    179191
    180192
     
    196208batteries while connected to the USB port.
    197209
    198 To import dive information from a dive computer to your computer with _subsurface_, it is necessary that the two pieces of equipment must communicate. In order to set up this communication, you need to find the appropriate information to instruct _subsurface_ where and how to import the dive information. *Appendix A* provides the technical information to help you achieve this for different operating systems and *Appendix B* has divecomputer specific information.
     210To import dive information from a dive computer to your computer with _subsurface_, it is necessary that the two pieces of equipment must communicate. In order to set up this communication, you need to find the appropriate information to instruct _subsurface_ where and how to import the dive information. *Appendix A* provides the technical information to help you achieve this for different operating systems and *Appendix B* has dive computer specific information.
    199211
    200212Now it is time to hook up your dive computer to your PC:
     
    206218        (You should consult the manual of your specific dive computer for your brand and type)
    207219
    208  - In Subsurface, from the main menu, select _Import -> Import From Dive Computer_. The following dialogue appears:
     220 - In _subsurface_, from the main menu, select _Import -> Import From Dive Computer_. The following dialogue appears:
    209221
    210222
     
    219231 -  Click the _OK_ button.
    220232
    221  - If there is a problem in communicating with your dive computer, an error message will be shown, similar to this text: "Unable to open /dev/ttyUSB0 Mares (Puck Pro)". In this case, consult *Appendix A* for information specific to the operating system of your _subsurface_ computer and consult *Appendix B* for information specific to some dive computers.
     233 - If there is a problem in communicating with your dive computer, an error message will be shown, similar to this text: "Unable to open /dev/ttyUSB0 Mares (Puck Pro)". In this case, consult *Appendix A* for information specific to the operating system of your _subsurface_ computer and consult *Appendix B* for information specific to some dive computers.
     234
     235[icon="images/icons/important.png"]
     236[IMPORTANT]
     237In the case of *communication failure* then check the following:
     2381) Is the dive coputer still in PC-communication or Upload mode?
     2392) Is the battery of the dive computer fully loaded? If not then load or replace the battery.
     2403) Is the cable faulty? Does the cable work perfectly using other software? Has it worked before, or is this the first time you are using the cable?
     2414) Consult *Appendix A* and make sure you specified the correct Mount Point (see above). If your _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 communcation failure between dive computer and _subsurface_ computer.
     242
    222243
    223244 - With communication established, watch how your data is retrieved from your dive computer!
    224    Depending on your type of computer and/or number of dives, this
    225    could take some time. Please be patient. The import dialogue shows a progress bar at the bottom of the dialogue:
     245   Depending on your make of computer and/or number of dives, this
     246   could take some time. Please be patient. The _Download_ dialogue shows a progress bar at the bottom of the dialogue:
    226247
    227248image::images/ImportFromDC2.png["Download dialogue 2",align="center"]
    228249
    229 When download of the dive information is complete, all the imported dives appear on your Dive List, sorted by date and time. Switch off your dive computer to conserve its battery power.
     250When download of the dive information is complete, all the imported dives appear in the Dive List, sorted by date and time. Disconnect and switch off the dive computer to conserve its battery power.
    230251If one selects a particular dive, the Dive Profile panel shows an informative graph of dive depth against time for that particular dive.
    231252
     
    270291*Notes*: Type any additional information here.
    271292
    272 The *Save* and *Cancel* buttons are used to save all the information for the dive after all the other information has been added. Here is an example of a completed Dive Notes panel:
     293The *Save* and *Cancel* buttons are used to save all the information for the whole dive after ALL the other information has been added. Do NOT use them before also completing the Equipment tab. Here is an example of a completed Dive Notes panel:
    273294
    274295image::images/CompletedDiveInfo.png["Example: A completed Dive Notes tab",align="center"]
     
    286307image::images/CylinderDataEntry1.png["Initial cylinder dialogue",align="center"]
    287308
    288 The + icon at the top right allows one to add more cylinders for this dive. The dark dustbin icon on the left allows one to delete information for a cylinder.
     309The + burron at the top right allows one to add more cylinders for this dive. The dark dustbin icon on the left allows one to delete information for a cylinder.
    289310
    290311Start by selecting a cylinder type. The AL80 cylinder is shown as the default cylinder type. If you wish to change this, click on the AL80. This will bring up a dropdown list, accessible through a down-arrow:
     
    296317Now you need to indicate the starting pressure and the ending pressure of the specified gas during your dive. The unit of pressure (metric/imperial) corresponds to the setting you chose in the preferences [red]#[[LINK]]#.
    297318
    298 Finally you need to type in the gas mixture that you used. If you used air, you can enter 21% or leave the field blank. If you used nitrox or trimix, specify the percentage of oxygen and the percentage of helium. Leave any inappropriate fields empty. Add information for any additional cylinders by using the + icon at the top right hand. Here is an example of a complete description for a dive using two cylinders (air and EAN40):
     319Finally you need to type in the gas mixture that you used. If you used air, you can enter 21% or leave the field blank. If you used nitrox or trimix, specify the percentage of oxygen and the percentage of helium. Leave any inappropriate fields empty. Add information for any additional cylinders by using the + button at the top right hand. Here is an example of a complete description for a dive using two cylinders (air and EAN40):
    299320
    300321image::images/CylinderDataEntry3.png["Example: a completed cylinder dive information table",align="center"]
    301322
    302 *Weights*: Information about the weighting system used during a dive can be entered using a dialogue very similar to that of the cylinder information. If you click the + icon on the top right of the weights dialogue, the table looks like this:
     323*Weights*: Information about the weighting system used during a dive can be entered using a dialogue very similar to that of the cylinder information. If you click the + button on the top right of the weights dialogue, the table looks like this:
    303324
    304325image::images/WeightsDataEntry1.png["The Weights dialogue",align="center"]
     
    308329image::images/WeightsDataEntry2.png["Weights type drop-down list button",align="center"]
    309330
    310 Use the dropdown list to select your type of weighting system. In the *Weight* field, type in the weight used during the dive. It is possible to enter information for more than one weighting system by adding an additional system using the + icon on the top right hand. Weighting 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:
     331Use the dropdown list to select your type of weighting system. In the *Weight* field, type in the weight used during the dive. It is possible to enter information for more than one weighting system by adding an additional system using the + button on the top right hand. Weighting 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:
    311332
    312333image::images/WeightsDataEntry3.png["Example: A completed weights information table",align="center"]
     
    314335==== Saving the updated dive information
    315336
    316 The information entered in the *Dive Notes* tab, the *Equipment* tab can be saved with all the other information of your dives in your logbook by using the two buttons on the bottom right hand of the Dive Notes tab. If one clicks Save, the dive data are saved. If one clicks Cancel, the newly entered dive data are deleted, although the dive profile obtained from the dive computer will be retained. When one exits _subsurface_ there is a final prompt to confirm that the new data should be saved.
     337The information entered in the *Dive Notes* tab, the *Equipment* tab can be saved with all the other information of your dives in your logbook by using the two buttons on the top right hand of the *Dive Notes* tab. If one clicks _Save_, the dive data are saved. If one clicks _Cancel_, the newly entered dive data are deleted, although the dive profile obtained from the dive computer will be retained. When one exits _subsurface_ there is a final prompt to confirm that the new data should be saved.
    317338
    318339=== Importing dive information from other digital data sources or other data formats
     
    328349the same dive and merges the information as best as it can. If
    329350there are no time zone issues (or other reasons that would cause the
    330 beginning time of the dives to be substantially different) _subsurface_
     351beginning time of the dives to be almost simmultaneous) _subsurface_
    331352will not create duplicate entries.
    332353
     
    600621For a more detailed explanation of _gradient factors_, use the following links:
    601622
    602 - link:http://www.tek-dive.com/portal/upload/M-Values.pdf[Understanding M-values, by Erik Baker, _Immersed_ Vol. 3, No. 3.]
     623- link:http://www.tek-dive.com/portal/upload/M-Values.pdf[Understanding M-values, by Erik Baker, 1988, _Immersed_ Vol. 3, No. 3.]
    603624
    604625- link:http://www.rebreatherworld.com/general-and-new-to-rebreather-articles/5037-gradient-factors-for-dummies.html[Gradient factors for dummies, by Kevin Watts]
     
    847868
    848869
    849 == APPENDIX A: Operating system specific information for importing dive information from dive computer.
     870== APPENDIX A: Operating system specific information for importing dive information from a dive computer.
    850871
    851872=== Make sure that your OS has the required drivers installed
Note: See TracChangeset for help on using the changeset viewer.