Final update to ReleaseNotes for 4.0
[subsurface.git] / ReleaseNotes.txt
1                         Subsurface 4.0
2                         ==============
3
4 The Subsurface developer team is proud to announce the release of the
5 next major version of Subsurface.
6
7 Subsurface is an open source divelog program that runs on Windows, Mac
8 and Linux.
9
10 With Subsurface the user can download dive information directly from a
11 large number of supported dive computers. Subsurface is able to track
12 single- and multi-tank dives using air, Nitrox or TriMix. It displays
13 a dive profile with all related information including air consumption
14 and alarms. It also allows logging of information like weights and
15 exposure protection used, dive masters and dive buddies, and enables
16 the user to rate dives and provide additional dive notes.
17
18 With Subsurface the user can track dive locations including GPS
19 coordinates (which can also be conveniently entered using a map
20 interface). Subsurface calculates a wide variety of statistics of the
21 user's diving and keeps track of information like the user's SAC rate,
22 partial pressures of O2, N2 and He, calculated deco information, and
23 many more.
24
25 Subsurface allows the user to print out a detailed log book including
26 dive profiles and other relevant information. The program is localized
27 in about 20 languages and well supported by an active developer
28 community.
29
30 One of the major strengths of Subsurface is its support of a wide range
31 of dive computers (most common dive computers are supported with the help
32 of libdivecomputer); a detailed list is in the SupportedDivecomputers.txt
33 file. Subsurface can also import existing dive logs from several sources
34 including MacDive, Suunto DM3/DM4, JDiveLog and divelogs.de. Another
35 strength is its ability to visualize the depth profile (and, if
36 available, the tank pressure curve) in very innovative ways that give
37 the user additional information on relative velocity (and momentary
38 air consumption) during the dive through the coloring of the graphs.
39
40 New in version 4.0 (compared to Subsurface 3.1):
41 --------------------------------------------------
42
43 With version 4.0 the Subsurface team switched to a different UI
44 toolkit. This caused the need to do a complete rewrite of a large
45 chunk of the Subsurface code base. We decided to keep much of the
46 logic and core of the existing code around, but used the opportunity
47 for quite a bit of cleanup and many improvements.
48
49 The basic concepts are the same, most of the basic features are the
50 same, but trying to create a concise list of changes that summarizes
51 the more than 1600 commits that have gone in since version 3.1 seems a
52 daunting task.
53
54 Here are some of the highlights:
55
56 - new map widget with a spinning globe to visualize dive locations
57 - much more "native" look and feel under Windows and Mac
58 - ability to edit dives "in place": simply click on an entry in the
59   Dive Notes or Equipment tabs to start editing
60 - more data about each dive is presented in the Dive Notes and can
61   be edited without separate dialogs and without having to go through
62   context menues
63 - graphical editor for dive profiles for manually added dives
64 - better information overlay for the dive profile
65 - addition of a "ruler" tool in the profile window that allows
66   measuring of many properties between two points in the profile
67 - better tag system with both predefined user-specified free text tags
68 - better integration with divelogs.de (upload & download support)
69 - ability to show the user manual from within the application without
70   a life internet connection and without opening the manual in an
71   external browser window
72 - better statistics (with per-trip statistics available)
73
74 Known issues:
75
76 - Filter->Select Events is not implemented
77 - Dive planner has been disabled for now
78 - https support for divelogs.de on Windows is disabled
79
80
81
82 New in version 3.1 (compared to Subsurface 3.0.2):
83 --------------------------------------------------
84
85 - track tags for dives (things like 'boat', 'shore', 'deep', etc)
86 - enable filtering by tags
87 - ability to modify events from a context menu in the dive profile
88   (this includes the ability to add gaschange events)
89 - direct export / upload to the divelogs.de online logbook
90 - import of Suunto DM4 files
91 - improved printout formatting and printer dialog
92 - support for color printing
93 - dive planning: add option for last stop at 6m/20ft
94 - added support for Heinrichs Weikamp OSTC3 and Suunto DX
95 - native support for the Shearwater Petrel (much faster download)
96 - various bug fixes
97
98
99
100 New in version 3.0.2 (compared to Subsurface 3.0.1):
101 ----------------------------------------------------
102
103 This update was mainly triggered by a bug in the handling of pO2
104 values read from CCR / rebreather dive computers. This bug can lead to
105 incorrect data being stored in the Subsurface XML file. Installing
106 Subsurface 3.0.2 and re-downloading the dives will correct the
107 incorrect data. In order to re-download the dives connect your dive
108 computer (this should only affect people with certain tec dive
109 computers like the Shearwater Petrel or Predator that store pO2 values
110 read from a pO2 sensor in their dive log), open the download dialog,
111 check the box "Force download of all dives" and download your
112 dives. After you save your data file the correct pO2 data should be
113 stored in the samples.
114
115 If you are using one of those dive computers, have saved data files
116 with Subsurface 3.0 or 3.0.1 and have since deleted those dives from
117 your dive computers, please contact the developers as we also have an
118 experimental script that should be able to fix incorrect XML files -
119 but re-downloading the data is the much more reliable way to address
120 this issue.
121
122 In addition to this bug fix, 3.0.2 brings a number of other improvements:
123  - A Portuguese localization of Subsurface was added.
124  - Subsurface now remembers its window size and pane layout the next time
125    it is started.
126  - Several importers for data for third party dive software were improved.
127  - Dives from the Heinrichs & Weikamp DR5 and from kenozooid can now be
128    imported into Subsurface.
129  - A crash with localized versions of Subsurface on Mac was resolved.
130  - The map provider for the GPS maps is now configurable.
131  - The layout of some dialog boxes was changed to improve usability on
132    small screens.
133  - It is now easier to edit date and time of existing dives (and you can
134    now edit duration, maximum and average depth for dives that were
135    manually entered).
136  - Several small bugs were addressed.
137
138
139 New in version 3.0.1 (compared to Subsurface 3.0):
140 --------------------------------------------------
141
142 - Several bug fixes for importing log files from other divelog software;
143   especially imports from DivingLog should work much better now, but
144   also new importer functions for UDDF and UDCF
145 - Fixes for SAC calculation and gas volume estimates at high pressures
146   (air and nitrox are NOT ideal gases in the physics sense)
147 - Added Help link to the online user manual
148 - Improved the user manual
149 - random other bug fixes
150
151
152 New in version 3.0 (compared to Subsurface 2.1):
153 ------------------------------------------------
154
155 - Many new divecomputers supported, bugfixes for existing divecomputers
156   - Cressi Leonardo, Seemann XP5, Mares Matrix, Mares Puck Pro, Mares
157     Nemo Wide 2, Shearwater Petrel, Shearwater Predator, Aeris A300
158     AI, Hollis DG03
159   - significant improvements for the Heinrichs Weiskamp OSTC
160 - Significantly improved selection of divecomputers for direct download
161 - Map display of GPS locations of dives and ability to enter and edit those
162 - Improved automatic dive numbering
163 - Data overlay for profile plot (with additional statistics information)
164 - Zoom function for profile plot
165 - Dive planner
166 - Improved printing support
167 - Improved dive trip handling
168 - Support for downloading dives from multiple computers (so for example
169   both your main and your backup computer)
170 - Added ability to import existing divelogs from Suunto DM3 (no manual
171   unpacking needed anymore), MacDive and divelogs.de
172 - Lots of features to make tec divers happy:
173   - Experimental deco calculation with optional display of a calculated
174     ceiling (Buhlmann ZH16 with gradient factors)
175   - Display of deco information from some divecomputers that support this
176   - TriMix support
177   - CCR support (fixed or variable setpoint, on dive computers that support
178     this)
179   - Optional pO2, pN2 and pHe graphs
180   - CNS tracking for supported divecomputers
181 - Lots of bug fixes
182
183
184 License: GPLv2
185
186 Subsurface can be found at http://subsurface.hohndel.org
187
188 At the time of the 3.1 release subsurface supports the following dive
189 computers:
190
191 Atomics Aquatics
192         Cobalt
193 Cressi / Zeagle / Mares
194         Edy, Nemo Sport
195         N2iTiON3
196         Leonardo
197 Mares
198         Nemo, Nemo Excel, Nemo Apneist,...
199         Puck, Puck Air, Nemo Air, Nemo Wide,...
200         Darwin, Darwin Air, M1, M2, Airlab
201         Icon HD, Icon HD Net Ready, Nemo Wide 2
202 Oceanic / Aeris / Sherwood / Hollis / Genesis / Seemann / Tusa (Pelagic)
203         VT Pro, Versa Pro, Pro Plus 2, Wisdom, Atmos 2, Atmos AI, Atmos Elite,...
204         Veo 250, XP5, Veo 180Nx, XR2, React Pro, React Pro White, DG02, Insight,...
205         Atom 2.0, VT3, Datamask, Geo, Geo 2.0, Veo 2.0, Veo 3.0, Pro Plus 2.1, Pro Plus 3,
206         Compumask, Elite T3, Epic, Manta, IQ-900 (Zen), IQ-950 (Zen Air), IQ-750 (Element II),...
207 Heinrichs Weikamp
208         OSTC, OSTC Mk.2, OSTC 2N, OSTC3
209         Frog
210 Reefnet
211         Sensus
212         Sensus Pro
213         Sensus Ultra
214 Shearwater
215         Predator, Petrel
216 Suunto
217         Solution
218         Eon, Solution Alpha and Solution Nitrox/Vario
219         Vyper, Cobra, Vytec, Vytec DS, D3, Spyder, Gekko, Mosquito, Stinger, Zoop
220         Vyper2, Cobra2, Cobra3, Vyper Air and HelO2
221         DX, D9, D6, D4, D9tx, D6i and D4i
222 Uemis
223         Zurich
224 Uwatec
225         Aladin
226         Memo Mouse
227         Smart, Galileo (infraread)
228 Zeagle
229         N2iTiON 3
230