markusritschel / oceanpack

Routines to handle log files of the OceanPack from SubCtech®
https://markusritschel.github.io/oceanpack/
MIT License
0 stars 0 forks source link

Oceanpack

build codecov License MIT license

Disclaimer: This is not an official package. The company SubCtech is not involved in the development of the routines provided here.

This repository contains routines for the evaluation of data from the OceanPack™ AUMS (Autonomous Underwater Measuring System) by SubCtech®.

The oceanpack module contains routines to read-in log files of the OceanPack as well as various helper functions to help with the data processing, e.g.

Installation

Clone this repo via

git clone https://github.com/markusritschel/oceanpack

Then, in the new directory (cd oceanpack/) install the package via:

pip install .

or via

pip install -e .

if you plan to make changes to the code.

Alternatively, install directly from GitHub via

pip install 'git+https://github.com/markusritschel/oceanpack.git'

Examples

In the subdirectory notebooks one can also find a Jupyter Notebook showing the usage of the various functions based on a short dataset.

Testing

Run make tests in the source directory to test the code. This will execute both the unit tests and docstring examples (using pytest).

Run make lint to check code style consistency.

Contact & Issues

For any questions or issues, please contact me via git@markusritschel.de or open an issue.


© Markus Ritschel 2024