Library of python modules for reading and processing raw RDI Teledyne ADCP data. The code interfaces the UH package pycurrents and its Multiread for efficient reading of raw ADCP data.
velosearaptor.io provides convenience functions for reading raw data either into an xarray.Dataset or into the output structure format provided by the UH software package.
velosearaptor.adcp is a collection of functions that are useful to quickly analyze raw ADCP data.
velosearaptor.madcp contains functions for processing moored ADCP data. Many thanks to Eric Fiering for sharing his code on moored ADCP data processing mcm_avp.py that much of this is based on.
This package depends on the pycurrents package. Installation instructions can either be found here, or a conda environment including all necessary dependencies can be installed via conda env create -f environment.yml. Take a look at environment.yml and requirements.txt and copy the relevant parts if you would like to incude the package and its dependencies in other environments.
Note that this method only works with the editable pip install of velosearaptor (e.g. pip install -e .) since it compiles magdec locally and does not do a system install. See note at bottom for system install.
Requirements:
- A C compiler, e.g. in OSX with homebrew use
brew install gcc condapackage manager- The velosearaptor environment installed via conda, e.g.
conda env create -f environment.yml
With the requirements satisfied, run the shell script:
./install_magdec.shTo remove, delete the geomag/ directory.
For a system install you need to cd geomag and do something like sudo make install.