dol
dolfyn
pypi i dolfyn
dol

dolfyn

A library for oceanographic doppler instruments such as Acoustic Doppler Profilers (ADPs, ADCPs) and Acoustic Doppler Velocimeters (ADVs).

by Levi Kilcher

1.0.2 (see all)
pypi i dolfyn
Readme

DOLfYN

Build Coverage Status Documentation Status

BIG NEWS!!!

Hello everyone! Just so that you know, we have released dolfyn 1.0! This is a MAJOR REFACTOR of the code so that DOLfYN is now built on xarray, rather than the somewhat contrived and purpose-built pyDictH5 package.

This means that DOLfYN 1.0 is not backwards compatible with earlier version. This, in turn, means two things:

  1. The data files (.h5 files) you created with earlier versions of DOLfYN will no longer load with DOLfYN 1.0.0.
  2. The syntax of DOLfYN 1.0 is completely different from earlier version.

Because of this, it's probably easiest to continue using earlier versions of DOLfYN for your old data. If you want to bring some data into DOLfYN 1.0, you will need to dolfyn.read(binary_source_file.ext), and then refactor your code to work properly with DOLfYN's new syntax. I may be providing some updates to dolfyn 0.12 via the v0.12-backports branch (and associated releases), but I doubt that will last long. If you are using 0.13, we recommend switching to 1.0.

Very sorry that we didn't communicate the plan for this change, but the truth is that we simply don't know who our users are. The good news is that I think in the long run this will make DOLfYN a much more robust, powerful, and compatible tool -- especially because we now write/load xarray-formatted netcdf4 files, which is becoming a standard.

A HUGE THANK YOU to @jmcvey3 who did the vast majority of the work to make this happen.

Summary

DOLfYN is the Doppler Oceanography Library for pYthoN.

It is designed to read and work with Acoustic Doppler Velocimeter (ADV) and Acoustic Doppler Profiler (ADP/ADCP) data. DOLfYN includes libraries for reading binary Nortek(tm) and Teledyne RDI(tm) data files.

  • Read in binary data files from acoustic Doppler instruments
  • Clean data
  • Rotate vector data through coordinate systems (i.e. beam - instrument - Earth frames of reference)
  • Motion correction for buoy-mounted ADV velocity measurements (via onboard IMU data)
  • Bin/ensemble averaging
  • Calculate turbulence statistics

Documentation

For details visit the DOLfYN homepage.

Installation

DOLfYN requires Python 3.7 or later and a number of dependencies. See the install page for greater details.

License

DOLfYN is copyright through the National Renewable Energy Laboratory, Pacific Northwest National Laboratory, and Sandia National Laboratories. The software is distributed under the Revised BSD License. See the license for more information.

GitHub Stars

26

LAST COMMIT

5mos ago

MAINTAINERS

1

CONTRIBUTORS

9

OPEN ISSUES

16

OPEN PRs

2
VersionTagPublished
1.0.2
1mo ago
1.0.1
3mos ago
1.0.0
5mos ago
0.12.3
7mos ago
No alternatives found
No tutorials found
Add a tutorial