From 0f7dfcee26812b44d276ea44acefa135a376c0f6 Mon Sep 17 00:00:00 2001 From: Willem Ferguson Date: Sun, 16 Mar 2014 06:34:35 +0200 Subject: User manual: Update sections 4 and 5 A new figure is included to reflect the actions of the new profile buttons on the calculated ceilings. A number of small edits on sections 4 and 5 of the user manual are done. These sections are now finalised for the new release. Signed-off-by: Willem Ferguson Signed-off-by: Dirk Hohndel --- Documentation/images/Ceilings2.jpg | Bin 0 -> 24514 bytes Documentation/user-manual.html.git | 309 ++++++++++++++++++++++++------------- Documentation/user-manual.txt | 48 +++--- 3 files changed, 228 insertions(+), 129 deletions(-) create mode 100644 Documentation/images/Ceilings2.jpg diff --git a/Documentation/images/Ceilings2.jpg b/Documentation/images/Ceilings2.jpg new file mode 100644 index 000000000..66a818417 Binary files /dev/null and b/Documentation/images/Ceilings2.jpg differ diff --git a/Documentation/user-manual.html.git b/Documentation/user-manual.html.git index 8ff3e0431..8fd84ecc5 100644 --- a/Documentation/user-manual.html.git +++ b/Documentation/user-manual.html.git @@ -1813,7 +1813,10 @@ water temperature and surface air consumption (SAC).

Of all the panels in Subsurface, the Dive Profile contains the most detailed -information about each dive. The main item in the Dive profile is the graph of +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 @@ -1863,6 +1866,48 @@ cellspacing="0" cellpadding="4">

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.

+
+ + + +
+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.

+
+ + + +
+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.
+
+
+ + + +
+Note +Clicking this button allows display of the partial pressure of nitrogen during the dive.
+
+
+ + + +
+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. @@ -1877,8 +1922,6 @@ times of increased normalized air consumption while dark green reflects times when the diver was using less gas than average. The colour coding is obviously only possible when a tank sensor is connected and tank pressure readings during the dive are available.

-

Water temperature is displayed with its own blue line with temperature values -placed adjacent to significant changes.

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 @@ -1891,50 +1934,94 @@ that free divers clearly won’t care about.

FIGURE: Measuring Bar
-

Measurements of depth differences can be achieved by using the button with -two vertical bars at the right of the dive profile panel (users should refer to -the above figure, -bottom right). The measurement is done by dragging the red dots to the two points +

+ + + +
+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 -along the line connecting the -two red dots.

-

The dive profile can include further information that is typically more -interesting for tec divers. Enabling these is described in the section entitled -Setting up Preferences. Basically, users can include graphs of the partial -pressures -of O2, N2, and He during the dive as well as a calculated and dive computer -reported deco ceilings (only visible for deep, long, or repetitive dives). The -partial pressure graphs are added below the profile data, the calculated ceiling -is shown as a green overlay on top of the dive profile. Above the profile the -currently used gradient factors are shown (e.g. GF 35/75). Please note that -these are NOT the gradient factors in use by the dive computer in question, -but the gradient factors used by Subsurface to calculate deco obligations -during the dive.

-

The graph can also include the dive computer reported ceiling (or more -precisely, the first deco stop that the dive computer recorded – users are reminded that not +in the horizontal white area underneath the +two red dots.

+
+

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). Because of the differences in used algorithms -and amount of data available (and factors taken into consideration) at the time -of the calculation it is unlikely that both of these are the same; this can be -true even if the same algorithm and gradient factors (see below) are used. +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 dark green section in the profile at the beginning of this section). This is caused by the fact that Subsurface’s -calculations describe the deco obligation at that point in time during a dive, +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 +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 time.

-

For a more detailed explanation of gradient factors, use the following links:

+longer non-stop bottom times.

+
+ + + +
+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.
+
+
+ + + +
+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:
+
+
+ + + +
+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).
+
+
+ + + +
+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).
+
+
+
+Figure: Ceiling with 3m resolution +
+
+

Gradient Factor settings strongly affect the calculated ceilings and their depths. +For more information about Gradient factors, see the section on 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:

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 +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.

@@ -1973,9 +2060,9 @@ during subsequent dive analyses.

Figure: Information Box -

The moment the mouse points inside the Dive Profile panel, it expands and +

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 (see right-hand part of figure (B) above +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 @@ -1988,6 +2075,59 @@ maximum operating depth, effective air depth (EAD), effective 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 statstics, represented as four +buttons on the left of the profile panel. These are:

+
+ + + +
+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.
+
+
+ + + +
+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.
+
+
+ + + +
+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.
+
+
+ + + +
+Note +Clicking this button displays the Effective Air Depth (EAD) as well as the Effective +Narcotic Depth (END) for the dive. These are numbers of importance to divers who use Nitrox or +Trimix as breathing gases. Their values are dependent on the composition of the breathing gas.
+
+

Figure (B) above shows an information box with a nearly complete set of data.

@@ -2012,8 +2152,8 @@ a dive or a group of dives and then right-clicking.

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 that -has an older date/time. Therefore, one may sometimes need to renumber the dives. +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) @@ -2033,28 +2173,30 @@ list comprising five dive trips (B, on the right):

Grouping into trips allows a rapid way of accessing individual dives without -having to scan 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.

+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.

-

5.3.1. Viewing the dives during a particular trip

-

Once when 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.

-
-
-

5.3.2. Editing the title and associated information for a particular trip

+

5.3.1. 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 +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 during the trip, etc.). After entering this -information, users should select Save from the buttons at the top right of the Trip Notes +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.

+

5.3.2. Viewing the dives during a particular trip

+

Once when 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.

+
+

5.3.3. 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 @@ -2074,7 +2216,8 @@ 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 bellow show the selection and context menu on the left (A) and +into a separate trip. The figures bellow shows the selection and context menu +on the left (A) and the completed action on the right (B):

@@ -2096,18 +2239,17 @@ calibration dives of the dive computer or dives of extremely short duration.

5.4.2. Unlink a dive from a trip

Users can unlink dives from the trip to which they belong. In order to do this, -users should select and right-click -the relevant dives to bring up the context menu. Then the option Remove dive(s) -from trip should be selected. -The dives that have been unlinked now appear immediately above the trip to +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.

5.4.3. 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, users must select +the trip immediately above the currently active trip. To do this, select and right-click -the dives to bring up the context menu, and then select Add dive(s) to trip +the dive(s) to bring up the context menu, and then select Add dive(s) to trip immediately above.

@@ -2153,7 +2295,7 @@ below shows the depth profile two such dives that were merged:

  • -Universal Dive Data format (UDDF). User should refer to http://uddf.org for more information. +Universal Dive Data format (UDDF). Refer to http://uddf.org for more information. UDDF is a generic format that enables communication among many dive computers and computer programs.

    @@ -2324,7 +2466,7 @@ independently, with some units in the metric system and other in the imperial.
    • -

    This panel allows two type of selections:

    +

    This panel allows two type of selections:

    • @@ -2343,44 +2485,6 @@ figure below).

    • -Ceiling: 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. -Subsurface can indicate these ceilings above which the diver should not ascend -at a particular point in time (see the green-shaded areas in the figure in the -section on Dive Profiles) and in the figure below: -

      -
        -
      • -

        -If the Calculated ceiling option is checked, then a ceiling is shown if it exists for -a particular dive (A in figure below) -

        -
        • -
      • -

        -If the show all tissues option is checked, the ceiling is shown for the tissue -compartments following the Bühlmann model (B in figure below). -

        -
        • -
      • -

        -If the 3m increments option is checked, then the ceiling is indicated in 3 m increments -(C in figure below). -

        -
        • -
      • -

        -If the dive computer itself calculates a ceiling and makes it available to -Subsurface during upload of dives, this can be -shown by checking Dive computer reported ceiling and it can be drawn in red by -checking Draw ceiling red. -

        -
        • -
      -
      • -
    • -

      If a Maximum operating depth (MOD) or an Equivalent air depth (EAD) applies to a dive profile, these can be shown by checking the appropriate boxes.

      @@ -2395,16 +2499,9 @@ appropriate box.
    -
    -
    -
    -Figure: Ceiling with 3m resolution -
    -
    -

    • -Misc: Here users can set the gradient factors used while diving. GF_Low is +Misc: Gradient Factors: Here users can set the gradient factors used while diving. GF_Low is the gradient factor at deep 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 @@ -3302,7 +3399,7 @@ you may stay in the water for a long time, but spend most of it at the surface.

      diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index f33ac677f..4569bd895 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1201,7 +1201,7 @@ water temperature and surface air consumption (SAC). image::images/Profile2.png["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 laft hand side +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 @@ -1343,7 +1343,6 @@ during the dive. For more information external to this manual see: ** 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 @@ -1445,8 +1444,8 @@ 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 that -has an older date/time. Therefore, one may sometimes need to renumber the dives. +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) @@ -1465,27 +1464,30 @@ 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 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. - -==== Viewing the dives during a particular trip -Once when 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. +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 +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 during the trip, etc.). After entering this -information, users should select *Save* from the buttons at the top right of the *Trip Notes* +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 when 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 @@ -1506,7 +1508,8 @@ 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 bellow show the selection and context menu on the left (A) and +into a separate trip. The figures bellow 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"] @@ -1524,18 +1527,17 @@ 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, -users should select and right-click -the relevant dives to bring up the context menu. Then the option *Remove dive(s) -from trip* should be selected. -The dives that have been unlinked now appear immediately above the trip to +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, users must select +the trip immediately above the currently active trip. To do this, select and right-click -the dives to bring up the context menu, and then select *Add dive(s) to trip +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) @@ -1570,7 +1572,7 @@ A dive log can be saved in two formats: * _Subsurface_ XML format. This is the native format used by _Subsurface_. -* Universal Dive Data format (UDDF). User should refer to http://uddf.org for more information. +* Universal Dive Data format (UDDF). Refer to http://uddf.org for more information. UDDF is a generic format that enables communication among many dive computers and computer programs. -- cgit v1.2.3-70-g09d2