Python API for enDAQ data recorders
Project description
endaq.device
endaq.device
(formerly endaqlib
) provides a means of representing, accessing, configuring
and controlling enDAQâ„¢ data
recorders.
It also supports legacy SlamStickâ„¢ devices (X, C, and S).
Installation
For the most recent features that are still under development, you can also use pip to install endaq directly from the GitHub repository:
pip install git+https://github.com/MideTechnology/endaq-device.git@develop
Note: While endaq-device
installs into the same endaq
'namespace' as
endaq-python, it is
otherwise separate; the two packages are not interdependent, and one can
be installed without the other. The packages do distinctly different
things, and have very different use-cases.
Documentation
Note: the documentation is currently a work in progress.
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]
pip install -r ./docs/requirements.txt
sphinx-build -W -b html docs docs/_build
Note: The documentation build conflicts with endaq-python; if you already have
endaq-python installed, it is easiest to work in a virtual environment (e.g., first using
python -m venv <env dir>
followed by <venv dir>\Scripts\activate
under Windows,
source <venv dir>/bin/activate
under Linux/macOS).
License
The endaq-python repository is licensed under the MIT license. The full text can be found in the LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for endaq_device-1.0.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 966f5fee202b00b9b83e8f05f733b059ee29ebba983341625e36c628acd3072a |
|
MD5 | 5603771331e4c7d707fb31e7b6e1dc78 |
|
BLAKE2b-256 | 3f1d05982b6064e7634618323826d5c33beafb117ec382e4216e0e0c352b38d9 |