ARUS python package provides a computational and experimental framework to manage and process sensory data or wireless devices, to develop and run activity recognition algorithms on the data, and to create interactive programs using the algorithms and wireless devices.
This package is licensed under GPL version 3.
python >= 3.7.0
# Need these SDKs to install arus[metawear] on Windows. Visual Studio C++ SDK (v14.1) Windows SDK (10.0.16299.0) Windows SDK (10.0.17763.0) # Need these packages to install arus[metawear] on Ubuntu or equivalent packages on other linux distributions. libbluetooth-dev libboost-all-dev bluez
> pip install arus # Optionally, you may install plugins via pip extra syntax. > pip install arus[metawear] > pip install arus[demo] > pip install arus[dev] > pip install arus[nn]
arus[metawear]: This optional component installs dependency supports for streaming data from Bluetooth metawear sensors.
arus[demo]: This optional component installs dependency supports for running the demo app that demonstrates a real-time interactive activity recognition training and testing program.
arus[dev]: These optional component installs dependency supports for running some package and version management functions in the
arus[nn]: The optional component installs dependency supports for PyTorch and Tensorboard, which are required by
arus.models.report module. Note that for Windows, you should install the
torch package manually using
pip following the
Get started for development¶
> git clone https://github.com/qutang/arus.git > cd arus > # Install poetry python package management tool https://python-poetry.org/docs/ > # On Linux > curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python > # On windows powershell > (Invoke-WebRequest -Uri https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python > # Install package dependencies > poetry install > # Install optional component dependencies > poetry install --extras "metawear demo dev nn" > # Run unit tests > poetry run pytest
- Use Google’s python coding guidance: http://google.github.io/styleguide/pyguide.html.
arus package release VERSION --releaseto bump and tag versions.
VERSIONcan be manual version code following semantic versioning,
- Changelogs are automatically generated when building the documentation website, do not create it manually.
- Pypi release will be handled by github action
deploy.yml, which will be triggered whenever a new tag is pushed. Therefore, developers should only tag release versions.
- After commits, even not bumping and releasing the package, you may run
arus package docs --releaseto update the documentation website, where the developer version changelogs will be updated immediately.