README
Open on GitHub ↗Subsurface
Subsurface can be found at http://subsurface-divelog.org/
Our user forum is at http://subsurface-divelog.org/user-forum/
Report bugs and issues at https://github.com/Subsurface/subsurface/issues
License: GPLv2
We are releasing 'nightly' builds of Subsurface that are built from the latest version of the code. Versions of this build for Windows, macOS, Android (requiring sideloading), and a Linux AppImage can be downloaded from the Latest Dev Release page on our website. Alternatively, they can be downloaded directly from GitHub. Additionally, those same versions are
posted to the Subsurface-daily repos on Ubuntu Launchpad, Fedora COPR, and
OpenSUSE OBS, and released to Snapcraft into the 'edge' channel of subsurface.
You can get the sources to the latest development version from the git
repository:
git clone https://github.com/Subsurface/subsurface.git
You can also fork the repository and browse the sources at the same site,
simply using https://github.com/Subsurface/subsurface
Additionally, artifacts for Windows, macOS, Android, Linux AppImage, and iOS (simulator build) are generated for all open pull requests and linked in pull request comments. Use these if you want to test the changes in a specific pull request and provide feedback before it has been merged.
If you want a more stable version that is a little bit more tested you can get this from the Curent Release page on our website.
Detailed build instructions can be found in the INSTALL.md file.
System Requirements
On desktop, the integrated Googlemaps feature of Subsurface requires a GPU
driver that has support for at least OpenGL 2.1. If your driver does not
support that, you may have to run Subsurface in software renderer mode.
Subsurface will automatically attempt to detect this scenario, but in case
it doesn't you may have to enable the software renderer manually with
the following:
- Learn how to set persistent environment variables on your OS
- Set the environment variable 'QT_QUICK_BACKEND' with the value of 'software'
Basic Usage
Install and start from the desktop, or you can run it locally from the
build directory:
On Linux:
$ ./subsurface
On Mac:
$ open Subsurface.app
Native builds on Windows are not really supported (the official Windows
installers are cross-built on Linux).
You can give a data file as command line argument, or (once you have
set this up in the Preferences) Subsurface picks a default file for
you when started from the desktop or without an argument.
If you have a dive computer supported by libdivecomputer, you can just
select "Import from Divecomputer" from the "Import" menu, select which
dive computer you have (and where it is connected if you need to - note
that there's a special selection for Bluetooth dive computers), and click
on "Download".
The latest list of supported dive computers can be found in the file
SupportedDivecomputers.txt.
Much more detailed end user instructions can be found from inside
Subsurface by selecting Help (typically F1). When building from source
this is also available as Documentation/user-manual.txt. The
documentation for the latest release is also available on-line
http://subsurface-divelog.org/documentation/
Contributing
Subsurface welcomes contributions through code, testing, documentation,
translations, design, and user support. See our
contribution guide to find the correct workflow.
Translations are managed through Transifex. Please do not submit pull
requests that directly edit translation files; the contribution guide links
to the application and website translation projects.
A bit of Subsurface history
In fall of 2011, when a forced lull in kernel development gave him an
opportunity to start on a new endeavor, Linus Torvalds decided to tackle
his frustration with the lack of decent divelog software on Linux.
Subsurface is the result of the work of him and a team of developers since
then. It now supports Linux, Windows and macOS and allows data import from
a large number of dive computers and several existing divelog programs. It
provides advanced visualization of the key information provided by a
modern dive computer and allows the user to track a wide variety of data
about their diving.
In fall of 2012 Dirk Hohndel took over as maintainer of Subsurface.