depthviz 0.3.0.dev2

Python CLI tool for generating depth tracking overlays for your dive footage from exported dive computer logs.

depthviz: Transform your dive footage with depth tracking

[!NOTE] This project is in active development. Feel free to open an issue for any feedback or feature requests.

depthviz makes it easy to add dynamic depth tracking, giving your viewers a deeper understanding of your underwater sensation. It is a command-line tool for generating depth overlay videos from the data recorded by your dive computer. It processes your dive log and creates a video that visualizes the depth over time.

This allows you to create more informative and engaging dive videos, enriching the storytelling experience for both yourself and your audience. Click here to watch a sample video.

Installation

Prerequisites:

• Python (3.9 or higher) installed on your system.
• pipx for installing Python CLI tools.

Installation:

pipx install depthviz

Usage

1. Download Your Data:

Export your dive log data from your dive computer or diving application. See the source options below for supported formats.

2. Generate the Overlay:

depthviz -i <input_file> -s <source> -o <output_video.mp4>

Arguments:

• -i, --input <input_file>: Path to your file containing your dive log.
• -s, --source <source>: Source of the dive computer data. See the table below for supported sources.
• -o, --output <output_video.mp4>: Path or filename for the generated video with the depth overlay. The output file format must be .mp4.

Source Options:

Source	Description	File type	Development Status
apnealizer	Data exported from Apnealizer, logging and analyzing application.	CSV	:white_check_mark: Supported
shearwater	Data exported from Shearwater dive computers.	XML	:white_check_mark: Supported
garmin	Data exported from Garmin dive computers.	-	:x: Sample data needed :rotating_light:
suunto	Data exported from Suunto dive computers.	-	:x: Sample data needed :rotating_light:
manual	Manually input the dive data, for those who don't have a dive computer.	-	:construction: Under development

Example:

Example of generating a depth overlay video named depth_overlay.mp4 using data from my_dive.xml exported from Shearwater dive computers (source: shearwater).

depthviz -i my_dive.xml -s shearwater -o depth_overlay.mp4

3. Integrate with Your Footage:

Import the generated overlay video into your preferred video editing software and combine it with your original dive footage. Adjust the blending and position of the overlay to suit your video style.

Watch this tutorial on how to import an overlay video in CapCut Desktop.

Contribution

We welcome contributions to the depthviz project! If you have any ideas for improvement, bug fixes, or feature suggestions, feel free to open an issue to discuss or submit a pull request.

Help Us Expand Dive Computer Support!

Missing your dive computer? Help us add support! Submit a Dive Computer Support Request issue with your dive log file and export source.

By providing this information, you'll be helping us understand the specific format of your dive computer's exported data. This allows us to implement the necessary parsing logic and add support for your device in a future release.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.

Contact

For any inquiries, please open an issue. We'd love to hear from you!