endaq is available on PYPI via pip
:
pip install endaq
For the most recent features that are still under development, you can also use pip
to install endaq directly from GitHub:
pip install git+https://github.com/MideTechnology/endaq-python.git@development
This package consists of several submodules, you can read more about how these are used in their respective readme files:
endaq.calc
(readme): A computational backend for vibration analysis.endaq.cloud
(readme): Tools for interacting with enDAQ Cloud services.endaq.ide
(readme): High-level utility functions to aid in importing and inspecting enDAQ IDE recording files.endaq.plot
(readme): A package comprising a collection of plotting utilities for sensor data analysis.
The docs for this package can be found here.
To locally build the Sphinx documentation from a clone of the repo:
cd <repo root dir>
pip install -e .[docs]
sphinx-build -W -b html docs docs/_build
The endaq-python repository is licensed under the MIT license. The full text can be found in the LICENSE file.