scikit-diveMove Documentation¶
scikit-diveMove is a Python interface to R package diveMove for scientific data analysis, with a focus on diving behaviour analysis. It has utilities to represent, visualize, filter, analyse, and summarize time-depth recorder (TDR) data. Miscellaneous functions for handling location data are also provided.
scikit-diveMove is hosted at https://github.com/spluque/scikit-diveMove
Installation¶
Type the following at a terminal command line:
pip install scikit-kinematics
Or install from source tree by typing the following at the command line:
python setup.py install
Once installed, skdiveMove can be easily imported as:
import skdiveMove as skdive
Dependencies¶
skdiveMove depends primarily on R
package diveMove, which must be
installed and available to the user running Python. If needed, install
diveMove at the R
prompt:
install.packages("diveMove")
Required Python packages are listed in the requirements file.
Testing¶
The skdiveMove package can be tested with unittest:
python -m unittest -v skdiveMove/tests
or pytest:
pytest -v skdiveMove/tests
Development¶
Developers and hackers can clone the project from Github:
git clone https://github.com/spluque/scikit-diveMove.git .
and then install with:
pip install -e .["dev"]